Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

14.16 14.18.10 Resource ResearchDefinition Measure - Content Operations

Clinical Decision Support Quality Information icon Work Group Maturity Level : 0 N/A   Trial Use Standards Status : Informative Security Category : Business Anonymous Compartments : Not linked to any defined compartments

The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about. 14.16.1 Scope and Usage This resource is a definition resource from a FHIR workflow perspective - see Workflow , specifically Definition . TODO 14.16.2 Boundaries and Relationships TODO 14.16.3 Resource Content Structure UML XML JSON Turtle R3 Diff All Structure Name Flags Card. Type Description & Constraints ResearchDefinition I TU DomainResource A research context or question + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension url Σ 0..1 uri Canonical identifier for this research definition, represented as a URI (globally unique) identifier Σ 0..* Identifier Additional identifier for the research definition version Σ 0..1 string Business version of the research definition name Σ I 0..1 string Name for this research definition (computer friendly) title Σ 0..1 string Name for this research definition (human friendly) shortTitle 0..1 string Title for use in informal contexts subtitle 0..1 string Subordinate title of the ResearchDefinition status ?! Σ 1..1 code draft | active | retired | unknown PublicationStatus ( Required ) experimental Σ 0..1 boolean For testing purposes, not real usage subject[x] 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Subject type ( Extensible ) subjectCodeableConcept CodeableConcept subjectReference Reference ( Group ) date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher description Σ 0..1 markdown Natural language description of the research definition comment 0..* string Used for footnotes or explanatory notes useContext Σ 0..* UsageContext The context that the content is intended to support jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for research definition (if applicable) Jurisdiction ( Extensible ) purpose 0..1 markdown Why this research definition is defined usage 0..1 string Describes the clinical usage of the ResearchDefinition copyright 0..1 markdown Use and/or publishing restrictions approvalDate 0..1 date When the research definition was approved by publisher lastReviewDate 0..1 date When the research definition was last reviewed effectivePeriod Σ 0..1 Period When the research definition is expected to be used topic 0..* CodeableConcept The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc. DefinitionTopic ( Example ) author 0..* ContactDetail Who authored the content editor 0..* ContactDetail Who edited the content reviewer 0..* ContactDetail Who reviewed the content endorser 0..* ContactDetail Who endorsed the content relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc. library 0..* canonical ( Library ) Logic used by the ResearchDefinition population Σ 1..1 Reference ( ResearchElementDefinition ) What population? exposure Σ 0..1 Reference ( ResearchElementDefinition ) What exposure? exposureAlternative Σ 0..1 Reference ( ResearchElementDefinition ) What alternative exposure state? outcome Σ 0..1 Reference ( ResearchElementDefinition ) What outcome? Documentation for this format UML Diagram ( Legend ) ResearchDefinition ( DomainResource ) An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers url : uri [0..1] A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance identifier : Identifier [0..*] The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts version : string [0..1] A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1] A short, descriptive, user-friendly title for the research definition title : string [0..1] The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary shortTitle : string [0..1] An explanatory or alternate title for the ResearchDefinition giving additional information about its content subtitle : string [0..1] The status of this research definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of an artifact. (Strength=Required) PublicationStatus ! » A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage experimental : boolean [0..1] The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything subject[x] : Type [0..1] « CodeableConcept | Reference ( Group ); The possible types of subjects for the research (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType + » The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes date : dateTime [0..1] The name of the organization or individual that published the research definition publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the research definition from a consumer's perspective description : markdown [0..1] A human-readable string to clarify or explain concepts about the resource comment : string [0..*] The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research definition instances useContext : UsageContext [0..*] A legal or geographic region in which the research definition is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible) Jurisdiction ValueSet + » Explanation of why this research definition is needed and why it has been designed as it has purpose : markdown [0..1] A detailed description, from a clinical perspective, of how the ResearchDefinition is used usage : string [0..1] A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition copyright : markdown [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date lastReviewDate : date [0..1] The period during which the research definition content was or is planned to be in active use effectivePeriod : Period [0..1] Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching topic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the content author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the content editor : ContactDetail [0..*] An individual or organization primarily responsible for review of some aspect of the content reviewer : ContactDetail [0..*] An individual or organization responsible for officially endorsing the content for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, or bibliographic references relatedArtifact : RelatedArtifact [0..*] A reference to a Library resource containing the formal logic used by the ResearchDefinition library : canonical [0..*] « Library » A reference to a ResearchElementDefinition resource that defines the population for the research population : Reference [1..1] « ResearchElementDefinition » A reference to a ResearchElementDefinition resource that defines the exposure for the research exposure : Reference [0..1] « ResearchElementDefinition » A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research exposureAlternative : Reference [0..1] « ResearchElementDefinition » A reference to a ResearchElementDefinition resomece that defines the outcome for the research outcome : Reference [0..1] « ResearchElementDefinition » XML Template < <!-- from --> <!-- from --> < <</identifier> < < < < < < < <</subject[x]> < < <</contact> < < <</useContext> <</jurisdiction> < < < < < <</effectivePeriod> <</topic> <</author> <</editor> <</reviewer> <</endorser> <</relatedArtifact> <</library> <</population> <</exposure> <</exposureAlternative> <</outcome> </ResearchDefinition> JSON Template { "resourceType" : "", // from // from " " " " " " " " " " }, " }, " " " " " " " " " " " " " " " " " " " " " " " " } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ a fhir:; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ] Changes since R3 This resource did not exist in Release 2 This analysis is available as XML or JSON . Structure Name Flags Card. Type Description & Constraints ResearchDefinition I TU DomainResource A research context or question + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension url Σ 0..1 uri Canonical identifier for this research definition, represented as a URI (globally unique) identifier Σ 0..* Identifier Additional identifier for the research definition version Σ 0..1 string Business version of the research definition name Σ I 0..1 string Name for this research definition (computer friendly) title Σ 0..1 string Name for this research definition (human friendly) shortTitle 0..1 string Title for use in informal contexts subtitle 0..1 string Subordinate title of the ResearchDefinition status ?! Σ 1..1 code draft | active | retired | unknown PublicationStatus ( Required ) experimental Σ 0..1 boolean For testing purposes, not real usage subject[x] 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Subject type ( Extensible ) subjectCodeableConcept CodeableConcept subjectReference Reference ( Group ) date Σ 0..1 dateTime Date last changed publisher Σ 0..1 string Name of the publisher (organization or individual) contact Σ 0..* ContactDetail Contact details for the publisher description Σ 0..1 markdown Natural language description of the research definition comment 0..* string Used for footnotes or explanatory notes useContext Σ 0..* UsageContext The context that the content is intended to support jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for research definition (if applicable) Jurisdiction ( Extensible ) purpose 0..1 markdown Why this research definition is defined usage 0..1 string Describes the clinical usage of the ResearchDefinition copyright 0..1 markdown Use and/or publishing restrictions approvalDate 0..1 date When the research definition was approved by publisher lastReviewDate 0..1 date When the research definition was last reviewed effectivePeriod Σ 0..1 Period When the research definition is expected to be used topic 0..* CodeableConcept The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc. DefinitionTopic ( Example ) author 0..* ContactDetail Who authored the content editor 0..* ContactDetail Who edited the content reviewer 0..* ContactDetail Who reviewed the content endorser 0..* ContactDetail Who endorsed the content relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc. library 0..* canonical ( Library ) Logic used by the ResearchDefinition population Σ 1..1 Reference ( ResearchElementDefinition ) What population? exposure Σ 0..1 Reference ( ResearchElementDefinition ) What exposure? exposureAlternative Σ 0..1 Reference ( ResearchElementDefinition ) What alternative exposure state? outcome Σ 0..1 Reference ( ResearchElementDefinition ) What outcome? Documentation for this format UML Diagram ( Legend ) ResearchDefinition ( DomainResource ) An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers url : uri [0..1] A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance identifier : Identifier [0..*] The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts version : string [0..1] A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1] A short, descriptive, user-friendly title for the research definition title : string [0..1] The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary shortTitle : string [0..1] An explanatory or alternate title for the ResearchDefinition giving additional information about its content subtitle : string [0..1] The status of this research definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of an artifact. (Strength=Required) PublicationStatus ! » A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage experimental : boolean [0..1] The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything subject[x] : Type [0..1] « CodeableConcept | Reference ( Group ); The possible types of subjects for the research (E.g. Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType + » The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes date : dateTime [0..1] The name of the organization or individual that published the research definition publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the research definition from a consumer's perspective description : markdown [0..1] A human-readable string to clarify or explain concepts about the resource comment : string [0..*] The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist 5 operations operations associated with indexing and searching for appropriate research definition instances useContext : UsageContext [0..*] A legal or geographic region in which the research definition is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible) Jurisdiction ValueSet + » Explanation of why this research definition is needed and why it has been designed as it has purpose : markdown [0..1] A detailed description, from a clinical perspective, of how the ResearchDefinition is used usage : string [0..1] A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition copyright : markdown [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date lastReviewDate : date [0..1] The period during which the research definition content was or is planned to be in active use effectivePeriod : Period [0..1] Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching topic : CodeableConcept [0..*] « High-level categorization of the definition, used for searching, sorting, and filtering. (Strength=Example) DefinitionTopic ?? » An individiual or organization primarily involved in the creation and maintenance of the content author : ContactDetail [0..*] An individual or organization primarily responsible for internal coherence of the content editor : ContactDetail [0..*] An individual or organization primarily responsible for review of some aspect of the content reviewer : ContactDetail [0..*] An individual or organization responsible for officially endorsing the content for use in some setting endorser : ContactDetail [0..*] Related artifacts such as additional documentation, justification, or bibliographic references relatedArtifact : RelatedArtifact [0..*] A reference to a Library resource containing the formal logic used by the ResearchDefinition library : canonical [0..*] « Library » A reference to a ResearchElementDefinition resource that defines the population for the research population : Reference [1..1] « ResearchElementDefinition » A reference to a ResearchElementDefinition resource that defines the exposure for the research exposure : Reference [0..1] « ResearchElementDefinition » A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research exposureAlternative : Reference [0..1] « ResearchElementDefinition » A reference to a ResearchElementDefinition resomece that defines the outcome for the research outcome : Reference [0..1] « ResearchElementDefinition » XML Template < <!-- from --> <!-- from --> < <</identifier> < < < < < < < <</subject[x]> < < <</contact> < < <</useContext> <</jurisdiction> < < < < < <</effectivePeriod> <</topic> <</author> <</editor> <</reviewer> <</endorser> <</relatedArtifact> <</library> <</population> <</exposure> <</exposureAlternative> <</outcome> </ResearchDefinition> JSON Template { "resourceType" : "", // from // from " " " " " " " " " " }, " }, " " " " " " " " " " " " " " " " " " " " " " " " } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ a fhir:; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from # from fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: # . One of these 2 fhir: ] fhir:) ] fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: fhir: ] Changes since Release 3 This resource did not exist in Release 2 This analysis is available as XML or JSON .   See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis 14.16.3.1 Terminology Bindings Path Definition Type Reference ResearchDefinition.status The lifecycle status of an artifact. Required PublicationStatus ResearchDefinition.subject[x] The possible types of subjects for the research (E.g. Patient, Practitioner, Organization, Location, etc.). Extensible SubjectType ResearchDefinition.jurisdiction Countries and regions within which this artifact is targeted for use. Extensible Jurisdiction ValueSet ResearchDefinition.topic High-level categorization of the definition, used for searching, sorting, and filtering. Example DefinitionTopic 14.16.3.2 Constraints id Level Location Description Expression rsd-0 Warning (base) Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}') 14.16.4 Search Parameters Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services. it:

Name Type Description Expression In Common composed-of reference What resource is being referenced ResearchDefinition.relatedArtifact.where(type='composed-of').resource (Any) context token A use context assigned to the research definition (ResearchDefinition.useContext.value as CodeableConcept) context-quantity quantity A quantity- or range-valued use context assigned to the research definition (ResearchDefinition.useContext.value as Quantity) | (ResearchDefinition.useContext.value as Range) context-type token A type of use context assigned to the research definition ResearchDefinition.useContext.code context-type-quantity composite A use context type and quantity- or range-based value assigned to the research definition On ResearchDefinition.useContext:   context-type: code   context-quantity: value.as(Quantity) | value.as(Range) context-type-value composite A use context type and value assigned to the research definition On ResearchDefinition.useContext:   context-type: code   context: value.as(CodeableConcept) date date The research definition publication date ResearchDefinition.date depends-on reference What resource is being referenced ResearchDefinition.relatedArtifact.where(type='depends-on').resource | ResearchDefinition.library ( Library , Any) derived-from reference What resource is being referenced ResearchDefinition.relatedArtifact.where(type='derived-from').resource (Any) description string The description of the research definition ResearchDefinition.description effective date The time during which the research definition is intended to be in use ResearchDefinition.effectivePeriod identifier token External identifier for the research definition ResearchDefinition.identifier jurisdiction token Intended jurisdiction for the research definition ResearchDefinition.jurisdiction name string Computationally friendly name of the research definition ResearchDefinition.name predecessor reference What resource is being referenced ResearchDefinition.relatedArtifact.where(type='predecessor').resource (Any) publisher string Name of the publisher of the research definition ResearchDefinition.publisher status token The current status of the research definition ResearchDefinition.status successor reference $evaluate-measure What resource is being referenced ResearchDefinition.relatedArtifact.where(type='successor').resource (Any) Evaluate Measure
title string $data-requirements The human-friendly name of the research definition ResearchDefinition.title Data Requirements
topic token $submit-data Topics associated with the ResearchDefinition ResearchDefinition.topic Submit Data
url uri $collect-data The uri that identifies the research definition ResearchDefinition.url Collect Data
version token $care-gaps The business version of the research definition ResearchDefinition.version Care Gaps

For more information about operations, including how they are invoked, see Operations .