LOINC – IVD Test Code (LIVD) Mapping
1.0.0 - STU 1 International flag

LOINC – IVD Test Code (LIVD) Mapping, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/livd/ and changes regularly. See the Directory of published versions

Resource Profile: LIVD ObservationDefinition

Official URL: http://hl7.org/fhir/uv/livd/StructureDefinition/observationdefinition-uv-livd Version: 1.0.0
Standards status: Trial-use Active as of 2018-08-14 Maturity Level: 2 Computable Name: LIVDObservationDefinition
Other Identifiers: OID:2.16.840.1.113883.4.642.40.51.42.9

Profile on the ObservationDefinition resource for representing the analytes that can be measured by the included devices for which the test codes and applicable result values are mapped.

Description

The LIVD ObservationDefinition is a profile on the ObservationDefinition resource for representing the analytes that can be measured by the included devices for which the test codes and applicable result values are mapped.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ObservationDefinition 0..* ObservationDefinition LIVDObservationDefinition
... id Σ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ObservationDefinitionDevice S 1..* Reference(LIVDDeviceDefinition) LIVD DeviceDefinition
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-livd-devicedefinition
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... coding Σ 1..* Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
... Slices for identifier SΣ 0..* Identifier Business identifier for this ObservationDefinition instance
Slice: Unordered, Open by value:type.coding.code
.... identifier:VendorReferenceID SΣ 0..1 Identifier Business identifier for this ObservationDefinition instance
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... value Σ 1..1 string The value that is unique
Example General: 123456
... permittedDataType S 0..1 code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.

Example General: CodeableConcept
... method S 0..1 CodeableConcept Method used to produce the observation
Binding: ObservationMethods (example): Methods for simple observations.
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... unit S 0..1 CodeableConcept SI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... conversionFactor S 0..1 decimal SI unit to customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... validCodedValueSet S 0..1 Reference(ValueSet) Value set of valid coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ObservationDefinition.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​identifier:VendorReferenceID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ObservationDefinition.​identifier:VendorReferenceID.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ObservationDefinition.​permittedDataType Base required ObservationDataType 📍4.0.1 FHIR Std.
ObservationDefinition.​method Base example Observation Methods 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​customaryUnit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​unit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.category Base required ObservationRangeCategory 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.context Base extensible Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ObservationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ObservationDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ObservationDefinition 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()
dom-5 error ObservationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ObservationDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ObservationDefinition 0..* ObservationDefinition LIVDObservationDefinition
... id 1..1 id Logical id of this artifact
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ObservationDefinitionDevice S 1..* Reference(LIVDDeviceDefinition) LIVD DeviceDefinition
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-livd-devicedefinition
... category 0..0 Category of observation
.... coding 1..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
... Slices for identifier S 0..* Identifier Business identifier for this ObservationDefinition instance
Slice: Unordered, Open by value:type.coding.code
.... identifier:VendorReferenceID S 0..1 Identifier Business identifier for this ObservationDefinition instance
..... type 1..1 CodeableConcept Description of identifier
...... coding
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: LIVDVendorReferenceID
..... value 1..1 string The value that is unique
... permittedDataType S 0..1 code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
... multipleResultsAllowed 0..0 Multiple results allowed
... method S 0..1 CodeableConcept Method used to produce the observation
... preferredReportName 0..0 Preferred report name
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
.... unit S 0..1 CodeableConcept SI unit for quantitative results
.... conversionFactor S 0..1 decimal SI unit to customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... qualifiedInterval 0..0 Qualified range for continuous and ordinal observation results
... validCodedValueSet S 0..1 Reference(ValueSet) Value set of valid coded values for the observations conforming to this ObservationDefinition
... normalCodedValueSet 0..0 Value set of normal coded values for the observations conforming to this ObservationDefinition
... abnormalCodedValueSet 0..0 Value set of abnormal coded values for the observations conforming to this ObservationDefinition
... criticalCodedValueSet 0..0 Value set of critical coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ObservationDefinition 0..* ObservationDefinition LIVDObservationDefinition
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ObservationDefinitionDevice S 1..* Reference(LIVDDeviceDefinition) LIVD DeviceDefinition
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-livd-devicedefinition
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... Slices for identifier SΣ 0..* Identifier Business identifier for this ObservationDefinition instance
Slice: Unordered, Open by value:type.coding.code
.... identifier:VendorReferenceID SΣ 0..1 Identifier Business identifier for this ObservationDefinition instance
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: LIVDVendorReferenceID
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... permittedDataType S 0..1 code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.

