Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU see ballot notes ). 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

2.25.0 2.1.27.6.0 MetaData Types MetaDatatypes

FHIR Infrastructure Modeling and Methodology icon Work Group Maturity Level : 4 Standards Status : Partially Normative
This page has been approved as part of an ANSI

Types Framework Cross Reference: Base Types standard. See the Infrastructure | Datatypes Package for further details. | 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 Contributor DataRequirement ParameterDefinition RelatedArtifact
TriggerDefinition Expression UsageContext ExtendedContactDetail
VirtualServiceDetail Availability MonetaryComponent

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

See also Examples , Detailed Descriptions and Mappings .

The ContactDetail structure defines general contact details.

Structure

Name Flags Card. Type Description & Constraints doco
. . 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


doco Documentation for this format

Definition: XML | JSON

UML Diagram ( Legend )

ContactDetail The name of an individual to contact name : string [0..1] The contact details for the individual (if a name was provided) or the organization telecom : ContactPoint [0..*] Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string DataType [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*]

XML Template

< xmlns="http://hl7.org/fhir">

<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>
</[name]>

</ContactDetail>

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
  • No Changes

See the Full Difference for further information

Structure

Name Flags Card. Type Description & Constraints doco
. . 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


doco Documentation for this format

UML Diagram ( Legend )

ContactDetail The name of an individual to contact name : string [0..1] The contact details for the individual (if a name was provided) or the organization telecom : ContactPoint [0..*] Element DataType Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*]

XML Template

< xmlns="http://hl7.org/fhir">

<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>
</[name]>

</ContactDetail>

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
  • No Changes

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 , ImplementationGuide , Library , Measure , MessageDefinition , MetadataResource , NamingSystem , ObservationDefinition , OperationDefinition , Parameters , PlanDefinition , Questionnaire , ResearchDefinition , ResearchElementDefinition , ResearchStudy Requirements , SearchParameter , SpecimenDefinition , StructureDefinition , StructureMap , SubscriptionTopic , Task , TerminologyCapabilities , TestScript and ValueSet

2.25.0.0.1.1 Interpretation of ContactDetail in different contexts   2.25.0.0.2 Contributor 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 UML XML JSON Turtle R3 Diff All 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 ) Contributor The type of contributor type : code [1..1] « The type of contributor. (Strength=Required) ContributorType ! » The name of the individual or organization responsible for the contribution name : string [1..1] Contact details to assist a user in finding and communicating with the contributor contact : ContactDetail [0..*] Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*] XML Template < xmlns="http://hl7.org/fhir"> <!-- from Element: --> < < <</contact> </[name]> JSON Template { // from Element: " " " } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ # from Element: fhir: fhir: fhir: ] Changes since Release 3 Contributor No Changes 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 UML Diagram ( Legend ) Contributor The type of contributor type : code [1..1] « The type of contributor. (Strength=Required) ContributorType ! » The name of the individual or organization responsible for the contribution name : string [1..1] Contact details to assist a user in finding and communicating with the contributor contact : ContactDetail [0..*] Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*] XML Template < xmlns="http://hl7.org/fhir"> <!-- from Element: --> < < <</contact> </[name]> JSON Template { // from Element: " " " } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ # from Element: fhir: fhir: fhir: ] Changes since Release 3 Contributor No Changes See the Full Difference for further information 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 2.25.0.0.2.1 Interpretation of Contributor in different contexts  

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 doco
. . 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 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
Subject type Participant Resource Types ( Extensible )
. . . . subjectCodeableConcept CodeableConcept
. . . . subjectReference Reference ( Group )
. . . codeFilter Σ I C 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 C 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
. . . 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
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
SortDirection ( Required )

doco Documentation for this format

Definition: XML | JSON

UML Diagram ( Legend )

DataRequirement The 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 profile type : code [1..1] « A list of all the concrete types defined in this version List of the FHIR specification - Abstract Types, Data Types and Resource Types. types (resources, data types). (Strength=Required) FHIRAllTypes FHIRTypes ! » The profile of the required data, specified as the uri of the profile definition profile : canonical [0..*] « StructureDefinition » The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed subject[x] : Element DataType [0..1] « CodeableConcept | Reference ( Group ); The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType ParticipantResourceTypes + » 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] CodeFilter The 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 CodeableConcept path : 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 CodeableConcept searchParam : 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 valueset valueSet : 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 codes code : Coding [0..*] DateFilter The 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 Timing path : 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 Timing searchParam : 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 now value[x] : Element DataType [0..1] « dateTime | Period | Duration » ValueFilter The 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 a type that is comparable to the valueFilter.value[x] element for the filter path : string [0..1] A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter searchParam : string [0..1] The comparator to be used to determine whether the value is matching comparator : code [0..1] « Possible comparators for the valueFilter element. (Strength=Required) ValueFilterComparator ! » The value of the filter value[x] : DataType [0..1] « dateTime | Period | Duration » Sort The 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 constant path : string [1..1] The direction of the sort, ascending or descending direction : code [1..1] « The possible sort directions, ascending or descending. (Strength=Required) SortDirection ! » Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string DataType [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*] 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'ed codeFilter [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'ed dateFilter [0..*] Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed) valueFilter [0..*] Specifies the order of the results to be returned sort [0..*]

XML Template

< xmlns="http://hl7.org/fhir">

<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]>

 <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>
 <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>
</[name]>

</DataRequirement>

JSON Template

{doco
  // 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 }
  }],
  "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: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.valueFilter [ # 0..* What values are expected
    fhir:DataRequirement.valueFilter.path [ string ]; # 0..1 An attribute to filter on
    fhir:DataRequirement.valueFilter.searchParam [ string ]; # 0..1 A parameter to search on
    fhir:DataRequirement.valueFilter.comparator [ code ]; # 0..1 eq | gt | lt | ge | le | sa | eb
    # DataRequirement.valueFilter.value[x] : 0..1 The value of the filter, as a Period, DateTime, or Duration value. One of these 3
      fhir:DataRequirement.valueFilter.valueDateTime [ dateTime ]
      fhir:DataRequirement.valueFilter.valuePeriod [ Period ]
      fhir:DataRequirement.valueFilter.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
  • No Changes Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to http://hl7.org/fhir/ValueSet/fhir-types|5.0.0-ballot
  • Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to http://hl7.org/fhir/ValueSet/fhir-types|5.0.0-ballot
DataRequirement.subject[x]
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to http://hl7.org/fhir/ValueSet/participant-resource-types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to http://hl7.org/fhir/ValueSet/participant-resource-types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
DataRequirement.valueFilter
  • Added Element
DataRequirement.valueFilter.path
  • Added Element
DataRequirement.valueFilter.searchParam
  • Added Element
DataRequirement.valueFilter.comparator
  • Added Element
DataRequirement.valueFilter.value[x]
  • Added Element

See the Full Difference for further information

Structure

Name Flags Card. Type Description & Constraints doco
. . 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 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
Subject type Participant Resource Types ( Extensible )
. . . . subjectCodeableConcept CodeableConcept
. . . . subjectReference Reference ( Group )
. . . codeFilter Σ I C 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 C 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
. . . 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
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
SortDirection ( Required )

doco Documentation for this format

UML Diagram ( Legend )

DataRequirement The 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 profile type : code [1..1] « A list of all the concrete types defined in this version List of the FHIR specification - Abstract Types, Data Types and Resource Types. types (resources, data types). (Strength=Required) FHIRAllTypes FHIRTypes ! » The profile of the required data, specified as the uri of the profile definition profile : canonical [0..*] « StructureDefinition » The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed subject[x] : Element DataType [0..1] « CodeableConcept | Reference ( Group ); The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). (Strength=Extensible) SubjectType ParticipantResourceTypes + » 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] CodeFilter The 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 CodeableConcept path : 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 CodeableConcept searchParam : 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 valueset valueSet : 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 codes code : Coding [0..*] DateFilter The 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 Timing path : 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 Timing searchParam : 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 now value[x] : Element DataType [0..1] « dateTime | Period | Duration » ValueFilter The 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 a type that is comparable to the valueFilter.value[x] element for the filter path : string [0..1] A search parameter defined on the specified type of the DataRequirement, and which searches on elements of a type compatible with the type of the valueFilter.value[x] for the filter searchParam : string [0..1] The comparator to be used to determine whether the value is matching comparator : code [0..1] « Possible comparators for the valueFilter element. (Strength=Required) ValueFilterComparator ! » The value of the filter value[x] : DataType [0..1] « dateTime | Period | Duration » Sort The 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 constant path : string [1..1] The direction of the sort, ascending or descending direction : code [1..1] « The possible sort directions, ascending or descending. (Strength=Required) SortDirection ! » Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string DataType [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*] 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'ed codeFilter [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'ed dateFilter [0..*] Value filters specify additional constraints on the data for elements other than code-valued or date-valued. Each value filter specifies an additional constraint on the data (i.e. valueFilters are AND'ed, not OR'ed) valueFilter [0..*] Specifies the order of the results to be returned sort [0..*]

XML Template

< xmlns="http://hl7.org/fhir">

<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]>

 <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>
 <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>
</[name]>

</DataRequirement>

JSON Template

{doco
  // 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 }
  }],
  "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: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.valueFilter [ # 0..* What values are expected
    fhir:DataRequirement.valueFilter.path [ string ]; # 0..1 An attribute to filter on
    fhir:DataRequirement.valueFilter.searchParam [ string ]; # 0..1 A parameter to search on
    fhir:DataRequirement.valueFilter.comparator [ code ]; # 0..1 eq | gt | lt | ge | le | sa | eb
    # DataRequirement.valueFilter.value[x] : 0..1 The value of the filter, as a Period, DateTime, or Duration value. One of these 3
      fhir:DataRequirement.valueFilter.valueDateTime [ dateTime ]
      fhir:DataRequirement.valueFilter.valuePeriod [ Period ]
      fhir:DataRequirement.valueFilter.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
  • No Changes Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to http://hl7.org/fhir/ValueSet/fhir-types|5.0.0-ballot
  • Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to http://hl7.org/fhir/ValueSet/fhir-types|5.0.0-ballot
DataRequirement.subject[x]
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to http://hl7.org/fhir/ValueSet/participant-resource-types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
  • Change value set from http://hl7.org/fhir/ValueSet/subject-type to http://hl7.org/fhir/ValueSet/participant-resource-types
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/resource-types" to "http://hl7.org/fhir/fhir-types"
DataRequirement.valueFilter
  • Added Element
DataRequirement.valueFilter.path
  • Added Element
DataRequirement.valueFilter.searchParam
  • Added Element
DataRequirement.valueFilter.comparator
  • Added Element
DataRequirement.valueFilter.value[x]
  • Added Element

See the Full Difference for further information

Constraints

id Level Location Description Expression
drq-1 img  drq-1 Rule DataRequirement.codeFilter Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists()
drq-2 img  drq-2 Rule DataRequirement.dateFilter Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists()

Terminology Bindings

DataRequirement.subject[x]
Path Definition Type Reference
DataRequirement.type A list of all the concrete types defined in this version of the

All FHIR specification - Abstract Types, Data Types and Resource Types. types

Required FHIRTypes
DataRequirement.subject[x]

All Resource Types that represent participant resources

Extensible ParticipantResourceTypes
DataRequirement.valueFilter.comparator

The possible types type of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.). comparator operator to use

Extensible Required SubjectType ValueFilterComparator
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 MedicationUsages 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 RequestOrchestration

 

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 MedicationUsages and Encounters.

Structure

Name Flags Card. Type Description & Constraints doco
. . 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
. . . documentation Σ 0..1 string A brief description of the parameter
. . . type Σ 1..1 code What type of value
FHIRAllTypes All FHIR Types ( Required )
. . . profile Σ 0..1 canonical ( StructureDefinition ) What profile the value is expected to be

doco Documentation for this format

Definition: XML | JSON

UML Diagram ( Legend )

ParameterDefinition The name of the parameter used to allow access to the value of the parameter in evaluation contexts name : code [0..1] Whether the parameter is input or output for the module use : code [1..1] « Whether the parameter is input or output. (Strength=Required) OperationParameterUse ! » The minimum number of times this parameter SHALL appear in the request or response min : integer [0..1] The maximum number of times this element is permitted to appear in the request or response max : string [0..1] A brief discussion of what the parameter is for and how it is used by the module documentation : string [0..1] The type of the parameter type : code [1..1] « A list of all the concrete types defined in this version List of the FHIR specification - Abstract Types, Data Types and Resource Types. types (resources, data types). (Strength=Required) FHIRAllTypes FHIRTypes ! » If specified, this indicates a profile that the input data must conform to, or that the output data will conform to profile : canonical [0..1] « StructureDefinition » Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string DataType [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*]

XML Template

< xmlns="http://hl7.org/fhir">

<ParameterDefinition 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]>

</ParameterDefinition>

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
  • No Changes Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to http://hl7.org/fhir/ValueSet/fhir-types|5.0.0-ballot
  • Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to http://hl7.org/fhir/ValueSet/fhir-types|5.0.0-ballot

See the Full Difference for further information

Structure

Name Flags Card. Type Description & Constraints doco
. . 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
. . . documentation Σ 0..1 string A brief description of the parameter
. . . type Σ 1..1 code What type of value
FHIRAllTypes All FHIR Types ( Required )
. . . profile Σ 0..1 canonical ( StructureDefinition ) What profile the value is expected to be

doco Documentation for this format

UML Diagram ( Legend )

ParameterDefinition The name of the parameter used to allow access to the value of the parameter in evaluation contexts name : code [0..1] Whether the parameter is input or output for the module use : code [1..1] « Whether the parameter is input or output. (Strength=Required) OperationParameterUse ! » The minimum number of times this parameter SHALL appear in the request or response min : integer [0..1] The maximum number of times this element is permitted to appear in the request or response max : string [0..1] A brief discussion of what the parameter is for and how it is used by the module documentation : string [0..1] The type of the parameter type : code [1..1] « A list of all the concrete types defined in this version List of the FHIR specification - Abstract Types, Data Types and Resource Types. types (resources, data types). (Strength=Required) FHIRAllTypes FHIRTypes ! » If specified, this indicates a profile that the input data must conform to, or that the output data will conform to profile : canonical [0..1] « StructureDefinition » Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string DataType [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*]

XML Template

< xmlns="http://hl7.org/fhir">

<ParameterDefinition 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]>

</ParameterDefinition>

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
  • No Changes Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to http://hl7.org/fhir/ValueSet/fhir-types|5.0.0-ballot
  • Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to http://hl7.org/fhir/ValueSet/fhir-types|5.0.0-ballot

See the Full Difference for further information

Constraints

Terminology Bindings

Path Definition Type Reference
ParameterDefinition.use

Whether the an operation parameter is an input or output. an output parameter.

Required OperationParameterUse
ParameterDefinition.type A list of all the concrete types defined in this version of the

All FHIR specification - Abstract Types, Data Types and Resource Types. types

Required All Types FHIRTypes

 

See also Examples , Detailed Descriptions and Mappings .

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

Structure

Name Flags Card. Type Description & Constraints doco
. . 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 | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
RelatedArtifactType ( Required )
. . label . classifier Σ 0..1 0..* string CodeableConcept Short label Additional classifiers
CitationArtifactClassifier ( Example )

. . . display label Σ 0..1 string Brief description of the related artifact Short label
. . . url citation Σ 0..1 url markdown Where Bibliographic citation for the artifact can be accessed
. . . document Σ 0..1 Attachment What document is being referenced
. . . resource Σ 0..1 canonical ( Any ) What resource artifact is being referenced
. . . resourceReference Σ 0..1 Reference ( Any ) What artifact, if not a conformance resource
... publicationStatus Σ 0..1 code draft | active | retired | unknown
PublicationStatus ( Required )
... publicationDate Σ 0..1 date Date of publication of the artifact being referred to

doco Documentation for this format

Definition: XML | JSON

UML Diagram ( Legend )

RelatedArtifact The type of relationship to the related artifact type : code [1..1] « The type of relationship to the related artifact. (Strength=Required) RelatedArtifactType ! » Provides additional classifiers of the related artifact classifier : CodeableConcept [0..*] « Additional classifiers for the related artifact. (Strength=Example) CitationArtifactClassifier ?? » A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index label : string [0..1] A brief description of the document or knowledge resource being referenced, suitable for display to a consumer display : string [0..1] A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format citation : markdown [0..1] A url for the artifact that can be followed to access the actual content url : url [0..1] The document being referenced, represented as an attachment. This is exclusive with the resource element document : Attachment [0..1] The related resource, artifact, such as a library, value set, profile, or other knowledge resource resource : canonical [0..1] « Any » Element Unique id for The related artifact, if the element within artifact is not a canonical resource, or a resource (for internal references). This may be any string value that does not contain spaces reference to a canonical resource id resourceReference : string Reference [0..1] « Any » May be used to represent additional information that is not part of the basic definition The publication status of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied artifact being referred to the definition and use publicationStatus : code [0..1] « Publication status of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part artifact being referred to. (Strength=Required) PublicationStatus ! » The date of the definition publication of the extension artifact being referred to extension publicationDate : Extension date [0..*] [0..1] DataType

Turtle Template

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

[
 # from Element: Element.extension
  fhir:

  fhir:RelatedArtifact.type [ code ]; # 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
  fhir:RelatedArtifact.classifier [ CodeableConcept ], ... ; # 0..* Additional classifiers

  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:

  fhir:RelatedArtifact.document [ Attachment ]; # 0..1 What document is being referenced
  fhir:

  fhir:RelatedArtifact.resource [ canonical(Any) ]; # 0..1 What artifact is being referenced
  fhir:RelatedArtifact.resourceReference [ Reference(Any) ]; # 0..1 What artifact, if not a conformance resource
  fhir:RelatedArtifact.publicationStatus [ code ]; # 0..1 draft | active | retired | unknown
  fhir:RelatedArtifact.publicationDate [ date ]; # 0..1 Date of publication of the artifact being referred to

]

Changes since Release 3

RelatedArtifact
RelatedArtifact.classifier
  • No Changes Added Element
RelatedArtifact.resourceReference
  • Added Element
RelatedArtifact.publicationStatus
  • Added Element
RelatedArtifact.publicationDate
  • Added Element
RelatedArtifact.url
  • deleted

See the Full Difference for further information

Structure

Name Flags Card. Type Description & Constraints doco
. . 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 | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
RelatedArtifactType ( Required )
. . label . classifier Σ 0..1 0..* string CodeableConcept Short label Additional classifiers
CitationArtifactClassifier ( Example )

. . . display label Σ 0..1 string Brief description of the related artifact Short label
. . . url citation Σ 0..1 url markdown Where Bibliographic citation for the artifact can be accessed
. . . document Σ 0..1 Attachment What document is being referenced
. . . resource Σ 0..1 canonical ( Any ) What resource artifact is being referenced
. . . resourceReference Σ 0..1 Reference ( Any ) What artifact, if not a conformance resource
... publicationStatus Σ 0..1 code draft | active | retired | unknown
PublicationStatus ( Required )
... publicationDate Σ 0..1 date Date of publication of the artifact being referred to

doco Documentation for this format

UML Diagram ( Legend )

RelatedArtifact The type of relationship to the related artifact type : code [1..1] « The type of relationship to the related artifact. (Strength=Required) RelatedArtifactType ! » Provides additional classifiers of the related artifact classifier : CodeableConcept [0..*] « Additional classifiers for the related artifact. (Strength=Example) CitationArtifactClassifier ?? » A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index label : string [0..1] A brief description of the document or knowledge resource being referenced, suitable for display to a consumer display : string [0..1] A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format citation : markdown [0..1] A url for the artifact that can be followed to access the actual content url : url [0..1] The document being referenced, represented as an attachment. This is exclusive with the resource element document : Attachment [0..1] The related resource, artifact, such as a library, value set, profile, or other knowledge resource resource : canonical [0..1] « Any » Element Unique id for The related artifact, if the element within artifact is not a canonical resource, or a resource (for internal references). This may be any string value that does not contain spaces reference to a canonical resource id resourceReference : string Reference [0..1] « Any » May be used to represent additional information that is not part of the basic definition The publication status of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied artifact being referred to the definition and use publicationStatus : code [0..1] « Publication status of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part artifact being referred to. (Strength=Required) PublicationStatus ! » The date of the definition publication of the extension artifact being referred to extension publicationDate : Extension date [0..*] [0..1] DataType

Turtle Template

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

[
 # from Element: Element.extension
  fhir:

  fhir:RelatedArtifact.type [ code ]; # 1..1 documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
  fhir:RelatedArtifact.classifier [ CodeableConcept ], ... ; # 0..* Additional classifiers

  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:

  fhir:RelatedArtifact.document [ Attachment ]; # 0..1 What document is being referenced
  fhir:

  fhir:RelatedArtifact.resource [ canonical(Any) ]; # 0..1 What artifact is being referenced
  fhir:RelatedArtifact.resourceReference [ Reference(Any) ]; # 0..1 What artifact, if not a conformance resource
  fhir:RelatedArtifact.publicationStatus [ code ]; # 0..1 draft | active | retired | unknown
  fhir:RelatedArtifact.publicationDate [ date ]; # 0..1 Date of publication of the artifact being referred to

]

Changes since Release 3

RelatedArtifact
RelatedArtifact.classifier
  • No Changes Added Element
RelatedArtifact.resourceReference
  • Added Element
RelatedArtifact.publicationStatus
  • Added Element
RelatedArtifact.publicationDate
  • Added Element
RelatedArtifact.url
  • deleted

See the Full Difference for further information

Constraints

Terminology Bindings

Path Definition Type Reference
RelatedArtifact.type

The type of relationship to the related artifact.

Required RelatedArtifactType
RelatedArtifact.classifier

Citation artifact classifier

Example CitationArtifactClassifier
RelatedArtifact.publicationStatus

The lifecycle status of an artifact.

Required PublicationStatus

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 , ArtifactAssessment , ChargeItemDefinition , Citation , CodeSystem , Composition , ConceptMap , DeviceDefinition , EventDefinition , Evidence , EvidenceReport , EvidenceVariable , Library , Measure , Parameters MetadataResource , NamingSystem , PlanDefinition , RequestGroup , ResearchDefinition , ResearchElementDefinition RequestOrchestration , ResearchStudy , StructureMap and Task ValueSet

The RelatedArtifact type is used in a variety of contexts, and supports flexible description of relationships between artifacts. For example, the type can be used to describe both successor and predecessor relationships. This flexibility is needed to support use cases where only one side or other of the relationship is represented in FHIR. In practice, this datatype SHALL NOT be used to create bi-directional linking between FHIR resources.

 

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

Name Flags Card. Type Description & Constraints doco
. . 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
. . . code Σ 0..1 CodeableConcept Coded definition of 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)

doco Documentation for this format

Definition: XML | JSON

UML Diagram ( Legend )

TriggerDefinition The type of triggering event type : code [1..1] « The type of trigger. (Strength=Required) TriggerType ! » A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context name : string [0..1] A code that identifies the event code : CodeableConcept [0..1] A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied subscriptionTopic : canonical [0..1] « SubscriptionTopic » The timing of the event (if this is a periodic trigger) timing[x] : Element DataType [0..1] « Timing | Reference ( Schedule )| date | dateTime » The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true data : DataRequirement [0..*] A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires condition : Expression [0..1] Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string DataType [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*]

XML Template

< xmlns="http://hl7.org/fhir">

<TriggerDefinition 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 -->
 <code><!-- 0..1 CodeableConcept Coded definition of the event --></code>
 <subscriptionTopic><!-- 0..1 canonical(SubscriptionTopic) What event --></subscriptionTopic>

 <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]>

</TriggerDefinition>

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
  fhir:TriggerDefinition.code [ CodeableConcept ]; # 0..1 Coded definition of the event
  fhir:TriggerDefinition.subscriptionTopic [ canonical(SubscriptionTopic) ]; # 0..1 What 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
TriggerDefinition.code
  • No Changes Added Element
TriggerDefinition.subscriptionTopic
  • Added Element

See the Full Difference for further information

Structure

Name Flags Card. Type Description & Constraints doco
. . 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
. . . code Σ 0..1 CodeableConcept Coded definition of 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)

doco Documentation for this format

UML Diagram ( Legend )

TriggerDefinition The type of triggering event type : code [1..1] « The type of trigger. (Strength=Required) TriggerType ! » A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context name : string [0..1] A code that identifies the event code : CodeableConcept [0..1] A reference to a SubscriptionTopic resource that defines the event. If this element is provided, no other information about the trigger definition may be supplied subscriptionTopic : canonical [0..1] « SubscriptionTopic » The timing of the event (if this is a periodic trigger) timing[x] : Element DataType [0..1] « Timing | Reference ( Schedule )| date | dateTime » The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true data : DataRequirement [0..*] A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires condition : Expression [0..1] Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string DataType [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*]

XML Template

< xmlns="http://hl7.org/fhir">

<TriggerDefinition 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 -->
 <code><!-- 0..1 CodeableConcept Coded definition of the event --></code>
 <subscriptionTopic><!-- 0..1 canonical(SubscriptionTopic) What event --></subscriptionTopic>

 <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]>

</TriggerDefinition>

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
  fhir:TriggerDefinition.code [ CodeableConcept ]; # 0..1 Coded definition of the event
  fhir:TriggerDefinition.subscriptionTopic [ canonical(SubscriptionTopic) ]; # 0..1 What 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
TriggerDefinition.code
  • No Changes Added Element
TriggerDefinition.subscriptionTopic
  • Added Element

See the Full Difference for further information

Constraints

id Level Location Description Expression
trd-1 img  trd-1 Rule (base) Either timing, or a data requirement, but not both data.empty() or timing.empty()
trd-2 img  trd-2 Rule (base) A condition only if there is a data requirement condition.exists() implies data.exists()
trd-3 img  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 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

Name Flags Card. Type Description & Constraints doco
. . 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 0..1 code text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc.
ExpressionLanguage Expression Language ( Extensible but limited to http://hl7.org/fhir/ValueSet/mimetypes icon )
. . . reference Σ 0..1 uri Where the expression is found

doco Documentation for this format

Definition: XML | JSON

UML Diagram ( Legend )

Expression A brief, natural language description of the condition that effectively communicates the intended semantics description : string [0..1] A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined name : id [0..1] The media type of the language for the expression language : code [1..1] [0..1] « The media type of the expression language. (Strength=Extensible) ExpressionLanguage + » An expression in the specified language that returns a value expression : string [0..1] A URI that defines where the expression is found reference : uri [0..1] Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string DataType [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*]

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]"/><!-- 0..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:

  fhir:Expression.language [ code ]; # 0..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

Expression
Expression.language
  • Min Cardinality changed from 1 to 0
  • Change max value set from http://www.rfc-editor.org/bcp/bcp13.txt to http://hl7.org/fhir/ValueSet/mimetypes
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/expression-language" to "urn:ietf:bcp:13"
  • Change max value set from http://www.rfc-editor.org/bcp/bcp13.txt to http://hl7.org/fhir/ValueSet/mimetypes
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/expression-language" to "urn:ietf:bcp:13"

See the Full Difference for further information

Structure

Name Flags Card. Type Description & Constraints doco
. . 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 0..1 code text/cql | text/fhirpath | application/x-fhir-query | text/cql-identifier | text/cql-expression | etc.
ExpressionLanguage Expression Language ( Extensible but limited to http://hl7.org/fhir/ValueSet/mimetypes icon )
. . . reference Σ 0..1 uri Where the expression is found

doco Documentation for this format

UML Diagram ( Legend )

Expression A brief, natural language description of the condition that effectively communicates the intended semantics description : string [0..1] A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined name : id [0..1] The media type of the language for the expression language : code [1..1] [0..1] « The media type of the expression language. (Strength=Extensible) ExpressionLanguage + » An expression in the specified language that returns a value expression : string [0..1] A URI that defines where the expression is found reference : uri [0..1] Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string DataType [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*]

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]"/><!-- 0..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:

  fhir:Expression.language [ code ]; # 0..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

Expression
Expression.language
  • Min Cardinality changed from 1 to 0
  • Change max value set from http://www.rfc-editor.org/bcp/bcp13.txt to http://hl7.org/fhir/ValueSet/mimetypes
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/expression-language" to "urn:ietf:bcp:13"
  • Change max value set from http://www.rfc-editor.org/bcp/bcp13.txt to http://hl7.org/fhir/ValueSet/mimetypes
  • Change code system for extensibly bound codes from "http://hl7.org/fhir/expression-language" to "urn:ietf:bcp:13"

See the Full Difference for further information

Constraints

id Level Location Description Expression
exp-1 img  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 icon ExpressionLanguage

Expression is used in the following places: TriggerDefinition , ActivityDefinition , ChargeItemDefinition , Consent , EvidenceVariable , Measure , Parameters Permission , PlanDefinition , RequestGroup , ResearchElementDefinition , StructureMap and Task RequestOrchestration

 

See also Examples , Detailed Descriptions and Mappings .

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

UML Diagram ( Legend )

UsageContext A code that identifies the type of context being specified by this usage context code : Coding [1..1] « A code that specifies a type of context being specified by a usage context. (Strength=Extensible) UsageContextType + » A value that defines the context specified in this context of use. The interpretation of the value is defined by the code value[x] : Element DataType [1..1] « CodeableConcept | Quantity | Range | Reference ( PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization ); A code that defines the specific value for the context being specified. (Strength=Example) Context of Use ValueSet ?? » Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string DataType [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*]

XML Template

< xmlns="http://hl7.org/fhir">

<UsageContext 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]>

</UsageContext>

JSON Template

{doco
  // 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
  • No Changes

See the Full Difference for further information

UML Diagram ( Legend )

UsageContext A code that identifies the type of context being specified by this usage context code : Coding [1..1] « A code that specifies a type of context being specified by a usage context. (Strength=Extensible) UsageContextType + » A value that defines the context specified in this context of use. The interpretation of the value is defined by the code value[x] : Element DataType [1..1] « CodeableConcept | Quantity | Range | Reference ( PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization ); A code that defines the specific value for the context being specified. (Strength=Example) Context of Use ValueSet ?? » Element Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces id : string DataType [0..1] May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension extension : Extension [0..*]

XML Template

< xmlns="http://hl7.org/fhir">

<UsageContext 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]>

</UsageContext>

JSON Template

{doco
  // 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
  • No Changes

See the Full Difference for further information

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

This value for set defines a base set of codes that can be used to indicate that the context being specified. content in a resource was developed with a focus and intent of supporting use within particular contexts.

Example Context of Use ValueSet

UsageContext is used in the following places: ActivityDefinition , ActorDefinition , CanonicalResource , CapabilityStatement , ChargeItemDefinition , Citation , CodeSystem , CompartmentDefinition , Composition , ConceptMap , ConditionDefinition , DeviceDefinition , EventDefinition , Evidence , EvidenceReport , EvidenceVariable , ExampleScenario , GraphDefinition , ImplementationGuide , Library , Measure , MessageDefinition , NamingSystem , ObservationDefinition , OperationDefinition , Parameters , PlanDefinition , Questionnaire , ResearchDefinition , ResearchElementDefinition Requirements , SearchParameter , SpecimenDefinition , StructureDefinition , StructureMap , SubscriptionTopic , Task , TerminologyCapabilities , TestScript and ValueSet

See also Examples , Detailed Descriptions and Mappings .

The ExtendedContactDetail structure defines extended contact details for a named, or unnamed individual/purpose.

These are extensively used in provider directory resources where contact information is often very rich in nature, and requires additional metadata around their usage.
This datatype permits the context of UsageContext the contact informations use to be provided, and groups them together with other important metadata.

Not all properties are expected to be present in different contexts all instances, and only the ones that apply.
e.g. A website contact will only have the telecom included, but might also include a purpose and possibly a period if required. Whereas an accounts contact detail could include their name, postal address and telephone number (and possibly Organization if it was an outsourced capability)

The period provides the general start and end of the contact's applicability for usage. This is not intended to store a history of usages over time, but a convenient way to record upcoming relevant changes to the content when it is being published.
This permits the a contact to be marked as becoming available from X, or is expected to no longer be available from Y. An extension may be used to mark a contact's general availability times (9am - 5pm) and also exceptions where the contact is not available (e.g. Public holidays)

Structure

Name Flags Card. Type Description & Constraints doco
.. ExtendedContactDetail Σ TU Element Contact information

Elements defined in Ancestors: id , extension
... purpose Σ 0..1 CodeableConcept The type of contact
Contact entity type icon ( Preferred )
... name Σ 0..* HumanName Name of an individual to contact

... telecom Σ 0..* ContactPoint Contact details (e.g.phone/fax/url)

... organization Σ 0..1 Reference ( Organization ) This contact detail is handled/monitored by a specific organization
... period Σ 0..1 Period Period that this contact was valid for usage

doco Documentation for this format

Definition: XML | JSON

XML Template


<ExtendedContactDetail xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <purpose><!-- 0..1 CodeableConcept The type of contact icon --></purpose>
 <name><!-- 0..* HumanName Name of an individual to contact --></name>
 <telecom><!-- 0..* ContactPoint Contact details (e.g.phone/fax/url) --></telecom>
 <address><!-- 0..1 Address Address for the contact --></address>
 <organization><!-- 0..1 Reference(Organization) This contact detail is handled/monitored by a specific organization --></organization>
 <period><!-- 0..1 Period Period that this contact was valid for usage --></period>
</ExtendedContactDetail>

Turtle Template


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

[
 # from Element: Element.extension
  fhir:ExtendedContactDetail.purpose [ CodeableConcept ]; # 0..1 The type of contact
  fhir:ExtendedContactDetail.name [ HumanName ], ... ; # 0..* Name of an individual to contact
  fhir:ExtendedContactDetail.telecom [ ContactPoint ], ... ; # 0..* Contact details (e.g.phone/fax/url)
  fhir:ExtendedContactDetail.address [ Address ]; # 0..1 Address for the contact
  fhir:ExtendedContactDetail.organization [ Reference(Organization) ]; # 0..1 This contact detail is handled/monitored by a specific organization
  fhir:ExtendedContactDetail.period [ Period ]; # 0..1 Period that this contact was valid for usage
]

Changes since Release 3

This complex-type did not exist in Release 3

Structure

Name Flags Card. Type Description & Constraints doco
.. ExtendedContactDetail Σ TU Element Contact information

Elements defined in Ancestors: id , extension
... purpose Σ 0..1 CodeableConcept The type of contact
Contact entity type icon ( Preferred )
... name Σ 0..* HumanName Name of an individual to contact

... telecom Σ 0..* ContactPoint Contact details (e.g.phone/fax/url)

... organization Σ 0..1 Reference ( Organization ) This contact detail is handled/monitored by a specific organization
... period Σ 0..1 Period Period that this contact was valid for usage

doco Documentation for this format

XML Template


<ExtendedContactDetail xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <purpose><!-- 0..1 CodeableConcept The type of contact icon --></purpose>
 <name><!-- 0..* HumanName Name of an individual to contact --></name>
 <telecom><!-- 0..* ContactPoint Contact details (e.g.phone/fax/url) --></telecom>
 <address><!-- 0..1 Address Address for the contact --></address>
 <organization><!-- 0..1 Reference(Organization) This contact detail is handled/monitored by a specific organization --></organization>
 <period><!-- 0..1 Period Period that this contact was valid for usage --></period>
</ExtendedContactDetail>

Turtle Template


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

[
 # from Element: Element.extension
  fhir:ExtendedContactDetail.purpose [ CodeableConcept ]; # 0..1 The type of contact
  fhir:ExtendedContactDetail.name [ HumanName ], ... ; # 0..* Name of an individual to contact
  fhir:ExtendedContactDetail.telecom [ ContactPoint ], ... ; # 0..* Contact details (e.g.phone/fax/url)
  fhir:ExtendedContactDetail.address [ Address ]; # 0..1 Address for the contact
  fhir:ExtendedContactDetail.organization [ Reference(Organization) ]; # 0..1 This contact detail is handled/monitored by a specific organization
  fhir:ExtendedContactDetail.period [ Period ]; # 0..1 Period that this contact was valid for usage
]

Changes since Release 3

This complex-type did not exist in Release 3

Constraints

Terminology Bindings

Path Definition Type Reference
ExtendedContactDetail.purpose

This example value set defines a set of codes that can be used to indicate the purpose for which you would contact a contact party.

Preferred ContactEntityType icon

ExtendedContactDetail is used in the following places: VirtualServiceDetail , HealthcareService , InsurancePlan , Location , Organization , OrganizationAffiliation and PractitionerRole

See also Examples , Detailed Descriptions and Mappings .

  The VirtualServiceDetail structure defines details of a virtual communication capability, such as a web conference call.

Structure

Name Flags Card. Type Description & Constraints doco
.. VirtualServiceDetail Σ TU Element Virtual Service Contact Details

Elements defined in Ancestors: id , extension
... channelType Σ 0..1 Coding Channel Type
VirtualServiceType ( Example )
... address[x] Σ 0..1 Contact address/number
.... addressUrl url
.... addressString string
.... addressContactPoint ContactPoint
.... addressExtendedContactDetail ExtendedContactDetail
... additionalInfo Σ 0..* url Address to see alternative connection details

... sessionKey Σ 0..1 string Session Key required by the virtual service

doco Documentation for this format

Definition: XML | JSON

XML Template


<VirtualServiceDetail xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <channelType><!-- 0..1 Coding Channel Type --></channelType>
 <address[x]><!-- 0..1 url|string|ContactPoint|ExtendedContactDetail Contact address/number --></address[x]>
 <additionalInfo value="[url]"/><!-- 0..* Address to see alternative connection details -->
 <maxParticipants value="[positiveInt]"/><!-- 0..1 Maximum number of participants supported by the virtual service -->
 <sessionKey value="[string]"/><!-- 0..1 Session Key required by the virtual service -->
</VirtualServiceDetail>

Turtle Template


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

[
 # from Element: Element.extension
  fhir:VirtualServiceDetail.channelType [ Coding ]; # 0..1 Channel Type
  # VirtualServiceDetail.address[x] : 0..1 Contact address/number. One of these 4
    fhir:VirtualServiceDetail.addressUrl [ url ]
    fhir:VirtualServiceDetail.addressString [ string ]
    fhir:VirtualServiceDetail.addressContactPoint [ ContactPoint ]
    fhir:VirtualServiceDetail.addressExtendedContactDetail [ ExtendedContactDetail ]
  fhir:VirtualServiceDetail.additionalInfo [ url ], ... ; # 0..* Address to see alternative connection details
  fhir:VirtualServiceDetail.maxParticipants [ positiveInt ]; # 0..1 Maximum number of participants supported by the virtual service
  fhir:VirtualServiceDetail.sessionKey [ string ]; # 0..1 Session Key required by the virtual service
]

Changes since Release 3

This complex-type did not exist in Release 3

Structure

Name Flags Card. Type Description & Constraints doco
.. VirtualServiceDetail Σ TU Element Virtual Service Contact Details

Elements defined in Ancestors: id , extension
... channelType Σ 0..1 Coding Channel Type
VirtualServiceType ( Example )
... address[x] Σ 0..1 Contact address/number
.... addressUrl url
.... addressString string
.... addressContactPoint ContactPoint
.... addressExtendedContactDetail ExtendedContactDetail
... additionalInfo Σ 0..* url Address to see alternative connection details

... sessionKey Σ 0..1 string Session Key required by the virtual service

doco Documentation for this format

XML Template


<VirtualServiceDetail xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <channelType><!-- 0..1 Coding Channel Type --></channelType>
 <address[x]><!-- 0..1 url|string|ContactPoint|ExtendedContactDetail Contact address/number --></address[x]>
 <additionalInfo value="[url]"/><!-- 0..* Address to see alternative connection details -->
 <maxParticipants value="[positiveInt]"/><!-- 0..1 Maximum number of participants supported by the virtual service -->
 <sessionKey value="[string]"/><!-- 0..1 Session Key required by the virtual service -->
</VirtualServiceDetail>

Turtle Template


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

[
 # from Element: Element.extension
  fhir:VirtualServiceDetail.channelType [ Coding ]; # 0..1 Channel Type
  # VirtualServiceDetail.address[x] : 0..1 Contact address/number. One of these 4
    fhir:VirtualServiceDetail.addressUrl [ url ]
    fhir:VirtualServiceDetail.addressString [ string ]
    fhir:VirtualServiceDetail.addressContactPoint [ ContactPoint ]
    fhir:VirtualServiceDetail.addressExtendedContactDetail [ ExtendedContactDetail ]
  fhir:VirtualServiceDetail.additionalInfo [ url ], ... ; # 0..* Address to see alternative connection details
  fhir:VirtualServiceDetail.maxParticipants [ positiveInt ]; # 0..1 Maximum number of participants supported by the virtual service
  fhir:VirtualServiceDetail.sessionKey [ string ]; # 0..1 Session Key required by the virtual service
]

Changes since Release 3

This complex-type did not exist in Release 3

Constraints

Terminology Bindings

Path Definition Type Reference
VirtualServiceDetail.channelType

Example codes for possible virtual service connection types.

Example VirtualServiceType

VirtualServiceDetail is used in the following places: Appointment , Encounter and Location

See also Examples , Detailed Descriptions and Mappings .

The Availability structure defines a pattern of availability data typically used in directory resources.

Structure

Name Flags Card. Type Description & Constraints doco
.. Availability Σ TU Element Availability data for an {item}

Elements defined in Ancestors: id , extension
... availableTime Σ C 0..* Element Times the {item} is available
+ Rule: Cannot include start/end times when selecting all day availability.

.... daysOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
DaysOfWeek ( Required )

.... allDay Σ 0..1 boolean Always available? i.e. 24 hour service
.... availableStartTime Σ 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime Σ 0..1 time Closing time of day (ignored if allDay = true)
... notAvailableTime Σ 0..* Element Not available during this time due to provided reason

.... description Σ 0..1 string Reason presented to the user explaining why time not available
.... during Σ 0..1 Period Service not available during this period

doco Documentation for this format

Definition: XML | JSON

XML Template


<Availability xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <availableTime>  <!-- 0..* Times the {item} is available -->
  <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun -->
  <allDay value="[boolean]"/><!-- 0..1 Always available? i.e. 24 hour service -->
  <availableStartTime value="[time]"/><!-- 0..1 Opening time of day (ignored if allDay = true) -->
  <availableEndTime value="[time]"/><!-- 0..1 Closing time of day (ignored if allDay = true) -->
 </availableTime>
 <notAvailableTime>  <!-- 0..* Not available during this time due to provided reason -->
  <description value="[string]"/><!-- 0..1 Reason presented to the user explaining why time not available -->
  <during><!-- 0..1 Period Service not available during this period --></during>
 </notAvailableTime>
</Availability>

Turtle Template


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

[
 # from Element: Element.extension
  fhir:Availability.availableTime [ # 0..* Times the {item} is available
    fhir:Availability.availableTime.daysOfWeek [ code ], ... ; # 0..* mon | tue | wed | thu | fri | sat | sun
    fhir:Availability.availableTime.allDay [ boolean ]; # 0..1 Always available? i.e. 24 hour service
    fhir:Availability.availableTime.availableStartTime [ time ]; # 0..1 Opening time of day (ignored if allDay = true)
    fhir:Availability.availableTime.availableEndTime [ time ]; # 0..1 Closing time of day (ignored if allDay = true)
  ], ...;
  fhir:Availability.notAvailableTime [ # 0..* Not available during this time due to provided reason
    fhir:Availability.notAvailableTime.description [ string ]; # 0..1 Reason presented to the user explaining why time not available
    fhir:Availability.notAvailableTime.during [ Period ]; # 0..1 Service not available during this period
  ], ...;
]

Changes since Release 3

This complex-type did not exist in Release 3

Structure

Name Flags Card. Type Description & Constraints doco
.. Availability Σ TU Element Availability data for an {item}

Elements defined in Ancestors: id , extension
... availableTime Σ C 0..* Element Times the {item} is available
+ Rule: Cannot include start/end times when selecting all day availability.

.... daysOfWeek Σ 0..* code mon | tue | wed | thu | fri | sat | sun
DaysOfWeek ( Required )

.... allDay Σ 0..1 boolean Always available? i.e. 24 hour service
.... availableStartTime Σ 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime Σ 0..1 time Closing time of day (ignored if allDay = true)
... notAvailableTime Σ 0..* Element Not available during this time due to provided reason

.... description Σ 0..1 string Reason presented to the user explaining why time not available
.... during Σ 0..1 Period Service not available during this period

doco Documentation for this format

XML Template


<Availability xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <availableTime>  <!-- 0..* Times the {item} is available -->
  <daysOfWeek value="[code]"/><!-- 0..* mon | tue | wed | thu | fri | sat | sun -->
  <allDay value="[boolean]"/><!-- 0..1 Always available? i.e. 24 hour service -->
  <availableStartTime value="[time]"/><!-- 0..1 Opening time of day (ignored if allDay = true) -->
  <availableEndTime value="[time]"/><!-- 0..1 Closing time of day (ignored if allDay = true) -->
 </availableTime>
 <notAvailableTime>  <!-- 0..* Not available during this time due to provided reason -->
  <description value="[string]"/><!-- 0..1 Reason presented to the user explaining why time not available -->
  <during><!-- 0..1 Period Service not available during this period --></during>
 </notAvailableTime>
</Availability>

Turtle Template


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

[
 # from Element: Element.extension
  fhir:Availability.availableTime [ # 0..* Times the {item} is available
    fhir:Availability.availableTime.daysOfWeek [ code ], ... ; # 0..* mon | tue | wed | thu | fri | sat | sun
    fhir:Availability.availableTime.allDay [ boolean ]; # 0..1 Always available? i.e. 24 hour service
    fhir:Availability.availableTime.availableStartTime [ time ]; # 0..1 Opening time of day (ignored if allDay = true)
    fhir:Availability.availableTime.availableEndTime [ time ]; # 0..1 Closing time of day (ignored if allDay = true)
  ], ...;
  fhir:Availability.notAvailableTime [ # 0..* Not available during this time due to provided reason
    fhir:Availability.notAvailableTime.description [ string ]; # 0..1 Reason presented to the user explaining why time not available
    fhir:Availability.notAvailableTime.during [ Period ]; # 0..1 Service not available during this period
  ], ...;
]

Changes since Release 3

This complex-type did not exist in Release 3

Constraints

id Level Location Description Expression
img  av-1 Rule Availability.availableTime Cannot include start/end times when selecting all day availability. allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not())

Terminology Bindings

Path Definition Type Reference
Availability.availableTime.daysOfWeek

The days of the week.

Required DaysOfWeek

Availability is used in the following places: HealthcareService , Location and PractitionerRole

See also Examples , Detailed Descriptions and Mappings .

The MonetaryComponent structure defines a the set of properties across the financial resources.

Structure

Name Flags Card. Type Description & Constraints doco
.. MonetaryComponent Σ TU Element Availability data for an {item}

Elements defined in Ancestors: id , extension
... type Σ 1..1 code base | surcharge | deduction | discount | tax | informational
PriceComponentType ( Required )
... code Σ 0..1 CodeableConcept Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
... factor Σ 0..1 decimal Factor used for calculating this component

doco Documentation for this format

Definition: XML | JSON

XML Template

Turtle Template


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

[
 # from Element: Element.extension
  fhir:MonetaryComponent.type [ code ]; # 1..1 base | surcharge | deduction | discount | tax | informational
  fhir:MonetaryComponent.code [ CodeableConcept ]; # 0..1 Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
  fhir:MonetaryComponent.factor [ decimal ]; # 0..1 Factor used for calculating this component
  fhir:MonetaryComponent.amount [ Money ]; # 0..1 Explicit value amount to be used
]

Changes since Release 3

This complex-type did not exist in Release 3

Structure

Name Flags Card. Type Description & Constraints doco
.. MonetaryComponent Σ TU Element Availability data for an {item}

Elements defined in Ancestors: id , extension
... type Σ 1..1 code base | surcharge | deduction | discount | tax | informational
PriceComponentType ( Required )
... code Σ 0..1 CodeableConcept Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
... factor Σ 0..1 decimal Factor used for calculating this component

doco Documentation for this format

XML Template

Turtle Template


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

[
 # from Element: Element.extension
  fhir:MonetaryComponent.type [ code ]; # 1..1 base | surcharge | deduction | discount | tax | informational
  fhir:MonetaryComponent.code [ CodeableConcept ]; # 0..1 Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
  fhir:MonetaryComponent.factor [ decimal ]; # 0..1 Factor used for calculating this component
  fhir:MonetaryComponent.amount [ Money ]; # 0..1 Explicit value amount to be used
]

Changes since Release 3

This complex-type did not exist in Release 3

Constraints

Terminology Bindings

Path Definition Type Reference
MonetaryComponent.type

Codes indicating the kind of the price component.

Required PriceComponentType
MonetaryComponent.code Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. Unknown No details provided yet

MonetaryComponent is used in the following places: ChargeItem , ChargeItemDefinition and Invoice