STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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

1.24.2 Data Requirement Detailed Descriptions

Clinical Decision Support Work GroupMaturity Level: N/ABallot Status: DSTU 2

1.24.2.1 DataRequirement

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
BindingFHIRAllTypes: Any 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..1
TypeReference(StructureDefinition)
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.

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

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