FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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: 4Ballot Status: Trial Use

Table of Contents

ContactDetail Contributor DataRequirement ParameterDefinition
RelatedArtifact TriggerDefinition UsageContext

See also Base Definition, Examples and Mappings.

ContactDetail
Definition

Specifies contact information for a person or organization.

Control1..1
Requirements

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

Summarytrue
ContactDetail.name
Definition

The name of an individual to contact.

Control0..1
Typestring
Summarytrue
Comments

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

ContactDetail.telecom
Definition

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

Control0..*
TypeContactPoint
Summarytrue

See also Base Definition, Examples and Mappings.

Contributor
Definition

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

Control1..1
Requirements

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

Summarytrue
Contributor.type
Definition

The type of contributor.

Control1..1
Terminology BindingContributorType (Required)
Typecode
Summarytrue
Contributor.name
Definition

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

Control1..1
Typestring
Summarytrue
Contributor.contact
Definition

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

Control0..*
TypeContactDetail
Summarytrue

See also Base Definition, Examples and Mappings.

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.

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

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

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

Control0..*
Typeuri
Summarytrue
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 value for this element can be a path to allow references to nested elements. In that case, all the elements along the path must be supported.

Control0..*
Typestring
Summarytrue
DataRequirement.codeFilter
Definition

Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data.

Control0..*
Summarytrue
DataRequirement.codeFilter.path
Definition

The code-valued attribute of the filter. 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. The path must resolve to an element of type code, Coding, or CodeableConcept.

Control1..1
Typestring
Summarytrue
DataRequirement.codeFilter.valueSet[x]
Definition

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 a member of the specified valueset.

Control0..1
Typestring|Reference(ValueSet)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
DataRequirement.codeFilter.valueCode
Definition

The codes for the code filter. Only one of valueSet, valueCode, valueCoding, 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 codes.

Control0..*
Typecode
Summarytrue
DataRequirement.codeFilter.valueCoding
Definition

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

Control0..*
TypeCoding
Summarytrue
DataRequirement.codeFilter.valueCodeableConcept
Definition

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

Control0..*
TypeCodeableConcept
Summarytrue
DataRequirement.dateFilter
Definition

Date filters specify additional constraints on the data in terms of the applicable date range for specific elements.

Control0..*
Summarytrue
DataRequirement.dateFilter.path
Definition

The date-valued attribute of the filter. 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. The path must resolve to an element of type dateTime, Period, Schedule, or Timing.

Control1..1
Typestring
Summarytrue
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 now.

Control0..1
TypedateTime|Period|Duration
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue

See also Base Definition, Examples and Mappings.

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.

Control1..1
Summarytrue
ParameterDefinition.name
Definition

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

Control0..1
Typecode
Summarytrue
ParameterDefinition.use
Definition

Whether the parameter is input or output for the module.

Control1..1
Terminology BindingOperationParameterUse (Required)
Typecode
Summarytrue
ParameterDefinition.min
Definition

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

Control0..1
Typeinteger
Summarytrue
ParameterDefinition.max
Definition

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

Control0..1
Typestring
Summarytrue
ParameterDefinition.documentation
Definition

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

Control0..1
Typestring
Summarytrue
ParameterDefinition.type
Definition

The type of the parameter.

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

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

Control0..1
TypeReference(StructureDefinition)
Summarytrue

See also Base Definition, Examples and Mappings.

RelatedArtifact
Definition

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

Control1..1
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
Definition

The type of relationship to the related artifact.

Control1..1
Terminology BindingRelatedArtifactType (Required)
Typecode
Summarytrue
RelatedArtifact.display
Definition

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

Control0..1
Typestring
Summarytrue
RelatedArtifact.citation
Definition

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

Control0..1
Typestring
Summarytrue
Comments

Additional structured information about citations should be captured as extensions.

RelatedArtifact.url
Definition

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

Control0..1
Typeuri
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
Definition

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

Control0..1
TypeAttachment
Summarytrue
RelatedArtifact.resource
Definition

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

Control0..1
TypeReference(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
Definition

A description of a triggering event.

Control1..1
Summarytrue
TriggerDefinition.type
Definition

The type of triggering event.

Control1..1
Terminology BindingTriggerType (Required)
Typecode
Summarytrue
TriggerDefinition.eventName
Definition

The name of the event (if this is a named-event trigger).

Control0..1
Typestring
Summarytrue
TriggerDefinition.eventTiming[x]
Definition

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

Control0..1
TypeTiming|Reference(Schedule)|date|dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
TriggerDefinition.eventData
Definition

The triggering data of the event (if this is a data trigger).

Control0..1
TypeDataRequirement
Summarytrue

See also Base Definition, Examples and Mappings.

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

Control1..1
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
Definition

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

Control1..1
Terminology BindingUsageContextType (Extensible)
TypeCoding
Summarytrue
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.

Control1..1
Terminology BindingContext of Use ValueSet (Example)
TypeCodeableConcept|Quantity|Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue