Name Flags Card. Type Description & Constraints DataRequirement ΣN Element Describes a required data item Elements defined in Ancestors: id, <a href="types.html#Element" title="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.">extension #xD; type Σ 1..1 code The type of the required data Binding: All FHIR Types (Required) #xD; profile Σ 0..* canonical(StructureDefinition) The profile of the required data #xD; subject[x] Σ 0..1 E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device Binding: Participant Resource Types (Extensible) #xD; subjectCodeableConcept CodeableConcept #xD; subjectReference Reference(Group) #xD; <a href="metadatatypes-definitions.html#DataRequirement.mustSupport" title="DataRequirement.mustSupport : 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. #xA;#xA;The value of mustSupport SHALL be a FHIRPath resolvable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).">mustSupport Σ 0..* string Indicates specific structure elements that are referenced by the knowledge module #xD; codeFilter ΣC 0..* Element What codes are expected + Rule: Either a path or a searchParam must be provided, but not both #xD; <a href="metadatatypes-definitions.html#DataRequirement.codeFilter.path" title="DataRequirement.codeFilter.path : The code-valued 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](fhirpath.html#simple) 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.">path ΣC 0..1 string A code-valued attribute to filter on #xD; searchParam ΣC 0..1 string A coded (token) parameter to search on #xD; valueSet Σ 0..1 canonical(ValueSet) ValueSet for the filter #xD; <a href="metadatatypes-definitions.html#DataRequirement.codeFilter.code" title="DataRequirement.codeFilter.code : 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.">code Σ 0..* Coding What code is expected #xD; dateFilter ΣC 0..* Element What dates/date ranges are expected + Rule: Either a path or a searchParam must be provided, but not both #xD; <a href="metadatatypes-definitions.html#DataRequirement.dateFilter.path" title="DataRequirement.dateFilter.path : The date-valued 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](fhirpath.html#simple) 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.">path ΣC 0..1 string A date-valued attribute to filter on #xD; searchParam ΣC 0..1 string A date valued parameter to search on #xD; <a href="metadatatypes-definitions.html#DataRequirement.dateFilter.value_x_" title="DataRequirement.dateFilter.value[x] : 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.">value[x] Σ 0..1 The value of the filter, as a Period, DateTime, or Duration value #xD; valueDateTime dateTime #xD; valuePeriod Period #xD; valueDuration Duration #xD; valueFilter Σ 0..* Element What values are expected #xD; <a href="metadatatypes-definitions.html#DataRequirement.valueFilter.path" title="DataRequirement.valueFilter.path : 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](fhirpath.html#simple) 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.">path Σ 0..1 string An attribute to filter on #xD; searchParam Σ 0..1 string A parameter to search on #xD; comparator Σ 0..1 code eq | gt | lt | ge | le | sa | eb Binding: Value Filter Comparator (Required) #xD; value[x] Σ 0..1 The value of the filter, as a Period, DateTime, or Duration value #xD; valueDateTime dateTime #xD; valuePeriod Period #xD; valueDuration Duration #xD; limit Σ 0..1 positiveInt Number of results #xD; sort Σ 0..* Element Order of the results #xD; path Σ 1..1 string The name of the attribute to perform the sort #xD; direction Σ 1..1 code ascending | descending Binding: SortDirection (Required) #xD; Documentation for this format
DataRequirement Type: Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
Describes a required data item for evaluation in terms of the type of data, and optional code or date-based filters of the data.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
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.
List of FHIR types (resources, data types).
The profile of the required data, specified as the uri of the profile definition.
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
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.
The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Indicates specific structure elements that are referenced by the knowledge module
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 on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details).
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.
Either a path or a searchParam must be provided, but not both
All FHIR elements must have a @value or children or both
The code-valued 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](fhirpath.html#simple) 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.
The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
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.
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.
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.
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.
The date-valued 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](fhirpath.html#simple) 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.
The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
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.
The value of the filter, as a Period, DateTime, or Duration value
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.
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).
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](fhirpath.html#simple) 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.
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.
The comparator to be used to determine whether the value is matching.
Possible comparators for the valueFilter element.
Specifies a maximum number of results that are required (uses the _count search parameter).
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".
Enables the requirement "most recent 5 results" to be expressed.
Specifies the order of the results to be returned.
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.
The name of the attribute to perform the sort
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.
The direction of the sort, ascending or descending.
The possible sort directions, ascending or descending.