Release 5 Preview #1

This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

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

Table of Contents

ContactDetail Contributor DataRequirement ParameterDefinition
RelatedArtifact TriggerDefinition Expression UsageContext

See also Base Definition, Examples and Mappings.

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

Specifies contact information for a person or organization.

Cardinality0..*
TypeDataType
Requirements

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

Summarytrue
ContactDetail.name
Element IdContactDetail.name
Definition

The name of an individual to contact.

Cardinality0..1
Typestring
Summarytrue
Comments

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

ContactDetail.telecom
Element IdContactDetail.telecom
Definition

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

Cardinality0..*
TypeContactPoint
Summarytrue

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.

Contributor
Standards StatusThis element has a standards status of "Trial Use"
Element IdContributor
Definition

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

Cardinality0..*
TypeDataType
Requirements

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

Summarytrue
Contributor.type
Element IdContributor.type
Definition

The type of contributor.

Cardinality1..1
Terminology BindingContributorType (Required)
Typecode
Summarytrue
Contributor.name
Element IdContributor.name
Definition

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

Cardinality1..1
Typestring
Summarytrue
Contributor.contact
Element IdContributor.contact
Definition

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

Cardinality0..*
TypeContactDetail
Summarytrue

See also Base Definition, Examples and Mappings.

DataRequirement
Standards StatusThis element has a standards status of "Trial Use"
Element IdDataRequirement
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.

Cardinality0..*
TypeDataType
Summarytrue
DataRequirement.type
Element IdDataRequirement.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.

Cardinality1..1
Terminology BindingAny defined Resource or Data Type name (including "Any" and "Type")
Typecode
Summarytrue
DataRequirement.profile
Element IdDataRequirement.profile
Definition

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

Cardinality0..*
Typecanonical(StructureDefinition)
Summarytrue
DataRequirement.subject[x]
Element IdDataRequirement.subject[x]
Definition

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

Cardinality0..1
Terminology BindingSubject type (Extensible)
TypeCodeableConcept|Reference(Group)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Meaning if MissingPatient
Summarytrue
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 IdDataRequirement.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 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).

Cardinality0..*
Typestring
Summarytrue
DataRequirement.codeFilter
Element IdDataRequirement.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.

Cardinality0..*
Summarytrue
Invariants
Defined on this element
drq-1Rule Either a path or a searchParam must be provided, but not bothpath.exists() xor searchParam.exists()
DataRequirement.codeFilter.path
Element IdDataRequirement.codeFilter.path
Definition

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

Cardinality0..1
Typestring
Summarytrue
Comments

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

DataRequirement.codeFilter.searchParam
Element IdDataRequirement.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.

Cardinality0..1
Typestring
Summarytrue
DataRequirement.codeFilter.valueSet
Element IdDataRequirement.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.

Cardinality0..1
Typecanonical(ValueSet)
Summarytrue
DataRequirement.codeFilter.code
Element IdDataRequirement.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.

Cardinality0..*
TypeCoding
Summarytrue
DataRequirement.dateFilter
Element IdDataRequirement.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.

Cardinality0..*
Summarytrue
Invariants
Defined on this element
drq-2Rule Either a path or a searchParam must be provided, but not bothpath.exists() xor searchParam.exists()
DataRequirement.dateFilter.path
Element IdDataRequirement.dateFilter.path
Definition

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

Cardinality0..1
Typestring
Summarytrue
Comments

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

DataRequirement.dateFilter.searchParam
Element IdDataRequirement.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.

Cardinality0..1
Typestring
Summarytrue
DataRequirement.dateFilter.value[x]
Element IdDataRequirement.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.

Cardinality0..1
TypedateTime|Period|Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
DataRequirement.limit
Element IdDataRequirement.limit
Definition

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

Cardinality0..1
TypepositiveInt
Requirements

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

Summarytrue
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 IdDataRequirement.sort
Definition

Specifies the order of the results to be returned.

Cardinality0..*
Requirements

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

Summarytrue
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 IdDataRequirement.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.

Cardinality1..1
Typestring
Summarytrue
DataRequirement.sort.direction
Element IdDataRequirement.sort.direction
Definition

The direction of the sort, ascending or descending.

Cardinality1..1
Terminology BindingSortDirection (Required)
Typecode
Summarytrue

See also Base Definition, Examples and Mappings.

ParameterDefinition
Standards StatusThis element has a standards status of "Trial Use"
Element IdParameterDefinition
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.

Cardinality0..*
TypeDataType
Summarytrue
ParameterDefinition.name
Element IdParameterDefinition.name
Definition

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

Cardinality0..1
Typecode
Summarytrue
ParameterDefinition.use
Element IdParameterDefinition.use
Definition

Whether the parameter is input or output for the module.

Cardinality1..1
Terminology BindingOperationParameterUse (Required)
Typecode
Summarytrue
ParameterDefinition.min
Element IdParameterDefinition.min
Definition

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

Cardinality0..1
Typeinteger
Summarytrue
ParameterDefinition.max
Element IdParameterDefinition.max
Definition

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

