DSTU2 FHIR Release 3 (STU)

This page is part of the FHIR Specification (v1.0.2: DSTU (v3.0.2: STU 2). 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 R3 R2

Orders and Observations Work Group Maturity Level : 1   Trial Use Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the DataElement resource.

LOINC Code DATE_LAST_CHANGED To Do Should this be an extension?
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 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 .

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. Multiple instances may share the same url if they have a distinct version.

DataElement.identifier
Definition

Formal 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 usable business identifiers to be easily associated with the module.

Summary true
Comments

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

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 specification, model, design or instance. This is an arbitrary value managed by the definition data element author manually. 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.

Note This is a business versionId, not a resource identifier version id (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. 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 Code N/A
DataElement.name DataElement.status
Definition

The term used by humans to refer to the status of this data element. Should ideally be unique within Enables tracking the context in which life-cycle of the data element is expected to be used. content.

Control 0..1 1..1
Terminology Binding PublicationStatus ( Required )
Type string code
Is Modifier true
Summary true
Comments

This may be similar to the question used to prompt someone for a Allows filtering of data element value, but the purpose elements that are appropriate for use vs. not.
This is communicating about the data element, labeled as "Is Modifier" because applications should not asking the question. (Refer to the 'question' use a retired data element for the latter.). without due consideration.

LOINC Code LONG_COMMON_NAME STATUS
DataElement.status DataElement.experimental
Definition

The status of the A boolean value to indicate that this data element. element is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Control 1..1 Binding ConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. ( Required ) 0..1
Type code boolean
Is Modifier true
Requirements

Allows filtering of data elements Enables experimental content to be developed following the same lifecycle that are appropriate would be used for use. a production-level data element.

Summary true
LOINC Code Comments STATUS

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.experimental DataElement.date
Definition

A flag to indicate that this search The date (and optionally time) when the data element definition is authored for testing purposes (or education/evaluation/marketing), was published. The date must change if and is not intended to be used for genuine usage. 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.

Control 0..1
Type boolean dateTime
Alternate Names Revision Date
Summary true
Comments

Allows filtering Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of search the data element definitions that are appropriate for use vs. not. element. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

LOINC Code DATE_LAST_CHANGED
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.contact DataElement.name
Definition

Contacts to assist a user in finding and communicating with A natural language name identifying the publisher. data element. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Control 0..* 0..1
Summary Type true string
Comments Requirements

May be a web site, an email address, a telephone number (tel:), etc. Support human navigation and code generation.

LOINC Code Summary N/A true
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.contact.name DataElement.title
Definition

The name of an individual to contact regarding A short, descriptive, user-friendly title for the data element.

Control 0..1
Type string
Summary true
Comments

If there is no named individual, This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. This may be similar to the telecom 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 organization as a whole. latter.).

LOINC Code LONG_COMMON_NAME
DataElement.contact.telecom DataElement.contact
Definition

Contact details for individual (if to assist a name was provided) or user in finding and communicating with the publisher.

Control 0..*
Type ContactPoint ContactDetail
Summary true
Comments

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

LOINC Code N/A
DataElement.date DataElement.useContext
Definition

The date this version of the data element content was published. The date must change when the business version changes, if it does, developed with a focus and it must change if the status code changes. In addition, it should change when the substantive content intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate data element changes. instances.

Control 0..1 0..*
Type dateTime UsageContext
Requirements

Assist in searching for appropriate content.

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 When multiple useContexts are specified, there is part no expectation whether all or any of the resource metadata. Additional specific dates may be added as extensions. contexts apply.

DataElement.useContext DataElement.jurisdiction
Definition

The content was developed with a focus and intent of supporting A legal or geographic region in which the contexts that are listed. These terms may be used to assist with indexing and searching of data element definitions. is intended to be used.

Control 0..*
Terminology Binding Context of Use ValueSet: Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. Jurisdiction ValueSet ( Extensible )
Type CodeableConcept
Summary true
LOINC Code Comments COMPONENT, PROPERTY, TIME_ASPCT, SYSTEM, SCALE_TYP, METHOD_TYP, CLASS, CLASSTYPE, ORDER_OBS, DOCUMENT_SECTION, HL7_ATTACHMENT_STRUCTURE

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 definition of the data element. element and/or its contents. 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 markdown
Requirements

Consumers 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: Indicates the degree of precision of the data element definition. 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
DataElement.mapping
Definition

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

Control 0..*
Invariants Defined 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.

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 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 (xpath: ( expression : base.empty(), xpath: not(exists(f:base)))
dae-2 : No slicing allowed (xpath: not(exists(f:slicing))) To Do ( expression Type should have {http://hl7.org/fhir/StructureDefinition/elementdefinition-de}. : slicing.empty(), xpath: not(exists(f:slicing)))