Release 4B Ballot #1

This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. 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: R4B R4

14.19 Resource ResearchDefinition - Content

Clinical Decision Support Work GroupMaturity Level: 0 Trial UseSecurity Category: Business 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.19.1 Scope and Usage

This resource is a definition resource from a FHIR workflow perspective - see Workflow, specifically Definition.

TODO

14.19.2 Boundaries and Relationships

TODO

14.19.3 References

No resources refer to this resource directly.

This resource implements the Definition pattern.

14.19.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchDefinition TUDomainResourceA 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..1uriCanonical identifier for this research definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the research definition
... version Σ0..1stringBusiness version of the research definition
... name Σ0..1stringName for this research definition (computer friendly)
... title Σ0..1stringName for this research definition (human friendly)
... shortTitle 0..1stringTitle for use in informal contexts
... subtitle 0..1stringSubordinate title of the ResearchDefinition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Subject type (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the research definition
... comment 0..*stringUsed for footnotes or explanatory notes
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for research definition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this research definition is defined
... usage 0..1stringDescribes the clinical usage of the ResearchDefinition
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the research definition was approved by publisher
... lastReviewDate 0..1dateWhen the research definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the research definition is expected to be used
... topic 0..*CodeableConceptThe category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
DefinitionTopic (Example)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... library 0..*canonical(Library)Logic used by the ResearchDefinition
... population Σ1..1Reference(ResearchElementDefinition)What population?
... exposure Σ0..1Reference(ResearchElementDefinition)What exposure?
... exposureAlternative Σ0..1Reference(ResearchElementDefinition)What alternative exposure state?
... outcome Σ0..1Reference(ResearchElementDefinition)What outcome?

doco 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 serversurl : 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 instanceidentifier : 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 artifactsversion : 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 generationname : string [0..1]A short, descriptive, user-friendly title for the research definitiontitle : string [0..1]The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessaryshortTitle : string [0..1]An explanatory or alternate title for the ResearchDefinition giving additional information about its contentsubtitle : 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 usageexperimental : 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 anythingsubject[x] : Element [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 changesdate : dateTime [0..1]The name of the organization or individual that published the research definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the research definition from a consumer's perspectivedescription : markdown [0..1]A human-readable string to clarify or explain concepts about the resourcecomment : 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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the research definition is intended to be usedjurisdiction : 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 haspurpose : markdown [0..1]A detailed description, from a clinical perspective, of how the ResearchDefinition is usedusage : 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 definitioncopyright : 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 usageapprovalDate : 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 datelastReviewDate : date [0..1]The period during which the research definition content was or is planned to be in active useeffectivePeriod : 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 searchingtopic : 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 contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]A reference to a Library resource containing the formal logic used by the ResearchDefinitionlibrary : canonical [0..*] « Library »A reference to a ResearchElementDefinition resource that defines the population for the researchpopulation : Reference [1..1] « ResearchElementDefinition »A reference to a ResearchElementDefinition resource that defines the exposure for the researchexposure : Reference [0..1] « ResearchElementDefinition »A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the researchexposureAlternative : Reference [0..1] « ResearchElementDefinition »A reference to a ResearchElementDefinition resomece that defines the outcome for the researchoutcome : Reference [0..1] « ResearchElementDefinition »

XML Template

<ResearchDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this research definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the research definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the research definition -->
 <name value="[string]"/><!-- 0..1 Name for this research definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this research definition (human friendly) -->
 <shortTitle value="[string]"/><!-- 0..1 Title for use in informal contexts -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the ResearchDefinition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the research definition -->
 <comment value="[string]"/><!-- 0..* Used for footnotes or explanatory notes -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for research definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this research definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the ResearchDefinition -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the research definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the research definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the research definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the ResearchDefinition --></library>
 <population><!-- 1..1 Reference(ResearchElementDefinition) What population? --></population>
 <exposure><!-- 0..1 Reference(ResearchElementDefinition) What exposure? --></exposure>
 <exposureAlternative><!-- 0..1 Reference(ResearchElementDefinition) What alternative exposure state? --></exposureAlternative>
 <outcome><!-- 0..1 Reference(ResearchElementDefinition) What outcome? --></outcome>
</ResearchDefinition>

JSON Template

{doco
  "resourceType" : "ResearchDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this research definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the research definition
  "version" : "<string>", // Business version of the research definition
  "name" : "<string>", // Name for this research definition (computer friendly)
  "title" : "<string>", // Name for this research definition (human friendly)
  "shortTitle" : "<string>", // Title for use in informal contexts
  "subtitle" : "<string>", // Subordinate title of the ResearchDefinition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the research definition
  "comment" : ["<string>"], // Used for footnotes or explanatory notes
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for research definition (if applicable)
  "purpose" : "<markdown>", // Why this research definition is defined
  "usage" : "<string>", // Describes the clinical usage of the ResearchDefinition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the research definition was approved by publisher
  "lastReviewDate" : "<date>", // When the research definition was last reviewed
  "effectivePeriod" : { Period }, // When the research definition is expected to be used
  "topic" : [{ CodeableConcept }], // The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "library" : [{ canonical(Library) }], // Logic used by the ResearchDefinition
  "population" : { Reference(ResearchElementDefinition) }, // R!  What population?
  "exposure" : { Reference(ResearchElementDefinition) }, // What exposure?
  "exposureAlternative" : { Reference(ResearchElementDefinition) }, // What alternative exposure state?
  "outcome" : { Reference(ResearchElementDefinition) } // What outcome?
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ResearchDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ResearchDefinition.url [ uri ]; # 0..1 Canonical identifier for this research definition, represented as a URI (globally unique)
  fhir:ResearchDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the research definition
  fhir:ResearchDefinition.version [ string ]; # 0..1 Business version of the research definition
  fhir:ResearchDefinition.name [ string ]; # 0..1 Name for this research definition (computer friendly)
  fhir:ResearchDefinition.title [ string ]; # 0..1 Name for this research definition (human friendly)
  fhir:ResearchDefinition.shortTitle [ string ]; # 0..1 Title for use in informal contexts
  fhir:ResearchDefinition.subtitle [ string ]; # 0..1 Subordinate title of the ResearchDefinition
  fhir:ResearchDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ResearchDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # ResearchDefinition.subject[x] : 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2
    fhir:ResearchDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:ResearchDefinition.subjectReference [ Reference(Group) ]
  fhir:ResearchDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:ResearchDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ResearchDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ResearchDefinition.description [ markdown ]; # 0..1 Natural language description of the research definition
  fhir:ResearchDefinition.comment [ string ], ... ; # 0..* Used for footnotes or explanatory notes
  fhir:ResearchDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ResearchDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for research definition (if applicable)
  fhir:ResearchDefinition.purpose [ markdown ]; # 0..1 Why this research definition is defined
  fhir:ResearchDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the ResearchDefinition
  fhir:ResearchDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ResearchDefinition.approvalDate [ date ]; # 0..1 When the research definition was approved by publisher
  fhir:ResearchDefinition.lastReviewDate [ date ]; # 0..1 When the research definition was last reviewed
  fhir:ResearchDefinition.effectivePeriod [ Period ]; # 0..1 When the research definition is expected to be used
  fhir:ResearchDefinition.topic [ CodeableConcept ], ... ; # 0..* The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
  fhir:ResearchDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:ResearchDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:ResearchDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:ResearchDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:ResearchDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:ResearchDefinition.library [ canonical(Library) ], ... ; # 0..* Logic used by the ResearchDefinition
  fhir:ResearchDefinition.population [ Reference(ResearchElementDefinition) ]; # 1..1 What population?
  fhir:ResearchDefinition.exposure [ Reference(ResearchElementDefinition) ]; # 0..1 What exposure?
  fhir:ResearchDefinition.exposureAlternative [ Reference(ResearchElementDefinition) ]; # 0..1 What alternative exposure state?
  fhir:ResearchDefinition.outcome [ Reference(ResearchElementDefinition) ]; # 0..1 What outcome?
]

Changes since R3

ResearchDefinition
ResearchDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ResearchDefinition TUDomainResourceA 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..1uriCanonical identifier for this research definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the research definition
... version Σ0..1stringBusiness version of the research definition
... name Σ0..1stringName for this research definition (computer friendly)
... title Σ0..1stringName for this research definition (human friendly)
... shortTitle 0..1stringTitle for use in informal contexts
... subtitle 0..1stringSubordinate title of the ResearchDefinition
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... subject[x] 0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Subject type (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the research definition
... comment 0..*stringUsed for footnotes or explanatory notes
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for research definition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this research definition is defined
... usage 0..1stringDescribes the clinical usage of the ResearchDefinition
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the research definition was approved by publisher
... lastReviewDate 0..1dateWhen the research definition was last reviewed
... effectivePeriod Σ0..1PeriodWhen the research definition is expected to be used
... topic 0..*CodeableConceptThe category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
DefinitionTopic (Example)
... author 0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser 0..*ContactDetailWho endorsed the content
... relatedArtifact 0..*RelatedArtifactAdditional documentation, citations, etc.
... library 0..*canonical(Library)Logic used by the ResearchDefinition
... population Σ1..1Reference(ResearchElementDefinition)What population?
... exposure Σ0..1Reference(ResearchElementDefinition)What exposure?
... exposureAlternative Σ0..1Reference(ResearchElementDefinition)What alternative exposure state?
... outcome Σ0..1Reference(ResearchElementDefinition)What outcome?

doco 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 serversurl : 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 instanceidentifier : 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 artifactsversion : 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 generationname : string [0..1]A short, descriptive, user-friendly title for the research definitiontitle : string [0..1]The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessaryshortTitle : string [0..1]An explanatory or alternate title for the ResearchDefinition giving additional information about its contentsubtitle : 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 usageexperimental : 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 anythingsubject[x] : Element [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 changesdate : dateTime [0..1]The name of the organization or individual that published the research definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the research definition from a consumer's perspectivedescription : markdown [0..1]A human-readable string to clarify or explain concepts about the resourcecomment : 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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the research definition is intended to be usedjurisdiction : 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 haspurpose : markdown [0..1]A detailed description, from a clinical perspective, of how the ResearchDefinition is usedusage : 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 definitioncopyright : 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 usageapprovalDate : 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 datelastReviewDate : date [0..1]The period during which the research definition content was or is planned to be in active useeffectivePeriod : 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 searchingtopic : 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 contentauthor : ContactDetail [0..*]An individual or organization primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individual or organization primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individual or organization responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]Related artifacts such as additional documentation, justification, or bibliographic referencesrelatedArtifact : RelatedArtifact [0..*]A reference to a Library resource containing the formal logic used by the ResearchDefinitionlibrary : canonical [0..*] « Library »A reference to a ResearchElementDefinition resource that defines the population for the researchpopulation : Reference [1..1] « ResearchElementDefinition »A reference to a ResearchElementDefinition resource that defines the exposure for the researchexposure : Reference [0..1] « ResearchElementDefinition »A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the researchexposureAlternative : Reference [0..1] « ResearchElementDefinition »A reference to a ResearchElementDefinition resomece that defines the outcome for the researchoutcome : Reference [0..1] « ResearchElementDefinition »

XML Template

<ResearchDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this research definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the research definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the research definition -->
 <name value="[string]"/><!-- 0..1 Name for this research definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this research definition (human friendly) -->
 <shortTitle value="[string]"/><!-- 0..1 Title for use in informal contexts -->
 <subtitle value="[string]"/><!-- 0..1 Subordinate title of the ResearchDefinition -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]>
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the research definition -->
 <comment value="[string]"/><!-- 0..* Used for footnotes or explanatory notes -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for research definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this research definition is defined -->
 <usage value="[string]"/><!-- 0..1 Describes the clinical usage of the ResearchDefinition -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the research definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the research definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the research definition is expected to be used --></effectivePeriod>
 <topic><!-- 0..* CodeableConcept The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc. --></topic>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation, citations, etc. --></relatedArtifact>
 <library><!-- 0..* canonical(Library) Logic used by the ResearchDefinition --></library>
 <population><!-- 1..1 Reference(ResearchElementDefinition) What population? --></population>
 <exposure><!-- 0..1 Reference(ResearchElementDefinition) What exposure? --></exposure>
 <exposureAlternative><!-- 0..1 Reference(ResearchElementDefinition) What alternative exposure state? --></exposureAlternative>
 <outcome><!-- 0..1 Reference(ResearchElementDefinition) What outcome? --></outcome>
</ResearchDefinition>

JSON Template

{doco
  "resourceType" : "ResearchDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this research definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the research definition
  "version" : "<string>", // Business version of the research definition
  "name" : "<string>", // Name for this research definition (computer friendly)
  "title" : "<string>", // Name for this research definition (human friendly)
  "shortTitle" : "<string>", // Title for use in informal contexts
  "subtitle" : "<string>", // Subordinate title of the ResearchDefinition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the research definition
  "comment" : ["<string>"], // Used for footnotes or explanatory notes
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for research definition (if applicable)
  "purpose" : "<markdown>", // Why this research definition is defined
  "usage" : "<string>", // Describes the clinical usage of the ResearchDefinition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the research definition was approved by publisher
  "lastReviewDate" : "<date>", // When the research definition was last reviewed
  "effectivePeriod" : { Period }, // When the research definition is expected to be used
  "topic" : [{ CodeableConcept }], // The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "library" : [{ canonical(Library) }], // Logic used by the ResearchDefinition
  "population" : { Reference(ResearchElementDefinition) }, // R!  What population?
  "exposure" : { Reference(ResearchElementDefinition) }, // What exposure?
  "exposureAlternative" : { Reference(ResearchElementDefinition) }, // What alternative exposure state?
  "outcome" : { Reference(ResearchElementDefinition) } // What outcome?
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ResearchDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ResearchDefinition.url [ uri ]; # 0..1 Canonical identifier for this research definition, represented as a URI (globally unique)
  fhir:ResearchDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the research definition
  fhir:ResearchDefinition.version [ string ]; # 0..1 Business version of the research definition
  fhir:ResearchDefinition.name [ string ]; # 0..1 Name for this research definition (computer friendly)
  fhir:ResearchDefinition.title [ string ]; # 0..1 Name for this research definition (human friendly)
  fhir:ResearchDefinition.shortTitle [ string ]; # 0..1 Title for use in informal contexts
  fhir:ResearchDefinition.subtitle [ string ]; # 0..1 Subordinate title of the ResearchDefinition
  fhir:ResearchDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ResearchDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  # ResearchDefinition.subject[x] : 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2
    fhir:ResearchDefinition.subjectCodeableConcept [ CodeableConcept ]
    fhir:ResearchDefinition.subjectReference [ Reference(Group) ]
  fhir:ResearchDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:ResearchDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ResearchDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ResearchDefinition.description [ markdown ]; # 0..1 Natural language description of the research definition
  fhir:ResearchDefinition.comment [ string ], ... ; # 0..* Used for footnotes or explanatory notes
  fhir:ResearchDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ResearchDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for research definition (if applicable)
  fhir:ResearchDefinition.purpose [ markdown ]; # 0..1 Why this research definition is defined
  fhir:ResearchDefinition.usage [ string ]; # 0..1 Describes the clinical usage of the ResearchDefinition
  fhir:ResearchDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ResearchDefinition.approvalDate [ date ]; # 0..1 When the research definition was approved by publisher
  fhir:ResearchDefinition.lastReviewDate [ date ]; # 0..1 When the research definition was last reviewed
  fhir:ResearchDefinition.effectivePeriod [ Period ]; # 0..1 When the research definition is expected to be used
  fhir:ResearchDefinition.topic [ CodeableConcept ], ... ; # 0..* The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.
  fhir:ResearchDefinition.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:ResearchDefinition.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:ResearchDefinition.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:ResearchDefinition.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:ResearchDefinition.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation, citations, etc.
  fhir:ResearchDefinition.library [ canonical(Library) ], ... ; # 0..* Logic used by the ResearchDefinition
  fhir:ResearchDefinition.population [ Reference(ResearchElementDefinition) ]; # 1..1 What population?
  fhir:ResearchDefinition.exposure [ Reference(ResearchElementDefinition) ]; # 0..1 What exposure?
  fhir:ResearchDefinition.exposureAlternative [ Reference(ResearchElementDefinition) ]; # 0..1 What alternative exposure state?
  fhir:ResearchDefinition.outcome [ Reference(ResearchElementDefinition) ]; # 0..1 What outcome?
]

Changes since Release 3

ResearchDefinition
ResearchDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.1.0

See the Full Difference for further information

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.19.4.1 Terminology Bindings

PathDefinitionTypeReference
ResearchDefinition.status The lifecycle status of an artifact.RequiredPublicationStatus
ResearchDefinition.subject[x] The possible types of subjects for the research (E.g. Patient, Practitioner, Organization, Location, etc.).ExtensibleSubjectType
ResearchDefinition.jurisdiction Countries and regions within which this artifact is targeted for use.ExtensibleJurisdiction ValueSet
ResearchDefinition.topic High-level categorization of the definition, used for searching, sorting, and filtering.ExampleDefinitionTopic

14.19.4.2 Constraints

idLevelLocationDescriptionExpression
rsd-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')

14.19.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
composed-ofreferenceWhat resource is being referencedResearchDefinition.relatedArtifact.where(type='composed-of').resource
(Any)
contexttokenA use context assigned to the research definition(ResearchDefinition.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the research definition(ResearchDefinition.useContext.value as Quantity) | (ResearchDefinition.useContext.value as Range)
context-typetokenA type of use context assigned to the research definitionResearchDefinition.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the research definitionOn ResearchDefinition.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the research definitionOn ResearchDefinition.useContext:
  context-type: code
  context: value.as(CodeableConcept)
datedateThe research definition publication dateResearchDefinition.date
depends-onreferenceWhat resource is being referencedResearchDefinition.relatedArtifact.where(type='depends-on').resource | ResearchDefinition.library
(Library, Any)
derived-fromreferenceWhat resource is being referencedResearchDefinition.relatedArtifact.where(type='derived-from').resource
(Any)
descriptionstringThe description of the research definitionResearchDefinition.description
effectivedateThe time during which the research definition is intended to be in useResearchDefinition.effectivePeriod
identifiertokenExternal identifier for the research definitionResearchDefinition.identifier
jurisdictiontokenIntended jurisdiction for the research definitionResearchDefinition.jurisdiction
namestringComputationally friendly name of the research definitionResearchDefinition.name
predecessorreferenceWhat resource is being referencedResearchDefinition.relatedArtifact.where(type='predecessor').resource
(Any)
publisherstringName of the publisher of the research definitionResearchDefinition.publisher
statustokenThe current status of the research definitionResearchDefinition.status
successorreferenceWhat resource is being referencedResearchDefinition.relatedArtifact.where(type='successor').resource
(Any)
titlestringThe human-friendly name of the research definitionResearchDefinition.title
topictokenTopics associated with the ResearchDefinitionResearchDefinition.topic
urluriThe uri that identifies the research definitionResearchDefinition.url
versiontokenThe business version of the research definitionResearchDefinition.version