Order Catalog Implementation Guide
0.1.0 - STU Ballot 1
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 
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.
The official URL for this profile is:
http://hl7.org/fhir/uv/order-catalog/StructureDefinition/InputObservationDefinition
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ObservationDefinition
Summary
Must-Support: 2 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from ObservationDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ObservationDefinition | 0..* | ObservationDefinition | Definition of an observation | |
  code | ||||
   coding | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system | |
   coding:LOINC | 0..* | Coding | Code defined by a terminology system | |
 system | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
 permittedDataType | S | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period |
  validCodedValueSet | S | 0..1 | Reference(Value Set for Observation Coded Values) | Value set of valid coded values for the observations conforming to this ObservationDefinition |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ObservationDefinition | I | 0..* | ObservationDefinition | Definition of an observation |
 id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| category | ΣI | 0..* | CodeableConcept | Category of observation Binding: ObservationCategoryCodes (example) |
| code | ΣI | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:LOINC | ΣI | 0..* | Coding | Code defined by a terminology system |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 0..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| identifier | ΣI | 0..* | Identifier | Business identifier for this ObservationDefinition instance |
| permittedDataType | SI | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required) Example General: CodeableConcept |
| multipleResultsAllowed | I | 0..1 | boolean | Multiple results allowed Example General: true |
| method | I | 0..1 | CodeableConcept | Method used to produce the observation Binding: ObservationMethods (example) |
| preferredReportName | I | 0..1 | string | Preferred report name |
| quantitativeDetails | I | 0..1 | BackboneElement | Characteristics of quantitative results |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| customaryUnit | I | 0..1 | CodeableConcept | Customary unit for quantitative results Binding: UCUMCodes (extensible) |
| unit | I | 0..1 | CodeableConcept | SI unit for quantitative results Binding: UCUMCodes (extensible) |
| conversionFactor | I | 0..1 | decimal | SI to Customary unit conversion factor |
| decimalPrecision | I | 0..1 | integer | Decimal precision of observation quantitative results |
| qualifiedInterval | I | 0..* | BackboneElement | Qualified range for continuous and ordinal observation results |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| category | I | 0..1 | code | reference | critical | absolute Binding: ObservationRangeCategory (required) Example General: critical |
| range | I | 0..1 | Range | The interval itself, for continuous or ordinal observations |
| context | I | 0..1 | CodeableConcept | Range context qualifier Binding: ObservationReferenceRangeMeaningCodes (extensible) |
| appliesTo | I | 0..* | CodeableConcept | Targetted population of the range Binding: ObservationReferenceRangeAppliesToCodes (example) |
| gender | I | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) Example General: female |
| age | I | 0..1 | Range | Applicable age range, if relevant |
| gestationalAge | I | 0..1 | Range | Applicable gestational age range, if relevant |
| condition | I | 0..1 | string | Condition associated with the reference range |
| validCodedValueSet | SI | 0..1 | Reference(Value Set for Observation Coded Values) | Value set of valid coded values for the observations conforming to this ObservationDefinition |
| normalCodedValueSet | I | 0..1 | Reference(ValueSet) | Value set of normal coded values for the observations conforming to this ObservationDefinition |
| abnormalCodedValueSet | I | 0..1 | Reference(ValueSet) | Value set of abnormal coded values for the observations conforming to this ObservationDefinition |
| criticalCodedValueSet | I | 0..1 | Reference(ValueSet) | Value set of critical coded values for the observations conforming to this ObservationDefinition |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ObservationDefinition | I | 0..* | ObservationDefinition | Definition of an observation |
| permittedDataType | I | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required) |
| validCodedValueSet | I | 0..1 | Reference(Value Set for Observation Coded Values) | Value set of valid coded values for the observations conforming to this ObservationDefinition |
| Documentation for this format | ||||
This structure is derived from ObservationDefinition
Summary
Must-Support: 2 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ObservationDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ObservationDefinition | 0..* | ObservationDefinition | Definition of an observation | |
| code | ||||
| coding | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system | |
| coding:LOINC | 0..* | Coding | Code defined by a terminology system | |
| system | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
| permittedDataType | S | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period |
| validCodedValueSet | S | 0..1 | Reference(Value Set for Observation Coded Values) | Value set of valid coded values for the observations conforming to this ObservationDefinition |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ObservationDefinition | I | 0..* | ObservationDefinition | Definition of an observation |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| category | ΣI | 0..* | CodeableConcept | Category of observation Binding: ObservationCategoryCodes (example) |
| code | ΣI | 1..1 | CodeableConcept | Type of observation (code / type) Binding: LOINCCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:LOINC | ΣI | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 0..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 0..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 0..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| identifier | ΣI | 0..* | Identifier | Business identifier for this ObservationDefinition instance |
| permittedDataType | SI | 0..* | code | Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period Binding: ObservationDataType (required) Example General: CodeableConcept |
| multipleResultsAllowed | I | 0..1 | boolean | Multiple results allowed Example General: true |
| method | I | 0..1 | CodeableConcept | Method used to produce the observation Binding: ObservationMethods (example) |
| preferredReportName | I | 0..1 | string | Preferred report name |
| quantitativeDetails | I | 0..1 | BackboneElement | Characteristics of quantitative results |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| customaryUnit | I | 0..1 | CodeableConcept | Customary unit for quantitative results Binding: UCUMCodes (extensible) |
| unit | I | 0..1 | CodeableConcept | SI unit for quantitative results Binding: UCUMCodes (extensible) |
| conversionFactor | I | 0..1 | decimal | SI to Customary unit conversion factor |
| decimalPrecision | I | 0..1 | integer | Decimal precision of observation quantitative results |
| qualifiedInterval | I | 0..* | BackboneElement | Qualified range for continuous and ordinal observation results |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| category | I | 0..1 | code | reference | critical | absolute Binding: ObservationRangeCategory (required) Example General: critical |
| range | I | 0..1 | Range | The interval itself, for continuous or ordinal observations |
| context | I | 0..1 | CodeableConcept | Range context qualifier Binding: ObservationReferenceRangeMeaningCodes (extensible) |
| appliesTo | I | 0..* | CodeableConcept | Targetted population of the range Binding: ObservationReferenceRangeAppliesToCodes (example) |
| gender | I | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) Example General: female |
| age | I | 0..1 | Range | Applicable age range, if relevant |
| gestationalAge | I | 0..1 | Range | Applicable gestational age range, if relevant |
| condition | I | 0..1 | string | Condition associated with the reference range |
| validCodedValueSet | SI | 0..1 | Reference(Value Set for Observation Coded Values) | Value set of valid coded values for the observations conforming to this ObservationDefinition |
| normalCodedValueSet | I | 0..1 | Reference(ValueSet) | Value set of normal coded values for the observations conforming to this ObservationDefinition |
| abnormalCodedValueSet | I | 0..1 | Reference(ValueSet) | Value set of abnormal coded values for the observations conforming to this ObservationDefinition |
| criticalCodedValueSet | I | 0..1 | Reference(ValueSet) | Value set of critical coded values for the observations conforming to this ObservationDefinition |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| ObservationDefinition.language | preferred | CommonLanguages Max Binding: AllLanguages |
| ObservationDefinition.category | example | ObservationCategoryCodes |
| ObservationDefinition.code | example | LOINCCodes |
| ObservationDefinition.permittedDataType | required | ObservationDataType |
| ObservationDefinition.method | example | ObservationMethods |
| ObservationDefinition.quantitativeDetails.customaryUnit | extensible | UCUMCodes |
| ObservationDefinition.quantitativeDetails.unit | extensible | UCUMCodes |
| ObservationDefinition.qualifiedInterval.category | required | ObservationRangeCategory |
| ObservationDefinition.qualifiedInterval.context | extensible | ObservationReferenceRangeMeaningCodes |
| ObservationDefinition.qualifiedInterval.appliesTo | example | ObservationReferenceRangeAppliesToCodes |
| ObservationDefinition.qualifiedInterval.gender | required | AdministrativeGender |
| Id | Path | Details | Requirements |
| dom-2 | ObservationDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | ObservationDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | ObservationDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | ObservationDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | ObservationDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | ObservationDefinition.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ObservationDefinition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ObservationDefinition.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ObservationDefinition.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ObservationDefinition.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.code.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ObservationDefinition.code.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ObservationDefinition.code.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.code.coding:LOINC | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.code.coding:LOINC.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ObservationDefinition.code.coding:LOINC.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ObservationDefinition.code.coding:LOINC.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.code.coding:LOINC.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.code.coding:LOINC.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.code.coding:LOINC.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.code.coding:LOINC.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.code.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.permittedDataType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.multipleResultsAllowed | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.preferredReportName | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.quantitativeDetails | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.quantitativeDetails.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ObservationDefinition.quantitativeDetails.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ObservationDefinition.quantitativeDetails.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ObservationDefinition.quantitativeDetails.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ObservationDefinition.quantitativeDetails.customaryUnit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.quantitativeDetails.unit | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.quantitativeDetails.conversionFactor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.quantitativeDetails.decimalPrecision | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.qualifiedInterval | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.qualifiedInterval.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ObservationDefinition.qualifiedInterval.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ObservationDefinition.qualifiedInterval.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | ObservationDefinition.qualifiedInterval.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | ObservationDefinition.qualifiedInterval.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.qualifiedInterval.range | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.qualifiedInterval.context | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.qualifiedInterval.appliesTo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.qualifiedInterval.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.qualifiedInterval.age | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.qualifiedInterval.gestationalAge | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.qualifiedInterval.condition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.validCodedValueSet | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.normalCodedValueSet | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.abnormalCodedValueSet | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | ObservationDefinition.criticalCodedValueSet | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Orders and Observations Work Group. Package hl7.fhir.uv.order-catalog#0.1.0 based on FHIR 4.0.1. Generated 2020-08-09
Links: Table of Contents |
QA Report | Search
| Version History |
|
Propose a change