SMART Health Cards: Vaccination & Testing Implementation Guide
1.0.0 - STU 1 International flag

SMART Health Cards: Vaccination & Testing Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-shc-vaccination-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Generic Laboratory Result Observation Profile - Allowable Data

Official URL: http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-infectious-disease-laboratory-result-observation-ad Version: 1.0.0
Standards status: Trial-use Maturity Level: 4 Computable Name: SHCInfectiousDiseaseLaboratoryResultObservationAD

Defines a fallback (AD) profile representing an infectious disease laboratory testing result in a health card.

See here for implementation details.

↓ Start here!

Description:

For representing laboratory test results related to infection with or immunity to an infectious disease.

Primary profile (DM) Fallback profile (AD) Scope of profile pair
Lab results - COVID-19 Fallback COVID-19 only
Lab results - Generic Fallback Other infectious diseases
For more information about the types of profiles in this IG, see the profiles page.

Note! This is a fallback "allowable data" (AD) profile. Implementers should validate against the primary "data minimization" (DM) profile if possible.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 0..1 id Should not be populated
... meta SΣ 0..1 Meta Metadata about the resource
.... security SΣ 0..1 Coding Limited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: Completed observation status (required)
... code SΣ 1..1 CodeableConcept LOINC identifying the lab test
Binding: LOINCCodes (required)
... subject SΣ 1..1 Reference(Patient Profile - General - Allowable Data) Patient to whom lab result applies
.... reference ΣC 1..1 string This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
... effective[x] SΣ 1..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣ 0..1 Reference(Organization) Organization which was responsible for the laboratory test result.
.... display SΣC 1..1 string Short, human-readable text representation of the organization.
Constraints: vc-should-be-under-30-chars
... Slices for value[x] SΣC 1..1 Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept Actual result
Binding: Lab result findings (SNOMED CT) (required)
.... value[x]:valueQuantity SΣC 0..1 Quantity Actual result
Constraints: vc-observation-quantity-should-have-range
.... value[x]:valueString SΣC 0..1 string String representation of results; used ONLY when a computable representation is not possible
Constraints: vc-should-be-under-20-chars
... referenceRange SC 0..* BackboneElement Provides guide for interpretation. SHOULD include if using valueQuantity.
Constraints: obs-3, vc-observation-range-only-quantity-or-string
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... component:specimen-supervision-status SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
...... coding Σ 1..1 Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code Σ 1..1 code SNOMED CT concept 'Type of supervision for specimen collection (observable entity)'
Fixed Value: 1208522006
..... Slices for value[x] Σ 1..1 CodeableConcept Actual component result
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept SΣ 1..1 CodeableConcept Actual component result
Binding: Specimen Collection Supervision Status (required)
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system
........ system Σ 1..1 uri Identity of the terminology system
........ code Σ 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.meta.security Base required Identity Assurance Level 📦1.0.0 This IG
Observation.status Base required Completed observation status 📦1.0.0 This IG
Observation.code Base required LOINC Codes 📦4.0.1 FHIR Std.
Observation.value[x]:valueCodeableConcept Base required Lab result findings (SNOMED CT) 📦1.0.0 This IG
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:specimen-supervision-status.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:specimen-supervision-status.​value[x]:valueCodeableConcept Base required Specimen Collection Supervision Status 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 error Observation 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 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
vc-observation-quantity-should-have-range warning Observation.value[x]:valueQuantity Quantitative lab results SHOULD include reference range %resource.referenceRange.exists()
vc-observation-range-only-quantity-or-string warning Observation.referenceRange Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise $this.exists() and (%resource.value.ofType(Quantity).exists() or %resource.value.ofType(string).exists())
vc-should-be-under-20-chars warning Observation.value[x]:valueString Length SHOULD be <20 for data minimization. $this.length() < 20
vc-should-be-under-30-chars warning Observation.performer.display Length SHOULD be <30 for data minimization. $this.length() < 30

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation Observation
... id 0..1 id Should not be populated
... meta S 0..1 Meta Metadata about the resource
.... security S 0..1 Coding Limited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
... status S 1..1 code registered | preliminary | final | amended +
Binding: Completed observation status (required)
... subject S 1..1 Reference(Patient Profile - General - Allowable Data) Patient to whom lab result applies
.... reference 1..1 string This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
.... type 0..0 Type the reference refers to (e.g. "Patient")
.... identifier 0..0 Logical reference, when literal reference is not known
.... display 0..0 Text alternative for the resource
... effective[x] S 1..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer S 0..1 Reference(Organization) Organization which was responsible for the laboratory test result.
.... display SC 1..1 string Short, human-readable text representation of the organization.
Constraints: vc-should-be-under-30-chars
... Slices for value[x] S 1..1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... value[x]:valueCodeableConcept S 0..1 CodeableConcept Actual result
Binding: Lab result findings (SNOMED CT) (required)
.... value[x]:valueQuantity SC 0..1 Quantity Actual result
Constraints: vc-observation-quantity-should-have-range
.... value[x]:valueString SC 0..1 string String representation of results; used ONLY when a computable representation is not possible
Constraints: vc-should-be-under-20-chars
... referenceRange SC 0..* BackboneElement Provides guide for interpretation. SHOULD include if using valueQuantity.
Constraints: vc-observation-range-only-quantity-or-string
... Slices for component 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:specimen-supervision-status S 0..1 BackboneElement Component results
..... code
...... coding 1..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code SNOMED CT concept 'Type of supervision for specimen collection (observable entity)'
Fixed Value: 1208522006
..... Slices for value[x] 1..1 CodeableConcept Actual component result
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept S 1..1 CodeableConcept Actual component result
Binding: Specimen Collection Supervision Status (required)
....... extension 0..0 Extension
....... coding 1..1 Coding Code defined by a terminology system
........ system 1..1 uri Identity of the terminology system
........ code 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.meta.security Base required Identity Assurance Level 📦1.0.0 This IG
Observation.status Base required Completed observation status 📦1.0.0 This IG
Observation.code Base required LOINC Codes 📦4.0.1 FHIR Std.
Observation.value[x]:valueCodeableConcept Base required Lab result findings (SNOMED CT) 📦1.0.0 This IG
Observation.component:specimen-supervision-status.​value[x]:valueCodeableConcept Base required Specimen Collection Supervision Status 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
vc-observation-quantity-should-have-range warning Observation.value[x]:valueQuantity Quantitative lab results SHOULD include reference range %resource.referenceRange.exists()
vc-observation-range-only-quantity-or-string warning Observation.referenceRange Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise $this.exists() and (%resource.value.ofType(Quantity).exists() or %resource.value.ofType(string).exists())
vc-should-be-under-20-chars warning Observation.value[x]:valueString Length SHOULD be <20 for data minimization. $this.length() < 20
vc-should-be-under-30-chars warning Observation.performer.display Length SHOULD be <30 for data minimization. $this.length() < 30
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 0..1 id Should not be populated
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security SΣ 0..1 Coding Limited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: Completed observation status (required)
... category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
... code SΣ 1..1 CodeableConcept LOINC identifying the lab test
Binding: LOINCCodes (required)
... subject SΣ 1..1 Reference(Patient Profile - General - Allowable Data) Patient to whom lab result applies
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 1..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..1 Reference(Organization) Organization which was responsible for the laboratory test result.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣC 1..1 string Short, human-readable text representation of the organization.
Constraints: vc-should-be-under-30-chars
... Slices for value[x] SΣC 1..1 Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept Actual result
Binding: Lab result findings (SNOMED CT) (required)
.... value[x]:valueQuantity SΣC 0..1 Quantity Actual result
Constraints: vc-observation-quantity-should-have-range
.... value[x]:valueString SΣC 0..1 string String representation of results; used ONLY when a computable representation is not possible
Constraints: vc-should-be-under-20-chars
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange SC 0..* BackboneElement Provides guide for interpretation. SHOULD include if using valueQuantity.
Constraints: obs-3, vc-observation-range-only-quantity-or-string
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:specimen-supervision-status SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..1 Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code SNOMED CT concept 'Type of supervision for specimen collection (observable entity)'
Fixed Value: 1208522006
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... Slices for value[x] Σ 1..1 CodeableConcept Actual component result
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept SΣ 1..1 CodeableConcept Actual component result
Binding: Specimen Collection Supervision Status (required)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 1..1 code Symbol in syntax defined by the system
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.meta.security Base required Identity Assurance Level 📦1.0.0 This IG
Observation.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required Completed observation status 📦1.0.0 This IG
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base required LOINC Codes 📦4.0.1 FHIR Std.
Observation.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.value[x]:valueCodeableConcept Base required Lab result findings (SNOMED CT) 📦1.0.0 This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:specimen-supervision-status.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:specimen-supervision-status.​value[x]:valueCodeableConcept Base required Specimen Collection Supervision Status 📦1.0.0 This IG
Observation.component:specimen-supervision-status.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:specimen-supervision-status.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 error Observation 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 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
vc-observation-quantity-should-have-range warning Observation.value[x]:valueQuantity Quantitative lab results SHOULD include reference range %resource.referenceRange.exists()
vc-observation-range-only-quantity-or-string warning Observation.referenceRange Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise $this.exists() and (%resource.value.ofType(Quantity).exists() or %resource.value.ofType(string).exists())
vc-should-be-under-20-chars warning Observation.value[x]:valueString Length SHOULD be <20 for data minimization. $this.length() < 20
vc-should-be-under-30-chars warning Observation.performer.display Length SHOULD be <30 for data minimization. $this.length() < 30

This structure is derived from Observation

Summary

Mandatory: 4 elements(9 nested mandatory elements)
Must-Support: 15 elements
Fixed: 2 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.value[x]
  • The element 1 is sliced based on the value of Observation.component
  • The element 1 is sliced based on the value of Observation.component.value[x]

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 0..1 id Should not be populated
... meta SΣ 0..1 Meta Metadata about the resource
.... security SΣ 0..1 Coding Limited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: Completed observation status (required)
... code SΣ 1..1 CodeableConcept LOINC identifying the lab test
Binding: LOINCCodes (required)
... subject SΣ 1..1 Reference(Patient Profile - General - Allowable Data) Patient to whom lab result applies
.... reference ΣC 1..1 string This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
... effective[x] SΣ 1..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer SΣ 0..1 Reference(Organization) Organization which was responsible for the laboratory test result.
.... display SΣC 1..1 string Short, human-readable text representation of the organization.
Constraints: vc-should-be-under-30-chars
... Slices for value[x] SΣC 1..1 Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept Actual result
Binding: Lab result findings (SNOMED CT) (required)
.... value[x]:valueQuantity SΣC 0..1 Quantity Actual result
Constraints: vc-observation-quantity-should-have-range
.... value[x]:valueString SΣC 0..1 string String representation of results; used ONLY when a computable representation is not possible
Constraints: vc-should-be-under-20-chars
... referenceRange SC 0..* BackboneElement Provides guide for interpretation. SHOULD include if using valueQuantity.
Constraints: obs-3, vc-observation-range-only-quantity-or-string
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
.... component:specimen-supervision-status SΣ 0..1 BackboneElement Component results
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
...... coding Σ 1..1 Coding Code defined by a terminology system
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code Σ 1..1 code SNOMED CT concept 'Type of supervision for specimen collection (observable entity)'
Fixed Value: 1208522006
..... Slices for value[x] Σ 1..1 CodeableConcept Actual component result
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept SΣ 1..1 CodeableConcept Actual component result
Binding: Specimen Collection Supervision Status (required)
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system
........ system Σ 1..1 uri Identity of the terminology system
........ code Σ 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.meta.security Base required Identity Assurance Level 📦1.0.0 This IG
Observation.status Base required Completed observation status 📦1.0.0 This IG
Observation.code Base required LOINC Codes 📦4.0.1 FHIR Std.
Observation.value[x]:valueCodeableConcept Base required Lab result findings (SNOMED CT) 📦1.0.0 This IG
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:specimen-supervision-status.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:specimen-supervision-status.​value[x]:valueCodeableConcept Base required Specimen Collection Supervision Status 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 error Observation 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 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
vc-observation-quantity-should-have-range warning Observation.value[x]:valueQuantity Quantitative lab results SHOULD include reference range %resource.referenceRange.exists()
vc-observation-range-only-quantity-or-string warning Observation.referenceRange Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise $this.exists() and (%resource.value.ofType(Quantity).exists() or %resource.value.ofType(string).exists())
vc-should-be-under-20-chars warning Observation.value[x]:valueString Length SHOULD be <20 for data minimization. $this.length() < 20
vc-should-be-under-30-chars warning Observation.performer.display Length SHOULD be <30 for data minimization. $this.length() < 30

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation Observation
... id 0..1 id Should not be populated
... meta S 0..1 Meta Metadata about the resource
.... security S 0..1 Coding Limited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
... status S 1..1 code registered | preliminary | final | amended +
Binding: Completed observation status (required)
... subject S 1..1 Reference(Patient Profile - General - Allowable Data) Patient to whom lab result applies
.... reference 1..1 string This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
.... type 0..0 Type the reference refers to (e.g. "Patient")
.... identifier 0..0 Logical reference, when literal reference is not known
.... display 0..0 Text alternative for the resource
... effective[x] S 1..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
... performer S 0..1 Reference(Organization) Organization which was responsible for the laboratory test result.
.... display SC 1..1 string Short, human-readable text representation of the organization.
Constraints: vc-should-be-under-30-chars
... Slices for value[x] S 1..1 Actual result
Slice: Unordered, Open by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... value[x]:valueCodeableConcept S 0..1 CodeableConcept Actual result
Binding: Lab result findings (SNOMED CT) (required)
.... value[x]:valueQuantity SC 0..1 Quantity Actual result
Constraints: vc-observation-quantity-should-have-range
.... value[x]:valueString SC 0..1 string String representation of results; used ONLY when a computable representation is not possible
Constraints: vc-should-be-under-20-chars
... referenceRange SC 0..* BackboneElement Provides guide for interpretation. SHOULD include if using valueQuantity.
Constraints: vc-observation-range-only-quantity-or-string
... Slices for component 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:specimen-supervision-status S 0..1 BackboneElement Component results
..... code
...... coding 1..1 Coding Code defined by a terminology system
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... code 1..1 code SNOMED CT concept 'Type of supervision for specimen collection (observable entity)'
Fixed Value: 1208522006
..... Slices for value[x] 1..1 CodeableConcept Actual component result
Slice: Unordered, Open by type:$this
...... value[x]:valueCodeableConcept S 1..1 CodeableConcept Actual component result
Binding: Specimen Collection Supervision Status (required)
....... extension 0..0 Extension
....... coding 1..1 Coding Code defined by a terminology system
........ system 1..1 uri Identity of the terminology system
........ code 1..1 code Symbol in syntax defined by the system

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Observation.meta.security Base required Identity Assurance Level 📦1.0.0 This IG
Observation.status Base required Completed observation status 📦1.0.0 This IG
Observation.code Base required LOINC Codes 📦4.0.1 FHIR Std.
Observation.value[x]:valueCodeableConcept Base required Lab result findings (SNOMED CT) 📦1.0.0 This IG
Observation.component:specimen-supervision-status.​value[x]:valueCodeableConcept Base required Specimen Collection Supervision Status 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
vc-observation-quantity-should-have-range warning Observation.value[x]:valueQuantity Quantitative lab results SHOULD include reference range %resource.referenceRange.exists()
vc-observation-range-only-quantity-or-string warning Observation.referenceRange Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise $this.exists() and (%resource.value.ofType(Quantity).exists() or %resource.value.ofType(string).exists())
vc-should-be-under-20-chars warning Observation.value[x]:valueString Length SHOULD be <20 for data minimization. $this.length() < 20
vc-should-be-under-30-chars warning Observation.performer.display Length SHOULD be <30 for data minimization. $this.length() < 30

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Observation C 0..* Observation Measurements and simple assertions
Constraints: obs-6, obs-7
... id Σ 0..1 id Should not be populated
... meta SΣ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security SΣ 0..1 Coding Limited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level (required)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business Identifier for observation
... basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest) Fulfills plan, proposal or order
... partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy) Part of referenced event
... status ?!SΣ 1..1 code registered | preliminary | final | amended +
Binding: Completed observation status (required)
... category 0..* CodeableConcept Classification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.
... code SΣ 1..1 CodeableConcept LOINC identifying the lab test
Binding: LOINCCodes (required)
... subject SΣ 1..1 Reference(Patient Profile - General - Allowable Data) Patient to whom lab result applies
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
... focus Σ 0..* Reference(Resource) What the observation is about, when it is not about the subject of record
... encounter Σ 0..1 Reference(Encounter) Healthcare event during which this observation is made
... effective[x] SΣ 1..1 Clinically relevant time/time-period for observation
.... effectiveDateTime dateTime
.... effectivePeriod Period
... issued Σ 0..1 instant Date/Time this version was made available
... performer SΣ 0..1 Reference(Organization) Organization which was responsible for the laboratory test result.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣC 1..1 string Short, human-readable text representation of the organization.
Constraints: vc-should-be-under-30-chars
... Slices for value[x] SΣC 1..1 Actual result
Slice: Unordered, Closed by type:$this
.... valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... value[x]:valueCodeableConcept SΣC 0..1 CodeableConcept Actual result
Binding: Lab result findings (SNOMED CT) (required)
.... value[x]:valueQuantity SΣC 0..1 Quantity Actual result
Constraints: vc-observation-quantity-should-have-range
.... value[x]:valueString SΣC 0..1 string String representation of results; used ONLY when a computable representation is not possible
Constraints: vc-should-be-under-20-chars
... dataAbsentReason C 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
... note 0..* Annotation Comments about the observation
... bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... method 0..1 CodeableConcept How it was done
Binding: ObservationMethods (example): Methods for simple observations.
... specimen 0..1 Reference(Specimen) Specimen used for this observation
... device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
... referenceRange SC 0..* BackboneElement Provides guide for interpretation. SHOULD include if using valueQuantity.
Constraints: obs-3, vc-observation-range-only-quantity-or-string
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... low C 0..1 SimpleQuantity(4.0.1) Low Range, if relevant
.... high C 0..1 SimpleQuantity(4.0.1) High Range, if relevant
.... type 0..1 CodeableConcept Reference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.
.... appliesTo 0..* CodeableConcept Reference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.
.... age 0..1 Range Applicable age range, if relevant
.... text 0..1 string Text based reference range in an observation
... hasMember Σ 0..* Reference(Observation | QuestionnaireResponse | MolecularSequence) Related resource that belongs to the Observation group
... derivedFrom Σ 0..* Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence) Related measurements the observation is made from
... Slices for component Σ 0..* BackboneElement Component results
Slice: Unordered, Open by value:code
.... component:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
..... value[x] Σ 0..1 Actual component result
...... valueQuantity Quantity
...... valueCodeableConcept CodeableConcept
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueRange Range
...... valueRatio Ratio
...... valueSampledData SampledData
...... valueTime time
...... valueDateTime dateTime
...... valuePeriod Period
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result
.... component:specimen-supervision-status SΣ 0..1 BackboneElement Component results
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 1..1 Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code SNOMED CT concept 'Type of supervision for specimen collection (observable entity)'
Fixed Value: 1208522006
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... Slices for value[x] Σ 1..1 CodeableConcept Actual component result
Slice: Unordered, Closed by type:$this
...... value[x]:valueCodeableConcept SΣ 1..1 CodeableConcept Actual component result
Binding: Specimen Collection Supervision Status (required)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0 Extension
Slice: Unordered, Open by value:url
....... coding Σ 1..1 Coding Code defined by a terminology system
........ id 0..1 string Unique id for inter-element referencing
........ extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
........ system Σ 1..1 uri Identity of the terminology system
........ version Σ 0..1 string Version of the system - if relevant
........ code Σ 1..1 code Symbol in syntax defined by the system
........ display Σ 0..1 string Representation defined by the system
........ userSelected Σ 0..1 boolean If this coding was chosen directly by the user
....... text Σ 0..1 string Plain text representation of the concept
..... dataAbsentReason C 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.
..... interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.
..... referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Observation.meta.security Base required Identity Assurance Level 📦1.0.0 This IG
Observation.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
Observation.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Observation.status Base required Completed observation status 📦1.0.0 This IG
Observation.category Base preferred Observation Category Codes 📍4.0.1 FHIR Std.
Observation.code Base required LOINC Codes 📦4.0.1 FHIR Std.
Observation.performer.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Observation.value[x]:valueCodeableConcept Base required Lab result findings (SNOMED CT) 📦1.0.0 This IG
Observation.dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
Observation.method Base example Observation Methods 📍4.0.1 FHIR Std.
Observation.referenceRange.​type Base preferred Observation Reference Range Meaning Codes 📍4.0.1 FHIR Std.
Observation.referenceRange.​appliesTo Base example Observation Reference Range Applies To Codes 📍4.0.1 FHIR Std.
Observation.component.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.
Observation.component:specimen-supervision-status.​code Base example LOINC Codes 📍4.0.1 FHIR Std.
Observation.component:specimen-supervision-status.​value[x]:valueCodeableConcept Base required Specimen Collection Supervision Status 📦1.0.0 This IG
Observation.component:specimen-supervision-status.​dataAbsentReason Base extensible DataAbsentReason 📍4.0.1 FHIR Std.
Observation.component:specimen-supervision-status.​interpretation Base extensible Observation Interpretation Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Observation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Observation 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 error Observation 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 error Observation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Observation A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
obs-3 error Observation.referenceRange Must have at least a low or a high or text low.exists() or high.exists() or text.exists()
obs-6 error Observation dataAbsentReason SHALL only be present if Observation.value[x] is not present dataAbsentReason.empty() or value.empty()
obs-7 error Observation If Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
vc-observation-quantity-should-have-range warning Observation.value[x]:valueQuantity Quantitative lab results SHOULD include reference range %resource.referenceRange.exists()
vc-observation-range-only-quantity-or-string warning Observation.referenceRange Reference range SHOULD be included for quantitative lab results, MAY be included for free text (string) results, and SHOULD NOT be included otherwise $this.exists() and (%resource.value.ofType(Quantity).exists() or %resource.value.ofType(string).exists())
vc-should-be-under-20-chars warning Observation.value[x]:valueString Length SHOULD be <20 for data minimization. $this.length() < 20
vc-should-be-under-30-chars warning Observation.performer.display Length SHOULD be <30 for data minimization. $this.length() < 30

This structure is derived from Observation

Summary

Mandatory: 4 elements(9 nested mandatory elements)
Must-Support: 15 elements
Fixed: 2 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Observation.value[x]
  • The element 1 is sliced based on the value of Observation.component
  • The element 1 is sliced based on the value of Observation.component.value[x]

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron