Structured Data Capture - Data Element Exchange 2.0 (STU2)

This page is part of the Structured Data Capture - Data Element Exchange Specification (v2.0: STU 2) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Definitions for the sdcde-dataelement Profile.

DataElement(SDCDataElement)
Definition

Sets expectations for SDC conformant systems wishing to share data elements between registries.

Control0..*
Alternate NamesMaster Observation, Data Element, CDE
Comments

Often called a clinical template.

InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
DataElement.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

DataElement.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
DataElement.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

DataElement.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

DataElement.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

DataElement.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

DataElement.extension
Definition

An Extension

Control0..*
TypeExtension
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-effective-period)
Definition

Identifies the date on which the element became (or is expected to become) active and the date on which the element became (or is expected to become) retired.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Period)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-document-reference)
Definition

Identifies a document that conveys some sort of information related to the data element.

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(DocumentReference))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-administrative-status)
Definition

Identifies internal processing status for the data element; e.g. "Under review".

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-change-description)
Definition

Summarizes changes to the data element since the previous version.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-submitter-org)
Definition

Organization responsible for submitting the data element to its registry.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(Organization))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.extension (http://hl7.org/fhir/StructureDefinition/11179-de-registry-org)
Definition

The organization that is the custodian for this data element.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(Organization))
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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.

Control1..1
Typeuri
Must Supporttrue
Requirements

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

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)
Control1..1
TypeIdentifier
Must Supporttrue
Requirements

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

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)
Control1..1
Typestring
Must Supporttrue
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
BindingThe lifecycle status of a Value Set or Concept Map.
The codes SHALL be taken from PublicationStatus
Typecode
Is Modifiertrue
Must Supporttrue
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
Must Supporttrue
Requirements

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

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
Must Supporttrue
Alternate NamesRevision Date
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.

Control1..1
Typestring
Must Supporttrue
Requirements

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

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.

Control1..1
Typestring
Must Supporttrue
Requirements

Support human navigation and code generation.

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
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.

Control1..*
TypeContactDetail
Must Supporttrue
Comments

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

LOINC CodeN/A
DataElement.contact.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.contact.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.contact.extension (http://hl7.org/fhir/StructureDefinition/11179-de-contact-address)
Definition

Postal address for a contact for the data element.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Address)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.contact.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.contact.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.contact.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/11179-de-contact-address
DataElement.contact.extension.valueAddress
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeAddress
DataElement.contact.name
Definition

The name of an individual to contact.

Control1..1
Typestring
Must Supporttrue
Comments

If there is no named individual, the telecom information is for the organization as a whole.

DataElement.contact.telecom
Definition

The contact details for the individual (if a name was provided) or the organization.

Control1..1
TypeContactPoint
Must Supporttrue
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
Must Supporttrue
Requirements

Assist in searching for appropriate content.

Comments

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

DataElement.useContext.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.useContext.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.useContext.extension (http://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context)
Definition

Identifies whether the useContext is a true context or a classification.

Control1..1 This element is affected by the following invariants: ele-1
Type (Extension Type: code)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.useContext.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.useContext.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.useContext.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/11179-de-classification-or-context
DataElement.useContext.extension.valueCode
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
BindingIdentifies whether a useContext represents a context or classification for the element
The codes SHALL be taken from ClassificationOrContext
Typecode
DataElement.useContext.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingA code that specifies a type of context being specified by a usage context
The codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable
TypeCoding
DataElement.useContext.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
BindingA code that defines the specific value for the context being specified
For example codes, see Context of Use ValueSet
TypeChoice of: CodeableConcept, Quantity, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
DataElement.jurisdiction
Definition

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

Control0..*
BindingCountries and regions within which this artifact is targeted for use
The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
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
Must Supporttrue
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.

Control1..1
BindingIndicates the degree of precision of the data element definition.
The codes SHALL be taken from DataElementStringency
Typecode
Must Supporttrue
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).

Fixed Valuecomparable
DataElement.mapping(ObjectClassPropertyMapping)
Definition

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

Control1..1 This element is affected by the following invariants: dae-3
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
1: Property extension can only be specified if ObjectClass extension is present (: extension(%ext-11179-property).exists implies extension(%ext-11179-objectClass).exists())
dae-3: At least one of name or uri SHALL be present (: uri.exists() or name.exists())
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
DataElement.mapping.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.mapping.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.mapping.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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
Must Supporttrue
Comments

The specification is described once, with general comments, and then specific mappings are made that reference this declaration.

Fixed Valueobjclass-prop
DataElement.mapping.uri
Definition

An absolute URI that identifies the specification that this mapping is expressed to.

Control1..1
Typeuri
Must Supporttrue
Comments

A formal identity for the specification being mapped to helps with identifying maps consistently.

Fixed Valuehttp://healthit.gov/sdc/objectclassproperty
DataElement.mapping.name
Definition

A name for the specification that is being mapped to.

Control0..1
Typestring
Must Supporttrue
DataElement.mapping.comment
Definition

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

Control0..1
Typestring
Must Supporttrue
DataElement.mapping(OtherMapping)
Definition

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

Control0..* This element is affected by the following invariants: dae-3
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
dae-3: At least one of name or uri SHALL be present (: uri.exists() or name.exists())
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
DataElement.mapping.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.mapping.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.mapping.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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
Must Supporttrue
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
Must Supporttrue
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
Must Supporttrue
DataElement.mapping.comment
Definition

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

Control0..1
Typestring
Must Supporttrue
DataElement.element
Definition

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

Control1..*
TypeElementDefinition
Must Supporttrue
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
2: One and only one DataElement.code must have is-data-element-concept set to "true" (: code.extension(%ext-11179-de-is-data-element-concept).count = 1)
dae-1: No base allowed (: base.empty())
dae-2: No slicing allowed (: slicing.empty())
DataElement.element.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.extension (http://hl7.org/fhir/StructureDefinition/elementdefinition-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).

Control0..* This element is affected by the following invariants: ele-1
Type (Extension Type: string)
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. The ordering is in order of preference. I.e. Most preferred question form is listed first. Note that this is for alternate phrasings of the question. Language translations are handled using the ISO 21090 string translation extensions.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/elementdefinition-question
DataElement.element.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
Typestring
DataElement.element.extension (http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits)
Definition

Identifies the units of measure in which the element should be captured or expressed.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Choice of: CodeableConcept, Reference(ValueSet))
Comments

Use a value set if more than one unit of measure is possible. Value sets will typically be short enough to display in a drop-down selection list.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits
DataElement.element.extension.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
BindingUnits of measure allowed for an element
The codes SHALL be taken from UCUM Codes
TypeChoice of: CodeableConcept, Reference(ValueSet)
[x] NoteSee Choice of Data Types for further information about how to use [x]
DataElement.element.extension (http://hl7.org/fhir/StructureDefinition/minLength)
Definition

The minimum number of characters that must be present in the simple data type to be considered a "valid" instance.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: integer)
Comments

