Data Requirement Code Filter

$10 / year

Data Requirement Code Filter describes a required data item for evaluation in terms of the type of data, and code-based filters for that data item. It refers to a constraint of the Data Requirement Structure.

Complexity

Data Requirement Code Filter is one of the two constraints of Data Requirement structure. It follows the rule that either a path or a search parameter must be provided, but not both. Validators should report it as an error if this rule is violated, and applications processing the content can reject it as an invalid resource.

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

Fast Healthcare Interoperability Resources (FHIR) is a draft standard describing data formats and elements (known as “resources”) and an application programming interface (API) for exchanging electronic health records. The standard was created by the Health Level Seven International (HL7) health-care standards organization.

Its goal is to facilitate interoperation between legacy healthcare systems, to make it easy to provide healthcare information to healthcare providers and individuals on a wide variety of devices from computers to tablets to cell phones, and to allow third-party application developers to provide medical applications which can be easily integrated into existing systems.

FHIR provides an alternative to document-centric approaches by directly exposing discrete data elements as services. For example, basic elements of healthcare like patients, admissions, diagnostic reports and medications can each be retrieved and manipulated via their own resource URLs (Uniform Resource Locators). FHIR was supported at an American Medical Informatics Association meeting by many EHR (Electronic health Record) vendors which value its open and extensible nature.

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 Code Filter Constraint, 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
DataRequirement_CodeFilterid#/definitions/stringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
DataRequirement_CodeFilterextensionarrayMay 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'}
DataRequirement_CodeFiltermodifierExtensionarrayMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).{'$ref': '#/definitions/Extension'}
DataRequirement_CodeFilterpath#/definitions/stringThe 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
DataRequirement_CodeFilter_path#/definitions/ElementExtensions for path
DataRequirement_CodeFiltersearchParam#/definitions/stringA 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.
DataRequirement_CodeFilter_searchParam#/definitions/ElementExtensions for searchParam
DataRequirement_CodeFiltervalueSet#/definitions/canonicalThe 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.
DataRequirement_CodeFiltercodearrayThe 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.{'$ref': '#/definitions/Coding'}
Related Data Packages