Summary
Diagnostics
Care Provision
Request & Response
Medications
Workflow
Entities
Management
Individuals
General
Billing
Support
Payment
Security
Other
Conformance
Documents
Terminology
Definitional Artifacts
Medication Definition
Evidence-Based Medicine
Quality Reporting & Testing
Public Health & Research
Complex
Primitive
ActivityDefinition
CapabilityStatement
ChargeItemDefinition
Claim
CodeSystem
Composition
ConceptMap
CoverageEligibilityRequest
Encounter
Group
Library
List
Measure
MedicinalProductDefinition
MessageHeader
NamingSystem
Observation
Patient
PlanDefinition
Resource
StructureDefinition
StructureMap
ValueSet
default
Base StructureDefinition for 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.
DataRequirement
Path
DataRequirement
Id
DataRequirement
Cardinality
0 - *
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Condition
ele-1
Path
DataRequirement.type
Id
DataRequirement.type
Type
Cardinality
1 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.profile
Id
DataRequirement.profile
Type
Cardinality
0 - *
Definition
The profile of the required data, specified as the uri of the profile definition.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
subject[x]
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
Path
DataRequirement.subject[x]
Id
DataRequirement.subject[x]
Type
Cardinality
0 - 1
Definition
The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
Comment
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.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.subject[x].CodeableConcept.coding
Id
CodeableConcept.coding
Type
Cardinality
0 - *
Definition
A reference to a code defined by a terminology system.
Comment
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.subject[x].CodeableConcept.coding.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.subject[x].CodeableConcept.coding.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.subject[x].CodeableConcept.coding.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.subject[x].CodeableConcept.coding.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.subject[x].CodeableConcept.coding.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
mustSupport
Indicates specific structure elements that are referenced by the knowledge module
Path
DataRequirement.mustSupport
Id
DataRequirement.mustSupport
Type
Cardinality
0 - *
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](fhirpath.html#simple) for full details).
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.codeFilter
Id
DataRequirement.codeFilter
Type
Cardinality
0 - *
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.
Comment
Constraint
drq-1 [error]
Either a path or a searchParam must be provided, but not both
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
DataRequirement.codeFilter.path
Id
DataRequirement.codeFilter.path
Type
Cardinality
0 - 1
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](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.
Comment
The path attribute contains a [Simple FHIRPath Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.codeFilter.searchParam
Id
DataRequirement.codeFilter.searchParam
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.codeFilter.valueSet
Id
DataRequirement.codeFilter.valueSet
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.codeFilter.code
Id
DataRequirement.codeFilter.code
Type
Cardinality
0 - *
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.codeFilter.code.Coding.system
Id
Coding.system
Type
Cardinality
0 - 1
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Comment
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.codeFilter.code.Coding.version
Id
Coding.version
Type
Cardinality
0 - 1
Definition
The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Comment
Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.codeFilter.code.Coding.code
Id
Coding.code
Type
Cardinality
0 - 1
Definition
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Comment
Requirements
Need to refer to a particular code in the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.codeFilter.code.Coding.display
Id
Coding.display
Type
Cardinality
0 - 1
Definition
A representation of the meaning of the code in the system, following the rules of the system.
Comment
Requirements
Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.codeFilter.code.Coding.userSelected
Id
Coding.userSelected
Type
Cardinality
0 - 1
Definition
Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Comment
Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Requirements
This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.dateFilter
Id
DataRequirement.dateFilter
Type
Cardinality
0 - *
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.
Comment
Constraint
drq-2 [error]
Either a path or a searchParam must be provided, but not both
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
DataRequirement.dateFilter.path
Id
DataRequirement.dateFilter.path
Type
Cardinality
0 - 1
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](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.
Comment
The path attribute contains a [Simple FHIR Subset](fhirpath.html#simple) that allows path traversal, but not calculation.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.dateFilter.searchParam
Id
DataRequirement.dateFilter.searchParam
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.dateFilter.value[x]
Id
DataRequirement.dateFilter.value[x]
Type
Cardinality
0 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.limit
Id
DataRequirement.limit
Type
Cardinality
0 - 1
Definition
Specifies a maximum number of results that are required (uses the _count search parameter).
Comment
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".
Requirements
Enables the requirement "most recent 5 results" to be expressed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.sort
Id
DataRequirement.sort
Type
Cardinality
0 - *
Definition
Specifies the order of the results to be returned.
Comment
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.
Requirements
Enables the requirement "most recent 5 results" to be expressed.
Constraint
ele-1 [error]
All FHIR elements must have a @value or children unless an empty Parameters resource
Path
DataRequirement.sort.path
Id
DataRequirement.sort.path
Type
Cardinality
1 - 1
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.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children
Path
DataRequirement.sort.direction
Id
DataRequirement.sort.direction
Type
Cardinality
1 - 1
Definition
The direction of the sort, ascending or descending.
Comment
Constraint
ele-1 [error]
All FHIR elements must have a @value or children