This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions
Modeling and Methodology Work Group | Maturity Level: 4 | Standards Status: Partially Normative |
Types Framework Cross Reference: Base Types | Datatypes | Resources | Patterns
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 | DataRequirement | ParameterDefinition | RelatedArtifact |
TriggerDefinition | Expression | UsageContext | ExtendedContactDetail |
VirtualServiceDetail | Availability | MonetaryComponent |
For an index of all datatypes, see the Datatypes page.
FHIR Infrastructure Work Group | Maturity Level: 5 | Standards Status: Normative |
See also Examples, Detailed Descriptions, Mappings, Profiles, Extensions and R4 Conversions
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
<ContactDetail 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> </ContactDetail>
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:name [ string ] ; # 0..1 Name of an individual to contact fhir:telecom ( [ ContactPoint ] ... ) ; # 0..* Contact details for individual or organization ]
Changes since Release 3
Changes from both R4 and R4B
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
<ContactDetail 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> </ContactDetail>
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:name [ string ] ; # 0..1 Name of an individual to contact fhir:telecom ( [ ContactPoint ] ... ) ; # 0..* Contact details for individual or organization ]
Changes since Release 3
Changes from both R4 and R4B
ContactDetail |
|
See the Full Difference for further information
Constraints
ContactDetail is used in the following places: Contributor, ActivityDefinition, ActorDefinition, CanonicalResource, CapabilityStatement, ChargeItemDefinition, Citation, CodeSystem, CompartmentDefinition, ConceptMap, ConditionDefinition, EventDefinition, Evidence, EvidenceReport, EvidenceVariable, ExampleScenario, GraphDefinition, Group, ImplementationGuide, Library, Measure, MessageDefinition, MetadataResource, NamingSystem, ObservationDefinition, OperationDefinition, PlanDefinition, Questionnaire, Requirements, SearchParameter, SpecimenDefinition, StructureDefinition, StructureMap, SubscriptionTopic, TerminologyCapabilities, TestPlan, TestScript and ValueSet
FHIR Infrastructure Work Group | Maturity Level: 5 | Standards Status: Trial Use |
See also Examples, Detailed Descriptions, Mappings, Profiles, Extensions and R4 Conversions
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 Binding: All FHIR Types (Required) |
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data |
subject[x] | Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: Participant Resource Types (Extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
codeFilter | ΣC | 0..* | Element | What codes are expected + Rule: Either a path or a searchParam must be provided, but not both |
path | ΣC | 0..1 | string | A code-valued attribute to filter on |
searchParam | ΣC | 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 | ΣC | 0..* | Element | What dates/date ranges are expected + Rule: Either a path or a searchParam must be provided, but not both |
path | ΣC | 0..1 | string | A date-valued attribute to filter on |
searchParam | ΣC | 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 | |||
valueFilter | Σ | 0..* | Element | What values are expected |
path | Σ | 0..1 | string | An attribute to filter on |
searchParam | Σ | 0..1 | string | A parameter to search on |
comparator | Σ | 0..1 | code | eq | gt | lt | ge | le | sa | eb Binding: Value Filter Comparator (Required) |
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 Binding: SortDirection (Required) |
Documentation for this format |
UML Diagram (Legend)
XML Template
<DataRequirement 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]"/><!-- I 0..1 A code-valued attribute to filter on --> <searchParam value="[string]"/><!-- I 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]"/><!-- I 0..1 A date-valued attribute to filter on --> <searchParam value="[string]"/><!-- I 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> <valueFilter> <!-- 0..* What values are expected --> <path value="[string]"/><!-- 0..1 An attribute to filter on --> <searchParam value="[string]"/><!-- 0..1 A parameter to search on --> <comparator value="[code]"/><!-- 0..1 eq | gt | lt | ge | le | sa | eb --> <value[x]><!-- 0..1 dateTime|Period|Duration The value of the filter, as a Period, DateTime, or Duration value --></value[x]> </valueFilter> <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> </DataRequirement>
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>", // I A code-valued attribute to filter on "searchParam" : "<string>", // I 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>", // I A date-valued attribute to filter on "searchParam" : "<string>", // I 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 } }], "valueFilter" : [{ // What values are expected "path" : "<string>", // An attribute to filter on "searchParam" : "<string>", // A parameter to search on "comparator" : "<code>", // eq | gt | lt | ge | le | sa | eb // 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:type [ code ] ; # 1..1 The type of the required data fhir:profile ( [ canonical(StructureDefinition) ] ... ) ; # 0..* The profile of the required data # subject[x] : 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device. One of these 2 fhir:subject [ a fhir:CodeableConcept ; CodeableConcept ] fhir:subject [ a fhir:Reference ; Reference(Group) ] fhir:mustSupport ( [ string ] ... ) ; # 0..* Indicates specific structure elements that are referenced by the knowledge module fhir:codeFilter ( [ # 0..* What codes are expected fhir:path [ string ] ; # 0..1 I A code-valued attribute to filter on fhir:searchParam [ string ] ; # 0..1 I A coded (token) parameter to search on fhir:valueSet [ canonical(ValueSet) ] ; # 0..1 ValueSet for the filter fhir:code ( [ Coding ] ... ) ; # 0..* What code is expected ] ... ) ; fhir:dateFilter ( [ # 0..* What dates/date ranges are expected fhir:path [ string ] ; # 0..1 I A date-valued attribute to filter on fhir:searchParam [ string ] ; # 0..1 I A date valued parameter to search on # value[x] : 0..1 The value of the filter, as a Period, DateTime, or Duration value. One of these 3 fhir:value [ a fhir:dateTime ; dateTime ] fhir:value [ a fhir:Period ; Period ] fhir:value [ a fhir:Duration ; Duration ] ] ... ) ; fhir:valueFilter ( [ # 0..* What values are expected fhir:path [ string ] ; # 0..1 An attribute to filter on fhir:searchParam [ string ] ; # 0..1 A parameter to search on fhir:comparator [ code ] ; # 0..1 eq | gt | lt | ge | le | sa | eb # value[x] : 0..1 The value of the filter, as a Period, DateTime, or Duration value. One of these 3 fhir:value [ a fhir:dateTime ; dateTime ] fhir:value [ a fhir:Period ; Period ] fhir:value [ a fhir:Duration ; Duration ] ] ... ) ; fhir:limit [ positiveInt ] ; # 0..1 Number of results fhir:sort ( [ # 0..* Order of the results fhir:path [ string ] ; # 1..1 The name of the attribute to perform the sort fhir:direction [ code ] ; # 1..1 ascending | descending ] ... ) ; ]
Changes since Release 3
Changes from both R4 and R4B
DataRequirement | |
DataRequirement.type |
|
DataRequirement.subject[x] |
|
DataRequirement.valueFilter |
|
DataRequirement.valueFilter.path |
|
DataRequirement.valueFilter.searchParam |
|
DataRequirement.valueFilter.comparator |
|
DataRequirement.valueFilter.value[x] |
|
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 Binding: All FHIR Types (Required) |
profile | Σ | 0..* | canonical(StructureDefinition) | The profile of the required data |
subject[x] | Σ | 0..1 | E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: Participant Resource Types (Extensible) | |
subjectCodeableConcept | CodeableConcept | |||
subjectReference | Reference(Group) | |||
mustSupport | Σ | 0..* | string | Indicates specific structure elements that are referenced by the knowledge module |
codeFilter | ΣC | 0..* | Element | What codes are expected + Rule: Either a path or a searchParam must be provided, but not both |
path | ΣC | 0..1 | string | A code-valued attribute to filter on |
searchParam | ΣC | 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 | ΣC | 0..* | Element | What dates/date ranges are expected + Rule: Either a path or a searchParam must be provided, but not both |
path | ΣC | 0..1 | string | A date-valued attribute to filter on |
searchParam | ΣC | 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 | |||
valueFilter | Σ | 0..* | Element | What values are expected |
path | Σ | 0..1 | string | An attribute to filter on |
searchParam | Σ | 0..1 | string | A parameter to search on |
comparator | Σ | 0..1 | code | eq | gt | lt | ge | le | sa | eb Binding: Value Filter Comparator (Required) |
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 Binding: SortDirection (Required) |
Documentation for this format |