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

This page is part of the Loinc/IVD Mapping FHIR IG (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, 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-ballot
Active as of 2018-08-14 Computable Name: LIVDObservationDefinition

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.

Usage:

Formal Views of Profile Content

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

This structure is derived from ObservationDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition 0..*ObservationDefinitionLIVDObservationDefinition
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ObservationDefinitionDevice S1..*Reference(LIVDDeviceDefinition)LIVD Device
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device
... ObservationDefinitionVendorReferenceIdentifier S0..1IdentifierLIVD Vendor Reference Identifier
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-vendorReferenceIdentifier
... code S1..1CodeableConceptType of observation (code / type)
... identifier S0..*IdentifierBusiness identifier for this ObservationDefinition instance
... permittedDataType S0..1codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
... multipleResultsAllowed 0..0
... method S0..1CodeableConceptMethod used to produce the observation
... preferredReportName 0..0
... quantitativeDetails S0..1BackboneElementCharacteristics of quantitative results
.... customaryUnit S0..1CodeableConceptCustomary unit for quantitative results
.... unit S0..1CodeableConceptSI unit for quantitative results
.... conversionFactor S0..1decimalSI unit to customary unit conversion factor
.... decimalPrecision S0..1integerDecimal precision of observation quantitative results
... qualifiedInterval 0..0
... validCodedValueSet S0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition
... normalCodedValueSet 0..0
... abnormalCodedValueSet 0..0
... criticalCodedValueSet 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition 0..*ObservationDefinitionLIVDObservationDefinition
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ObservationDefinitionDevice S1..*Reference(LIVDDeviceDefinition)LIVD Device
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... identifier SΣ0..*IdentifierBusiness identifier for this ObservationDefinition instance
... permittedDataType S0..1codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.



Example General: CodeableConcept
... method S0..1CodeableConceptMethod used to produce the observation
Binding: ObservationMethods (example): Methods for simple observations.

... quantitativeDetails S0..1BackboneElementCharacteristics of quantitative results
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... customaryUnit S0..1CodeableConceptCustomary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.

.... unit S0..1CodeableConceptSI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.

.... conversionFactor S0..1decimalSI unit to customary unit conversion factor
.... decimalPrecision S0..1integerDecimal precision of observation quantitative results
... validCodedValueSet S0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ObservationDefinition.codeexampleLOINCCodes (a valid code from LOINC)
ObservationDefinition.permittedDataTyperequiredObservationDataType
ObservationDefinition.methodexampleObservationMethods
ObservationDefinition.quantitativeDetails.customaryUnitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.quantitativeDetails.unitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.qualifiedInterval.categoryrequiredObservationRangeCategory
ObservationDefinition.qualifiedInterval.contextextensibleObservationReferenceRangeMeaningCodes
ObservationDefinition.qualifiedInterval.appliesToexampleObservationReferenceRangeAppliesToCodes
ObservationDefinition.qualifiedInterval.genderrequiredAdministrativeGender

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationDefinitionIf 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-4errorObservationDefinitionIf 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-5errorObservationDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition 0..*ObservationDefinitionLIVDObservationDefinition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ObservationDefinitionDevice S1..*Reference(LIVDDeviceDefinition)LIVD Device
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device
... ObservationDefinitionVendorReferenceIdentifier S0..1IdentifierLIVD Vendor Reference Identifier
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-vendorReferenceIdentifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... identifier SΣ0..*IdentifierBusiness identifier for this ObservationDefinition instance
... permittedDataType S0..1codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.



Example General: CodeableConcept
... method S0..1CodeableConceptMethod used to produce the observation
Binding: ObservationMethods (example): Methods for simple observations.

... quantitativeDetails S0..1BackboneElementCharacteristics of quantitative results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... customaryUnit S0..1CodeableConceptCustomary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.

.... unit S0..1CodeableConceptSI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.

.... conversionFactor S0..1decimalSI unit to customary unit conversion factor
.... decimalPrecision S0..1integerDecimal precision of observation quantitative results
... validCodedValueSet S0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ObservationDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ObservationDefinition.codeexampleLOINCCodes (a valid code from LOINC)
ObservationDefinition.permittedDataTyperequiredObservationDataType
ObservationDefinition.methodexampleObservationMethods
ObservationDefinition.quantitativeDetails.customaryUnitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.quantitativeDetails.unitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.qualifiedInterval.categoryrequiredObservationRangeCategory
ObservationDefinition.qualifiedInterval.contextextensibleObservationReferenceRangeMeaningCodes
ObservationDefinition.qualifiedInterval.appliesToexampleObservationReferenceRangeAppliesToCodes
ObservationDefinition.qualifiedInterval.genderrequiredAdministrativeGender

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationDefinitionIf 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-4errorObservationDefinitionIf 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-5errorObservationDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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()

This structure is derived from ObservationDefinition

Summary

Mandatory: 2 elements
Must-Support: 13 elements
Prohibited: 7 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from ObservationDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition 0..*ObservationDefinitionLIVDObservationDefinition
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ObservationDefinitionDevice S1..*Reference(LIVDDeviceDefinition)LIVD Device
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device
... ObservationDefinitionVendorReferenceIdentifier S0..1IdentifierLIVD Vendor Reference Identifier
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-vendorReferenceIdentifier
... code S1..1CodeableConceptType of observation (code / type)
... identifier S0..*IdentifierBusiness identifier for this ObservationDefinition instance
... permittedDataType S0..1codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
... multipleResultsAllowed 0..0
... method S0..1CodeableConceptMethod used to produce the observation
... preferredReportName 0..0
... quantitativeDetails S0..1BackboneElementCharacteristics of quantitative results
.... customaryUnit S0..1CodeableConceptCustomary unit for quantitative results
.... unit S0..1CodeableConceptSI unit for quantitative results
.... conversionFactor S0..1decimalSI unit to customary unit conversion factor
.... decimalPrecision S0..1integerDecimal precision of observation quantitative results
... qualifiedInterval 0..0
... validCodedValueSet S0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition
... normalCodedValueSet 0..0
... abnormalCodedValueSet 0..0
... criticalCodedValueSet 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition 0..*ObservationDefinitionLIVDObservationDefinition
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ObservationDefinitionDevice S1..*Reference(LIVDDeviceDefinition)LIVD Device
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... identifier SΣ0..*IdentifierBusiness identifier for this ObservationDefinition instance
... permittedDataType S0..1codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.



Example General: CodeableConcept
... method S0..1CodeableConceptMethod used to produce the observation
Binding: ObservationMethods (example): Methods for simple observations.

... quantitativeDetails S0..1BackboneElementCharacteristics of quantitative results
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... customaryUnit S0..1CodeableConceptCustomary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.

.... unit S0..1CodeableConceptSI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.

.... conversionFactor S0..1decimalSI unit to customary unit conversion factor
.... decimalPrecision S0..1integerDecimal precision of observation quantitative results
... validCodedValueSet S0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ObservationDefinition.codeexampleLOINCCodes (a valid code from LOINC)
ObservationDefinition.permittedDataTyperequiredObservationDataType
ObservationDefinition.methodexampleObservationMethods
ObservationDefinition.quantitativeDetails.customaryUnitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.quantitativeDetails.unitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.qualifiedInterval.categoryrequiredObservationRangeCategory
ObservationDefinition.qualifiedInterval.contextextensibleObservationReferenceRangeMeaningCodes
ObservationDefinition.qualifiedInterval.appliesToexampleObservationReferenceRangeAppliesToCodes
ObservationDefinition.qualifiedInterval.genderrequiredAdministrativeGender

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationDefinitionIf 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-4errorObservationDefinitionIf 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-5errorObservationDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition 0..*ObservationDefinitionLIVDObservationDefinition
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ObservationDefinitionDevice S1..*Reference(LIVDDeviceDefinition)LIVD Device
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device
... ObservationDefinitionVendorReferenceIdentifier S0..1IdentifierLIVD Vendor Reference Identifier
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-vendorReferenceIdentifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code SΣ1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... identifier SΣ0..*IdentifierBusiness identifier for this ObservationDefinition instance
... permittedDataType S0..1codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.



Example General: CodeableConcept
... method S0..1CodeableConceptMethod used to produce the observation
Binding: ObservationMethods (example): Methods for simple observations.

... quantitativeDetails S0..1BackboneElementCharacteristics of quantitative results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... customaryUnit S0..1CodeableConceptCustomary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.

.... unit S0..1CodeableConceptSI unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.

.... conversionFactor S0..1decimalSI unit to customary unit conversion factor
.... decimalPrecision S0..1integerDecimal precision of observation quantitative results
... validCodedValueSet S0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ObservationDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ObservationDefinition.codeexampleLOINCCodes (a valid code from LOINC)
ObservationDefinition.permittedDataTyperequiredObservationDataType
ObservationDefinition.methodexampleObservationMethods
ObservationDefinition.quantitativeDetails.customaryUnitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.quantitativeDetails.unitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.qualifiedInterval.categoryrequiredObservationRangeCategory
ObservationDefinition.qualifiedInterval.contextextensibleObservationReferenceRangeMeaningCodes
ObservationDefinition.qualifiedInterval.appliesToexampleObservationReferenceRangeAppliesToCodes
ObservationDefinition.qualifiedInterval.genderrequiredAdministrativeGender

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationDefinitionIf 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-4errorObservationDefinitionIf 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-5errorObservationDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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()

This structure is derived from ObservationDefinition

Summary

Mandatory: 2 elements
Must-Support: 13 elements
Prohibited: 7 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron