Data Requirement

$10 / year

The Data Requirement structure defines a general data requirement for a knowledge asset such as a decision support rule or quality measure.

Complexity

The Data Requirement describes a required data item. A Data Requirement differs from a parameter in that it specifies the data to be provided in terms of the type of data, and specific filters on code-valued and/or date-valued attributes. Data requirements are not named because they are referenced by type within the evaluation context.

Data Requirements are used by knowledge modules to communicate the set of required data to a consumer in a way that is computable (as opposed to a set of named parameters which must be integrated by hand based on the meaning of the parameter as communicated through the documentation).

Data Requirements are typically used to communicate patient-dependent information such as Medication Statements and Encounters, whereas Parameters are typically used to communicate patient-independent information such as configuration values.

Data Requirement is used in the following places:
– Trigger Definition
– Evidence Variable
– Guidance Response
– Library
– Plan Definition
– Research Element Definition

Date Created

2018-09-20

Last Modified

2019-11-01

Version

4.0.1

Update Frequency

Annual

Temporal Coverage

N/A

Spatial Coverage

United States

Source

John Snow Labs; Health Level Seven International;

Source License URL

Source License Requirements

N/A

Source Citation

N/A

Keywords

FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR

Other Titles

FHIR Data Requirement Datatype, Electronic Health Records Exchange Through FHIR

NameDescriptionTypeConstraints
Concept_NameName of the concept in the FHIR structure.stringrequired : 1
Computer_Ready_NameA Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this.string-
TypeThe type the structure describes.string-
Dollar_RefThe "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.string-
DescriptionA free text natural language description of the structure and its use.string-
ItemsThe value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value.string-
Concept NameComputer Ready NameTypeDollar RefDescriptionItems
DataRequirementid#/definitions/stringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
DataRequirementextensionarrayMay 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 manageable 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.{'$ref': '#/definitions/Extension'}
DataRequirementtype#/definitions/codeThe 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.
DataRequirement_type#/definitions/ElementExtensions for type
DataRequirementprofilearrayThe profile of the required data specified as the uri of the profile definition.{'$ref': '#/definitions/canonical'}
DataRequirementsubjectCodeableConcept#/definitions/CodeableConceptThe intended subjects of the data requirement. If this element is not provided a Patient subject is assumed.
DataRequirementsubjectReference#/definitions/ReferenceThe intended subjects of the data requirement. If this element is not provided a Patient subject is assumed.
DataRequirementmustSupportarrayIndicates 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).{'$ref': '#/definitions/string'}
DataRequirement_mustSupportarrayExtensions for mustSupport{'$ref': '#/definitions/Element'}
DataRequirementcodeFilterarrayCode 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.{'$ref': '#/definitions/DataRequirement_CodeFilter'}
Related Data Packages