FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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

Orders and Observations Work GroupMaturity Level: 1 Trial UseCompartments: Not linked to any defined compartments

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.

Control1..1
Alternate NamesMaster Observation; Data Element; CDE
Comments

Often called a clinical template.

DataElement.url
Definition

An absolute URI 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.

Control0..1
Typeuri
Requirements

Allows the data element to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version.

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.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this data element outside of FHIR, where it is not possible to use the logical URI.

LOINC CodeLOINC_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 can be placed in a lexicographical sequence.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
Comments

There may be different data element instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the data element with the format [url]|[version].

LOINC CodeN/A
DataElement.status
Definition

The status of this data element. Enables tracking the life-cycle of the content.

Control1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue
Summarytrue
Comments

Allows filtering of data elements that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired data element without due consideration.

LOINC CodeSTATUS
DataElement.experimental
Definition

A boolean value 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.

Control0..1
Typeboolean
Is Modifiertrue
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level data element.

Summarytrue
Comments

Allows filtering of data element that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental data element in production.

DataElement.date
Definition

The date (and optionally time) when the data element was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the data element changes.

Control0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
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 or be found by consulting Provenances associated with past versions of the resource.

LOINC CodeDATE_LAST_CHANGED
DataElement.publisher
Definition

The name of the individual or organization that published the data element.

Control0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the data element. May also allow for contact.

Summarytrue
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 CodeFixed to Regenstrief or SOURCE
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.

Control0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.

DataElement.title
Definition

A short, descriptive, user-friendly title for the data element.

Control0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. 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 CodeLONG_COMMON_NAME
DataElement.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Control0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

LOINC CodeN/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 for appropriate data element instances.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.

DataElement.jurisdiction
Definition

A legal or geographic region in which the data element is intended to be used.

Control0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the data element to be used in jurisdictions other than those for which it was originally designed or intended.

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.

Control0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the data element and/or its content.

Alternate NamesLicense; 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.

Control0..1
Terminology BindingDataElementStringency (Required)
Typecode
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).

Summarytrue
DataElement.mapping
Definition

Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.

Control0..*
InvariantsDefined on this element
dae-3: At least one of name or uri SHALL be present (expression : uri.exists() or name.exists(), xpath: exists(f:uri) or exists(f:name))
Affect this element
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.

Control1..1
Typeid
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.

Control0..1
Typeuri
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.

Control0..1
Typestring
DataElement.mapping.comment
Definition

Comments about this mapping, including version notes, issues, scope limitations, and other important notes for usage.

Control0..1
Typestring
DataElement.element
Definition

Defines the structure, type, allowed values and other constraining characteristics of the data element.

Control1..*
TypeElementDefinition
Summarytrue
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.

InvariantsDefined 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)))