Release 5 4

This page is part of the FHIR Specification (v5.0.0: R5 (v4.0.1: R4 - Mixed Normative and STU ). This is the ) in it's permanent home (it will always be available at this URL). The current published version. 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

Modeling and Methodology FHIR Infrastructure Work Group Maturity Level : 4 Standards Status : Partially Normative
This page has been approved as part of an ANSI standard. See the Infrastructure Package for further details.

Table of Contents

ExtendedContactDetail VirtualServiceDetail Availability MonetaryComponent
ContactDetail Contributor DataRequirement ParameterDefinition
RelatedArtifact TriggerDefinition Expression UsageContext
FHIR Infrastructure Work Group Maturity Level : 5 Standards Status : Normative

See also Base Definition , Examples , Mappings , Profiles , Extensions and R4 Conversions Mappings .

This DataType has been approved as part of an ANSI standard. See the Infrastructure Package for further details.
ContactDetail
Standards Status This element has a standards status of "Normative"
Element Id ContactDetail
Definition

Specifies contact information for a person or organization.

Short Display Contact information Cardinality 0..*
Type DataType Element
Requirements

Need to track contact information in the same way across multiple resources.

Summary true
ContactDetail.name
Element Id ContactDetail.name
Definition

The name of an individual to contact.

Short Display Name of an individual to contact Cardinality 0..1
Type string
Summary true
Comments

If there is no named individual, the telecom information is for the organization as a whole.

ContactDetail.telecom
Element Id ContactDetail.telecom
Definition

The contact details for the individual (if a name was provided) or the organization.

Short Display Contact details for individual or organization Cardinality 0..*
Type ContactPoint
Summary true

See also Base Definition , Examples and Mappings .

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.

FHIR Infrastructure
Contributor
Standards Status This element has a standards status of "Trial Use"
Element Id Contributor
Definition

A contributor to the content of a knowledge asset, including authors, editors, reviewers, and endorsers.

Cardinality Work Group 0..*
Type Maturity Level : 5 Standards Status : Trial Use Element
Requirements

Need to track contributor information in the same way across multiple resources.

Summary true
Contributor.type
Element Id Contributor.type
Definition

The type of contributor.

Cardinality 1..1
Terminology Binding ContributorType ( Required )
Type code
Summary true
Contributor.name
Element Id Contributor.name
Definition

The name of the individual or organization responsible for the contribution.

Cardinality 1..1
Type string
Summary true
Contributor.contact
Element Id Contributor.contact
Definition

Contact details to assist a user in finding and communicating with the contributor.

Cardinality 0..*
Type ContactDetail
Summary true

See also Base Definition , Examples , Mappings , Profiles , Extensions and R4 Conversions Mappings .

Invariants Affect this element drq-1 Rule Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists() Invariants Affect this element drq-1 Rule Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists() Invariants Affect this element drq-2 Rule Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists() Invariants Affect this element drq-2 Rule Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists()
DataRequirement
Standards Status This element has a standards status of "Trial Use"
Element Id DataRequirement
Definition

Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.

Short Display Describes a required data item Cardinality 0..*
Type DataType Element
Summary true
DataRequirement.type
Element Id DataRequirement.type
Definition

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.

Short Display The type of the required data Cardinality 1..1
Terminology Binding All FHIR Types ( Required Any defined Resource or Data Type name (including "Any" and "Type") )
Type code
Summary true
DataRequirement.profile
Element Id DataRequirement.profile
Definition

The profile of the required data, specified as the uri of the profile definition.

Short Display The profile of the required data Cardinality 0..*
Type canonical ( StructureDefinition )
Summary true
DataRequirement.subject[x]
Element Id DataRequirement.subject[x]
Definition

The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.

Short Display E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Cardinality 0..1
Terminology Binding Participant Resource Types Subject type ( Extensible )
Type CodeableConcept | Reference ( Group )
[x] Note See Choice of Datatypes Data Types for further information about how to use [x]
Meaning if Missing Patient
Summary true
Comments

The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.

DataRequirement.mustSupport
Element Id DataRequirement.mustSupport
Definition

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 resolvable resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

Short Display Indicates specific structure elements that are referenced by the knowledge module Cardinality 0..*
Type string
Summary true
DataRequirement.codeFilter
Element Id DataRequirement.codeFilter
Definition

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.

Short Display What codes are expected Cardinality 0..*
Summary true
Invariants
Defined on this element
drq-1 Rule Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists()
DataRequirement.codeFilter.path
Element Id DataRequirement.codeFilter.path
Definition

The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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 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.

Short Display A code-valued attribute to filter on Cardinality 0..1
Type string
Summary true
Comments

The path attribute contains a Simple FHIRPath Subset that allows path traversal, but not calculation.

DataRequirement.codeFilter.searchParam
Element Id DataRequirement.codeFilter.searchParam
Definition

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.

Short Display A coded (token) parameter to search on Cardinality 0..1
Type string
Summary true
DataRequirement.codeFilter.valueSet
Element Id DataRequirement.codeFilter.valueSet
Definition

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.

Short Display ValueSet for the filter Cardinality 0..1
Type canonical ( ValueSet )
Summary true
DataRequirement.codeFilter.code
Element Id DataRequirement.codeFilter.code
Definition

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.

Short Display What code is expected Cardinality 0..*
Type Coding
Summary true
DataRequirement.dateFilter
Element Id DataRequirement.dateFilter
Definition

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.

Short Display What dates/date ranges are expected Cardinality 0..*
Summary true
Invariants
Defined on this element
drq-2 Rule Either a path or a searchParam must be provided, but not both path.exists() xor searchParam.exists()
DataRequirement.dateFilter.path
Element Id DataRequirement.dateFilter.path
Definition

The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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 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.

Short Display A date-valued attribute to filter on Cardinality 0..1
Type string
Summary true
Comments

The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation.

DataRequirement.dateFilter.searchParam
Element Id DataRequirement.dateFilter.searchParam
Definition

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.

Short Display A date valued parameter to search on Cardinality 0..1
Type string
Summary true
DataRequirement.dateFilter.value[x]
Element Id DataRequirement.dateFilter.value[x]
Definition

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.

Short Display The value of the filter, as a Period, DateTime, or Duration value Cardinality 0..1
Type dateTime | Period | Duration
[x] Note See Choice of Datatypes for further information about how to use [x] Summary true DataRequirement.valueFilter Element Id DataRequirement.valueFilter Definition 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). Short Display What values are expected Cardinality 0..* Summary true DataRequirement.valueFilter.path Element Id DataRequirement.valueFilter.path Definition The attribute of the filter. The specified path SHALL be a FHIRPath resolvable 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 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. Short Display An attribute to filter on Cardinality 0..1 Type string Summary true Comments The path attribute contains a Simple FHIR Subset that allows path traversal, but not calculation. DataRequirement.valueFilter.searchParam Element Id DataRequirement.valueFilter.searchParam Definition 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. Short Display A parameter to search on Cardinality 0..1 Type string Summary true DataRequirement.valueFilter.comparator Element Id DataRequirement.valueFilter.comparator Definition The comparator to be used to determine whether the value is matching. Short Display eq | gt | lt | ge | le | sa | eb Cardinality 0..1 Terminology Binding Value Filter Comparator ( Required ) Type code Summary true DataRequirement.valueFilter.value[x] Element Id DataRequirement.valueFilter.value[x] Definition The value of the filter. Short Display The value of the filter, as a Period, DateTime, or Duration value Cardinality 0..1 Type dateTime | Period | Duration [x] Note See Choice of Datatypes Data Types for further information about how to use [x]
Summary true
DataRequirement.limit
Element Id DataRequirement.limit
Definition

Specifies a maximum number of results that are required (uses the _count search parameter).

Short Display Number of results Cardinality 0..1
Type positiveInt
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Summary true
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".

DataRequirement.sort
Element Id DataRequirement.sort
Definition

Specifies the order of the results to be returned.

Short Display Order of the results Cardinality 0..*
Requirements

Enables the requirement "most recent 5 results" to be expressed.

Summary true
Comments

This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.

DataRequirement.sort.path
Element Id DataRequirement.sort.path
Definition

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.

Short Display The name of the attribute to perform the sort Cardinality 1..1
Type string
Summary true
DataRequirement.sort.direction
Element Id DataRequirement.sort.direction
Definition

The direction of the sort, ascending or descending.

Short Display ascending | descending Cardinality 1..1
Terminology Binding SortDirection ( Required )
Type code
Summary true
FHIR Infrastructure Work Group Maturity Level : 5 Standards Status : Trial Use

See also Base Definition , Examples , Mappings , Profiles , Extensions and R4 Conversions Mappings .

ParameterDefinition
Standards Status This element has a standards status of "Trial Use"
Element Id ParameterDefinition
Definition

The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.

Short Display Definition of a parameter to a module Cardinality 0..*
Type DataType Element
Summary true
ParameterDefinition.name
Element Id ParameterDefinition.name
Definition

The name of the parameter used to allow access to the value of the parameter in evaluation contexts.

Short Display Name used to access the parameter value Cardinality 0..1
Type code
Summary true
ParameterDefinition.use
Element Id ParameterDefinition.use
Definition

Whether the parameter is input or output for the module.

Short Display in | out Cardinality 1..1
Terminology Binding Operation Parameter Use OperationParameterUse ( Required )
Type code
Summary true
ParameterDefinition.min
Element Id ParameterDefinition.min
Definition

The minimum number of times this parameter SHALL appear in the request or response.

Short Display Minimum cardinality Cardinality 0..1
Type integer
Summary true
ParameterDefinition.max
Element Id ParameterDefinition.max
Definition

The maximum number of times this element is permitted to appear in the request or response.

Short Display Maximum cardinality (a number of *) Cardinality 0..1
Type string
Summary true
ParameterDefinition.documentation
Element Id ParameterDefinition.documentation
Definition

A brief discussion of what the parameter is for and how it is used by the module.

Short Display A brief description of the parameter Cardinality 0..1
Type string
Summary true
ParameterDefinition.type
Element Id ParameterDefinition.type
Definition

The type of the parameter.

Short Display What type of value Cardinality 1..1
Terminology Binding All FHIR Types ( Required Any defined Resource or Data Type name (including "Any" and "Type") )
Type code
Summary true
ParameterDefinition.profile
Element Id ParameterDefinition.profile
Definition

If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.

Short Display What profile the value is expected to be Cardinality 0..1
Type canonical ( StructureDefinition )
Summary true
FHIR Infrastructure Work Group Maturity Level : 5 Standards Status : Trial Use

See also Base Definition , Examples , Mappings , Profiles , Extensions and R4 Conversions Mappings .

Comments The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet. RelatedArtifact.classifier Element Id RelatedArtifact.classifier Definition Provides additional classifiers of the related artifact. Short Display Additional classifiers Cardinality 0..* Terminology Binding Citation Artifact Classifier ( Example ) Type CodeableConcept Summary true canonical ( Any ) Comments If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases. RelatedArtifact.publicationDate Element Id RelatedArtifact.publicationDate
RelatedArtifact
Standards Status This element has a standards status of "Trial Use"
Element Id RelatedArtifact
Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

Short Display Related artifacts for a knowledge resource Cardinality 0..*
Type DataType Element
Requirements

Knowledge resources must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Summary true
Comments

Each related artifact is either an attachment, or a reference to another knowledge resource, but not both.

RelatedArtifact.type
Element Id RelatedArtifact.type
Definition

The type of relationship to the related artifact.

Short Display 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 Cardinality 1..1
Terminology Binding RelatedArtifactType ( Required )
Type code
Summary true
RelatedArtifact.label
Element Id RelatedArtifact.label
Definition

A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

Short Display Short label Cardinality 0..1
Type string
Summary true
RelatedArtifact.display
Element Id RelatedArtifact.display
Definition

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

Short Display Brief description of the related artifact Cardinality 0..1
Type string
Summary true
RelatedArtifact.citation
Element Id RelatedArtifact.citation
Definition

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

Short Display Bibliographic citation for the artifact Cardinality 0..1
Type markdown
Summary true
Comments

Additional structured information about citations should be captured as extensions.

RelatedArtifact.document RelatedArtifact.url
Element Id RelatedArtifact.document RelatedArtifact.url
Definition

The document being referenced, represented as an attachment. This is exclusive with A url for the resource element. artifact that can be followed to access the actual content.

Short Display What document is being referenced Cardinality 0..1
Type Attachment Summary true RelatedArtifact.resource Element Id RelatedArtifact.resource Definition The related artifact, such as a library, value set, profile, or other knowledge resource. Short Display What artifact is being referenced Cardinality 0..1 Type url
Summary true
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type document or resource element is successor, present, this is a element SHALL NOT be provided (use the url or reference to in the prior knowledge resource. Attachment or resource reference).

RelatedArtifact.resourceReference RelatedArtifact.document
Element Id RelatedArtifact.resourceReference RelatedArtifact.document
Definition

The related artifact, if the artifact document being referenced, represented as an attachment. This is not a canonical resource, or a exclusive with the resource reference to a canonical resource. element.

Short Display What artifact, if not a conformance resource Cardinality 0..1
Type Reference ( Any Attachment )
Summary true
RelatedArtifact.publicationStatus RelatedArtifact.resource
Element Id RelatedArtifact.publicationStatus RelatedArtifact.resource
Definition

The publication status of the artifact being referred to. related resource, such as a library, value set, profile, or other knowledge resource.

Short Display draft | active | retired | unknown Cardinality 0..1
Terminology Binding Type PublicationStatus canonical ( Required Any )
Type code Summary true
Definition Comments

The date of publication of If the artifact being referred to. Short Display Date of publication of type is predecessor, this is a reference to the artifact being referred succeeding knowledge resource. If the type is successor, this is a reference to Cardinality 0..1 Type date Summary true the prior knowledge resource.

FHIR Infrastructure Work Group Maturity Level : 5 Standards Status : Trial Use

See also Base Definition , Examples , Mappings , Profiles , Extensions and R4 Conversions Mappings .

Invariants Affect this element trd-3 Rule 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()) Invariants Affect this element trd-3 Rule 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()) TriggerDefinition.code Element Id TriggerDefinition.code Definition A code that identifies the event. Short Display Coded definition of the event Cardinality 0..1 Type CodeableConcept Summary true TriggerDefinition.subscriptionTopic Element Id TriggerDefinition.subscriptionTopic Definition 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. Short Display What event Cardinality 0..1 Type canonical ( SubscriptionTopic ) Summary true Invariants Affect this element trd-3 Rule 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()) trd-1 Rule Either timing, or a data requirement, but not both data.empty() or timing.empty() Invariants Affect this element trd-3 Rule 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()) trd-2 Rule A condition only if there is a data requirement condition.exists() implies data.exists() trd-1 Rule Either timing, or a data requirement, but not both data.empty() or timing.empty() Invariants Affect this element trd-2 Rule A condition only if there is a data requirement condition.exists() implies data.exists()
TriggerDefinition
Standards Status This element has a standards status of "Trial Use"
Element Id TriggerDefinition
Definition

A description of a triggering event. Triggering events can be named events, data events, or periodic, as determined by the type element.

Short Display Defines an expected trigger for a module Cardinality 0..*
Type DataType Element
Summary true
Comments

If an event is a named-event, it means the event is completely pre-coordinated, and no other information can be specified for the event. If the event is one of the data- events, the data and condition elements specify the triggering criteria. The data element specifies the structured component, and the condition element provides additional optional refinement of that structured component. If the event is periodic, the timing element defines when the event is triggered. For both data- and periodic events, a name can be provided as a shorthand for the formal semantics provided by the other elements.

Invariants
Defined on this element
trd-1 Rule Either timing, or a data requirement, but not both data.empty() or timing.empty()
trd-2 Rule A condition only if there is a data requirement condition.exists() implies data.exists()
trd-3 Rule 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())
TriggerDefinition.type
Element Id TriggerDefinition.type
Definition

The type of triggering event.

Short Display named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended Cardinality 1..1
Terminology Binding TriggerType ( Required )
Type code
Summary true
TriggerDefinition.name
Element Id TriggerDefinition.name
Definition

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.

Short Display Name or URI that identifies the event Cardinality 0..1
Type string
Summary true
Comments

An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.

TriggerDefinition.timing[x]
Element Id TriggerDefinition.timing[x]
Definition

The timing of the event (if this is a periodic trigger).

Short Display Timing of the event Cardinality 0..1
Type Timing | Reference ( Schedule )| date | dateTime
[x] Note See Choice of Datatypes Data Types for further information about how to use [x]
Summary true
TriggerDefinition.data
Element Id TriggerDefinition.data
Definition

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.

Short Display Triggering data of the event (multiple = 'and') Cardinality 0..*
Type DataRequirement
Summary true
Comments

This element shall be present for any data type trigger.

TriggerDefinition.condition
Element Id TriggerDefinition.condition
Definition

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.

Short Display Whether the event triggers (boolean expression) Cardinality 0..1
Type Expression
Requirements

Need to be able to formally describe the triggering criteria.

Summary true
Comments

This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.

FHIR Infrastructure Work Group Maturity Level : 5 Standards Status : Trial Use

See also Base Definition , Examples , Mappings , Profiles , Extensions and R4 Conversions Mappings .

Invariants Affect this element exp-2 Rule The name must be a valid variable name in most computer languages name.hasValue() implies name.matches('[A-Za-z][A-Za-z0-9\\_]{0,63}') Comments If Expression.expression and Expression.reference are both present, the Expression.expression might just be a name pointing something within the referenced content. Invariants Affect this element exp-1 Rule An expression or a reference must be provided expression.exists() or reference.exists() Invariants Affect this element exp-1 Rule An expression or a reference must be provided expression.exists() or reference.exists()
Expression
Standards Status This element has a standards status of "Trial Use"
Element Id Expression
Definition

A expression that is evaluated in a specified context and returns a value. 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.

Short Display An expression that can be used to generate a value Cardinality 0..*
Type DataType Element
Summary true
Invariants exp-2 Rule The name must be a valid variable name in most computer languages name.hasValue() implies name.matches('[A-Za-z][A-Za-z0-9\\_]{0,63}')
Defined on this element
exp-1 Rule An expression or a reference must be provided expression.exists() or reference.exists()
Expression.description
Element Id Expression.description
Definition

A brief, natural language description of the condition that effectively communicates the intended semantics.

Short Display Natural language description of the condition Cardinality 0..1
Type string
Summary true
Expression.name
Element Id Expression.name
Definition

A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

Short Display Short name assigned to expression for reuse Cardinality 0..1
Type code id
Summary true
Expression.language
Element Id Expression.language
Definition

The media type of the language for the expression.

Short Display text/cql | text/fhirpath | application/x-fhir-query | etc. Cardinality 0..1 1..1
Terminology Binding Expression Language ExpressionLanguage ( Extensible ) Additional Bindings Purpose Mime Types Max Binding but limited to ??)
Type code
Requirements The cardinality of this element is optional to allow text only as part of the authoring process. However, in order to be executable, the expression element must be specified. Summary true
Expression.expression
Element Id Expression.expression
Definition

An expression in the specified language that returns a value.

Short Display Expression in specified language Cardinality 0..1
Type string
Summary true
Expression.reference
Element Id Expression.reference
Definition

A URI that defines where the expression is found.

Short Display Where the expression is found Cardinality 0..1
Type uri
Summary true
Comments

If both a reference and an expression is found, the reference SHALL point to the same expression.

FHIR Infrastructure Work Group Maturity Level : 5 Standards Status : Trial Use

See also Base Definition , Examples , Mappings , Profiles , Extensions and R4 Conversions Mappings .

VirtualServiceDetail.additionalInfo Element Id VirtualServiceDetail.additionalInfo Definition Address to see alternative connection details. Short Display Address to see alternative connection details Cardinality 0..* Type url Summary true Comments This web address can be used to provide additional details on the call, such as alternative/regional call in numbers, or other associated services. VirtualServiceDetail.maxParticipants Element Id VirtualServiceDetail.maxParticipants Definition Maximum number of participants supported by the virtual service. Short Display Maximum number of participants supported by the virtual service Cardinality 0..1 Type positiveInt Summary true Comments Some services have only a limitted number of participants permitted to connect at a time, this is typically used in "shared" virtual services that you might find on location resources. Typically on-demand services might not have these restrictions. VirtualServiceDetail.sessionKey Element Id VirtualServiceDetail.sessionKey Definition Session Key required by the virtual service. Short Display Session Key required by the virtual service Cardinality 0..1 Type string Summary true Comments Some services require a session key to be able to access the service once connected. This could be in cases where a shared number is used, and a session key is added to put into a private line, or to identify the participant in a call. 2.1.28.6.2.10 Availability FHIR Infrastructure Work Group Maturity Level : 5 Standards Status : Trial Use See also Base Definition , Examples , Mappings , Profiles , Extensions and R4 Conversions Availability Standards Status This element has a standards status of "Trial Use" Element Id Availability Definition Availability data for an {item}. Short Display Availability data for an {item} Cardinality 0..* Type DataType Summary true Availability.availableTime Element Id Availability.availableTime Definition Times the {item} is available. Short Display Times the {item} is available Cardinality 0..* Requirements A collection of times that the {item} is available. Summary true Invariants Defined on this element av-1 Rule Cannot include start/end times when selecting all day availability. allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not()) Availability.availableTime.daysOfWeek Element Id Availability.availableTime.daysOfWeek Definition mon | tue | wed | thu | fri | sat | sun. Short Display mon | tue | wed | thu | fri | sat | sun Cardinality 0..* Terminology Binding Days Of Week ( Required ) Type code Requirements Indicates which days of the week are available between the start and end Times. Summary true Availability.availableTime.allDay Element Id Availability.availableTime.allDay Definition Always available? i.e. 24 hour service. Short Display Always available? i.e. 24 hour service Cardinality 0..1 Type boolean Requirements Is this always available? (hence times are irrelevant) i.e. 24 hour service. Summary true Invariants Affect this element av-1 Rule Cannot include start/end times when selecting all day availability. allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not()) Availability.availableTime.availableStartTime Element Id Availability.availableTime.availableStartTime Definition Opening time of day (ignored if allDay = true). Short Display Opening time of day (ignored if allDay = true) Cardinality 0..1 Type time Requirements The opening time of day. Note: If the AllDay flag is set, then this time is ignored. Summary true Comments The timezone is expected to be specified or implied by the context this datatype is used. Invariants Affect this element av-1 Rule Cannot include start/end times when selecting all day availability. allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not()) Availability.availableTime.availableEndTime Element Id Availability.availableTime.availableEndTime Definition Closing time of day (ignored if allDay = true). Short Display Closing time of day (ignored if allDay = true) Cardinality 0..1 Type time Requirements The closing time of day. Note: If the AllDay flag is set, then this time is ignored. Summary true Comments The timezone is expected to be specified or implied by the context this datatype is used. Invariants Affect this element av-1 Rule Cannot include start/end times when selecting all day availability. allDay.exists().not() or (allDay implies availableStartTime.exists().not() and availableEndTime.exists().not()) Availability.notAvailableTime Element Id Availability.notAvailableTime Definition Not available during this time due to provided reason. Short Display Not available during this time due to provided reason Cardinality 0..* Requirements The {item} is not available during this period of time due to the provided reason. Summary true Availability.notAvailableTime.description Element Id Availability.notAvailableTime.description Definition Reason presented to the user explaining why time not available. Short Display Reason presented to the user explaining why time not available Cardinality 0..1 Type string Requirements The reason that can be presented to the user as to why this time is not available. Summary true Comments The reason will generally be provided to give the textual reason for displaying when the {item} is not available, e.g. 'Closed public holidays' or 'Independence Day'. In cases such as this, the during might not be included and local knowledge would be required in such cases (as don't desire to keep updating when the holiday occurs each year). e.g.2: 'Closed for maintenance over the summer' for this example you would want to include the during period, unless this was a university hospital and the "summer" period was well known, but would recommend its inclusion anyway. Availability.notAvailableTime.during Element Id Availability.notAvailableTime.during Definition Service not available during this period. Short Display Service not available during this period Cardinality 0..1 Type Period Requirements The {item} is not available (seasonally or for a public holiday) during this period. Summary true 2.1.28.6.2.11 MonetaryComponent FHIR Infrastructure Work Group Maturity Level : 5 Standards Status : Trial Use See also Base Definition , Examples , Mappings , Profiles , Extensions and R4 Conversions MonetaryComponent Standards Status This element has a standards status of "Trial Use" Element Id MonetaryComponent Definition Availability data for an {item}. Short Display Availability data for an {item} Cardinality 0..* Type DataType Summary true MonetaryComponent.type Element Id MonetaryComponent.type Definition base | surcharge | deduction | discount | tax | informational. Short Display base | surcharge | deduction | discount | tax | informational Cardinality 1..1 Terminology Binding Price Component Type ( Required ) Type code Summary true MonetaryComponent.code Element Id MonetaryComponent.code Definition Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. Short Display Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. Cardinality 0..1 Terminology Binding PriceComponentCode : Type CodeableConcept Summary true MonetaryComponent.factor Element Id MonetaryComponent.factor Definition Factor used for calculating this component. Short Display Factor used for calculating this component Cardinality 0..1 Type decimal Summary true MonetaryComponent.amount Element Id MonetaryComponent.amount Definition Explicit value amount to be used. Short Display Explicit value amount to be used Cardinality 0..1 Type Money Summary true
UsageContext
Standards Status This element has a standards status of "Trial Use"
Element Id UsageContext
Definition

Specifies clinical/business/etc. metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).

Short Display Describes the context of use for a conformance or knowledge resource Cardinality 0..*
Type DataType Element
Requirements

Consumers of the resource must be able to determine the intended applicability for the resource. Ideally, this information would be used programmatically to determine when and how it should be incorporated or exposed.

Summary true
UsageContext.code
Element Id UsageContext.code
Definition

A code that identifies the type of context being specified by this usage context.

Short Display Type of context being specified Cardinality 1..1
Terminology Binding UsageContextType ( Extensible )
Type Coding
Summary true
UsageContext.value[x]
Element Id UsageContext.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Short Display Value that defines the context Cardinality 1..1
Terminology Binding Context of Use ValueSet ConformanceUseContext ( Example )
Type CodeableConcept | Quantity | Range | Reference ( PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization )
[x] Note See Choice of Datatypes for further information about how to use [x] Summary true 2.1.28.6.2.8 ExtendedContactDetail FHIR Infrastructure Work Group Maturity Level : 5 Standards Status : Trial Use See also Base Definition , Examples , Mappings , Profiles , Extensions and R4 Conversions ExtendedContactDetail Standards Status This element has a standards status of "Trial Use" Element Id ExtendedContactDetail Definition Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization. Short Display Contact information Cardinality 0..* Type DataType Requirements Need to track contact and address information in the same way across multiple resources. Summary true Comments This datatype may be sparsely populated, i.e. only contain a purpose and phone number or address, but other cases could be completed filled out. ExtendedContactDetail.purpose Element Id ExtendedContactDetail.purpose Definition The purpose/type of contact. Short Display The type of contact Cardinality 0..1 Terminology Binding Contact entity type ( Preferred ) Type CodeableConcept Summary true Comments If no purpose is defined, then these contact details may be used for any purpose. ExtendedContactDetail.name Element Id ExtendedContactDetail.name Definition The name of an individual to contact, some types of contact detail are usually blank. Short Display Name of an individual to contact Cardinality 0..* Type HumanName Summary true Comments If there is no named individual, the telecom/address information is not generally monitored by a specific individual. ExtendedContactDetail.telecom Element Id ExtendedContactDetail.telecom Definition The contact details application for the purpose defined. Short Display Contact details (e.g.phone/fax/url) Cardinality 0..* Type ContactPoint Summary true ExtendedContactDetail.address Element Id ExtendedContactDetail.address Definition Address for the contact. Short Display Address for the contact Cardinality 0..1 Type Address Summary true Comments More than 1 address would be for different purposes, and thus should be entered as a different entry,. ExtendedContactDetail.organization Element Id ExtendedContactDetail.organization Definition This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization. Short Display This contact detail is handled/monitored by a specific organization Cardinality 0..1 Type Reference ( Organization ) Requirements Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm). Summary true ExtendedContactDetail.period Element Id ExtendedContactDetail.period Definition Period that this contact was valid for usage. Short Display Period that this contact was valid for usage Cardinality 0..1 Type Period Summary true Comments If the details have multiple periods, then enter in a new ExtendedContact with the new period. 2.1.28.6.2.9 VirtualServiceDetail FHIR Infrastructure Work Group Maturity Level : 5 Standards Status : Trial Use See also Base Definition , Examples , Mappings , Profiles , Extensions and R4 Conversions VirtualServiceDetail Standards Status This element has a standards status of "Trial Use" Element Id VirtualServiceDetail Definition Virtual Service Contact Details. Short Display Virtual Service Contact Details Cardinality 0..* Type DataType Summary true VirtualServiceDetail.channelType Element Id VirtualServiceDetail.channelType Definition The type of virtual service to connect to (i.e. Teams, Zoom, Specific VMR technology, WhatsApp). Short Display Channel Type Cardinality 0..1 Terminology Binding Virtual Service Type ( Example ) Type Coding Summary true Comments As this type defines what the virtual service is, it then defines what address and additional information might be relevant. Some profiles could be used for specific types to define what the other values could/should be. VirtualServiceDetail.address[x] Element Id VirtualServiceDetail.address[x] Definition What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type). Short Display Contact address/number Cardinality 0..1 Type url | string | ContactPoint | ExtendedContactDetail [x] Note See Choice of Datatypes Data Types for further information about how to use [x]
Summary true