Current Build

2.25.0 MetaData Types

FHIR Infrastructure Work GroupMaturity Level: 4Ballot Status: Normative

Normative Candidate Note: Some of the content on this page (marked clearly) is candidate normative content for R4 in the Infrastructure Package. Once normative, it will lose it's Maturity Level, and breaking changes will no longer be made.

This page describes a set of types used for conveying metadata about knowledge resources (mainly for Terminology, Conformance and Clinical Definition resources).

Table of Contents

ContactDetail Contributor DataRequirement ParameterDefinition
RelatedArtifact TriggerDefinition Expression UsageContext

For an index of all data types, see the Data types page.

Normative Candidate Note: This DataType is candidate normative content as part of the overall resource for R4 in the Infrastructure Package. Once normative, it will lose it's Maturity Level, and breaking changes will no longer be made.

See also Examples, Detailed Descriptions and Mappings.

The ContactDetail structure defines general contact details.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactDetailΣNElementContact information
Elements defined in Ancestors: id, extension
... nameΣ0..1stringName of an individual to contact
... telecomΣ0..*ContactPointContact details for individual or organization

doco Documentation for this format

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <name value="[string]"/><!-- 0..1 Name of an individual to contact -->
 <telecom><!-- 0..* ContactPoint Contact details for individual or organization --></telecom>
</[name]>

Turtle Template

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

[
 # from Element: Element.extension
  fhir:ContactDetail.name [ string ]; # 0..1 Name of an individual to contact
  fhir:ContactDetail.telecom [ ContactPoint ], ... ; # 0..* Contact details for individual or organization
]

Changes since Release 3

  • No Changes
ContactDetail

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContactDetailΣNElementContact information
Elements defined in Ancestors: id, extension
... nameΣ0..1stringName of an individual to contact
... telecomΣ0..*ContactPointContact details for individual or organization

doco Documentation for this format

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <name value="[string]"/><!-- 0..1 Name of an individual to contact -->
 <telecom><!-- 0..* ContactPoint Contact details for individual or organization --></telecom>
</[name]>

Turtle Template

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

[
 # from Element: Element.extension
  fhir:ContactDetail.name [ string ]; # 0..1 Name of an individual to contact
  fhir:ContactDetail.telecom [ ContactPoint ], ... ; # 0..* Contact details for individual or organization
]

Changes since Release 3

  • No Changes
ContactDetail

See the Full Difference for further information

Constraints

ContactDetail is used in the following places: Contributor, ActivityDefinition, CapabilityStatement, ChargeItemDefinition, CodeSystem, CompartmentDefinition, ConceptMap, EventDefinition, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, OperationDefinition, PlanDefinition, Questionnaire, ResearchStudy, SearchParameter, StructureDefinition, StructureMap, TerminologyCapabilities, TestScript and ValueSet

 

Normative Candidate Note: This DataType (and the rest on this page) is not normative - it is still undergoing Trial Use while more experience is gathered.

See also Examples, Detailed Descriptions and Mappings.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContributorΣTUElementContributor information
Elements defined in Ancestors: id, extension
... typeΣ1..1codeauthor | editor | reviewer | endorser
ContributorType (Required)
... nameΣ1..1stringWho contributed the content
... contactΣ0..*ContactDetailContact details of the contributor

doco Documentation for this format

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <type value="[code]"/><!-- 1..1 author | editor | reviewer | endorser -->
 <name value="[string]"/><!-- 1..1 Who contributed the content -->
 <contact><!-- 0..* ContactDetail Contact details of the contributor --></contact>
</[name]>

Turtle Template

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

[
 # from Element: Element.extension
  fhir:Contributor.type [ code ]; # 1..1 author | editor | reviewer | endorser
  fhir:Contributor.name [ string ]; # 1..1 Who contributed the content
  fhir:Contributor.contact [ ContactDetail ], ... ; # 0..* Contact details of the contributor
]

Changes since Release 3

  • No Changes
Contributor

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ContributorΣTUElementContributor information
Elements defined in Ancestors: id, extension
... typeΣ1..1codeauthor | editor | reviewer | endorser
ContributorType (Required)
... nameΣ1..1stringWho contributed the content
... contactΣ0..*ContactDetailContact details of the contributor

doco Documentation for this format

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <type value="[code]"/><!-- 1..1 author | editor | reviewer | endorser -->
 <name value="[string]"/><!-- 1..1 Who contributed the content -->
 <contact><!-- 0..* ContactDetail Contact details of the contributor --></contact>
</[name]>

Turtle Template

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

[
 # from Element: Element.extension
  fhir:Contributor.type [ code ]; # 1..1 author | editor | reviewer | endorser
  fhir:Contributor.name [ string ]; # 1..1 Who contributed the content
  fhir:Contributor.contact [ ContactDetail ], ... ; # 0..* Contact details of the contributor
]

Changes since Release 3

  • No Changes
Contributor

See the Full Difference for further information

Constraints

Terminology Bindings

PathDefinitionTypeReference
Contributor.type The type of contributor.RequiredContributorType

Contributor is used in the following places: (not used as yet)

 

See also Examples, Detailed Descriptions and Mappings.

The DataRequirement structure defines a general data requirement for a knowledge asset such as a decision support rule or quality measure.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataRequirementΣTUElementDescribes a required data item
Elements defined in Ancestors: id, extension
... typeΣ1..1codeThe type of the required data
FHIRAllTypes (Required)
... profileΣ0..*canonical(StructureDefinition)The profile of the required data
... subject[x]Σ0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Subject type (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... mustSupportΣ0..*stringIndicates specific structure elements that are referenced by the knowledge module
... codeFilterΣI0..*ElementWhat codes are expected
+ Rule: Either a path or a searchParam must be provided, but not both
.... pathΣ0..1stringA code-valued attribute to filter on
.... searchParamΣ0..1stringA coded (token) parameter to search on
.... valueSetΣ0..1canonical(ValueSet)Valueset for the filter
.... codeΣ0..*CodingWhat code is expected
... dateFilterΣI0..*ElementWhat dates/date ranges are expected
+ Rule: Either a path or a searchParam must be provided, but not both
.... pathΣ0..1stringA date-valued attribute to filter on
.... searchParamΣ0..1stringA date valued parameter to search on
.... value[x]Σ0..1The value of the filter, as a Period, DateTime, or Duration value
..... valueDateTimedateTime
..... valuePeriodPeriod
..... valueDurationDuration
... limitΣ0..1positiveIntNumber of results
... sortΣ0..*ElementOrder of the results
.... pathΣ1..1stringThe name of the attribute to perform the sort
.... directionΣ1..1codeascending | descending
SortDirection (Required)

doco Documentation for this format

UML Diagram (Legend)

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*DataRequirementThe type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profiletype : code [1..1] « A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. (Strength=Required)FHIRAllTypes! »The profile of the required data, specified as the uri of the profile definitionprofile : canonical [0..*] « StructureDefinition »The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumedsubject[x] : Type [0..1] « CodeableConcept|Reference(Group); The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType+ »Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details)mustSupport : string [0..*]Specifies a maximum number of results that are required (uses the _count search parameter)limit : positiveInt [0..1]CodeFilterThe code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConceptpath : string [0..1]A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConceptsearchParam : string [0..1]The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valuesetvalueSet : canonical [0..1] « ValueSet »The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codescode : Coding [0..*]DateFilterThe date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timingpath : string [0..1]A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or TimingsearchParam : string [0..1]The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before nowvalue[x] : Type [0..1] « dateTime|Period|Duration »SortThe attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constantpath : string [1..1]The direction of the sort, ascending or descendingdirection : code [1..1] « The possible sort directions, ascending or descending. (Strength=Required)SortDirection! »Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'edcodeFilter[0..*]Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'eddateFilter[0..*]Specifies the order of the results to be returnedsort[0..*]

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <type value="[code]"/><!-- 1..1 The type of the required data -->
 <profile><!-- 0..* canonical(StructureDefinition) The profile of the required data --></profile>
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]>
 <mustSupport value="[string]"/><!-- 0..* Indicates specific structure elements that are referenced by the knowledge module -->
 <codeFilter>  <!-- 0..* What codes are expected -->
  <path value="[string]"/><!-- 0..1 A code-valued attribute to filter on -->
  <searchParam value="[string]"/><!-- 0..1 A coded (token) parameter to search on -->
  <valueSet><!-- 0..1 canonical(ValueSet) Valueset for the filter --></valueSet>
  <code><!-- 0..* Coding What code is expected --></code>
 </codeFilter>
 <dateFilter>  <!-- 0..* What dates/date ranges are expected -->
  <path value="[string]"/><!-- 0..1 A date-valued attribute to filter on -->
  <searchParam value="[string]"/><!-- 0..1 A date valued parameter to search on -->
  <value[x]><!-- 0..1 dateTime|Period|Duration The value of the filter, as a Period, DateTime, or Duration value --></value[x]>
 </dateFilter>
 <limit value="[positiveInt]"/><!-- 0..1 Number of results -->
 <sort>  <!-- 0..* Order of the results -->
  <path value="[string]"/><!-- 1..1 The name of the attribute to perform the sort -->
  <direction value="[code]"/><!-- 1..1 ascending | descending -->
 </sort>
</[name]>

Turtle Template

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

[
 # from Element: Element.extension
  fhir:DataRequirement.type [ code ]; # 1..1 The type of the required data
  fhir:DataRequirement.profile [ canonical(StructureDefinition) ], ... ; # 0..* The profile of the required data
  # DataRequirement.subject[x] : 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2
    fhir:DataRequirement.subjectCodeableConcept [ CodeableConcept ]
    fhir:DataRequirement.subjectReference [ Reference(Group) ]
  fhir:DataRequirement.mustSupport [ string ], ... ; # 0..* Indicates specific structure elements that are referenced by the knowledge module
  fhir:DataRequirement.codeFilter [ # 0..* What codes are expected
    fhir:DataRequirement.codeFilter.path [ string ]; # 0..1 A code-valued attribute to filter on
    fhir:DataRequirement.codeFilter.searchParam [ string ]; # 0..1 A coded (token) parameter to search on
    fhir:DataRequirement.codeFilter.valueSet [ canonical(ValueSet) ]; # 0..1 Valueset for the filter
    fhir:DataRequirement.codeFilter.code [ Coding ], ... ; # 0..* What code is expected
  ], ...;
  fhir:DataRequirement.dateFilter [ # 0..* What dates/date ranges are expected
    fhir:DataRequirement.dateFilter.path [ string ]; # 0..1 A date-valued attribute to filter on
    fhir:DataRequirement.dateFilter.searchParam [ string ]; # 0..1 A date valued parameter to search on
    # DataRequirement.dateFilter.value[x] : 0..1 The value of the filter, as a Period, DateTime, or Duration value. One of these 3
      fhir:DataRequirement.dateFilter.valueDateTime [ dateTime ]
      fhir:DataRequirement.dateFilter.valuePeriod [ Period ]
      fhir:DataRequirement.dateFilter.valueDuration [ Duration ]
  ], ...;
  fhir:DataRequirement.limit [ positiveInt ]; # 0..1 Number of results
  fhir:DataRequirement.sort [ # 0..* Order of the results
    fhir:DataRequirement.sort.path [ string ]; # 1..1 The name of the attribute to perform the sort
    fhir:DataRequirement.sort.direction [ code ]; # 1..1 ascending | descending
  ], ...;
]

Changes since Release 3

DataRequirement
DataRequirement.type
  • Remove Codes BodySite, DataElement, DeviceComponent, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ProcedureRequest, ReferralRequest, ServiceDefinition
  • Add Codes Expression, MarketingStatus, MoneyQuantity, ProdCharacteristic, ProductShelfLife, SubstanceAmount, SubstanceMoiety, canonical, url, BiologicallyDerivedProduct, BodyStructure, CatalogEntry, ChargeItemDefinition, CoverageEligibilityRequest, CoverageEligibilityResponse, DeviceDefinition, EventDefinition, ExampleScenario, ImmunizationEvaluation, InsurancePlan, Invoice, ItemInstance, MedicationKnowledge, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductClinicals, MedicinalProductContraindication, MedicinalProductDeviceSpec, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, ObservationDefinition, OrganizationAffiliation, ServiceRequest, SpecimenDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, TerminologyCapabilities, UserSession, VerificationResult
DataRequirement.profile
  • Type changed from uri to canonical
DataRequirement.subject[x]
  • Added Element
DataRequirement.codeFilter.path
  • Min Cardinality changed from 1 to 0
DataRequirement.codeFilter.searchParam
  • Added Element
DataRequirement.codeFilter.valueSet
  • Renamed from valueSet[x] to valueSet
  • Remove string, Remove Reference(ValueSet), Add canonical
DataRequirement.codeFilter.code
  • Added Element
DataRequirement.dateFilter.path
  • Min Cardinality changed from 1 to 0
DataRequirement.dateFilter.searchParam
  • Added Element
DataRequirement.limit
  • Added Element
DataRequirement.sort
  • Added Element
DataRequirement.sort.path
  • Added Element
DataRequirement.sort.direction
  • Added Element
DataRequirement.codeFilter.valueCode
  • deleted
DataRequirement.codeFilter.valueCoding
  • deleted
DataRequirement.codeFilter.valueCodeableConcept
  • deleted

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DataRequirementΣTUElementDescribes a required data item
Elements defined in Ancestors: id, extension
... typeΣ1..1codeThe type of the required data
FHIRAllTypes (Required)
... profileΣ0..*canonical(StructureDefinition)The profile of the required data
... subject[x]Σ0..1E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Subject type (Extensible)
.... subjectCodeableConceptCodeableConcept
.... subjectReferenceReference(Group)
... mustSupportΣ0..*stringIndicates specific structure elements that are referenced by the knowledge module
... codeFilterΣI0..*ElementWhat codes are expected
+ Rule: Either a path or a searchParam must be provided, but not both
.... pathΣ0..1stringA code-valued attribute to filter on
.... searchParamΣ0..1stringA coded (token) parameter to search on
.... valueSetΣ0..1canonical(ValueSet)Valueset for the filter
.... codeΣ0..*CodingWhat code is expected
... dateFilterΣI0..*ElementWhat dates/date ranges are expected
+ Rule: Either a path or a searchParam must be provided, but not both
.... pathΣ0..1stringA date-valued attribute to filter on
.... searchParamΣ0..1stringA date valued parameter to search on
.... value[x]Σ0..1The value of the filter, as a Period, DateTime, or Duration value
..... valueDateTimedateTime
..... valuePeriodPeriod
..... valueDurationDuration
... limitΣ0..1positiveIntNumber of results
... sortΣ0..*ElementOrder of the results
.... pathΣ1..1stringThe name of the attribute to perform the sort
.... directionΣ1..1codeascending | descending
SortDirection (Required)

doco Documentation for this format

UML Diagram (Legend)

ElementExtensions - as described for all elements: additional information that is not part of the basic definition of the resource / typeextension : Extension 0..*DataRequirementThe type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profiletype : code [1..1] « A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. (Strength=Required)FHIRAllTypes! »The profile of the required data, specified as the uri of the profile definitionprofile : canonical [0..*] « StructureDefinition »The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumedsubject[x] : Type [0..1] « CodeableConcept|Reference(Group); The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType+ »Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details)mustSupport : string [0..*]Specifies a maximum number of results that are required (uses the _count search parameter)limit : positiveInt [0..1]CodeFilterThe code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConceptpath : string [0..1]A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConceptsearchParam : string [0..1]The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valuesetvalueSet : canonical [0..1] « ValueSet »The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codescode : Coding [0..*]DateFilterThe date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timingpath : string [0..1]A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or TimingsearchParam : string [0..1]The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before nowvalue[x] : Type [0..1] « dateTime|Period|Duration »SortThe attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constantpath : string [1..1]The direction of the sort, ascending or descendingdirection : code [1..1] « The possible sort directions, ascending or descending. (Strength=Required)SortDirection! »Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'edcodeFilter[0..*]Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'eddateFilter[0..*]Specifies the order of the results to be returnedsort[0..*]

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <type value="[code]"/><!-- 1..1 The type of the required data -->
 <profile><!-- 0..* canonical(StructureDefinition) The profile of the required data --></profile>
 <subject[x]><!-- 0..1 CodeableConcept|Reference(Group) E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device --></subject[x]>
 <mustSupport value="[string]"/><!-- 0..* Indicates specific structure elements that are referenced by the knowledge module -->
 <codeFilter>  <!-- 0..* What codes are expected -->
  <path value="[string]"/><!-- 0..1 A code-valued attribute to filter on -->
  <searchParam value="[string]"/><!-- 0..1 A coded (token) parameter to search on -->
  <valueSet><!-- 0..1 canonical(ValueSet) Valueset for the filter --></valueSet>
  <code><!-- 0..* Coding What code is expected --></code>
 </codeFilter>
 <dateFilter>  <!-- 0..* What dates/date ranges are expected -->
  <path value="[string]"/><!-- 0..1 A date-valued attribute to filter on -->
  <searchParam value="[string]"/><!-- 0..1 A date valued parameter to search on -->
  <value[x]><!-- 0..1 dateTime|Period|Duration The value of the filter, as a Period, DateTime, or Duration value --></value[x]>
 </dateFilter>
 <limit value="[positiveInt]"/><!-- 0..1 Number of results -->
 <sort>  <!-- 0..* Order of the results -->
  <path value="[string]"/><!-- 1..1 The name of the attribute to perform the sort -->
  <direction value="[code]"/><!-- 1..1 ascending | descending -->
 </sort>
</[name]>

Turtle Template

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

