Release 4B
FoundationThis page is part of the FHIR Specification (v4.3.0: R4B - STU). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3
| FHIR Infrastructure Work Group | Maturity Level: 4 | Standards Status: Partially Normative |
|
This page has been approved as part of an ANSI standard.
See the Infrastructure Package for further details.
|
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.
|
|
This DataType has been approved as part of an ANSI standard.
See the Infrastructure Package for further details.
|
See also Examples, Detailed Descriptions and Mappings.
The ContactDetail structure defines general contact details.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ContactDetail | ΣN | Element | Contact information Elements defined in Ancestors: id, extension | |
  name | Σ | 0..1 | string | Name of an individual to contact |
  telecom | Σ | 0..* | ContactPoint | Contact details for individual or organization |
| Documentation for this format | ||||
UML Diagram (Legend)
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]>
JSON Template
{
// from Element: extension
"name" : "<string>", // Name of an individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or organization
}
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
| ContactDetail |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ContactDetail | ΣN | Element | Contact information Elements defined in Ancestors: id, extension | |
| name | Σ | 0..1 | string | Name of an individual to contact |
| telecom | Σ | 0..* | ContactPoint | Contact details for individual or organization |
| 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]>
JSON Template
{
// from Element: extension
"name" : "<string>", // Name of an individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or organization
}
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 ]
Constraints
ContactDetail is used in the following places: Contributor, ActivityDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, ConceptMap, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, OperationDefinition, Parameters, PlanDefinition, Questionnaire, ResearchDefinition, ResearchElementDefinition, ResearchStudy, SearchParameter, StructureDefinition, StructureMap, SubscriptionTopic, Task, 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Contributor | ΣTU | Element | Contributor information Elements defined in Ancestors: id, extension | |
| type | Σ | 1..1 | code | author | editor | reviewer | endorser ContributorType (Required) |
| name | Σ | 1..1 | string | Who contributed the content |
| contact | Σ | 0..* | ContactDetail | Contact details of the contributor |
| Documentation for this format | ||||
UML Diagram (Legend)
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]>
JSON Template
{
// from Element: extension
"type" : "<code>", // R! author | editor | reviewer | endorser
"name" : "<string>", // R! Who contributed the content
"contact" : [{ ContactDetail }] // Contact details of the contributor
}
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
| Contributor |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Contributor | ΣTU | Element | Contributor information Elements defined in Ancestors: id, extension | |
| type | Σ | 1..1 | code | author | editor | reviewer | endorser ContributorType (Required) |
| name | Σ | 1..1 | string | Who contributed the content |
| contact | Σ | 0..* | ContactDetail | Contact details of the contributor |
| 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]>
JSON Template
{
// from Element: extension
"type" : "<code>", // R! author | editor | reviewer | endorser
"name" : "<string>", // R! Who contributed the content
"contact" : [{ ContactDetail }] // Contact details of the contributor
}
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 ]
Constraints
Terminology Bindings
| Path | Definition | Type | Reference |
|---|---|---|---|
| Contributor.type | The type of contributor. | Required | ContributorType |
Contributor is used in the following places: Parameters, StructureMap and Task
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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DataRequirement | ΣTU | Element | Describes a required data item Elements defined in Ancestors: id, extension | |
| type | Σ | 1..1 | code | The type of the required data FHIRAllTypes (Required) |
 profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data |
  subject[x] | Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Subject type (Extensible) | |
 subjectCodeableConcept | CodeableConcept | |||
| subjectReference | Reference(Group) | |||
| mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
| codeFilter | ΣI | 0..* | Element | What codes are expected + Rule: Either a path or a searchParam must be provided, but not both |
| path | Σ | 0..1 | string | A code-valued attribute to filter on |
| searchParam | Σ | 0..1 | string | A coded (token) parameter to search on |
| valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter |
| code | Σ | 0..* | Coding | What code is expected |
| dateFilter | ΣI | 0..* | Element | What dates/date ranges are expected + Rule: Either a path or a searchParam must be provided, but not both |
| path | Σ | 0..1 | string | A date-valued attribute to filter on |
| searchParam | Σ | 0..1 | string | A date valued parameter to search on |
 value[x] | Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |
 valueDateTime | dateTime | |||
| valuePeriod | Period | |||
| valueDuration | Duration | |||
| limit | Σ | 0..1 | positiveInt | Number of results |
| sort | Σ | 0..* | Element | Order of the results |
| path | Σ | 1..1 | string | The name of the attribute to perform the sort |
| direction | Σ | 1..1 | code | ascending | descending SortDirection (Required) |
| Documentation for this format | ||||
UML Diagram (Legend)
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]>
JSON Template
{
// from Element: extension
"type" : "<code>", // R! The type of the required data
"profile" : [{ canonical(StructureDefinition) }], // The profile of the required data
// subject[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2:
"subjectCodeableConcept" : { CodeableConcept },
"subjectReference" : { Reference(Group) },
"mustSupport" : ["<string>"], // Indicates specific structure elements that are referenced by the knowledge module
"codeFilter" : [{ // What codes are expected
"path" : "<string>", // A code-valued attribute to filter on
"searchParam" : "<string>", // A coded (token) parameter to search on
"valueSet" : { canonical(ValueSet) }, // Valueset for the filter
"code" : [{ Coding }] // What code is expected
}],
"dateFilter" : [{ // What dates/date ranges are expected
"path" : "<string>", // A date-valued attribute to filter on
"searchParam" : "<string>", // A date valued parameter to search on
// value[x]: The value of the filter, as a Period, DateTime, or Duration value. One of these 3:
"valueDateTime" : "<dateTime>"
"valuePeriod" : { Period }
"valueDuration" : { Duration }
}],
"limit" : "<positiveInt>", // Number of results
"sort" : [{ // Order of the results
"path" : "<string>", // R! The name of the attribute to perform the sort
"direction" : "<code>" // R! ascending | descending
}]
}
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 |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| DataRequirement | ΣTU | Element | Describes a required data item Elements defined in Ancestors: id, extension | |
| type | Σ | 1..1 | code | The type of the required data FHIRAllTypes (Required) |
| profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data |
| subject[x] | Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Subject type (Extensible) | |
| subjectCodeableConcept | CodeableConcept | |||
| subjectReference | Reference(Group) | |||
| mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
| codeFilter | ΣI | 0..* | Element | What codes are expected + Rule: Either a path or a searchParam must be provided, but not both |
| path | Σ | 0..1 | string | A code-valued attribute to filter on |
| searchParam | Σ | 0..1 | string | A coded (token) parameter to search on |
| valueSet | Σ | 0..1 | canonical(ValueSet) | Valueset for the filter |
| code | Σ | 0..* | Coding | What code is expected |
| dateFilter | ΣI | 0..* | Element | What dates/date ranges are expected + Rule: Either a path or a searchParam must be provided, but not both |
| path | Σ | 0..1 | string | A date-valued attribute to filter on |
| searchParam | Σ | 0..1 | string | A date valued parameter to search on |
| value[x] | Σ | 0..1 | The value of the filter, as a Period, DateTime, or Duration value | |
| valueDateTime | dateTime | |||
| valuePeriod | Period | |||
| valueDuration | Duration | |||
| limit | Σ | 0..1 | positiveInt | Number of results |
| sort | Σ | 0..* | Element | Order of the results |
| path | Σ | 1..1 | string | The name of the attribute to perform the sort |
| direction | Σ | 1..1 | code | ascending | descending SortDirection (Required) |
| Documentation for this format | ||||
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]>
JSON Template
{
// from Element: extension
"type" : "<code>", // R! The type of the required data
"profile" : [{ canonical(StructureDefinition) }], // The profile of the required data
// subject[x]: E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2:
"subjectCodeableConcept" : { CodeableConcept },
"subjectReference" : { Reference(Group) },
"mustSupport" : ["<string>"], // Indicates specific structure elements that are referenced by the knowledge module
"codeFilter" : [{ // What codes are expected
"path" : "<string>", // A code-valued attribute to filter on
"searchParam" : "<string>", // A coded (token) parameter to search on
"valueSet" : { canonical(ValueSet) }, // Valueset for the filter
"code" : [{ Coding }] // What code is expected
}],
"dateFilter" : [{ // What dates/date ranges are expected
"path" : "<string>", // A date-valued attribute to filter on
"searchParam" : "<string>", // A date valued parameter to search on
// value[x]: The value of the filter, as a Period, DateTime, or Duration value. One of these 3:
"valueDateTime" : "<dateTime>"
"valuePeriod" : { Period }
"valueDuration" : { Duration }
}],
"limit" : "<positiveInt>", // Number of results
"sort" : [{ // Order of the results
"path" : "<string>", // R! The name of the attribute to perform the sort
"direction" : "<code>" // R! ascending | descending
}]
}
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 ], ...; ]
Constraints
| id | Level | Location | Description | Expression |
| drq-1 | Rule | DataRequirement.codeFilter | Either a path or a searchParam must be provided, but not both | path.exists() xor searchParam.exists() |
| drq-2 | Rule | DataRequirement.dateFilter | Either a path or a searchParam must be provided, but not both | path.exists() xor searchParam.exists() |
Terminology Bindings
| Path | Definition | Type | Reference |
|---|---|---|---|
| DataRequirement.type | A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | Required | All Types |
| DataRequirement.subject[x] | The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). | Extensible | SubjectType |
| DataRequirement.sort.direction | The possible sort directions, ascending or descending. | Required | SortDirection |
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, Parameters, PlanDefinition, ResearchElementDefinition, StructureMap and Task
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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ParameterDefinition | ΣTU | Element | Definition of a parameter to a module Elements defined in Ancestors: id, extension | |
| name | Σ | 0..1 | code | Name used to access the parameter value |
| use | Σ | 1..1 | code | in | out OperationParameterUse (Required) |
| min | Σ | 0..1 | integer | Minimum cardinality |
| max | Σ | 0..1 | string | Maximum cardinality (a number of *) |
| documentation | Σ | 0..1 | string | A brief description of the parameter |
| type | Σ | 1..1 | code | What type of value FHIRAllTypes (Required) |
| profile | Σ | 0..1 | canonical(StructureDefinition) | What profile the value is expected to be |
| Documentation for this format | ||||
UML Diagram (Legend)
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]>
JSON Template
{
// from Element: extension
"name" : "<code>", // Name used to access the parameter value
"use" : "<code>", // R! in | out
"min" : <integer>, // Minimum cardinality
"max" : "<string>", // Maximum cardinality (a number of *)
"documentation" : "<string>", // A brief description of the parameter
"type" : "<code>", // R! What type of value
"profile" : { canonical(StructureDefinition) } // What profile the value is expected to be
}
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 |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ParameterDefinition | ΣTU | Element | Definition of a parameter to a module Elements defined in Ancestors: id, extension | |
| name | Σ | 0..1 | code | Name used to access the parameter value |
| use | Σ | 1..1 | code | in | out OperationParameterUse (Required) |
| min | Σ | 0..1 | integer | Minimum cardinality |
| max | Σ | 0..1 | string | Maximum cardinality (a number of *) |
| documentation | Σ | 0..1 | string | A brief description of the parameter |
| type | Σ | 1..1 | code | What type of value FHIRAllTypes (Required) |
| profile | Σ | 0..1 | canonical(StructureDefinition) | What profile the value is expected to be |
| 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]>
JSON Template
{
// from Element: extension
"name" : "<code>", // Name used to access the parameter value
"use" : "<code>", // R! in | out
"min" : <integer>, // Minimum cardinality
"max" : "<string>", // Maximum cardinality (a number of *)
"documentation" : "<string>", // A brief description of the parameter
"type" : "<code>", // R! What type of value
"profile" : { canonical(StructureDefinition) } // What profile the value is expected to be
}
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 |
|
See the Full Difference for further information
Constraints
Terminology Bindings
| Path | Definition | Type | Reference |
|---|---|---|---|
| ParameterDefinition.use | Whether the parameter is input or output. | Required | OperationParameterUse |
| ParameterDefinition.type | A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types. | Required | All 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedArtifact | ΣTU | Element | Related artifacts for a knowledge resource Elements defined in Ancestors: id, extension | |
| type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of RelatedArtifactType (Required) |
| label | Σ | 0..1 | string | Short label |
| display | Σ | 0..1 | string | Brief description of the related artifact |
| citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact |
| url | Σ | 0..1 | url | Where the artifact can be accessed |
| document | Σ | 0..1 | Attachment | What document is being referenced |
| resource | Σ | 0..1 | canonical(Any) | What resource is being referenced |
| Documentation for this format | ||||
UML Diagram (Legend)
XML Template
<[name] xmlns="http://hl7.org/fhir"> <!-- from Element: extension --> <type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of --> <label value="[string]"/><!-- 0..1 Short label --> <display value="[string]"/><!-- 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- 0..1 Bibliographic citation for the artifact --> <url value="[url]"/><!-- 0..1 Where the artifact can be accessed --> <document><!-- 0..1 Attachment What document is being referenced --></document> <resource><!-- 0..1 canonical(Any) What resource is being referenced --></resource> </[name]>
JSON Template
{
// from Element: extension
"type" : "<code>", // R! documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
"label" : "<string>", // Short label
"display" : "<string>", // Brief description of the related artifact
"citation" : "<markdown>", // Bibliographic citation for the artifact
"url" : "<url>", // Where the artifact can be accessed
"document" : { Attachment }, // What document is being referenced
"resource" : { canonical(Any) } // What resource is being referenced
}
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.label [ string ]; # 0..1 Short label fhir:RelatedArtifact.display [ string ]; # 0..1 Brief description of the related artifact fhir:RelatedArtifact.citation [ markdown ]; # 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 |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedArtifact | ΣTU | Element | Related artifacts for a knowledge resource Elements defined in Ancestors: id, extension | |
| type | Σ | 1..1 | code | documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of RelatedArtifactType (Required) |
| label | Σ | 0..1 | string | Short label |
| display | Σ | 0..1 | string | Brief description of the related artifact |
| citation | Σ | 0..1 | markdown | Bibliographic citation for the artifact |
| url | Σ | 0..1 | url | Where the artifact can be accessed |
| document | Σ | 0..1 | Attachment | What document is being referenced |
| resource | Σ | 0..1 | canonical(Any) | What resource is being referenced |
| Documentation for this format | ||||
XML Template
<[name] xmlns="http://hl7.org/fhir"> <!-- from Element: extension --> <type value="[code]"/><!-- 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of --> <label value="[string]"/><!-- 0..1 Short label --> <display value="[string]"/><!-- 0..1 Brief description of the related artifact --> <citation value="[markdown]"/><!-- 0..1 Bibliographic citation for the artifact --> <url value="[url]"/><!-- 0..1 Where the artifact can be accessed --> <document><!-- 0..1 Attachment What document is being referenced --></document> <resource><!-- 0..1 canonical(Any) What resource is being referenced --></resource> </[name]>
JSON Template
{
// from Element: extension
"type" : "<code>", // R! documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
"label" : "<string>", // Short label
"display" : "<string>", // Brief description of the related artifact
"citation" : "<markdown>", // Bibliographic citation for the artifact
"url" : "<url>", // Where the artifact can be accessed
"document" : { Attachment }, // What document is being referenced
"resource" : { canonical(Any) } // What resource is being referenced
}
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.label [ string ]; # 0..1 Short label fhir:RelatedArtifact.display [ string ]; # 0..1 Brief description of the related artifact fhir:RelatedArtifact.citation [ markdown ]; # 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 ]
Constraints
Terminology Bindings
| Path | Definition | Type | Reference |
|---|---|---|---|
| RelatedArtifact.type | The type of relationship to the related artifact. | Required | RelatedArtifactType |
The following examples illustrate the use of relatedArtifact elements to provide citations:
<relatedArtifact>
<label value="1"/>
<type value="citation"/>
<citation value="Linder, J.A., D.W. Bates, G.M. Lee, J.A. Finkelstein. 2005. _Antibiotic treatment of children with sore throat_ JAMA 294(18):2315-2322. "/>
</relatedArtifact>
<relatedArtifact>
<type value="citation"/>
<label value="2"/>
<citation value="Infectious Diseases Society of America. 2012. _Clinical Practice Guideline for the Diagnosis and Management of Group A Streptococcal Pharyngitis: 2012 Update._ "/>
</relatedArtifact>
<relatedArtifact>
<type value="citation"/>
<label value="3"/>
<citation value="Roberts, R.R., B. Hota, I. Ahmad, et al. _Hospital and Societal Costs of Antimicrobial-Resistant Infections in a Chicago Teaching Hospital: Implications for Antibiotic Stewardship._ Clin Infect Dis. Oct 2009; 49(8):1175-84."/>
</relatedArtifact>RelatedArtifact is used in the following places: ActivityDefinition, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, Library, Measure, Parameters, PlanDefinition, RequestGroup, ResearchDefinition, ResearchElementDefinition, ResearchStudy, StructureMap and Task
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:
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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TriggerDefinition | ΣTU | Element | Defines 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 + Rule: A named event requires a name, a periodic event requires timing, and a data event requires data Elements defined in Ancestors: id, extension | |
| type | Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended TriggerType (Required) |
| name | Σ | 0..1 | string | Name or URI that identifies the event |
| timing[x] | Σ | 0..1 | Timing of the event | |
| timingTiming | Timing | |||
| timingReference | Reference(Schedule) | |||
| timingDate | date | |||
| timingDateTime | dateTime | |||
| data | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and') |
| condition | Σ | 0..1 | Expression | Whether the event triggers (boolean expression) |
| Documentation for this format | ||||
UML Diagram (Legend)
XML Template
<[name] xmlns="http://hl7.org/fhir"> <!-- from Element: extension --> <type value="[code]"/><!-- 1..1 named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended --> <name value="[string]"/><!-- 0..1 Name or URI that identifies the event --> <timing[x]><!-- 0..1 Timing|Reference(Schedule)|date|dateTime Timing of the event --></timing[x]> <data><!-- 0..* DataRequirement Triggering data of the event (multiple = 'and') --></data> <condition><!-- 0..1 Expression Whether the event triggers (boolean expression) --></condition> </[name]>
JSON Template
{
// from Element: extension
"type" : "<code>", // R! named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
"name" : "<string>", // Name or URI that identifies the event
// timing[x]: Timing of the event. One of these 4:
"timingTiming" : { Timing },
"timingReference" : { Reference(Schedule) },
"timingDate" : "<date>",
"timingDateTime" : "<dateTime>",
"data" : [{ DataRequirement }], // Triggering data of the event (multiple = 'and')
"condition" : { Expression } // Whether the event triggers (boolean expression)
}
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..* Triggering data of the event (multiple = 'and') fhir:TriggerDefinition.condition [ Expression ]; # 0..1 Whether the event triggers (boolean expression) ]
Changes since Release 3
| TriggerDefinition |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| TriggerDefinition | ΣTU | Element | Defines 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 + Rule: A named event requires a name, a periodic event requires timing, and a data event requires data Elements defined in Ancestors: id, extension | |
| type | Σ | 1..1 | code | named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended TriggerType (Required) |
| name | Σ | 0..1 | string | Name or URI that identifies the event |
| timing[x] | Σ | 0..1 | Timing of the event | |
| timingTiming | Timing | |||
| timingReference | Reference(Schedule) | |||
| timingDate | date | |||
| timingDateTime | dateTime | |||
| data | Σ | 0..* | DataRequirement | Triggering data of the event (multiple = 'and') |
| condition | Σ | 0..1 | Expression | Whether the event triggers (boolean expression) |
| Documentation for this format | ||||
XML Template
<[name] xmlns="http://hl7.org/fhir"> <!-- from Element: extension --> <type value="[code]"/><!-- 1..1 named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended --> <name value="[string]"/><!-- 0..1 Name or URI that identifies the event --> <timing[x]><!-- 0..1 Timing|Reference(Schedule)|date|dateTime Timing of the event --></timing[x]> <data><!-- 0..* DataRequirement Triggering data of the event (multiple = 'and') --></data> <condition><!-- 0..1 Expression Whether the event triggers (boolean expression) --></condition> </[name]>
JSON Template
{
// from Element: extension
"type" : "<code>", // R! named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
"name" : "<string>", // Name or URI that identifies the event
// timing[x]: Timing of the event. One of these 4:
"timingTiming" : { Timing },
"timingReference" : { Reference(Schedule) },
"timingDate" : "<date>",
"timingDateTime" : "<dateTime>",
"data" : [{ DataRequirement }], // Triggering data of the event (multiple = 'and')
"condition" : { Expression } // Whether the event triggers (boolean expression)
}
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..* Triggering data of the event (multiple = 'and') fhir:TriggerDefinition.condition [ Expression ]; # 0..1 Whether the event triggers (boolean expression) ]
Changes since Release 3
| TriggerDefinition |
|
See the Full Difference for further information
Constraints
| id | Level | Location | Description | Expression |
| trd-1 | Rule | (base) | Either timing, or a data requirement, but not both | data.empty() or timing.empty() |
| trd-2 | Rule | (base) | A condition only if there is a data requirement | condition.exists() implies data.exists() |
| trd-3 | Rule | (base) | A named event requires a name, a periodic event requires timing, and a data event requires data | (type = 'named-event' implies name.exists()) and (type = 'periodic' implies timing.exists()) and (type.startsWith('data-') implies data.exists()) |
Terminology Bindings
| Path | Definition | Type | Reference |
|---|---|---|---|
| TriggerDefinition.type | The type of trigger. | Required | TriggerType |
TriggerDefinition is used in the following places: EventDefinition, Parameters, PlanDefinition, StructureMap and Task
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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Expression | ΣTU | Element | An 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..1 | string | Natural language description of the condition |
| name | Σ | 0..1 | id | Short name assigned to expression for reuse |
| language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc. ExpressionLanguage (Extensible but limited to http://hl7.org/fhir/ValueSet/mimetypes ) |
| expression | Σ | 0..1 | string | Expression in specified language |
| reference | Σ | 0..1 | uri | Where the expression is found |
| Documentation for this format | ||||
UML Diagram (Legend)
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 | text/cql-identifier | text/cql-expression | etc. --> <expression value="[string]"/><!-- 0..1 Expression in specified language --> <reference value="[uri]"/><!-- 0..1 Where the expression is found --> </Expression>
JSON Template
{
// from Element: extension
"description" : "<string>", // Natural language description of the condition
"name" : "<id>", // Short name assigned to expression for reuse
"language" : "<code>", // R! text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc.
"expression" : "<string>", // Expression in specified language
"reference" : "<uri>" // Where the expression is found
}
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 | text/cql-identifier | text/cql-expression | 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
| Expression | |
| Expression.language |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Expression | ΣTU | Element | An 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..1 | string | Natural language description of the condition |
| name | Σ | 0..1 | id | Short name assigned to expression for reuse |
| language | Σ | 1..1 | code | text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc. ExpressionLanguage (Extensible but limited to http://hl7.org/fhir/ValueSet/mimetypes ) |
| expression | Σ | 0..1 | string | Expression in specified language |
| reference | Σ | 0..1 | uri | Where the expression is found |
| 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 | text/cql-identifier | text/cql-expression | etc. --> <expression value="[string]"/><!-- 0..1 Expression in specified language --> <reference value="[uri]"/><!-- 0..1 Where the expression is found --> </Expression>
JSON Template
{
// from Element: extension
"description" : "<string>", // Natural language description of the condition
"name" : "<id>", // Short name assigned to expression for reuse
"language" : "<code>", // R! text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc.
"expression" : "<string>", // Expression in specified language
"reference" : "<uri>" // Where the expression is found
}
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 | text/cql-identifier | text/cql-expression | 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
| Expression | |
| Expression.language |
|
See the Full Difference for further information
Constraints
| id | Level | Location | Description | Expression |
| exp-1 | Rule | (base) | An expression or a reference must be provided | expression.exists() or reference.exists() |
Terminology Bindings
| Path | Definition | Type | Reference |
|---|---|---|---|
| Expression.language | The media type of the expression language. | Extensible, but limited to http://hl7.org/fhir/ValueSet/mimetypes | ExpressionLanguage |
Expression is used in the following places: TriggerDefinition, ActivityDefinition, EvidenceVariable, Measure, Parameters, PlanDefinition, RequestGroup, ResearchElementDefinition, StructureMap and Task
See also Examples, Detailed Descriptions and Mappings.
The UsageContext structure defines the context of use for a module.
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| UsageContext | ΣTU | Element | Describes the context of use for a conformance or knowledge resource Elements defined in Ancestors: id, extension | |
| code | Σ | 1..1 | Coding | Type of context being specified UsageContextType (Extensible) |
| value[x] | Σ | 1..1 | Value that defines the context ConformanceUseContext (Example) | |
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueReference | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||
| Documentation for this format | ||||
UML Diagram (Legend)
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|Reference(Group| HealthcareService|InsurancePlan|Location|Organization|PlanDefinition| ResearchStudy) Value that defines the context --></value[x]> </[name]>
JSON Template
{
// from Element: extension
"code" : { Coding }, // R! Type of context being specified
// value[x]: Value that defines the context. One of these 4:
"valueCodeableConcept" : { CodeableConcept }
"valueQuantity" : { Quantity }
"valueRange" : { Range }
"valueReference" : { Reference(Group|HealthcareService|InsurancePlan|Location|
Organization|PlanDefinition|ResearchStudy) }
}
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 4 fhir:UsageContext.valueCodeableConcept [ CodeableConcept ] fhir:UsageContext.valueQuantity [ Quantity ] fhir:UsageContext.valueRange [ Range ] fhir:UsageContext.valueReference [ Reference(Group|HealthcareService|InsurancePlan|Location|Organization|PlanDefinition| ResearchStudy) ] ]
Changes since Release 3
| UsageContext |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| UsageContext | ΣTU | Element | Describes the context of use for a conformance or knowledge resource Elements defined in Ancestors: id, extension | |
| code | Σ | 1..1 | Coding | Type of context being specified UsageContextType (Extensible) |
| value[x] | Σ | 1..1 | Value that defines the context ConformanceUseContext (Example) | |
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valueReference | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||
| 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|Reference(Group| HealthcareService|InsurancePlan|Location|Organization|PlanDefinition| ResearchStudy) Value that defines the context --></value[x]> </[name]>
JSON Template
{
// from Element: extension
"code" : { Coding }, // R! Type of context being specified
// value[x]: Value that defines the context. One of these 4:
"valueCodeableConcept" : { CodeableConcept }
"valueQuantity" : { Quantity }
"valueRange" : { Range }
"valueReference" : { Reference(Group|HealthcareService|InsurancePlan|Location|
Organization|PlanDefinition|ResearchStudy) }
}
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 4 fhir:UsageContext.valueCodeableConcept [ CodeableConcept ] fhir:UsageContext.valueQuantity [ Quantity ] fhir:UsageContext.valueRange [ Range ] fhir:UsageContext.valueReference [ Reference(Group|HealthcareService|InsurancePlan|Location|Organization|PlanDefinition| ResearchStudy) ] ]
Constraints
Terminology Bindings
| Path | Definition | Type | Reference |
|---|---|---|---|
| UsageContext.code | A code that specifies a type of context being specified by a usage context. | Extensible | UsageContextType |
| UsageContext.value[x] | A code that defines the specific value for the context being specified. | Example | Context of Use ValueSet |
UsageContext is used in the following places: ActivityDefinition, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, ConceptMap, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, GraphDefinition, ImplementationGuide, Library, Measure, MessageDefinition, NamingSystem, OperationDefinition, Parameters, PlanDefinition, Questionnaire, ResearchDefinition, ResearchElementDefinition, SearchParameter, StructureDefinition, StructureMap, SubscriptionTopic, Task, TerminologyCapabilities, TestScript and ValueSet
FHIR ®© HL7.org 2011+. FHIR Release 4B (v4.3.0) hl7.fhir.r4b.core#4.3.0 generated on Sat, May 28, 2022 12:58+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change