This page is part of the FHIR Specification (v1.2.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. |
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. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
Comments | Typically, this is used for values that can go in a v3 II data type. |
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 StructureDefinition, Questionnaire or instance. This is an arbitrary value managed by the definition author manually. |
Note | This is a business versionId, not a resource identifier (see discussion) |
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. |
LOINC Code | N/A |
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.). |
LOINC Code | LONG_COMMON_NAME |
DataElement.status | |
Definition | The status of the data element. |
Control | 1..1 |
Binding | ConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. (Required) |
Type | code |
Is Modifier | true |
Requirements | Allows filtering of data elements that are appropriate for use. |
Summary | true |
LOINC Code | STATUS |
DataElement.experimental | |
Definition | A flag to indicate that this search data element 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.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. |
LOINC Code | Fixed to Regenstrief or SOURCE |
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. |
LOINC Code | N/A |
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.date | |
Definition | The date this version of 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 | 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. Additional specific dates may be added as extensions. |
LOINC Code | DATE_LAST_CHANGED |
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 data element definitions. |
Control | 0..* |
Binding | Context of Use ValueSet: Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. (Extensible) |
Type | CodeableConcept |
Summary | true |
LOINC Code | COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE |
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 its definition. |
DataElement.stringency | |
Definition | Identifies how precise the data element is in its definition. |
Control | 0..1 |
Binding | DataElementStringency: Indicates the degree of precision of the data element definition. (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.comments | |
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}. |