[
 # from Element: Element.extension
  fhir:DataRequirement.type [ code ]; # 1..1 The type of the required data
  fhir:DataRequirement.profile [ canonical(StructureDefinition) ], ... ; # 0..* The profile of the required data
  # DataRequirement.subject[x] : 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2
    fhir:DataRequirement.subjectCodeableConcept [ CodeableConcept ]
    fhir:DataRequirement.subjectReference [ Reference(Group) ]
  fhir:DataRequirement.mustSupport [ string ], ... ; # 0..* Indicates specific structure elements that are referenced by the knowledge module
  fhir:DataRequirement.codeFilter [ # 0..* What codes are expected
    fhir:DataRequirement.codeFilter.path [ string ]; # 0..1 A code-valued attribute to filter on
    fhir:DataRequirement.codeFilter.searchParam [ string ]; # 0..1 A coded (token) parameter to search on
    fhir:DataRequirement.codeFilter.valueSet [ canonical(ValueSet) ]; # 0..1 Valueset for the filter
    fhir:DataRequirement.codeFilter.code [ Coding ], ... ; # 0..* What code is expected
  ], ...;
  fhir:DataRequirement.dateFilter [ # 0..* What dates/date ranges are expected
    fhir:DataRequirement.dateFilter.path [ string ]; # 0..1 A date-valued attribute to filter on
    fhir:DataRequirement.dateFilter.searchParam [ string ]; # 0..1 A date valued parameter to search on
    # DataRequirement.dateFilter.value[x] : 0..1 The value of the filter, as a Period, DateTime, or Duration value. One of these 3
      fhir:DataRequirement.dateFilter.valueDateTime [ dateTime ]
      fhir:DataRequirement.dateFilter.valuePeriod [ Period ]
      fhir:DataRequirement.dateFilter.valueDuration [ Duration ]
  ], ...;
  fhir:DataRequirement.limit [ positiveInt ]; # 0..1 Number of results
  fhir:DataRequirement.sort [ # 0..* Order of the results
    fhir:DataRequirement.sort.path [ string ]; # 1..1 The name of the attribute to perform the sort
    fhir:DataRequirement.sort.direction [ code ]; # 1..1 ascending | descending
  ], ...;
]

Changes since Release 3

DataRequirement
DataRequirement.type
  • Remove Codes BodySite, DataElement, DeviceComponent, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ProcedureRequest, ReferralRequest, ServiceDefinition
  • Add Codes Expression, MarketingStatus, MoneyQuantity, ProdCharacteristic, ProductShelfLife, SubstanceAmount, SubstanceMoiety, canonical, url, BiologicallyDerivedProduct, BodyStructure, CatalogEntry, ChargeItemDefinition, CoverageEligibilityRequest, CoverageEligibilityResponse, DeviceDefinition, EventDefinition, ExampleScenario, ImmunizationEvaluation, InsurancePlan, Invoice, ItemInstance, MedicationKnowledge, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductClinicals, MedicinalProductContraindication, MedicinalProductDeviceSpec, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, ObservationDefinition, OrganizationAffiliation, ServiceRequest, SpecimenDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, TerminologyCapabilities, UserSession, VerificationResult
DataRequirement.profile
  • Type changed from uri to canonical
DataRequirement.subject[x]
  • Added Element
DataRequirement.codeFilter.path
  • Min Cardinality changed from 1 to 0
DataRequirement.codeFilter.searchParam
  • Added Element
DataRequirement.codeFilter.valueSet
  • Renamed from valueSet[x] to valueSet
  • Remove string, Remove Reference(ValueSet), Add canonical
DataRequirement.codeFilter.code
  • Added Element
DataRequirement.dateFilter.path
  • Min Cardinality changed from 1 to 0
DataRequirement.dateFilter.searchParam
  • Added Element
DataRequirement.limit
  • Added Element
DataRequirement.sort
  • Added Element
DataRequirement.sort.path
  • Added Element
DataRequirement.sort.direction
  • Added Element
DataRequirement.codeFilter.valueCode
  • deleted
DataRequirement.codeFilter.valueCoding
  • deleted
DataRequirement.codeFilter.valueCodeableConcept
  • deleted

See the Full Difference for further information

Constraints

idLevelLocationDescriptionExpression
drq-1Rule DataRequirement.codeFilterEither a path or a searchParam must be provided, but not bothpath.exists() xor searchParam.exists()
drq-2Rule DataRequirement.dateFilterEither a path or a searchParam must be provided, but not bothpath.exists() xor searchParam.exists()

Terminology Bindings

PathDefinitionTypeReference
DataRequirement.type A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.RequiredAll Types
DataRequirement.subject[x] The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).ExtensibleSubjectType
DataRequirement.sort.direction The possible sort directions, ascending or descending.RequiredSortDirection

A DataRequirement differs from a parameter in that it specifies the data to be provided in terms of the type of data, and specific filters on code-valued and/or date-valued attributes. Data requirements are not named because they are referenced by type within the evaluation context.

DataRequirements are used by knowledge modules to communicate the set of required data to a consumer in a way that is computable (as opposed to a set of named parameters which must be integrated by hand based on the meaning of the parameter as communicated through the documentation).

DataRequirements are typically used to communicate patient-dependent information such as MedicationStatements and Encounters, whereas Parameters are typically used to communicate patient-independent information such as configuration values.

For example, consider the following CQL expression:

define "Total Colectomy Procedures":
  [Procedure: "Total Colectomy Value Set"] P
    where P.performedPeriod during "Measurement Period"

The criteria is looking for procedures matching the "Total Colectomy Value Set" that were performed during the "Measurement Period". In this case, "Measurement Period" is a parameter, referenced by name, whereas the reference to Procedure uses the name of the resource type, and so constitutes a data requirement of the criteria:

<dataRequirement>
	<type value="Procedure"/>
	<codeFilter>
		<path value="code"/>
		<valueSetString value="Total Colectomy Value Set"/>
	</codeFilter>
	<dateFilter>
		<path value="performedPeriod"/>
		<valuePeriod>
			<start value="2016-01-01"/>
			<end value="2016-12-31"/>
		</valuePeriod>
	</dateFilter>
</dataRequirement>

If a resource type has multiple date attributes, then it may be necessary to include multiple date criteria. For instance, in the example above the Procedure resource is using the performedPeriod date attribute. However, the Procedure resource also provides a performedDateTime (specific date and/or time when procedure was performed) attribute. Therefore, if the date criteria for the Procedure in the example was recorded using the performedDateTime attribute, the date criteria would be incomplete. To account for this additional date attribute, the example could be expanded as follows:

define "Total Colectomy Procedures":
  [Procedure: "Total Colectomy Value Set"] P
    where exists (P.performedPeriod during "Measurement Period")
	  or exists (P.performedDateTime during "Measurement Period")

The data requirement for the expanded criteria:

<dataRequirement>
	<type value="Procedure"/>
	<codeFilter>
		<path value="code"/>
		<valueSetString value="Total Colectomy Value Set"/>
	</codeFilter>
	<dateFilter>
		<path value="performedPeriod"/>
		<path value="performedDateTime"/>
	</dateFilter>
</dataRequirement>

DataRequirement is used in the following places: TriggerDefinition, GuidanceResponse, Library and PlanDefinition

 

See also Examples, Detailed Descriptions and Mappings.

The ParameterDefinition structure defines a parameter to a knowledge asset such as a decision support rule or quality measure.

Parameters are typically used to communicate patient-independent information such as configuration values, whereas DataRequirements are typically used to communicate patient-dependent information such as MedicationStatements and Encounters.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParameterDefinitionΣTUElementDefinition of a parameter to a module
Elements defined in Ancestors: id, extension
... nameΣ0..1codeName used to access the parameter value
... useΣ1..1codein | out
OperationParameterUse (Required)
... minΣ0..1integerMinimum cardinality
... maxΣ0..1stringMaximum cardinality (a number of *)
... documentationΣ0..1stringA brief description of the parameter
... typeΣ1..1codeWhat type of value
FHIRAllTypes (Required)
... profileΣ0..1canonical(StructureDefinition)What profile the value is expected to be

doco Documentation for this format

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <name value="[code]"/><!-- 0..1 Name used to access the parameter value -->
 <use value="[code]"/><!-- 1..1 in | out -->
 <min value="[integer]"/><!-- 0..1 Minimum cardinality -->
 <max value="[string]"/><!-- 0..1 Maximum cardinality (a number of *) -->
 <documentation value="[string]"/><!-- 0..1 A brief description of the parameter -->
 <type value="[code]"/><!-- 1..1 What type of value -->
 <profile><!-- 0..1 canonical(StructureDefinition) What profile the value is expected to be --></profile>
</[name]>

Turtle Template

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

[
 # from Element: Element.extension
  fhir:ParameterDefinition.name [ code ]; # 0..1 Name used to access the parameter value
  fhir:ParameterDefinition.use [ code ]; # 1..1 in | out
  fhir:ParameterDefinition.min [ integer ]; # 0..1 Minimum cardinality
  fhir:ParameterDefinition.max [ string ]; # 0..1 Maximum cardinality (a number of *)
  fhir:ParameterDefinition.documentation [ string ]; # 0..1 A brief description of the parameter
  fhir:ParameterDefinition.type [ code ]; # 1..1 What type of value
  fhir:ParameterDefinition.profile [ canonical(StructureDefinition) ]; # 0..1 What profile the value is expected to be
]

Changes since Release 3

ParameterDefinition
ParameterDefinition.type
  • Remove Codes BodySite, DataElement, DeviceComponent, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ProcedureRequest, ReferralRequest, ServiceDefinition
  • Add Codes Expression, MarketingStatus, MoneyQuantity, ProdCharacteristic, ProductShelfLife, SubstanceAmount, SubstanceMoiety, canonical, url, BiologicallyDerivedProduct, BodyStructure, CatalogEntry, ChargeItemDefinition, CoverageEligibilityRequest, CoverageEligibilityResponse, DeviceDefinition, EventDefinition, ExampleScenario, ImmunizationEvaluation, InsurancePlan, Invoice, ItemInstance, MedicationKnowledge, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductClinicals, MedicinalProductContraindication, MedicinalProductDeviceSpec, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, ObservationDefinition, OrganizationAffiliation, ServiceRequest, SpecimenDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, TerminologyCapabilities, UserSession, VerificationResult
ParameterDefinition.profile
  • Type changed from Reference(StructureDefinition) to canonical

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParameterDefinitionΣTUElementDefinition of a parameter to a module
Elements defined in Ancestors: id, extension
... nameΣ0..1codeName used to access the parameter value
... useΣ1..1codein | out
OperationParameterUse (Required)
... minΣ0..1integerMinimum cardinality
... maxΣ0..1stringMaximum cardinality (a number of *)
... documentationΣ0..1stringA brief description of the parameter
... typeΣ1..1codeWhat type of value
FHIRAllTypes (Required)
... profileΣ0..1canonical(StructureDefinition)What profile the value is expected to be

doco Documentation for this format

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <name value="[code]"/><!-- 0..1 Name used to access the parameter value -->
 <use value="[code]"/><!-- 1..1 in | out -->
 <min value="[integer]"/><!-- 0..1 Minimum cardinality -->
 <max value="[string]"/><!-- 0..1 Maximum cardinality (a number of *) -->
 <documentation value="[string]"/><!-- 0..1 A brief description of the parameter -->
 <type value="[code]"/><!-- 1..1 What type of value -->
 <profile><!-- 0..1 canonical(StructureDefinition) What profile the value is expected to be --></profile>
</[name]>

Turtle Template

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

[
 # from Element: Element.extension
  fhir:ParameterDefinition.name [ code ]; # 0..1 Name used to access the parameter value
  fhir:ParameterDefinition.use [ code ]; # 1..1 in | out
  fhir:ParameterDefinition.min [ integer ]; # 0..1 Minimum cardinality
  fhir:ParameterDefinition.max [ string ]; # 0..1 Maximum cardinality (a number of *)
  fhir:ParameterDefinition.documentation [ string ]; # 0..1 A brief description of the parameter
  fhir:ParameterDefinition.type [ code ]; # 1..1 What type of value
  fhir:ParameterDefinition.profile [ canonical(StructureDefinition) ]; # 0..1 What profile the value is expected to be
]

Changes since Release 3

ParameterDefinition
ParameterDefinition.type
  • Remove Codes BodySite, DataElement, DeviceComponent, EligibilityRequest, EligibilityResponse, ExpansionProfile, ImagingManifest, ProcedureRequest, ReferralRequest, ServiceDefinition
  • Add Codes Expression, MarketingStatus, MoneyQuantity, ProdCharacteristic, ProductShelfLife, SubstanceAmount, SubstanceMoiety, canonical, url, BiologicallyDerivedProduct, BodyStructure, CatalogEntry, ChargeItemDefinition, CoverageEligibilityRequest, CoverageEligibilityResponse, DeviceDefinition, EventDefinition, ExampleScenario, ImmunizationEvaluation, InsurancePlan, Invoice, ItemInstance, MedicationKnowledge, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductClinicals, MedicinalProductContraindication, MedicinalProductDeviceSpec, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, ObservationDefinition, OrganizationAffiliation, ServiceRequest, SpecimenDefinition, SubstanceNucleicAcid, SubstancePolymer, SubstanceProtein, SubstanceReferenceInformation, SubstanceSourceMaterial, SubstanceSpecification, TerminologyCapabilities, UserSession, VerificationResult
ParameterDefinition.profile
  • Type changed from Reference(StructureDefinition) to canonical

See the Full Difference for further information

Constraints

Terminology Bindings

PathDefinitionTypeReference
ParameterDefinition.use Whether the parameter is input or output.RequiredOperationParameterUse
ParameterDefinition.type A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.RequiredAll Types

 

See also Examples, Detailed Descriptions and Mappings.

The RelatedArtifact structure defines resources related to a module such as previous and next versions of documents, documentation, citations, etc. Note that the name resource here is being used in a more general sense than the FHIR-specific Resource. The related resource may be a FHIR resource, or it may be another type of resource, represented using the Attachment data type.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedArtifactΣTUElementRelated artifacts for a knowledge resource
Elements defined in Ancestors: id, extension
... typeΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
RelatedArtifactType (Required)
... displayΣ0..1stringBrief description of the related artifact
... citationΣ0..1stringBibliographic citation for the artifact
... urlΣ0..1urlWhere the artifact can be accessed
... documentΣ0..1AttachmentWhat document is being referenced
... resourceΣ0..1canonical(Any)What resource is being referenced

doco Documentation for this format

XML Template

Turtle Template

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

[
 # from Element: Element.extension
  fhir:RelatedArtifact.type [ code ]; # 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
  fhir:RelatedArtifact.display [ string ]; # 0..1 Brief description of the related artifact
  fhir:RelatedArtifact.citation [ string ]; # 0..1 Bibliographic citation for the artifact
  fhir:RelatedArtifact.url [ url ]; # 0..1 Where the artifact can be accessed
  fhir:RelatedArtifact.document [ Attachment ]; # 0..1 What document is being referenced
  fhir:RelatedArtifact.resource [ canonical(Any) ]; # 0..1 What resource is being referenced
]

Changes since Release 3

RelatedArtifact
RelatedArtifact.url
  • Type changed from uri to url
RelatedArtifact.resource
  • Type changed from Reference(Resource) to canonical

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedArtifactΣTUElementRelated artifacts for a knowledge resource
Elements defined in Ancestors: id, extension
... typeΣ1..1codedocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
RelatedArtifactType (Required)
... displayΣ0..1stringBrief description of the related artifact
... citationΣ0..1stringBibliographic citation for the artifact
... urlΣ0..1urlWhere the artifact can be accessed
... documentΣ0..1AttachmentWhat document is being referenced
... resourceΣ0..1canonical(Any)What resource is being referenced

doco Documentation for this format

Turtle Template

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

[
 # from Element: Element.extension
  fhir:RelatedArtifact.type [ code ]; # 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
  fhir:RelatedArtifact.display [ string ]; # 0..1 Brief description of the related artifact
  fhir:RelatedArtifact.citation [ string ]; # 0..1 Bibliographic citation for the artifact
  fhir:RelatedArtifact.url [ url ]; # 0..1 Where the artifact can be accessed
  fhir:RelatedArtifact.document [ Attachment ]; # 0..1 What document is being referenced
  fhir:RelatedArtifact.resource [ canonical(Any) ]; # 0..1 What resource is being referenced
]

Changes since Release 3

RelatedArtifact
RelatedArtifact.url
  • Type changed from uri to url
RelatedArtifact.resource
  • Type changed from Reference(Resource) to canonical

See the Full Difference for further information

Constraints

Terminology Bindings

PathDefinitionTypeReference
RelatedArtifact.type The type of relationship to the related artifact.RequiredRelatedArtifactType

RelatedArtifact is used in the following places: ActivityDefinition, EventDefinition, Library, Measure, PlanDefinition, RequestGroup and ResearchStudy

 

See also Examples, Detailed Descriptions and Mappings.

The TriggerDefinition structure defines when a knowledge artifact is expected to be evaluated. The structure can represent three main kinds of triggering events, depending on the value of type:

  • Named Event
  • Scheduled Event
  • Data Event

A named event is an event identified by the implementation environment. This allows any event generated within the implementation environment to be used as a trigger, but it requires pre-coordination of the names involved with the consuming environments. HL7 v2 events are assigned the URI http://terminology.hl7.org/CodeSystem/v2-0003#[code] e.g. http://terminology.hl7.org/CodeSystem/v2-0003/A01, and reference any data change that would trigger the sending of the matching HL7 v2 version, if the application providing the FHIR API supports v2 events internally.

A scheduled event occurs on a fixed or periodic schedule.

And finally, a data event occurs in response to some data-related event in the integrated environment such as a record being added or updated. The data-of-interest for a data event is described using a DataRequirement. This allows for systems to automatically invoke based on data activity occurring within the system. A condition may also be specified to further refine the trigger

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. TriggerDefinitionΣITUElementDefines an expected trigger for a module
+ Rule: Either timing, or a data requirement, but not both
+ Rule: A condition only if there is a data requirement
Elements defined in Ancestors: id, extension
... typeΣ1..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
TriggerType (Required)
... nameΣ0..1stringName or URI that identifies the event
... timing[x]Σ0..1Timing of the event
.... timingTimingTiming
.... timingReferenceReference(Schedule)
.... timingDatedate
.... timingDateTimedateTime
... dataΣ0..1DataRequirementTriggering data of the event
... conditionΣ0..1ExpressionWhether the event triggers (boolean expression)

doco Documentation for this format

Turtle Template

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

[
 # from Element: Element.extension
  fhir:TriggerDefinition.type [ code ]; # 1..1 named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
  fhir:TriggerDefinition.name [ string ]; # 0..1 Name or URI that identifies the event
  # TriggerDefinition.timing[x] : 0..1 Timing of the event. One of these 4
    fhir:TriggerDefinition.timingTiming [ Timing ]
    fhir:TriggerDefinition.timingReference [ Reference(Schedule) ]
    fhir:TriggerDefinition.timingDate [ date ]
    fhir:TriggerDefinition.timingDateTime [ dateTime ]
  fhir:TriggerDefinition.data [ DataRequirement ]; # 0..1 Triggering data of the event
  fhir:TriggerDefinition.condition [ Expression ]; # 0..1 Whether the event triggers (boolean expression)
]

Changes since Release 3

TriggerDefinition
TriggerDefinition.type
  • Add Code data-changed
TriggerDefinition.name
  • Added Element
TriggerDefinition.timing[x]
  • Added Element
TriggerDefinition.data
  • Added Element
TriggerDefinition.condition
  • Added Element
TriggerDefinition.eventName
  • deleted
TriggerDefinition.eventTiming[x]
  • deleted
TriggerDefinition.eventData
  • deleted

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. TriggerDefinitionΣITUElementDefines an expected trigger for a module
+ Rule: Either timing, or a data requirement, but not both
+ Rule: A condition only if there is a data requirement
Elements defined in Ancestors: id, extension
... typeΣ1..1codenamed-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
TriggerType (Required)
... nameΣ0..1stringName or URI that identifies the event
... timing[x]Σ0..1Timing of the event
.... timingTimingTiming
.... timingReferenceReference(Schedule)
.... timingDatedate
.... timingDateTimedateTime
... dataΣ0..1DataRequirementTriggering data of the event
... conditionΣ0..1ExpressionWhether the event triggers (boolean expression)

doco Documentation for this format

Turtle Template

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

[
 # from Element: Element.extension
  fhir:TriggerDefinition.type [ code ]; # 1..1 named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
  fhir:TriggerDefinition.name [ string ]; # 0..1 Name or URI that identifies the event
  # TriggerDefinition.timing[x] : 0..1 Timing of the event. One of these 4
    fhir:TriggerDefinition.timingTiming [ Timing ]
    fhir:TriggerDefinition.timingReference [ Reference(Schedule) ]
    fhir:TriggerDefinition.timingDate [ date ]
    fhir:TriggerDefinition.timingDateTime [ dateTime ]
  fhir:TriggerDefinition.data [ DataRequirement ]; # 0..1 Triggering data of the event
  fhir:TriggerDefinition.condition [ Expression ]; # 0..1 Whether the event triggers (boolean expression)
]

Changes since Release 3

TriggerDefinition
TriggerDefinition.type
  • Add Code data-changed
TriggerDefinition.name
  • Added Element
TriggerDefinition.timing[x]
  • Added Element
TriggerDefinition.data
  • Added Element
TriggerDefinition.condition
  • Added Element
TriggerDefinition.eventName
  • deleted
TriggerDefinition.eventTiming[x]
  • deleted
TriggerDefinition.eventData
  • deleted

See the Full Difference for further information

Constraints

idLevelLocationDescriptionExpression
trd-1Rule (base)Either timing, or a data requirement, but not bothdata.empty() or timing.empty()
trd-2Rule (base)A condition only if there is a data requirementcondition.exists() implies data.exists()

Terminology Bindings

PathDefinitionTypeReference
TriggerDefinition.type The type of trigger.RequiredTriggerType

TriggerDefinition is used in the following places: EventDefinition and PlanDefinition

 

See also Examples, Detailed Descriptions and Mappings.

The Expression structure defines an expression that generates a value. The expression is provided in a specifed language (by mime type)

The context of use of the expression must specify the context in which the expression is evaluated, and how the result of the expression is used.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExpressionΣITUElementAn expression that can be used to generate a value
+ Rule: An expression or a reference must be provided
Elements defined in Ancestors: id, extension
... descriptionΣ0..1stringNatural language description of the condition
... nameΣ0..1idShort name assigned to expression for reuse
... languageΣ1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
ExpressionLanguage (Extensible but limited to http://www.rfc-editor.org/bcp/bcp13.txt )
... expressionΣ0..1stringExpression in specified language
... referenceΣ0..1uriWhere the expression is found

doco Documentation for this format

XML Template

<Expression xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <description value="[string]"/><!-- 0..1 Natural language description of the condition -->
 <name value="[id]"/><!-- 0..1 Short name assigned to expression for reuse -->
 <language value="[code]"/><!-- 1..1 text/cql | text/fhirpath | application/x-fhir-query | etc. -->
 <expression value="[string]"/><!-- 0..1 Expression in specified language -->
 <reference value="[uri]"/><!-- 0..1 Where the expression is found -->
</Expression>

Turtle Template

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

[
 # from Element: Element.extension
  fhir:Expression.description [ string ]; # 0..1 Natural language description of the condition
  fhir:Expression.name [ id ]; # 0..1 Short name assigned to expression for reuse
  fhir:Expression.language [ code ]; # 1..1 text/cql | text/fhirpath | application/x-fhir-query | etc.
  fhir:Expression.expression [ string ]; # 0..1 Expression in specified language
  fhir:Expression.reference [ uri ]; # 0..1 Where the expression is found
]

Changes since Release 3

This complex-type did not exist in Release 2

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ExpressionΣITUElementAn expression that can be used to generate a value
+ Rule: An expression or a reference must be provided
Elements defined in Ancestors: id, extension
... descriptionΣ0..1stringNatural language description of the condition
... nameΣ0..1idShort name assigned to expression for reuse
... languageΣ1..1codetext/cql | text/fhirpath | application/x-fhir-query | etc.
ExpressionLanguage (Extensible but limited to http://www.rfc-editor.org/bcp/bcp13.txt )
... expressionΣ0..1stringExpression in specified language
... referenceΣ0..1uriWhere the expression is found

doco Documentation for this format

XML Template

<Expression xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <description value="[string]"/><!-- 0..1 Natural language description of the condition -->
 <name value="[id]"/><!-- 0..1 Short name assigned to expression for reuse -->
 <language value="[code]"/><!-- 1..1 text/cql | text/fhirpath | application/x-fhir-query | etc. -->
 <expression value="[string]"/><!-- 0..1 Expression in specified language -->
 <reference value="[uri]"/><!-- 0..1 Where the expression is found -->
</Expression>

Turtle Template

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

[
 # from Element: Element.extension
  fhir:Expression.description [ string ]; # 0..1 Natural language description of the condition
  fhir:Expression.name [ id ]; # 0..1 Short name assigned to expression for reuse
  fhir:Expression.language [ code ]; # 1..1 text/cql | text/fhirpath | application/x-fhir-query | etc.
  fhir:Expression.expression [ string ]; # 0..1 Expression in specified language
  fhir:Expression.reference [ uri ]; # 0..1 Where the expression is found
]

Changes since Release 3

This complex-type did not exist in Release 2

Constraints

idLevelLocationDescriptionExpression
exp-1Rule (base)An expression or a reference must be providedexpression.exists() or reference.exists()

Terminology Bindings

PathDefinitionTypeReference
Expression.language The media type of the expression language.Extensible, but limited to http://www.rfc-editor.org/bcp/bcp13.txt ExpressionLanguage

Expression is used in the following places: TriggerDefinition, ActivityDefinition, Measure and PlanDefinition

 

See also Examples, Detailed Descriptions and Mappings.

The UsageContext structure defines the context of use for a module.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. UsageContextΣTUElementDescribes the context of use for a conformance or knowledge resource
Elements defined in Ancestors: id, extension
... codeΣ1..1CodingType of context being specified
UsageContextType (Extensible)
... value[x]Σ1..1Value that defines the context
ConformanceUseContext (Example)
.... valueCodeableConceptCodeableConcept
.... valueQuantityQuantity
.... valueRangeRange

doco Documentation for this format

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <code><!-- 1..1 Coding Type of context being specified --></code>
 <value[x]><!-- 1..1 CodeableConcept|Quantity|Range Value that defines the context --></value[x]>
</[name]>

JSON Template

{doco
  // from Element: extension
  "code" : { Coding }, // R!  Type of context being specified
  // value[x]: Value that defines the context. One of these 3:
  "valueCodeableConcept" : { CodeableConcept }
  "valueQuantity" : { Quantity }
  "valueRange" : { Range }
}

Turtle Template

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

[
 # from Element: Element.extension
  fhir:UsageContext.code [ Coding ]; # 1..1 Type of context being specified
  # UsageContext.value[x] : 1..1 Value that defines the context. One of these 3
    fhir:UsageContext.valueCodeableConcept [ CodeableConcept ]
    fhir:UsageContext.valueQuantity [ Quantity ]
    fhir:UsageContext.valueRange [ Range ]
]

Changes since Release 3

  • No Changes
UsageContext

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. UsageContextΣTUElementDescribes the context of use for a conformance or knowledge resource
Elements defined in Ancestors: id, extension
... codeΣ1..1CodingType of context being specified
UsageContextType (Extensible)
... value[x]Σ1..1Value that defines the context
ConformanceUseContext (Example)
.... valueCodeableConceptCodeableConcept
.... valueQuantityQuantity
.... valueRangeRange

doco Documentation for this format

XML Template

<[name] xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <code><!-- 1..1 Coding Type of context being specified --></code>
 <value[x]><!-- 1..1 CodeableConcept|Quantity|Range Value that defines the context --></value[x]>
</[name]>

JSON Template

{doco
  // from Element: extension
  "code" : { Coding }, // R!  Type of context being specified
  // value[x]: Value that defines the context. One of these 3:
  "valueCodeableConcept" : { CodeableConcept }
  "valueQuantity" : { Quantity }
  "valueRange" : { Range }
}

Turtle Template

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

[
 # from Element: Element.extension
  fhir:UsageContext.code [ Coding ]; # 1..1 Type of context being specified
  # UsageContext.value[x] : 1..1 Value that defines the context. One of these 3
    fhir:UsageContext.valueCodeableConcept [ CodeableConcept ]
    fhir:UsageContext.valueQuantity [ Quantity ]
    fhir:UsageContext.valueRange [ Range ]
]

Changes since Release 3

  • No Changes
UsageContext

See the Full Difference for further information

Constraints

Terminology Bindings

PathDefinitionTypeReference
UsageContext.code A code that specifies a type of context being specified by a usage context.ExtensibleUsageContextType
UsageContext.value[x] A code that defines the specific value for the context being specified.ExampleContext of Use ValueSet

UsageContext is used in the following places: ActivityDefinition, CapabilityStatement, ChargeItemDefinition, CodeSystem, CompartmentDefinition, ConceptMap, EventDefinition, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, OperationDefinition, PlanDefinition, Questionnaire, SearchParameter, StructureDefinition, StructureMap, TerminologyCapabilities, TestScript and ValueSet