This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R3 R2
Detailed Descriptions for the elements in the DataElement resource.
DataElement | |
Definition | The formal description of a single piece of information that can be gathered and reported. |
Control | 1..1 |
Alternate Names | Master Observation; Data Element; CDE |
Comments | Often called a clinical template. |
Invariants | Defined on this element dae-1: Can have a maximum of one definitional binding or primary concept (xpath: count(f:concept[f:primary[@value='true']|f:mapping/f:definitional[@value='true']])<=1) |
DataElement.url | |
Definition | The uri that is used to identify this element when it is referenced in a specification, model, design or an instance (should be globally unique URI, and an be urn:uuid: or urn:oid:). |
Control | 0..1 |
Type | uri |
Summary | true |
DataElement.identifier | |
Definition | Formal identifier that is used to identify this data element when it is represented in other formats, or referenced in a specification, model, design or an instance. |
Control | 0..1 |
Type | Identifier |
Summary | true |
Comments | Typically, this is used for values that can go in a v3 II data type. |
DataElement.version | |
Definition | The identifier that is used to identify this version of the data element when it is referenced in a Profile, Questionnaire or instance. This is an arbitrary value managed by the definition author manually. |
Control | 0..1 |
Type | string |
Requirements | There may be multiple resource versions of the data element that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control. |
Summary | true |
Comments | N/A. |
DataElement.publisher | |
Definition | The name of the individual or organization that published the data element. |
Control | 0..1 |
Type | string |
Requirements | Helps establish the "authority/credibility" of the data element. May also allow for contact. |
Summary | true |
Comments | Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context. |
DataElement.contact | |
Definition | Contacts to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Summary | true |
Comments | May be a web site, an email address, a telephone number (tel:), etc. |
DataElement.contact.name | |
Definition | The name of an individual to contact regarding the data element. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | If there is no named individual, the telecom is for the organization as a whole. |
DataElement.contact.telecom | |
Definition | Contact details for individual (if a name was provided) or the publisher. |
Control | 0..* |
Type | ContactPoint |
Summary | true |
DataElement.status | |
Definition | The status of the data element. |
Control | 1..1 |
Binding | ResourceDataElementStatus: Required: http://hl7.org/fhir/resource-observation-def-status (The lifecycle status of a Resource data element) |
Type | code |
Is Modifier | true |
Requirements | Allows filtering of data elements that are appropriate for use vs. not. |
Summary | true |
DataElement.experimental | |
Definition | A flag to indicate that this search data elemnt definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
Control | 0..1 |
Type | boolean |
Summary | true |
Comments | Allows filtering of search data element definitions that are appropriate for use vs. not. |
DataElement.date | |
Definition | The date that the status for this business version of the data element became effective. (I.e. Date the draft was created, date element became active or date element became retired). |
Control | 0..1 |
Type | dateTime |
Summary | true |
Comments | This refers to the "business" version - the DataElement.version which changes based on business processes. It does not refer to the date of the RESTful version which is part of the resource metadata. |
DataElement.name | |
Definition | The term used by humans to refer to the data element. Should ideally be unique within the context in which the data element is expected to be used. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | This may be similar to the question used to prompt someone for a data element value, but the purpose is communicating about the data element, not asking the question. (Refer to the 'question' element for the latter.). |
DataElement.category | |
Definition | A set of terms from external terminologies that may be used to assist with indexing and searching of data element definitions. |
Control | 0..* |
Type | CodeableConcept |
Requirements | Assist in searching for appropriate data elements. |
Summary | true |
DataElement.granularity | |
Definition | Identifies how precise the data element is in its definition. |
Control | 0..1 |
Binding | DataElementGranularity: Required: http://hl7.org/fhir/dataelement-granularity (Indicates the degree of precision of the data element definition) |
Type | code |
Requirements | Allows determining whether the degree of comparability of data element instances - less granular data elements result in data that is less comparable (or at least requires more work to compare). |
Summary | true |
To Do | Should this be an extension?. |
DataElement.code | |
Definition | A code that provides the meaning for a data element according to a particular terminology. |
Control | 0..* |
Type | Coding |
Requirements | Many data elements may have codes that define the concepts described by the data element. E.g. LOINC, SNOMED, various meta-thesauruses, etc. |
Summary | true |
Comments | The data element definition and other constraints SHALL be a proper constraint on the meaning (as defined in the code system, including relationships) of any code listed here. Where multiple codes exist in a terminology that could correspond to the data element, the most granular code(s) should be selected, so long as they are not more restrictive than the data element itself. |
DataElement.question | |
Definition | The default/suggested phrasing to use when prompting a human to capture the data element in question form (e.g. In a survey). |
Control | 0..1 |
Type | string |
Summary | true |
DataElement.label | |
Definition | The text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | Question and label serve similar purposes in they both can be used to prompt for capturing a data element. Whether the question form or label form should be used will depend on the type of instrument being used to capture the information. |
DataElement.definition | |
Definition | Provides a complete explanation of the meaning of the data element for human readability. |
Control | 0..1 |
Type | string |
Alternate Names | Definition; Description |
DataElement.copyright | |
Definition | A copyright statement relating to the definition of the data element. Copyright statements are generally legal restrictions on the use and publishing of the details of the definition of the data element. |
Control | 0..1 |
Type | string |
Alternate Names | License; Restrictions |
Comments | The copyright statement does not apply to values for the data element, only to it's definition. |
DataElement.comments | |
Definition | Comments about the use of the element, including notes about how to use the data properly, exceptions to proper use, etc. |
Control | 0..1 |
Type | string |
Comments | If it is possible to capture usage rules using invariants, that mechanism should be used in preference to this element. |
DataElement.requirements | |
Definition | Explains why this element is needed and why it's been constrained as it has. |
Control | 0..1 |
Type | string |
Comments | This element does not describe the usage of the element (that's done in comments), rather it's for traceability of why the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element. |
DataElement.synonym | |
Definition | Identifies additional names by which this element might also be known. |
Control | 0..* |
Type | string |
Requirements | Allows for better easier recognition of the element by multiple communities, including international communities. |
DataElement.type | |
Definition | The FHIR data type that is the type for data that corresponds to this data element. |
Control | 0..1 |
Binding | DataType: Any defined Data Type name |
Type | code |
Comments | If absent, the structure represents a concept rather than an element. |
DataElement.example[x] | |
Definition | A sample value for this element demonstrating the type of information that would typically be captured. |
Control | 0..1 |
Type | * |
Comments | This will most commonly be present for data where it's not implicitly obvious from either the data type or value set what the values might be. (I.e. Example values for dates or quantities would generally be unnecessary.). |
DataElement.maxLength | |
Definition | Indicates the shortest length that SHALL be supported by conformant instances without truncation. |
Control | 0..1 |
Type | integer |
Comments | If not specified, there is no conformance expectation for length support. |
DataElement.units[x] | |
Definition | Identifies the units of measure in which the data element should be captured or expressed. |
Control | 0..1 |
Binding | Units: Preferred: See http://hl7.org/fhir/vs/units (Type of measurement system used to express a value) |
Type | CodeableConcept|Reference(ValueSet) |
Comments | Use a value set if more than one unit of measure is possible. |
DataElement.binding | |
Definition | Binds to a value set if this element is coded (code, Coding, CodeableConcept). |
Control | 0..1 |
Invariants | Defined on this element dae-14: Example value sets are always extensible (xpath: not(f:conformance/@value='example' and f:isExtensible/@value='false')) dae-3: provide either a valueSet or a description (or both) (xpath: (exists(f:valueSet)) or exists(f:description)) |
DataElement.binding.isExtensible | |
Definition | If true, then conformant systems may use additional codes or (where the data type permits) text alone to convey concepts not covered by the set of codes identified in the binding. If false, then conformant systems are constrained to the provided codes alone. |
Control | 1..1 |
Type | boolean |
Comments | When the binding use used for elements with a type of "code" (rather than Coding or CodableConcept), the binding is treated as non-extensible regardless of the value of this property. |
Invariants | Affect this element dae-14: Example value sets are always extensible (xpath: not(f:conformance/@value='example' and f:isExtensible/@value='false')) |
DataElement.binding.conformance | |
Definition | Indicates the degree of conformance expectations associated with this binding. |
Control | 0..1 |
Binding | BindingConformance: Required: http://hl7.org/fhir/binding-conformance (Binding conformance for applications) |
Type | code |
Invariants | Affect this element dae-14: Example value sets are always extensible (xpath: not(f:conformance/@value='example' and f:isExtensible/@value='false')) |
DataElement.binding.description | |
Definition | Describes the intended use of this particular set of codes. |
Control | 0..1 |
Type | string |
Invariants | Affect this element dae-3: provide either a valueSet or a description (or both) (xpath: (exists(f:valueSet)) or exists(f:description)) |
DataElement.binding.valueSet | |
Definition | Points to the value set that identifies the set of codes to be used. |
Control | 0..1 |
Type | Reference(ValueSet) |
Comments | The display can contain the value set description. The reference may be version-specific or not. |
Invariants | Affect this element dae-3: provide either a valueSet or a description (or both) (xpath: (exists(f:valueSet)) or exists(f:description)) |
DataElement.mapping | |
Definition | Identifies a concept from an external specification that roughly corresponds to this element. |
Control | 0..* |
Requirements | Provides guidance to implementers familiar with or converting content from other specifications. May also help formally define the meaning of the element by mapping to a reference model. |
Comments | Mappings are not necessarily specific enough for safe translation. |
Invariants | Defined on this element dae-26: Must have at a name or a uri (or both) (xpath: exists(f:uri) or exists(f:name)) |
DataElement.mapping.uri | |
Definition | A URI that identifies the specification that this mapping is expressed to. |
Control | 0..1 |
Type | uri |
Comments | A formal identity for the specification being mapped to helps with identifying maps consistently. |
Invariants | Affect this element dae-26: Must have at a name or a uri (or both) (xpath: exists(f:uri) or exists(f:name)) |
DataElement.mapping.definitional | |
Definition | If true, indicates that the official meaning of the data element is exactly equivalent to the mapped element. |
Control | 0..1 |
Type | boolean |
Default Value | false |
Requirements | Distinguishes mappings that approximate the meaning of the element from the mapping that is exactly equivalent to the data element. |
DataElement.mapping.name | |
Definition | A name for the specification that is being mapped to. |
Control | 0..1 |
Type | string |
Invariants | Affect this element dae-26: Must have at a name or a uri (or both) (xpath: exists(f:uri) or exists(f:name)) |
DataElement.mapping.comments | |
Definition | Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. |
Control | 0..1 |
Type | string |
DataElement.mapping.map | |
Definition | Expresses what part of the target specification corresponds to this element. |
Control | 1..1 |
Type | string |
Comments | For most mappings, the syntax is undefined. Syntax will be provided for mappings to the RIM. Multiple mappings may be possible and may include constraints on other resource elements that identify when a particular mapping applies. |