For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/minLength
DataElement.element.extension.valueInteger
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
Typeinteger
DataElement.element.extension (http://hl7.org/fhir/StructureDefinition/regex)
Definition

A regular expression that defines the syntax for the data element to be considered valid.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/regex
DataElement.element.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
Typestring
DataElement.element.extension (http://hl7.org/fhir/StructureDefinition/entryFormat)
Definition

Additional instructions for the user to guide their input (i.e. a human readable version of a regular expression like "nnn-nnn-nnn"). In most UIs this is the placeholder (or 'ghost') text placed directly inside the edit controls and that disappear when the control gets the focus.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/entryFormat
DataElement.element.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
Typestring
DataElement.element.extension (http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces)
Definition

Identifies the maximum number of decimal places that may be specified for the data element.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: integer)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
DataElement.element.extension.valueInteger
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
Typeinteger
DataElement.element.path
Definition

The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.

Control1..1
Typestring
Must Supporttrue
DataElement.element.representation
Definition

Codes that define how this element is represented in instances, when the deviation varies from the normal case.

Control0..*
BindingHow a property is represented when serialized.
The codes SHALL be taken from PropertyRepresentation
Typecode
Comments

In resources, this is rarely used except for special cases where the representation deviates from the normal, and can only be done in the base standard (and profiles must reproduce what the base standard does). This element is used quite commonly in Logical models when the logical models represent a specific serialization format (e.g. CDA, v2 etc).

DataElement.element.sliceName
Definition

The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element.

Control0..0
Typestring
Requirements

May also be used for code generation purposes.

Comments

The name SHALL be unique within the structure within the context of the constrained resource element. (Though to avoid confusion, uniqueness across all elements is recommended.).

DataElement.element.label
Definition

A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.

Control0..1
Typestring
Must Supporttrue
Comments

See also the extension (http://hl7.org/fhir/StructureDefinition/elementdefinition-question)[extension-elementdefinition-question.html].

DataElement.element.code
Definition

A code that has the same meaning as the element in a particular terminology.

Control0..*
BindingCodes representing the data element concept for a data element
The codes SHALL be taken from DataElement SDC Concept; other codes may be used where these codes are not suitable
TypeCoding
Must Supporttrue
Requirements

Links the meaning of an element to an external terminology, and is very useful for searching and indexing.

Comments

The concept SHALL be properly aligned with the data element definition and other constraints, 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. The mappings may be used to provide more or less granular or structured equivalences in the code system.

LOINC CodeLOINC_NUM
DataElement.element.code.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.code.extension (http://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept)
Definition

If true, indicates that the specified coding corresponds to the data element concept for the data element.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: boolean)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.code.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.code.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.code.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/11179-de-is-data-element-concept
DataElement.element.code.extension.valueBoolean
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
Typeboolean
DataElement.element.code.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

DataElement.element.code.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

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

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

DataElement.element.code.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1
Typecode
Requirements

Need to refer to a particular code in the system.

DataElement.element.code.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

DataElement.element.code.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

DataElement.element.slicing
Definition

Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).

Control0..0
TypeElement
Comments

The first element in the sequence, the one that carries the slicing, is the definition that applies to all the slices. This is based on the unconstrained element, but can apply any constraints as appropriate. This may include the common constraints on the children of the element.

InvariantsDefined on this element
eld-1: If there are no discriminators, there must be a definition (: discriminator.exists() or description.exists())
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
DataElement.element.slicing.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.slicing.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.slicing.discriminator
Definition

Designates which child elements are used to discriminate between the slices when processing an instance. If one or more discriminators are provided, the value of the child elements in the instance data SHALL completely distinguish which slice the element in the resource matches based on the allowed values for those elements in each of the slices.

Control0..*
TypeElement
Comments

If there is no discriminator, the content is hard to process, so this should be avoided. If the base element has a cardinality of ..1, and there is a choice of types, the discriminator must be "@type".

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
DataElement.element.slicing.discriminator.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.slicing.discriminator.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.slicing.discriminator.type
Definition

How the element value is interpreted when discrimination is evaluated.

Control1..1
BindingHow an element value is interpreted when discrimination is evaluated
The codes SHALL be taken from DiscriminatorType
Typecode
DataElement.element.slicing.discriminator.path
Definition

A FHIRPath expression, using a restricted subset of FHIRPath, that is used to identify the element on which discrimination is based.

Control1..1
Typestring
Comments

The only FHIRPath functions that are allowed are resolve(), and extension(url).

DataElement.element.slicing.description
Definition

A human-readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated.

Control0..1 This element is affected by the following invariants: eld-1
Typestring
Comments

If it's really not possible to differentiate them, the design should be re-evaluated to make the content usable.

DataElement.element.slicing.ordered
Definition

If the matching elements have to occur in the same order as defined in the profile.

Control0..1
Typeboolean
Comments

Order should only be required when it is a pressing concern for presentation. Profile authors should consider making the order a feature of the rules about the narrative, not the rules about the data - requiring ordered data makes the profile much less re-usable.

Default Valuefalse
DataElement.element.slicing.rules
Definition

Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.

Control1..1
BindingHow slices are interpreted when evaluating an instance.
The codes SHALL be taken from SlicingRules
Typecode
Comments

Allowing additional elements makes for a much for flexible template - it's open for use in wider contexts, but also means that the content of the resource is not closed, and applications have to decide how to handle content not described by the profile.

DataElement.element.short
Definition

A concise description of what this element means (e.g. for use in autogenerated summaries).

Control0..1
Typestring
Comments

May change the term to provide language more appropriate to the context of the profile or to reflect slicing.

DataElement.element.definition
Definition

Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.

Control1..1
Typemarkdown
Must Supporttrue
Requirements

To allow a user to state the usage of an element in a particular context.

Alternate NamesDescription
Comments

It is easy for a different definition to change the meaning of an element and this can have nasty downstream consequences. Please be careful when providing definitions.

LOINC CodeTERM DEFINITION/DESCRIPTION(S)
DataElement.element.comment
Definition

Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc.

Control0..1
Typemarkdown
Must Supporttrue
Comments

If it is possible to capture usage rules using constraints, that mechanism should be used in preference to this element.

LOINC CodeCOMMENTS
DataElement.element.requirements
Definition

This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.

Control0..1
Typemarkdown
Must Supporttrue
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.

LOINC CodeR/O/C
DataElement.element.alias
Definition

Identifies additional names by which this element might also be known.

Control0..*
Typestring
Must Supporttrue
Requirements

Allows for better easier recognition of the element by multiple communities, including international communities.

Alternate Namessynonym, other name
LOINC CodeRELATED NAMES (only some of these apply)
DataElement.element.min
Definition

The minimum number of times this element SHALL appear in the instance.

Control0..1 This element is affected by the following invariants: eld-2
TypeunsignedInt
Must Supporttrue
DataElement.element.max
Definition

The maximum number of times this element is permitted to appear in the instance.

Control0..1 This element is affected by the following invariants: eld-3, eld-2
Typestring
Must Supporttrue
InvariantsDefined on this element
eld-3: Max SHALL be a number or "*" (: empty() or ($this = '*') or (toInteger() >= 0))
DataElement.element.base
Definition

Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. This information is provided when the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot.

Control0..0
TypeElement
Comments

The base information does not carry any information that could not be determined from the path and related profiles, but making this determination requires both that the related profiles are available, and that the algorithm to determine them be available. So they are deformalised into this location for tooling convenience, and to ensure that the base information is available without dependencies.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
DataElement.element.base.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.base.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.base.path
Definition

The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a StructureDefinition without a StructureDefinition.base.

Control1..1
Typestring
DataElement.element.base.min
Definition

Minimum cardinality of the base element identified by the path.

Control1..1
TypeunsignedInt
Comments

This is provided for consistency with max, and may affect code generation of mandatory elements of the base resource are generated differently (some reference implementations have done this).

DataElement.element.base.max
Definition

Maximum cardinality of the base element identified by the path.

Control1..1
Typestring
Comments

This is provided to code generation, since the serialization representation in JSON differs depending on whether the base element has max > 1. Also, some forms of code generation may differ.

DataElement.element.contentReference
Definition

Identifies the identity of an element defined elsewhere in the profile whose content rules should be applied to the current element.

Control0..0 This element is affected by the following invariants: eld-5
Typeuri
DataElement.element.type
Definition

The data type or resource that the value of this element is permitted to be.

Control0..1 This element is affected by the following invariants: eld-13
TypeElement
Must Supporttrue
Comments

The Type of the element can be left blank in a differential constraint, in which case the type is inherited from the resource. Abstract types are not permitted to appear as a type when multiple types are listed. (I.e. Abstract types cannot be part of a choice).

InvariantsDefined on this element
eld-4: Aggregation may only be specified if one of the allowed types for the element is a resource (: aggregation.empty() or (code = 'Reference'))
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
LOINC CodeHL7_V2_DATATYPE (translation required), HL7_V3_DATATYPE (translation required)
DataElement.element.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.type.code
Definition

URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.

Control1..1
Typeuri
Must Supporttrue
Comments

If the element is a reference to another resource, this element contains "Reference", and the targetProfile element defines what resources can be referenced. The targetProfile may be a reference to the general definition of a resource (e.g. http://hl7.org/fhir/StructureDefinition/Patient). There would be one pair of type/code for each allowed target resource type.

LOINC CodeHL7_V2_DATATYPE (translation required), HL7_V3_DATATYPE (translation required)
DataElement.element.type.profile
Definition

Identifies a profile structure or implementation Guide that SHALL hold for the datatype this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.

Control0..1
Typeuri
DataElement.element.type.targetProfile
Definition

Identifies a profile structure or implementation Guide that SHALL hold for the target of the reference this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.

Control0..1
Typeuri
DataElement.element.type.aggregation
Definition

If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.

Control0..* This element is affected by the following invariants: eld-4
BindingHow resource references can be aggregated.
The codes SHALL be taken from AggregationMode
Typecode
DataElement.element.type.versioning
Definition

Whether this reference needs to be version specific or version independent, or whether either can be used.

Control0..1
BindingWhether a reference needs to be version specific or version independent, or whether either can be used
The codes SHALL be taken from ReferenceVersionRules
Typecode
Comments

The base specification never makes a rule as to which form is allowed, but implementation guides may do this.

Default Valueeither
DataElement.element.defaultValue[x]
Definition

The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').

Control0..1 This element is affected by the following invariants: eld-15
TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Default values can only be specified on a resource, data type, or extension definition, and never in a profile that applies to one of these. Specifying a default value means that the property can never been unknown - it must always have a value. Further, the default value can never be changed. For these reasons, default values are (and should be) used extremely sparingly.

DataElement.element.meaningWhenMissing
Definition

The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing'.

Control0..1 This element is affected by the following invariants: eld-15
Typemarkdown
Comments

Implicit meanings for missing values can only be specified on a resource, data type, or extension definition, and never in a profile that applies to one of these. An implicit meaning for a missing value can never be changed, and specifying one has the consequence that constraining its use in profiles eliminates use cases as possibilities, not merely moving them out of scope.

DataElement.element.orderMeaning
Definition

If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning.

Control0..1
Typestring
Comments

This element can only be asserted on repeating elements and can only be introduced when defining resources or data types. It can be further refined profiled elements but if absent in the base type, a profile cannot assert meaning.

DataElement.element.fixed[x]
Definition

Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.

Control0..0 This element is affected by the following invariants: eld-5, eld-6, eld-8
TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

This is not recommended for Coding and CodeableConcept since these often have highly contextual properties such as version or display.

DataElement.element.pattern[x]
Definition

Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).

Control0..0 This element is affected by the following invariants: eld-5, eld-7, eld-8
TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Mostly used for fixing values of CodeableConcept. At present, pattern[x] is not recommended as a basis for slicing while issues related to this are investigated during the STU period.

DataElement.element.example
Definition

A sample value for this element demonstrating the type of information that would typically be found in the element.

Control0..*
TypeElement
Must Supporttrue
Comments

Examples 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.) If the example value is fully populated, the publication tool can generate an instance automatically.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
DataElement.element.example.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.example.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.example.label
Definition

Describes the purpose of this example amoung the set of examples.

Control1..1
Typestring
Must Supporttrue
DataElement.element.example.value[x]
Definition

The actual value for the element, which must be one of the types allowed for this element.

Control1..1
TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
LOINC CodeEXMPL_ANSWERS
DataElement.element.minValue[x]
Definition

The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.

Control0..1
TypeChoice of: date, dateTime, instant, time, decimal, integer, positiveInt, unsignedInt, Quantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Comments

Except for date/date/instant, the type of the minValue[x] SHALL be the same as the specified type of the element. For the date/dateTime/instant values, the type of minValue[x] SHALL be either the same, or a a Duration which specifies a relative time limit to the current time. The duration value is positive, and is subtracted from the current clock to determine the minimum allowable value. A minimum value for a Quantity is interpreted as an canonical minimum - e.g. you cannot provide 100mg if the minimum value is 10g.

DataElement.element.maxValue[x](l)
Definition

The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.

Control0..1
TypeChoice of: date, dateTime, instant, time, decimal, integer, positiveInt, unsignedInt, Quantity
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Comments

Except for date/date/instant, the type of the maxValue[x] SHALL be the same as the specified type of the element. For the date/dateTime/instant values, the type of maxValue[x] SHALL be either the same, or a a Duration which specifies a relative time limit to the current time. The duration value is positive, and is added to the current clock to determine the maximum allowable value. A maximum value for a Quantity is interpreted as an canonical maximum - e.g. you cannot provide 10g if the maximum value is 50mg.

DataElement.element.maxLength
Definition

Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element.

Control0..1
Typeinteger
Must Supporttrue
Comments

Receivers are not required to reject instances that exceed the maximum length. The full length could be stored. In some cases, data might be truncated, though truncation should be undertaken with care and an understanding of the consequences of doing so. If not specified, there is no conformance expectation for length support.

DataElement.element.condition
Definition

A reference to an invariant that may make additional statements about the cardinality or value in the instance.

Control0..*
Typeid
Must Supporttrue
DataElement.element.constraint
Definition

Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.

Control0..*
TypeElement
Must Supporttrue
Comments

Constraints should be declared on the "context" element - the lowest element in the hierarchy that is common to all nodes referenced by the constraint.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
DataElement.element.constraint.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.constraint.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.constraint.key
Definition

Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.

Control1..1 This element is affected by the following invariants: eld-14
Typeid
Must Supporttrue
DataElement.element.constraint.requirements
Definition

Description of why this constraint is necessary or appropriate.

Control0..1
Typestring
Must Supporttrue
Comments

To be used if the reason for the constraint may not be intuitive to all implementers.

DataElement.element.constraint.severity
Definition

Identifies the impact constraint violation has on the conformance of the instance.

Control1..1
BindingSHALL applications comply with this constraint?
The codes SHALL be taken from ConstraintSeverity
Typecode
Must Supporttrue
Comments

This allows constraints to be asserted as "shall" (error) and "should" (warning).

DataElement.element.constraint.human
Definition

Text that can be used to describe the constraint in messages identifying that the constraint has been violated.

Control1..1
Typestring
Must Supporttrue
Comments

Should be expressed in business terms as much as possible.

DataElement.element.constraint.expression
Definition

A FHIRPath expression of constraint that can be executed to see if this constraint is met.

Control1..1
Typestring
Must Supporttrue
Requirements

Used by validation tooling tests of the validity of the resource.

DataElement.element.constraint.xpath
Definition

An XPath expression of constraint that can be executed to see if this constraint is met.

Control0..1
Typestring
Must Supporttrue
Requirements

Used in Schematron tests of the validity of the resource.

Comments

Elements SHALL use "f" as the namespace prefix for the FHIR namespace, and "x" for the xhtml namespace, and SHALL NOT use any other prefixes.

Note: we are considering deprecating the xpath element. Implementer feedback is welcome.

DataElement.element.constraint.source
Definition

A reference to the original source of the constraint, for traceability purposes.

Control0..1
Typeuri
Comments

This is used when, e.g. rendering, where it is not useful to present inherited constraints when rendering the snapshot.

DataElement.element.mustSupport
Definition

If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way. If false, the element may be ignored and not supported.

Control0..0
Typeboolean
Requirements

Allows a profile to set expectations for system capabilities beyond merely respecting cardinality constraints.

Comments

"Something useful" is context dependent and impossible to describe in the base FHIR specification. For this reason, tue mustSupport flag is never set to true by the FHIR specification itself - it is only set to true in profiles.

This is done in Resource Profiles, where the profile labels an element as mustSupport=true. When a profile does this, it SHALL also make clear exactly what kind of "support" is required, as this can mean many things.

Note that an element that has the property IsModifier is not necessarily a "key" element (e.g. one of the important elements to make use of the resource), nor is it automatically mustSupport - however both of these things are more likely to be true for IsModifier elements than for other elements.

Default Valuefalse
DataElement.element.isModifier
Definition

If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.

Control0..1
Typeboolean
Requirements

Allows elements to be introduced into a specification that can't safely be ignored by applications that don't recognize them.

Comments

Only the definition of an element can set IsModifier true - either the specification itself or where an extension is originally defined. Once set, it cannot be changed in derived profiles. An element/extension that has isModifier=true SHOULD also have a minimum cardinality of 1, so that there is no lack of clarity about what to do if it is missing. If it can be missing, the definition SHALL make the meaning of a missing element clear.

Default Valuefalse
DataElement.element.isSummary
Definition

Whether the element should be included if a client requests a search with the parameter _summary=true.

Control0..1
Typeboolean
Requirements

Allow clients to search through large resources quickly.

Comments

Some resources include a set of simple metadata, and some very large data. This element is used to reduce the quantity of data returned in searches. Note that servers may pre-cache summarized resources for optimal performance, so servers may not support per-profile use of the isSummary flag. When a request is made with _summary=true, serailisers only include elements marked as 'isSummary = true'. Other than Attachment.data, all data type properties are included in the summary form. Modifier elements or elements with minimum cardinality = 1 must be marked as summary elements.

Default Valuefalse
DataElement.element.binding
Definition

Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).

Control0..1 This element is affected by the following invariants: eld-11
TypeElement
Must Supporttrue
Comments

For a CodeableConcept, when no codes are allowed - only text, use a binding of strength "required" with a description explaining that no coded values are allowed and what sort of information to put in the "text" element.

InvariantsDefined on this element
eld-10: provide either a reference or a description (or both) (: valueSet.exists() or description.exists())
eld-12: ValueSet as a URI SHALL start with http:// or https:// or urn: (: valueSet.is(uri).not() or valueSet.as(uri).startsWith('http:') or valueSet.as(uri).startsWith('https') or valueSet.as(uri).startsWith('urn:'))
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
LOINC CodeANSWER LIST, NORMATIVE ANSWER LIST
DataElement.element.binding.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.binding.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.binding.strength
Definition

Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.

Control1..1
BindingIndication of the degree of conformance expectations associated with a binding.
The codes SHALL be taken from BindingStrength
Typecode
Must Supporttrue
Alternate Namesconformance, extensibility
Comments

For further discussion, see Using Terminologies.

LOINC CodeN/A
DataElement.element.binding.description
Definition

Describes the intended use of this particular set of codes.

Control0..1 This element is affected by the following invariants: eld-10
Typestring
Must Supporttrue
DataElement.element.binding.valueSetReference
Definition

Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. If the binding refers to an explicit value set - the normal case - then use a Reference(ValueSet) preferably containing the canonical URL for the value set. If the reference is to an implicit value set - usually, an IETF RFC that defines a grammar, such as mime types - then use a uri.

Control1..1 This element is affected by the following invariants: eld-10, eld-12
TypeReference(Structured Data Capture Data Element Exchange Value Set)
Must Supporttrue
Comments

For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.

InvariantsDefined on this element
3: Must have data element permitted value concept map extension if and only if data element permitted value valueset extension is present (: extension(%ext-11179-permitted-value-valueset).count() = extension(%ext-11179-permitted-value-conceptmap).count())
LOINC CodeCODE_TABLE
DataElement.element.binding.valueSetReference.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.binding.valueSetReference.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.binding.valueSetReference.extension (http://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset)
Definition

Allows expressing the value set that must be stored internally by the system (as distinct from the base value set which defines values for exchange).

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(ValueSet))
Comments

The permitted value set must have a 1..1 set of codes for each code in the value meaning value set.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.binding.valueSetReference.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.binding.valueSetReference.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.binding.valueSetReference.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/11179-permitted-value-valueset
DataElement.element.binding.valueSetReference.extension.valueReference
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeReference(ValueSet)
DataElement.element.binding.valueSetReference.extension (http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap)
Definition

Expresses the linkage between the internal codes used for storage and the codes used for exchange.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Reference(ConceptMap))
Comments

The permitted value set must have a 1..1 set of codes for each code in the value meaning value set. The source for the concept map is the value set the extension appears on. The target is the permitted-value-valueset.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.binding.valueSetReference.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.binding.valueSetReference.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.binding.valueSetReference.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap
DataElement.element.binding.valueSetReference.extension.valueReference
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
TypeReference(ConceptMap)
DataElement.element.binding.valueSetReference.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control0..1 This element is affected by the following invariants: ref-1
Typestring
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

DataElement.element.binding.valueSetReference.identifier
Definition

An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

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

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

DataElement.element.binding.valueSetReference.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

DataElement.element.mapping(ClassPropertyMapping)
Definition

A mapping that defines the data element in terms of the SDC project's ObjectClass and Property value sets.

Control0..1
TypeElement
Must Supporttrue
Requirements

Provides guidance to implementers familiar with or converting content from other specifications.

Comments

Mappings are not necessarily specific enough for safe translation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
DataElement.element.mapping.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.mapping.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.mapping.extension (http://hl7.org/fhir/StructureDefinition/11179-objectClass)
Definition

A concept that represents a set of ideas, abstractions, or things in the real world that can be identified with explicit boundaries and meaning and whose properties and behavior follow the same rules. It may be either a single concept or a group of associated concepts, abstractions, or things.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Coding)
Comments

ObjectClass and Property are treated as a data model that can be mapped to, like any other. This extension merely captures the ObjectClass element as a discrete code. The information conveyed here should also be conveyed in human-readable form in the mapping.map element.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.mapping.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.mapping.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.mapping.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/11179-objectClass
DataElement.element.mapping.extension.valueCoding
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
BindingCodes representing the ISO 11179 Object Class for a data element
The codes SHALL be taken from DataElement SDC Concept; other codes may be used where these codes are not suitable
TypeCoding
Must Supporttrue
DataElement.element.mapping.extension (http://hl7.org/fhir/StructureDefinition/11179-objectClassProperty)
Definition

A quality common to all members of an object class. A property may be any feature that humans naturally use to distinguish one individual object from another. It is the human perception of a single quality of an object class in the real world. It is conceptual and thus has no particular associated means of representation by which the property can be communicated.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: Coding)
Comments

ObjectClass and Property are treated as a data model that can be mapped to like any other. This extension merely captures the Property element as a discrete code. The information conveyed here should also be conveyed in human-readable form in the mapping.map element.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.mapping.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.mapping.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.mapping.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/11179-objectClassProperty
DataElement.element.mapping.extension.valueCoding
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
BindingCodes representing the ISO 11179 Object Class Property for a data element
The codes SHALL be taken from DataElement SDC Concept; other codes may be used where these codes are not suitable
TypeCoding
Must Supporttrue
DataElement.element.mapping.identity
Definition

An internal reference to the definition of a mapping.

Control1..1
Typeid
Must Supporttrue
Fixed Valueobjclass-prop
DataElement.element.mapping.language
Definition

Identifies the computable language in which mapping.map is expressed.

Control0..1
BindingThe mime type of an attachment. Any valid mime type is allowed.
The codes SHALL be taken from http://www.rfc-editor.org/bcp/bcp13.txt
Typecode
Comments

If omitted, then there can be no expectation of computational interpretation of the mapping.

DataElement.element.mapping.map
Definition

This should be expressed as "[uri for object class code system]#[code for object class code system] | [uri for property code system]#[code for property code system]".

Control1..1
Typestring
Must Supporttrue
Comments

We express the mapping even though the class and property extensions already convey the data to ensure that systems that don't recognize the extensions still understand the mappings.

DataElement.element.mapping.comment
Definition

Comments that provide information about the mapping or its use.

Control0..1
Typestring
DataElement.element.mapping(OtherElementMapping)
Definition

Identifies a concept from an external specification that roughly corresponds to this element.

Control0..*
TypeElement
Must Supporttrue
Requirements

Provides guidance to implementers familiar with or converting content from other specifications.

Comments

Mappings are not necessarily specific enough for safe translation.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
DataElement.element.mapping.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.mapping.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.mapping.extension (http://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence)
Definition

The level of equivalence between the element containing the mapping and the element mapped to.

Control0..1 This element is affected by the following invariants: ele-1
Type (Extension Type: code)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
DataElement.element.mapping.extension.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
DataElement.element.mapping.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

DataElement.element.mapping.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/elementdefinition-equivalence
DataElement.element.mapping.extension.valueCode
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..1
BindingThe degree of equivalence between concepts.
The codes SHALL be taken from ConceptMapEquivalence
Typecode
DataElement.element.mapping.identity
Definition

An internal reference to the definition of a mapping.

Control1..1
Typeid
Must Supporttrue
DataElement.element.mapping.language
Definition

Identifies the computable language in which mapping.map is expressed.

Control0..1
BindingThe mime type of an attachment. Any valid mime type is allowed.
The codes SHALL be taken from http://www.rfc-editor.org/bcp/bcp13.txt
Typecode
Must Supporttrue
Comments

The most common languages will be application/sparql-results+xml, application/sql and application/xquery.

DataElement.element.mapping.map
Definition

Expresses what part of the target specification corresponds to this element.

Control1..1
Typestring
Must Supporttrue
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.

DataElement.element.mapping.comment
Definition

Comments that provide information about the mapping or its use.

Control0..1
Typestring