Cardinality0..1
Typestring
Summarytrue
ParameterDefinition.documentation
Element IdParameterDefinition.documentation
Definition

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

Cardinality0..1
Typestring
Summarytrue
ParameterDefinition.type
Element IdParameterDefinition.type
Definition

The type of the parameter.

Cardinality1..1
Terminology BindingAny defined Resource or Data Type name (including "Any" and "Type")
Typecode
Summarytrue
ParameterDefinition.profile
Element IdParameterDefinition.profile
Definition

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

Cardinality0..1
Typecanonical(StructureDefinition)
Summarytrue

See also Base Definition, Examples and Mappings.

RelatedArtifact
Standards StatusThis element has a standards status of "Trial Use"
Element IdRelatedArtifact
Definition

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

Cardinality0..*
TypeDataType
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.

Summarytrue
Comments

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

RelatedArtifact.type
Element IdRelatedArtifact.type
Definition

The type of relationship to the related artifact.

Cardinality1..1
Terminology BindingRelatedArtifactType (Required)
Typecode
Summarytrue
RelatedArtifact.label
Element IdRelatedArtifact.label
Definition

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

Cardinality0..1
Typestring
Summarytrue
RelatedArtifact.display
Element IdRelatedArtifact.display
Definition

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

Cardinality0..1
Typestring
Summarytrue
RelatedArtifact.citation
Element IdRelatedArtifact.citation
Definition

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

Cardinality0..1
Typemarkdown
Summarytrue
Comments

Additional structured information about citations should be captured as extensions.

RelatedArtifact.url
Element IdRelatedArtifact.url
Definition

A url for the artifact that can be followed to access the actual content.

Cardinality0..1
Typeurl
Summarytrue
Comments

If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference).

RelatedArtifact.document
Element IdRelatedArtifact.document
Definition

The document being referenced, represented as an attachment. This is exclusive with the resource element.

Cardinality0..1
TypeAttachment
Summarytrue
RelatedArtifact.resource
Element IdRelatedArtifact.resource
Definition

The related resource, such as a library, value set, profile, or other knowledge resource.

Cardinality0..1
Typecanonical(Any)
Summarytrue
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

See also Base Definition, Examples and Mappings.

TriggerDefinition
Standards StatusThis element has a standards status of "Trial Use"
Element IdTriggerDefinition
Definition

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

Cardinality0..*
TypeDataType
Summarytrue
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-1Rule Either timing, or a data requirement, but not bothdata.empty() or timing.empty()
trd-2Rule A condition only if there is a data requirementcondition.exists() implies data.exists()
trd-3Rule 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 IdTriggerDefinition.type
Definition

The type of triggering event.

Cardinality1..1
Terminology BindingTriggerType (Required)
Typecode
Summarytrue
TriggerDefinition.name
Element IdTriggerDefinition.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.

Cardinality0..1
Typestring
Summarytrue
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 IdTriggerDefinition.timing[x]
Definition

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

Cardinality0..1
TypeTiming|Reference(Schedule)|date|dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
TriggerDefinition.data
Element IdTriggerDefinition.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.

Cardinality0..*
TypeDataRequirement
Summarytrue
Comments

This element shall be present for any data type trigger.

TriggerDefinition.condition
Element IdTriggerDefinition.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.

Cardinality0..1
TypeExpression
Requirements

Need to be able to formally describe the triggering criteria.

Summarytrue
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.

See also Base Definition, Examples and Mappings.

Expression
Standards StatusThis element has a standards status of "Trial Use"
Element IdExpression
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.

Cardinality0..*
TypeDataType
Summarytrue
Invariants
Defined on this element
exp-1Rule An expression or a reference must be providedexpression.exists() or reference.exists()
Expression.description
Element IdExpression.description
Definition

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

Cardinality0..1
Typestring
Summarytrue
Expression.name
Element IdExpression.name
Definition

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

Cardinality0..1
Typeid
Summarytrue
Expression.language
Element IdExpression.language
Definition

The media type of the language for the expression.

Cardinality1..1
Terminology BindingExpressionLanguage (Extensible but limited to ??)
Typecode
Summarytrue
Expression.expression
Element IdExpression.expression
Definition

An expression in the specified language that returns a value.

Cardinality0..1
Typestring
Summarytrue
Expression.reference
Element IdExpression.reference
Definition

A URI that defines where the expression is found.

Cardinality0..1
Typeuri
Summarytrue
Comments

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

See also Base Definition, Examples and Mappings.

UsageContext
Standards StatusThis element has a standards status of "Trial Use"
Element IdUsageContext
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).

Cardinality0..*
TypeDataType
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.

Summarytrue
UsageContext.code
Element IdUsageContext.code
Definition

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

Cardinality1..1
Terminology BindingUsageContextType (Extensible)
TypeCoding
Summarytrue
UsageContext.value[x]
Element IdUsageContext.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.

Cardinality1..1
Terminology BindingConformanceUseContext (Example)
TypeCodeableConcept|Quantity|Range|Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
PatternsReference(PlanDefinition,ResearchStudy,InsurancePlan,HealthcareService,Group,Location,Organization): No common pattern
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue