FHIR Release 3 (STU) Current Build
FHIR Infrastructure Work Group Maturity Level : 4 Ballot Standards Status : Trial Use Partially Normative
null

Table of Contents

ContactDetail Contributor DataRequirement ParameterDefinition
RelatedArtifact TriggerDefinition Expression UsageContext

See also Base Definition , Examples and Mappings .

Normative Note: This DataType is normative content. Breaking changes will no longer be made.

ContactDetail
Standards Status This element has a standards status of "Normative"
Element Id ContactDetail
Definition

Specifies contact information for a person or organization.

Control Cardinality 1..1 0..*
Type 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.

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

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

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.

Control Cardinality 1..1 0..*
Type 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.

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

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

Control Cardinality 0..*
Type ContactDetail
Summary true

See also Base Definition , Examples and Mappings .

DataRequirement.codeFilter.valueSet[x]
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.

Control Cardinality 1..1 0..*
Type 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.

Control Cardinality 1..1
Terminology Binding 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.

Control Cardinality 0..*
Type uri 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.

Cardinality 0..1
Terminology Binding Subject type ( Extensible )
Type CodeableConcept | Reference ( Group )
[x] Note See Choice of 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. Note that the

The value for this element can of mustSupport SHALL be a path to allow references to nested elements. In that case, all FHIRPath resolveable on the elements along type of the DataRequirement. The path must be supported. SHALL consist only of identifiers, constant indexers, and .resolve() (see the Simple FHIRPath Profile for full details).

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

Control 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 must SHALL be resolvable from a FHIRPath resolveable on the specified type of the required data. 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. 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.

Control Cardinality 1..1 0..1
Type string
Summary true
Definition Comments

The valueset for the code filter. The valueSet and value elements are exclusive. 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 attribute contains a member of the specified valueset. Control Simple FHIRPath Subset 0..1 that allows path traversal, but not calculation.

Type string | Reference ( ValueSet ) DataRequirement.codeFilter.searchParam [x] Note See Choice of Data Types for further information about how to use [x]
Summary Element Id true DataRequirement.codeFilter.valueCode DataRequirement.codeFilter.searchParam
Definition

The codes for A token parameter that refers to a search parameter defined on the code filter. Only one specified type of valueSet, valueCode, valueCoding, or valueCodeableConcept may be specified. If values are given, the filter will return only those data items for DataRequirement, and which the code-valued attribute specified by the path has a value that is one searches on elements of the specified codes. type code, Coding, or CodeableConcept.

Control Cardinality 0..* 0..1
Type code string
Summary true
DataRequirement.codeFilter.valueCoding DataRequirement.codeFilter.valueSet
Element Id DataRequirement.codeFilter.valueSet
Definition

The Codings valueset for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. If values The valueSet and code elements are given, additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued attribute element specified by in the path has a value that is one a member of the specified Codings. valueset.

Control Cardinality 0..* 0..1
Type Coding canonical ( ValueSet )
Summary true
DataRequirement.codeFilter.valueCodeableConcept DataRequirement.codeFilter.code
Element Id DataRequirement.codeFilter.code
Definition

The CodeableConcepts codes for the code filter. Only one of valueSet, valueCode, valueConding, or valueCodeableConcept may be specified. 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 CodeableConcepts. 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.

Control Cardinality 0..*
Type CodeableConcept 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.

Control 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 must SHALL be resolvable from a FHIRPath resolveable on the specified type of the required data. 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. 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.

Control Cardinality 1..1 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.

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 from before now.

Control Cardinality 0..1
Type dateTime | Period | Duration
[x] Note See Choice of 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).

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.

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.

Cardinality 1..1
Type string
Summary true
DataRequirement.sort.direction
Element Id DataRequirement.sort.direction
Definition

The direction of the sort, ascending or descending.

Cardinality 1..1
Terminology Binding SortDirection ( Required )
Type code
Summary true

See also Base Definition , Examples and 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.

Control Cardinality 1..1 0..*
Type 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.

Control Cardinality 0..1
Type code
Summary true
ParameterDefinition.use
Element Id ParameterDefinition.use
Definition

Whether the parameter is input or output for the module.

Control Cardinality 1..1
Terminology Binding 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.

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

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

Control Cardinality 0..1
Type string
Summary true
ParameterDefinition.type
Element Id ParameterDefinition.type
Definition

The type of the parameter.

Control Cardinality 1..1
Terminology Binding 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.

Control Cardinality 0..1
Type Reference canonical ( StructureDefinition )
Summary true

See also Base Definition , Examples and Mappings .

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.

Control Cardinality 1..1 0..*
Type 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.

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

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.

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

Control Cardinality 0..1
Type string markdown
Summary true
Comments

Additional structured information about citations should be captured as extensions.

RelatedArtifact.url
Element Id RelatedArtifact.url
Definition

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

Control Cardinality 0..1
Type uri url
Summary true
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 Id RelatedArtifact.document
Definition

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

Control Cardinality 0..1
Type Attachment
Summary true
RelatedArtifact.resource
Element Id RelatedArtifact.resource
Definition

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

Control Cardinality 0..1
Type Reference canonical ( Any )
Summary true
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 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.

Control Cardinality 1..1 0..*
Type 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.

Control Cardinality 1..1
Terminology Binding TriggerType ( Required )
Type code
Summary true
TriggerDefinition.eventName TriggerDefinition.name
Element Id TriggerDefinition.name
Definition

The A formal name of for the event. This may be an absolute URI that identifies the event (if this is formally (e.g. from a named-event trigger). trigger registry), or a simple relative URI that identifies the event in a local context.

Control 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.eventTiming[x] TriggerDefinition.timing[x]
Element Id TriggerDefinition.timing[x]
Definition

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

Control Cardinality 0..1
Type Timing | Reference ( Schedule )| date | dateTime
[x] Note See Choice of Data Types for further information about how to use [x]
Summary true
TriggerDefinition.eventData 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.

Control Cardinality 0..1 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.

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.

See also Base Definition , Examples and Mappings .

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.

Cardinality 0..*
Type Element
Summary true
Invariants
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.

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.

Cardinality 0..1
Type id
Summary true
Expression.language
Element Id Expression.language
Definition

The media type of the language for the expression.

Cardinality 1..1
Terminology Binding ExpressionLanguage ( Extensible but limited to ??)
Type code
Summary true
Expression.expression
Element Id Expression.expression
Definition

An expression in the specified language that returns a value.

Cardinality 0..1
Type string
Summary true
Expression.reference
Element Id Expression.reference
Definition

A URI that defines 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.

See also Base Definition , Examples and Mappings .

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

Specifies clinical/business/etc 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).

Control Cardinality 1..1 0..*
Type 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.

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

Control 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 Data Types for further information about how to use [x]
Summary true