Supported extensions
Work in progress.
This section of the Implementation Guide is subject to change.
This extension library contains all the extensions Clinically and Technically Assurance for use with EE Base. The profiles are found in the Profiles Index. The table below lists all the current extensions and the context of use. The context of use column indicates the profile and /or element where the extension may be applied. The type column indicates whether the extension is an modifierExtension or not. The general rule is extensions can be ignored by receivers. When a modifierExtension is received it MUST NOT be ignored as it modifies the meaning of the element or elements that contains it. Typically, this means information that qualifies or negates the primary meaning of the element that contains it.
See for more information from HL7 about FHIR extensions and FHIR modifierExtensions.
EE MPI Extensions
List of used EEBase extensions:
StructureDefinition Extension-EEMPI-PatientAge
Supports the date when exact date is unknown.
Purpose
This extension extends the Patient.birthDate datatype to support the exchange of information describing the age of subject, which is currently not supported by the FHIR standard.
Extension | I | | Extension | There are no (further) constraints on this element Element idShort description Optional Extensions Element Definition Optional Extension Element - found in all resources.
Data type Extension Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type string Mappings |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idShort description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
url | | 1..1 | uriFixed Value | Element idShort description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL.
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.
Data type uri Fixed value https://hl7.ee/fhir/StructureDefinition/Extension-EEMPI-PatientAge Mappings |
value[x] | | 0..1 | | There are no (further) constraints on this element Element idShort description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings |
valueAge | | | Age | Data type Age |
id | | 0..1 | string | There are no (further) constraints on this element Element idShort description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data type string Mappings |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idExtension.value[x].extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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.
Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count()) - ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()
Mappings |
value | Σ | 1..1 | decimal | There are no (further) constraints on this element Element idShort description Numerical value (with implicit precision) Definition The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Requirements Precision is handled implicitly in almost all cases of measurement.
Comments The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Data type decimal Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Minimum value Maximum value Mappings- rim: n/a
- v2: SN.2 / CQ - N/A
- rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
|
comparator | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idExtension.value[x].comparator Short description < | <= | >= | > - how to understand the value Definition How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Requirements Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Meaning when missing If there is no comparator, then there is no modification of the value
Data type code Binding How the Quantity should be understood and represented.
QuantityComparator (required)Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: SN.1 / CQ.1
- rim: IVL properties
|
unit | Σ | 1..1 | string | There are no (further) constraints on this element Element idShort description Unit representation Definition A human-readable form of the unit.
Requirements There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Comments Note that FHIR strings SHALL NOT exceed 1MB in size
Data type string Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: (see OBX.6 etc.) / CQ.2
- rim: PQ.unit
|
system | Σ I | 0..1 | uri | There are no (further) constraints on this element Element idExtension.value[x].system Short description System that defines coded unit form Definition The identification of the system that provides the coded form of the unit.
Requirements Need to know the system that defines the coded form of the unit.
Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier
Data type uri Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: (see OBX.6 etc.) / CQ.2
- rim: CO.codeSystem, PQ.translation.codeSystem
|
code | Σ | 0..1 | code | There are no (further) constraints on this element Element idShort description Coded form of the unit Definition A computer processable form of the unit in some unit representation system.
Requirements Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Comments The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Data type code Constraints- ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Mappings- rim: n/a
- v2: (see OBX.6 etc.) / CQ.2
- rim: PQ.code, MO.currency, PQ.translation.code
|
EE Base Extensions
List of used EEBase extensions:
HL7 Common Extensions
The following HL7 extensions have been agreed as suitable to be included for use with the EE Base Profiles Index because the use case for an Extension is fully met by a pre-existing HL7 common Extension. All other HL7 common extensions may be used to extend the EE Base if required by the local implementation.