Example General: CodeableConcept
... method S 0..1 CodeableConcept Method used to produce the observation
Binding: ObservationMethods (example): Methods for simple observations.
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... unit S 0..1 CodeableConcept SI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... conversionFactor S 0..1 decimal SI unit to customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... validCodedValueSet S 0..1 Reference(ValueSet) Value set of valid coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ObservationDefinition.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ObservationDefinition.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​identifier:VendorReferenceID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ObservationDefinition.​identifier:VendorReferenceID.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ObservationDefinition.​permittedDataType Base required ObservationDataType 📍4.0.1 FHIR Std.
ObservationDefinition.​method Base example Observation Methods 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​customaryUnit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​unit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.category Base required ObservationRangeCategory 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.context Base extensible Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ObservationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ObservationDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ObservationDefinition 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()
dom-5 error ObservationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ObservationDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 7 elements(3 nested mandatory elements)
Must-Support: 13 elements
Prohibited: 7 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ObservationDefinition.identifier

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ObservationDefinition 0..* ObservationDefinition LIVDObservationDefinition
... id Σ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ObservationDefinitionDevice S 1..* Reference(LIVDDeviceDefinition) LIVD DeviceDefinition
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-livd-devicedefinition
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... coding Σ 1..* Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
... Slices for identifier SΣ 0..* Identifier Business identifier for this ObservationDefinition instance
Slice: Unordered, Open by value:type.coding.code
.... identifier:VendorReferenceID SΣ 0..1 Identifier Business identifier for this ObservationDefinition instance
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... value Σ 1..1 string The value that is unique
Example General: 123456
... permittedDataType S 0..1 code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.

Example General: CodeableConcept
... method S 0..1 CodeableConcept Method used to produce the observation
Binding: ObservationMethods (example): Methods for simple observations.
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... unit S 0..1 CodeableConcept SI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... conversionFactor S 0..1 decimal SI unit to customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... validCodedValueSet S 0..1 Reference(ValueSet) Value set of valid coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ObservationDefinition.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​identifier:VendorReferenceID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ObservationDefinition.​identifier:VendorReferenceID.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ObservationDefinition.​permittedDataType Base required ObservationDataType 📍4.0.1 FHIR Std.
ObservationDefinition.​method Base example Observation Methods 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​customaryUnit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​unit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.category Base required ObservationRangeCategory 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.context Base extensible Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ObservationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ObservationDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ObservationDefinition 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()
dom-5 error ObservationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ObservationDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ObservationDefinition 0..* ObservationDefinition LIVDObservationDefinition
... id 1..1 id Logical id of this artifact
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ObservationDefinitionDevice S 1..* Reference(LIVDDeviceDefinition) LIVD DeviceDefinition
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-livd-devicedefinition
... category 0..0 Category of observation
.... coding 1..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
... Slices for identifier S 0..* Identifier Business identifier for this ObservationDefinition instance
Slice: Unordered, Open by value:type.coding.code
.... identifier:VendorReferenceID S 0..1 Identifier Business identifier for this ObservationDefinition instance
..... type 1..1 CodeableConcept Description of identifier
...... coding
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: LIVDVendorReferenceID
..... value 1..1 string The value that is unique
... permittedDataType S 0..1 code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
... multipleResultsAllowed 0..0 Multiple results allowed
... method S 0..1 CodeableConcept Method used to produce the observation
... preferredReportName 0..0 Preferred report name
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
.... unit S 0..1 CodeableConcept SI unit for quantitative results
.... conversionFactor S 0..1 decimal SI unit to customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... qualifiedInterval 0..0 Qualified range for continuous and ordinal observation results
... validCodedValueSet S 0..1 Reference(ValueSet) Value set of valid coded values for the observations conforming to this ObservationDefinition
... normalCodedValueSet 0..0 Value set of normal coded values for the observations conforming to this ObservationDefinition
... abnormalCodedValueSet 0..0 Value set of abnormal coded values for the observations conforming to this ObservationDefinition
... criticalCodedValueSet 0..0 Value set of critical coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ObservationDefinition 0..* ObservationDefinition LIVDObservationDefinition
... id Σ 1..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ObservationDefinitionDevice S 1..* Reference(LIVDDeviceDefinition) LIVD DeviceDefinition
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-livd-devicedefinition
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... code SΣ 1..1 CodeableConcept Type of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... Slices for identifier SΣ 0..* Identifier Business identifier for this ObservationDefinition instance
Slice: Unordered, Open by value:type.coding.code
.... identifier:VendorReferenceID SΣ 0..1 Identifier Business identifier for this ObservationDefinition instance
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 0..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: LIVDVendorReferenceID
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... permittedDataType S 0..1 code Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.

Example General: CodeableConcept
... method S 0..1 CodeableConcept Method used to produce the observation
Binding: ObservationMethods (example): Methods for simple observations.
... quantitativeDetails S 0..1 BackboneElement Characteristics of quantitative results
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... customaryUnit S 0..1 CodeableConcept Customary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... unit S 0..1 CodeableConcept SI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.
.... conversionFactor S 0..1 decimal SI unit to customary unit conversion factor
.... decimalPrecision S 0..1 integer Decimal precision of observation quantitative results
... validCodedValueSet S 0..1 Reference(ValueSet) Value set of valid coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ObservationDefinition.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ObservationDefinition.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​identifier:VendorReferenceID.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ObservationDefinition.​identifier:VendorReferenceID.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ObservationDefinition.​permittedDataType Base required ObservationDataType 📍4.0.1 FHIR Std.
ObservationDefinition.​method Base example Observation Methods 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​customaryUnit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​quantitativeDetails.​unit Base extensible UCUM Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.category Base required ObservationRangeCategory 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.context Base extensible Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
ObservationDefinition.​qualifiedInterval.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ObservationDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ObservationDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ObservationDefinition 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()
dom-5 error ObservationDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ObservationDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 7 elements(3 nested mandatory elements)
Must-Support: 13 elements
Prohibited: 7 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ObservationDefinition.identifier

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron