Order Catalog Implementation Guide
current - CI Build International flag

Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions

Resource Profile: InputObservationDefinition Profile

Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/InputObservationDefinition Version: current
Draft as of 2023-01-08 Computable Name: InputObservationDefinition

This profile constrains the base resource ObservationDefinition when referenced by ActivityDefinition.observationRequirement in the context of a catalog of laboratory services. Such a resource specifies the form of an input observation expected alongside the order of a laboratory service.

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..*ObservationDefinitionDefinition of an observation
... code
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LOINC 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
... permittedDataType S0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition C0..*ObservationDefinitionDefinition of an observation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): Codes identifying the state of an ObservationDefinition.

.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LOINC Σ0..*CodingCode defined by a terminology system
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
... permittedDataType S0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.



Example General: CodeableConcept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ObservationDefinition.statusrequiredPublicationStatus
ObservationDefinition.codeexampleLOINCCodes (a valid code from LOINC)
ObservationDefinition.permittedDataTyperequiredObservationDataType

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningObservationDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
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 C0..*ObservationDefinitionDefinition of an observation
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical canonical URL to reference this ObservationDefinition (globally unique)
... identifier Σ0..1IdentifierBusiness identifier of the ObservationDefinition
... version Σ0..1stringBusiness version of the ObservationDefinition
... name ΣC0..1stringName for this ObservationDefinition (computer friendly)
... title Σ0..1stringName for this ObservationDefinition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): Codes identifying the state of an ObservationDefinition.

... experimental Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1Reference(Practitioner | PractitionerRole | Organization)The name of the individual or organization that published the ObservationDefinition
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the ObservationDefinition
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for this ObservationDefinition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region for indicating where a resource is intended to be used.


... purpose 0..1markdownWhy this ObservationDefinition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen ObservationDefinition was approved by publisher
... lastReviewDate 0..1dateDate on which the asset content was last reviewed
... effectivePeriod Σ0..1PeriodThe effective date range for the ObservationDefinition
... derivedFromCanonical Σ0..*canonical(ObservationDefinition)Based on FHIR definition of another observation
... derivedFromUri Σ0..*uriBased on external definition
... subject Σ0..*CodeableConceptType of subject for the defined observation
... performerType Σ0..1CodeableConceptDesired kind of performer for such kind of observation
... category Σ0..*CodeableConceptGeneral type of observation
Binding: ObservationCategoryCodes (example): Codes for high level observation categories.


... code Σ1..1CodeableConceptType of observation
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LOINC Σ0..*CodingCode defined by a terminology system
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... permittedDataType S0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.



Example General: CodeableConcept
... multipleResultsAllowed 0..1booleanMultiple results allowed for conforming observations
Example General: true
... bodySite 0..1CodeableConceptBody part to be observed
Binding: SNOMEDCTBodyStructures (example): SNOMED CT body structures.

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

... specimen 0..*Reference(SpecimenDefinition)Kind of specimen used by this type of observation
... device 0..*Reference(DeviceDefinition | Device)Measurement device or model of device
... preferredReportName 0..1stringThe preferred name to be used when reporting the observation results
... quantitativeDetails 0..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
.... unit 0..1CodeableConceptPrimary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.

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

.... conversionFactor 0..1decimalPrimary to secondary unit conversion factor
.... decimalPrecision 0..1integerDecimal precision of observation quantitative results
... qualifiedValue 0..*BackboneElementSet of qualified values for observation 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
.... context 0..1CodeableConceptContext qualifier for the set of qualified values
Binding: ObservationReferenceRangeMeaningCodes (extensible)
.... appliesTo 0..*CodeableConceptTargetted population for the set of qualified values
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
Example General: female
.... age 0..1RangeApplicable age range for the set of qualified values
.... gestationalAge 0..1RangeApplicable gestational age range for the set of qualified values
.... condition 0..1stringCondition associated with the set of qualified values
.... rangeCategory 0..1codereference | critical | absolute
Binding: ObservationRangeCategory (required)
Example General: critical
.... range 0..1RangeThe range for continuous or ordinal observations
.... validCodedValueSet 0..1canonical(ValueSet)Value set of valid coded values as part of this set of qualified values
.... normalCodedValueSet 0..1canonical(ValueSet)Value set of normal coded values as part of this set of qualified values
.... abnormalCodedValueSet 0..1canonical(ValueSet)Value set of abnormal coded values as part of this set of qualified values
.... criticalCodedValueSet 0..1canonical(ValueSet)Value set of critical coded values as part of this set of qualified values
... hasMember 0..*Reference(ObservationDefinition | Questionnaire)Definitions of related resources belonging to this kind of observation group
... component 0..*BackboneElementComponent 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
.... code 1..1CodeableConceptType of observation
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... permittedDataType 0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.



Example General: CodeableConcept
.... quantitativeDetails 0..1See quantitativeDetails (ObservationDefinition)Characteristics of quantitative results
.... qualifiedValue 0..*See qualifiedValue (ObservationDefinition)Set of qualified values for observation results

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ObservationDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ObservationDefinition.statusrequiredPublicationStatus
ObservationDefinition.jurisdictionextensibleJurisdiction ValueSet
ObservationDefinition.categoryexampleObservationCategoryCodes
ObservationDefinition.codeexampleLOINCCodes (a valid code from LOINC)
ObservationDefinition.permittedDataTyperequiredObservationDataType
ObservationDefinition.bodySiteexampleSNOMEDCTBodyStructures
ObservationDefinition.methodexampleObservationMethods
ObservationDefinition.quantitativeDetails.unitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.quantitativeDetails.customaryUnitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.qualifiedValue.contextextensibleObservationReferenceRangeMeaningCodes
ObservationDefinition.qualifiedValue.appliesToexampleObservationReferenceRangeAppliesToCodes
ObservationDefinition.qualifiedValue.genderrequiredAdministrativeGender
ObservationDefinition.qualifiedValue.rangeCategoryrequiredObservationRangeCategory
ObservationDefinition.component.codeexampleLOINCCodes (a valid code from LOINC)
ObservationDefinition.component.permittedDataTyperequiredObservationDataType

Constraints

IdGradePath(s)DetailsRequirements
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

Must-Support: 1 element
Fixed Value: 1 element

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
.... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LOINC 0..*CodingCode defined by a terminology system
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
... permittedDataType S0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ObservationDefinition C0..*ObservationDefinitionDefinition of an observation
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): Codes identifying the state of an ObservationDefinition.

.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LOINC Σ0..*CodingCode defined by a terminology system
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
... permittedDataType S0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.



Example General: CodeableConcept

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ObservationDefinition.statusrequiredPublicationStatus
ObservationDefinition.codeexampleLOINCCodes (a valid code from LOINC)
ObservationDefinition.permittedDataTyperequiredObservationDataType

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningObservationDefinitionName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
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 C0..*ObservationDefinitionDefinition of an observation
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url Σ0..1uriLogical canonical URL to reference this ObservationDefinition (globally unique)
... identifier Σ0..1IdentifierBusiness identifier of the ObservationDefinition
... version Σ0..1stringBusiness version of the ObservationDefinition
... name ΣC0..1stringName for this ObservationDefinition (computer friendly)
... title Σ0..1stringName for this ObservationDefinition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): Codes identifying the state of an ObservationDefinition.

... experimental Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1Reference(Practitioner | PractitionerRole | Organization)The name of the individual or organization that published the ObservationDefinition
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the ObservationDefinition
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for this ObservationDefinition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Codes for country, country subdivision and region for indicating where a resource is intended to be used.


... purpose 0..1markdownWhy this ObservationDefinition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen ObservationDefinition was approved by publisher
... lastReviewDate 0..1dateDate on which the asset content was last reviewed
... effectivePeriod Σ0..1PeriodThe effective date range for the ObservationDefinition
... derivedFromCanonical Σ0..*canonical(ObservationDefinition)Based on FHIR definition of another observation
... derivedFromUri Σ0..*uriBased on external definition
... subject Σ0..*CodeableConceptType of subject for the defined observation
... performerType Σ0..1CodeableConceptDesired kind of performer for such kind of observation
... category Σ0..*CodeableConceptGeneral type of observation
Binding: ObservationCategoryCodes (example): Codes for high level observation categories.


... code Σ1..1CodeableConceptType of observation
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:LOINC Σ0..*CodingCode defined by a terminology system
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... permittedDataType S0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.



Example General: CodeableConcept
... multipleResultsAllowed 0..1booleanMultiple results allowed for conforming observations
Example General: true
... bodySite 0..1CodeableConceptBody part to be observed
Binding: SNOMEDCTBodyStructures (example): SNOMED CT body structures.

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

... specimen 0..*Reference(SpecimenDefinition)Kind of specimen used by this type of observation
... device 0..*Reference(DeviceDefinition | Device)Measurement device or model of device
... preferredReportName 0..1stringThe preferred name to be used when reporting the observation results
... quantitativeDetails 0..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
.... unit 0..1CodeableConceptPrimary unit for quantitative results
Binding: UCUMCodes (extensible): Codes identifying units of measure.

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

.... conversionFactor 0..1decimalPrimary to secondary unit conversion factor
.... decimalPrecision 0..1integerDecimal precision of observation quantitative results
... qualifiedValue 0..*BackboneElementSet of qualified values for observation 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
.... context 0..1CodeableConceptContext qualifier for the set of qualified values
Binding: ObservationReferenceRangeMeaningCodes (extensible)
.... appliesTo 0..*CodeableConceptTargetted population for the set of qualified values
Binding: ObservationReferenceRangeAppliesToCodes (example)
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
Example General: female
.... age 0..1RangeApplicable age range for the set of qualified values
.... gestationalAge 0..1RangeApplicable gestational age range for the set of qualified values
.... condition 0..1stringCondition associated with the set of qualified values
.... rangeCategory 0..1codereference | critical | absolute
Binding: ObservationRangeCategory (required)
Example General: critical
.... range 0..1RangeThe range for continuous or ordinal observations
.... validCodedValueSet 0..1canonical(ValueSet)Value set of valid coded values as part of this set of qualified values
.... normalCodedValueSet 0..1canonical(ValueSet)Value set of normal coded values as part of this set of qualified values
.... abnormalCodedValueSet 0..1canonical(ValueSet)Value set of abnormal coded values as part of this set of qualified values
.... criticalCodedValueSet 0..1canonical(ValueSet)Value set of critical coded values as part of this set of qualified values
... hasMember 0..*Reference(ObservationDefinition | Questionnaire)Definitions of related resources belonging to this kind of observation group
... component 0..*BackboneElementComponent 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
.... code 1..1CodeableConceptType of observation
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... permittedDataType 0..*codeQuantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period
Binding: ObservationDataType (required): Permitted data type for observation value.



Example General: CodeableConcept
.... quantitativeDetails 0..1See quantitativeDetails (ObservationDefinition)Characteristics of quantitative results
.... qualifiedValue 0..*See qualifiedValue (ObservationDefinition)Set of qualified values for observation results

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ObservationDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ObservationDefinition.statusrequiredPublicationStatus
ObservationDefinition.jurisdictionextensibleJurisdiction ValueSet
ObservationDefinition.categoryexampleObservationCategoryCodes
ObservationDefinition.codeexampleLOINCCodes (a valid code from LOINC)
ObservationDefinition.permittedDataTyperequiredObservationDataType
ObservationDefinition.bodySiteexampleSNOMEDCTBodyStructures
ObservationDefinition.methodexampleObservationMethods
ObservationDefinition.quantitativeDetails.unitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.quantitativeDetails.customaryUnitextensibleUCUMCodes (a valid code from UCUM)
ObservationDefinition.qualifiedValue.contextextensibleObservationReferenceRangeMeaningCodes
ObservationDefinition.qualifiedValue.appliesToexampleObservationReferenceRangeAppliesToCodes
ObservationDefinition.qualifiedValue.genderrequiredAdministrativeGender
ObservationDefinition.qualifiedValue.rangeCategoryrequiredObservationRangeCategory
ObservationDefinition.component.codeexampleLOINCCodes (a valid code from LOINC)
ObservationDefinition.component.permittedDataTyperequiredObservationDataType

Constraints

IdGradePath(s)DetailsRequirements
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

Must-Support: 1 element
Fixed Value: 1 element

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron