LOINC – IVD Test Code (LIVD) Mapping
0.3.0 - ballot

This page is part of the Loinc/IVD Mapping FHIR IG (v0.3.0: STU 1 (FHIR R4) Ballot 2) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: LIVD ObservationDefinition

Defining URL:http://hl7.org/fhir/uv/livd/StructureDefinition/observationdefinition-uv-livd
Version:0.3.0
Name:LIVDObservationDefinition
Status:Active as of 2018-08-14
Definition:

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.

Publisher:HL7 International - Orders and Observations Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/livd/StructureDefinition/observationdefinition-uv-livd

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.

Formal Views of Profile Content

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

This structure is derived from ObservationDefinition

Summary

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

Extensions

This structure refers to these extensions:

This structure is derived from ObservationDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition 0..*ObservationDefinitionLIVDObservationDefinition
... extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-device S1..*Reference(LIVDDeviceDefinition)Extension
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device
... ext-vendorReferenceIdentifier S0..1IdentifierExtension
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
... id Σ0..1stringLogical 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
... extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-device S1..*Reference(LIVDDeviceDefinition)Extension
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device
... ext-vendorReferenceIdentifier S0..1IdentifierExtension
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
NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition 0..*ObservationDefinitionLIVDObservationDefinition
... extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-device 1..*Reference(LIVDDeviceDefinition)Extension
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device
... ext-vendorReferenceIdentifier 0..1IdentifierExtension
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-vendorReferenceIdentifier
... identifier Σ0..*IdentifierBusiness identifier for this ObservationDefinition instance
... permittedDataType 0..1codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.


... method 0..1CodeableConceptMethod used to produce the observation
Binding: ObservationMethods (example): Methods for simple observations.

... quantitativeDetails 0..1BackboneElementCharacteristics of quantitative results
.... customaryUnit 0..1CodeableConceptCustomary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.

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

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

doco Documentation for this format

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
... extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-device S1..*Reference(LIVDDeviceDefinition)Extension
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device
... ext-vendorReferenceIdentifier S0..1IdentifierExtension
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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition 0..*ObservationDefinitionLIVDObservationDefinition
... id Σ0..1stringLogical 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
... extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-device S1..*Reference(LIVDDeviceDefinition)Extension
URL: http://hl7.org/fhir/uv/livd/StructureDefinition/ext-device
... ext-vendorReferenceIdentifier S0..1IdentifierExtension
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

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
ObservationDefinition.languagepreferredCommonLanguages
Max Binding: AllLanguages
ObservationDefinition.codeexampleLOINCCodes
ObservationDefinition.permittedDataTyperequiredObservationDataType
ObservationDefinition.methodexampleObservationMethods
ObservationDefinition.quantitativeDetails.customaryUnitextensibleUCUMCodes
ObservationDefinition.quantitativeDetails.unitextensibleUCUMCodes
ObservationDefinition.qualifiedInterval.categoryrequiredObservationRangeCategory
ObservationDefinition.qualifiedInterval.contextextensibleObservationReferenceRangeMeaningCodes
ObservationDefinition.qualifiedInterval.appliesToexampleObservationReferenceRangeAppliesToCodes
ObservationDefinition.qualifiedInterval.genderrequiredAdministrativeGender

Constraints

IdPathDetailsRequirements
dom-2ObservationDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ObservationDefinitionIf 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-4ObservationDefinitionIf 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-5ObservationDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ObservationDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1ObservationDefinition.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.extension:ObservationDefinitionDeviceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.extension:ObservationDefinitionDeviceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.extension:ObservationDefinitionVendorReferenceIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.extension:ObservationDefinitionVendorReferenceIdentifierMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.permittedDataTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.quantitativeDetailsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.quantitativeDetails.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.quantitativeDetails.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.quantitativeDetails.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.quantitativeDetails.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.quantitativeDetails.customaryUnitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.quantitativeDetails.unitAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.quantitativeDetails.conversionFactorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.quantitativeDetails.decimalPrecisionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.qualifiedInterval.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.qualifiedInterval.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.qualifiedInterval.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.qualifiedInterval.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.qualifiedInterval.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.qualifiedInterval.rangeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.qualifiedInterval.contextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.qualifiedInterval.appliesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.qualifiedInterval.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.qualifiedInterval.ageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.qualifiedInterval.gestationalAgeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.qualifiedInterval.conditionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.validCodedValueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())