This page is part of the FHIR Specification (v1.8.0: STU 3 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. |
DataElement.url | |
Definition | An absolute URL that is used to identify this data element when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this data element is (or will be) published. The URL SHOULD include the major version of the data element. For more information see Technical and Business Versions. |
Control | 0..1 |
Type | uri |
Requirements | Allows the data element to be referenced by a single globally unique identifier. |
Summary | true |
Comments | Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. |
DataElement.identifier | |
Definition | A 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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows externally provided and/or useable business identifiers to be easily associated with the module. |
Summary | true |
Comments | Typically, this is used for identifiers that can go in an HL7 v3 II data type - e.g. to identify this data element outside of FHIR, where the logical URL is not possible to use. |
LOINC Code | LOINC_NUM (the code is the identifier) |
DataElement.version | |
Definition | The identifier that is used to identify this version of the data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
Comments | There may be multiple different instances of a data element that have the same identifier but different versions. |
LOINC Code | N/A |
DataElement.status | |
Definition | The status of this data element. Enables tracking the life-cycle of the content. |
Control | 1..1 |
Terminology Binding | PublicationStatus (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | Allows filtering of data element that are appropriate for use vs. not. |
LOINC Code | STATUS |
DataElement.experimental | |
Definition | A flag to indicate that this data element is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Requirements | Enables experimental content to be developed following the same life-cycle as a production-level data element would. |
Summary | true |
Comments | Allows filtering of data element that are appropriate for use vs. not. |
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. The publisher (or steward) of the data element is the organization or individual primarily responsible for the maintenance and upkeep of the data element. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the data element. This item SHOULD be populated unless the information is available from context. |
LOINC Code | Fixed to Regenstrief or SOURCE |
DataElement.date | |
Definition | The date (and optionally time) when the data element was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the data element changes. |
Control | 0..1 |
Type | dateTime |
Summary | true |
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the data element. Additional specific dates may be added as extensions. |
LOINC Code | DATE_LAST_CHANGED |
DataElement.name | |
Definition | A natural language name identifying the data element. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
Control | 0..1 |
Type | string |
Requirements | Support human navigation & code generation. |
Summary | true |
Comments | The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly. |
DataElement.title | |
Definition | A short, descriptive, user-friendly title for the data element. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | null 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.). |
LOINC Code | LONG_COMMON_NAME |
DataElement.contact | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactDetail |
Summary | true |
Comments | May be a web site, an email address, a telephone number, etc. |
LOINC Code | N/A |
DataElement.useContext | |
Definition | The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions. |
Control | 0..* |
Type | UsageContext |
Requirements | Assist in searching for appropriate content. |
Summary | true |
Comments | When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply. |
DataElement.jurisdiction | |
Definition | A jurisdiction in which the data element is intended to be used. |
Control | 0..* |
Terminology Binding | Jurisdiction ValueSet (Extensible) |
Type | CodeableConcept |
Summary | true |
DataElement.copyright | |
Definition | A copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the data element. |
Control | 0..1 |
Type | markdown |
Requirements | Consumers of the library must be able to determine any legal restrictions on the use of the data element and/or its content. |
Alternate Names | License; Restrictions |
Comments | null The copyright statement does not apply to values for the data element, only to its definition. |
DataElement.stringency | |
Definition | Identifies how precise the data element is in its definition. |
Control | 0..1 |
Terminology Binding | DataElementStringency (Required) |
Type | code |
Requirements | Allows determining 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.mapping | |
Definition | Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with. |
Control | 0..* |
DataElement.mapping.identity | |
Definition | An internal id that is used to identify this mapping set when specific mappings are made on a per-element basis. |
Control | 1..1 |
Type | id |
Comments | The specification is described once, with general comments, and then specific mappings are made that reference this declaration. |
DataElement.mapping.uri | |
Definition | An absolute 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. |
DataElement.mapping.name | |
Definition | A name for the specification that is being mapped to. |
Control | 0..1 |
Type | string |
DataElement.mapping.comment | |
Definition | Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage. |
Control | 0..1 |
Type | string |
DataElement.element | |
Definition | Defines the structure, type, allowed values and other constraining characteristics of the data element. |
Control | 1..* |
Type | ElementDefinition |
Requirements | 1. |
Summary | true |
Comments | For simple data types there will only be one repetition. For complex data types, multiple repetitions will be present defining a nested structure using the "path" element. |
Invariants | Defined on this element dae-1: No base allowed (expression : base.empty(), xpath: not(exists(f:base))) dae-2: No slicing allowed (expression : slicing.empty(), xpath: not(exists(f:slicing))) |
To Do | Type should have {http://hl7.org/fhir/StructureDefinition/elementdefinition-de}. |