FHIR Tooling Extensions IG
0.3.0 - Release 0.2.0 International flag

This page is part of the HL7 Tools Extension IG (v0.3.0: Releases - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: Id Expectation Extension

Official URL: http://hl7.org/fhir/tools/StructureDefinition/id-expectation Version: 0.3.0
Active as of 2024-10-27 Maturity Level: 2 Computable Name: IdExpectationExt
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1.42.15

Specifies whether a particular element or resource is expected to have an id or not. Note that this can be done in a profile on the element, but it is sometimes useful to say this e.g. on an abstract element in a logical model

Context of Use

This extension may be used on the following element(s):

  • Element ID ElementDefinition
  • Element ID ElementDefinition.type

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Simple Extension of type code: Specifies whether a particular element or resource is expected to have an id or not. Note that this can be done in a profile on the element, but it is sometimes useful to say this e.g. on an abstract element in a logical model

Maturity: 2

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Whether a resource or an element should have an id
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/id-expectation"
... value[x] 1..1 code Value of extension
Binding: Id Expectation Set (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Whether a resource or an element should have an id
... id 0..1 id Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/id-expectation"

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension of type code: Specifies whether a particular element or resource is expected to have an id or not. Note that this can be done in a profile on the element, but it is sometimes useful to say this e.g. on an abstract element in a logical model

Maturity: 2

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Whether a resource or an element should have an id
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/id-expectation"
... value[x] 1..1 code Value of extension
Binding: Id Expectation Set (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Whether a resource or an element should have an id
... id 0..1 id Unique id for inter-element referencing
... extension 0..0
... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/id-expectation"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.value[x]requiredIdExpectationVS (a valid code from Id Expectation Codes)
http://hl7.org/fhir/tools/ValueSet/id-expectation
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()