Order Catalog Implementation Guide
0.1.0 - STU Ballot 1

This page is part of the Order Catalog Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: LabObservationDefinition

This profile constrains the base resource ObservationDefinition when referenced by ActivityDefinition.observationResultRequirement in the context of a catalog of laboratory services. Such a resource specifies the form of an output observation produced by a laboratory service.

The official URL for this profile is: 

http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabObservationDefinition

Formal Views of Profile Content

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

This structure is derived from ObservationDefinition

Summary

Must-Support: 3 elements
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element ObservationDefinition.code.coding is sliced based on the value of value:system

This structure is derived from ObservationDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition 0..*ObservationDefinitionDefinition of an observation
... code
.... coding 0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LOINC 0..1CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
... permittedDataType 0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
... multipleResultsAllowed S0..1booleanMultiple results allowed
.... unit S0..1CodeableConceptSI unit for quantitative results
..... coding 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://unitsofmeasure.org
... validCodedValueSet 0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition I0..*ObservationDefinitionDefinition of an observation
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... category ΣI0..*CodeableConceptCategory of observation
Binding: ObservationCategoryCodes (example)
... code ΣI1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LOINC ΣI0..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... identifier ΣI0..*IdentifierBusiness identifier for this ObservationDefinition instance
... permittedDataType I0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required)

Example General: CodeableConcept
... multipleResultsAllowed SI0..1booleanMultiple results allowed
Example General: true
... method I0..1CodeableConceptMethod used to produce the observation
Binding: ObservationMethods (example)
... preferredReportName I0..1stringPreferred report name
... quantitativeDetails SI0..1BackboneElementCharacteristics of quantitative results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... customaryUnit I0..1CodeableConceptCustomary unit for quantitative results
Binding: UCUMCodes (extensible)
.... unit SI0..1CodeableConceptSI unit for quantitative results
Binding: UCUMCodes (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://unitsofmeasure.org
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
.... conversionFactor I0..1decimalSI to Customary unit conversion factor
.... decimalPrecision I0..1integerDecimal precision of observation quantitative results
... qualifiedInterval I0..*BackboneElementQualified range for continuous and ordinal observation results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category I0..1codereference | critical | absolute
Binding: ObservationRangeCategory (required)
Example General: critical
.... range I0..1RangeThe interval itself, for continuous or ordinal observations
.... context I0..1CodeableConceptRange context qualifier
Binding: ObservationReferenceRangeMeaningCodes (extensible)
.... appliesTo I0..*CodeableConceptTargetted population of the range
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
Example General: female
.... age I0..1RangeApplicable age range, if relevant
.... gestationalAge I0..1RangeApplicable gestational age range, if relevant
.... condition I0..1stringCondition associated with the reference range
... validCodedValueSet I0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition
... normalCodedValueSet I0..1Reference(ValueSet)Value set of normal coded values for the observations conforming to this ObservationDefinition
... abnormalCodedValueSet I0..1Reference(ValueSet)Value set of abnormal coded values for the observations conforming to this ObservationDefinition
... criticalCodedValueSet I0..1Reference(ValueSet)Value set of critical coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition I0..*ObservationDefinitionDefinition of an observation
... multipleResultsAllowed I0..1booleanMultiple results allowed
... quantitativeDetails I0..1BackboneElementCharacteristics of quantitative results
.... unit I0..1CodeableConceptSI unit for quantitative results
Binding: UCUMCodes (extensible)

doco Documentation for this format

This structure is derived from ObservationDefinition

Summary

Must-Support: 3 elements
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

  • The element ObservationDefinition.code.coding is sliced based on the value of value:system

Differential View

This structure is derived from ObservationDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition 0..*ObservationDefinitionDefinition of an observation
... code
.... coding 0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LOINC 0..1CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
... permittedDataType 0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
... multipleResultsAllowed S0..1booleanMultiple results allowed
.... unit S0..1CodeableConceptSI unit for quantitative results
..... coding 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://unitsofmeasure.org
... validCodedValueSet 0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition I0..*ObservationDefinitionDefinition of an observation
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... category ΣI0..*CodeableConceptCategory of observation
Binding: ObservationCategoryCodes (example)
... code ΣI1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LOINC ΣI0..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... identifier ΣI0..*IdentifierBusiness identifier for this ObservationDefinition instance
... permittedDataType I0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required)

Example General: CodeableConcept
... multipleResultsAllowed SI0..1booleanMultiple results allowed
Example General: true
... method I0..1CodeableConceptMethod used to produce the observation
Binding: ObservationMethods (example)
... preferredReportName I0..1stringPreferred report name
... quantitativeDetails SI0..1BackboneElementCharacteristics of quantitative results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... customaryUnit I0..1CodeableConceptCustomary unit for quantitative results
Binding: UCUMCodes (extensible)
.... unit SI0..1CodeableConceptSI unit for quantitative results
Binding: UCUMCodes (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://unitsofmeasure.org
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
.... conversionFactor I0..1decimalSI to Customary unit conversion factor
.... decimalPrecision I0..1integerDecimal precision of observation quantitative results
... qualifiedInterval I0..*BackboneElementQualified range for continuous and ordinal observation results
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... category I0..1codereference | critical | absolute
Binding: ObservationRangeCategory (required)
Example General: critical
.... range I0..1RangeThe interval itself, for continuous or ordinal observations
.... context I0..1CodeableConceptRange context qualifier
Binding: ObservationReferenceRangeMeaningCodes (extensible)
.... appliesTo I0..*CodeableConceptTargetted population of the range
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... gender I0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
Example General: female
.... age I0..1RangeApplicable age range, if relevant
.... gestationalAge I0..1RangeApplicable gestational age range, if relevant
.... condition I0..1stringCondition associated with the reference range
... validCodedValueSet I0..1Reference(ValueSet)Value set of valid coded values for the observations conforming to this ObservationDefinition
... normalCodedValueSet I0..1Reference(ValueSet)Value set of normal coded values for the observations conforming to this ObservationDefinition
... abnormalCodedValueSet I0..1Reference(ValueSet)Value set of abnormal coded values for the observations conforming to this ObservationDefinition
... criticalCodedValueSet I0..1Reference(ValueSet)Value set of critical 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.categoryexampleObservationCategoryCodes
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.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.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.code.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.code.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.code.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.code.coding:LOINCAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.code.coding:LOINC.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.code.coding:LOINC.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.code.coding:LOINC.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.code.coding:LOINC.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.code.coding:LOINC.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.code.coding:LOINC.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.code.coding:LOINC.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.code.textAll 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.multipleResultsAllowedAll 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.preferredReportNameAll 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.unit.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.quantitativeDetails.unit.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.quantitativeDetails.unit.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.quantitativeDetails.unit.coding.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1ObservationDefinition.quantitativeDetails.unit.coding.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1ObservationDefinition.quantitativeDetails.unit.coding.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.quantitativeDetails.unit.coding.versionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.quantitativeDetails.unit.coding.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.quantitativeDetails.unit.coding.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.quantitativeDetails.unit.coding.userSelectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.quantitativeDetails.unit.textAll 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.qualifiedIntervalAll 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())
ele-1ObservationDefinition.normalCodedValueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.abnormalCodedValueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ObservationDefinition.criticalCodedValueSetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())