HL7 Europe Laboratory Report
0.1.0 - trial-use 150

This page is part of the HL7 Europe Laboratory Report (v0.1.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: Observation Results: laboratory

Official URL: http://hl7.eu/fhir/laboratory/StructureDefinition/Observation-resultslab-eu-lab Version: 0.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: ObservationResultsLaboratoryEu

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

This profile constrains the Observation resource to represent results produced by laboratory tests or panels/studies for the HL7 Europe project. This observation may represent the result of a simple laboratory test such as hematocrit or it may group the set of results produced by a multi-test study or panel such as a complete blood count, a dynamic function test, a urine specimen study. In the latter case, the observation carries the overall conclusion of the study and or a global interpretation by the producer of the study, in the comment element; and references the atomic results of the study as “has-member” child observations.

This profile constrains the Observation resource to represent a laboratory in vitro diagnostic test or panel/study. In case of a panel/study, the results of the panel appear as sub-observations. In this case this top-level Observation acts as a grouper of all the observations belonging to the panel or study. The top-level observation may carry a conclusion in the value element and or a global interpretation by the producer of the study, in the comment element.

This profile offers two options to indicate the Certified Reference Material used for the calibration (in general when the UCUM International Units are used for the results [IU]).

  • The first to be used when the Certified Reference Material is represented by a coded concept
  • The second when the Certified Reference Material is identified with an Identifier.

Adopters are invited to give their feedback about

  1. The most proper way to refer the Certified Reference Material, that is by using an Identifier or a CodeableConcept
  2. If a CodeableReference should be used
  3. If this information should be an extension of the Observation resource, or of other elements (e.g. DeviceMetric.calibration)

Usage:

Formal Views of Profile Content

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

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationLaboratory result for a simple test or for a panel/study
eu-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
eu-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
... Slices for extension 0..*ExtensionLaboratory Test Kit
Slice: Unordered, Open by value:url
... supportingInfo 0..*Reference(Resource)Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
... triggeredBy-r5 0..*(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
.... extension:observation 0..*ExtensionTriggering observation.
.... extension:type 0..*ExtensionThe type of trigger
... certifiedRefMaterialIdentifer 0..*IdentifierCertified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
... labTestKit 0..*Reference(Device)Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
... value-r5 0..1Attachment, Reference(MolecularSequence)only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]
.... value[x] 1..1AttachmentValue of extension
... status 1..1codeStatus of this observation (e.g. preliminary, final,...)
... Slices for category 1..*CodeableConceptIPSClassification of type of observation
Slice: Unordered, Open by pattern:$this
.... category:laboratory 1..1CodeableConceptClassification of type of observation
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
.... category:studyType 0..*CodeableConceptThe way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: Laboratory Study Types (required)
.... category:specialty 0..*CodeableConceptThe clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Specialty (required)
... code 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Laboratory Code (preferred)
... subject 1..1Reference(Patient: Animal | Patient: Person | Group | Device | Location)Who and/or what the observation is about
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... effective[x] 1..1Clinically relevant time/time-period for observation
.... effective[x]:All Types Content/Rules for all Types
..... data-absent-reason 0..1codeeffective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued 0..1instantDate/Time this result was made available
... performer 1..*Reference(PractitionerRole: Laboratory Report | Practitioner: Laboratory Report | Organization (IPS) | CareTeam | Patient: Person | RelatedPerson)Who is responsible for the observation
.... performerFunction 0..*CodeableConceptType of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
... Slices for value[x] 0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueString 0..1stringActual result
.... value[x]:valueRange 0..1RangeIPSSet of values bounded by low and high
.... value[x]:valueRatio 0..1RatioEuLabA measured ratio using UCUM
.... value[x]:valueTime 0..1timeActual result
.... value[x]:valueDateTime 0..1dateTimeActual result
.... value[x]:valuePeriod 0..1PeriodActual result
.... value[x]:valueQuantity 0..1QuantityEuLabA measured amount using UCUM
.... value[x]:valueCodeableConcept 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Setcandidate
Results Presence Absence - SNOMED CT IPS Free Setcandidate
Results Microorganism - SNOMED CT IPS Free Setcandidate
... dataAbsentReason 0..1CodeableConceptProvides a reason why the expected value is missing.
... interpretation 0..*CodeableConceptIPSConcept - reference to a terminology or just text
... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Laboratory Techniques (preferred)
... specimen 0..1Reference(Specimen: Laboratory)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)Measuring instrument
... hasMember 0..*Reference(Observation Results: laboratory)Related resource that belongs to the Observation group
... component 0..*BackboneElementLaboratory result
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... value-r5 0..1Attachment, Reference(MolecularSequence)only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]
..... value[x] 1..1AttachmentValue of extension
.... code 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Laboratory Observation - IPS (preferred)
.... Slices for value[x] 0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result
Slice: Unordered, Closed by type:$this
..... value[x]:valueString 0..1stringActual component result
..... value[x]:valueRange 0..1RangeIPSSet of values bounded by low and high
..... value[x]:valueRatio 0..1RatioEuLabA measured ratio using UCUM
..... value[x]:valueTime 0..1timeActual component result
..... value[x]:valueDateTime 0..1dateTimeActual component result
..... value[x]:valuePeriod 0..1PeriodActual component result
..... value[x]:valueQuantity 0..1QuantityEuLabA measured amount using UCUM
..... value[x]:valueCodeableConcept 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Setcandidate
Results Presence Absence - SNOMED CT IPS Free Setcandidate
Results Microorganism - SNOMED CT IPS Free Setcandidate

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.category:studyTyperequiredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
from this IG
Observation.category:specialtyrequiredLabSpecialtyEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab
from this IG
Observation.codepreferredLaboratoryResultStandardEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-obsCode-eu-lab
from this IG
Observation.value[x]:valueCodeableConceptpreferredResultsCodedValuesLaboratoryUvIps
Additional Bindings Purpose Documentation
Results Blood Group - SNOMED CT IPS Free Set candidate

Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Presence Absence - SNOMED CT IPS Free Set candidate

Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Microorganism - SNOMED CT IPS Free Set candidate

Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips
Observation.methodpreferredLabTechniqueEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-technique-eu-lab
from this IG
Observation.component.codepreferredResultsLaboratoryObservationUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-observations-uv-ips
Observation.component.value[x]:valueCodeableConceptpreferredResultsCodedValuesLaboratoryUvIps
Additional Bindings Purpose Documentation
Results Blood Group - SNOMED CT IPS Free Set candidate

Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Presence Absence - SNOMED CT IPS Free Set candidate

Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Microorganism - SNOMED CT IPS Free Set candidate

Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
eu-lab-1errorObservationIf observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
: (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2errorObservationIf observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
: component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationLaboratory result for a simple test or for a panel/study
eu-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
eu-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionLaboratory Test Kit
Slice: Unordered, Open by value:url
... supportingInfo 0..*Reference(Resource)Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:observation 0..*ExtensionTriggering observation.
..... extension 0..0
..... url 1..1uri"observation"
..... value[x] 1..1Reference(Observation)Value of extension
.... extension:type 0..*ExtensionThe type of trigger
..... extension 0..0
..... url 1..1uri"type"
..... value[x] 1..1codeValue of extension
.... extension:reason 0..*ExtensionExtension
..... extension 0..0
..... url 1..1uri"reason"
..... value[x] 1..1stringValue of extension
.... url 1..1uri"http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
... certifiedRefMaterialCodeable 0..*CodeableConceptCertified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
... certifiedRefMaterialIdentifer 0..*IdentifierCertified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
... labTestKit 0..*Reference(Device)Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
... value-r5 0..1Attachment, Reference(MolecularSequence)only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
.... value[x] 1..1AttachmentValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeStatus of this observation (e.g. preliminary, final,...)
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 1..*CodeableConceptIPSClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:laboratory 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
.... category:studyType 0..*CodeableConceptThe way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: Laboratory Study Types (required)
.... category:specialty 0..*CodeableConceptThe clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Specialty (required)
... code 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Laboratory Code (preferred)
... subject Σ1..1Reference(Patient: Animal | Patient: Person | Group | Device | Location)Who and/or what the observation is about
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... effective[x] Σ1..1Clinically relevant time/time-period for observation
.... effective[x]:All Types Content/Rules for all Types
..... data-absent-reason 0..1codeeffective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this result was made available
... performer Σ1..*Reference(PractitionerRole: Laboratory Report | Practitioner: Laboratory Report | Organization (IPS) | CareTeam | Patient: Person | RelatedPerson)Who is responsible for the observation
.... performerFunction 0..*CodeableConceptType of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
... Slices for value[x] ΣC0..1Actual result
Slice: Unordered, Open by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
.... value[x]:valueString ΣC0..1stringActual result
.... value[x]:valueRange C0..1RangeIPSSet of values bounded by low and high
.... value[x]:valueRatio C0..1RatioEuLabA measured ratio using UCUM
.... value[x]:valueTime ΣC0..1timeActual result
.... value[x]:valueDateTime ΣC0..1dateTimeActual result
.... value[x]:valuePeriod ΣC0..1PeriodActual result
.... value[x]:valueQuantity C0..1QuantityEuLabA measured amount using UCUM
.... value[x]:valueCodeableConcept 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Setcandidate
Results Presence Absence - SNOMED CT IPS Free Setcandidate
Results Microorganism - SNOMED CT IPS Free Setcandidate
... dataAbsentReason C0..1CodeableConceptProvides a reason why the expected value is missing.
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Laboratory Techniques (preferred)
... specimen 0..1Reference(Specimen: Laboratory)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)Measuring instrument
... hasMember Σ0..*Reference(Observation Results: laboratory)Related resource that belongs to the Observation group
... component Σ0..*BackboneElementLaboratory result
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... value-r5 0..1Attachment, Reference(MolecularSequence)only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
..... value[x] 1..1AttachmentValue of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Laboratory Observation - IPS (preferred)
.... Slices for value[x] Σ0..1Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... value[x]:valueString Σ0..1stringActual component result
..... value[x]:valueRange C0..1RangeIPSSet of values bounded by low and high
..... value[x]:valueRatio C0..1RatioEuLabA measured ratio using UCUM
..... value[x]:valueTime Σ0..1timeActual component result
..... value[x]:valueDateTime Σ0..1dateTimeActual component result
..... value[x]:valuePeriod Σ0..1PeriodActual component result
..... value[x]:valueQuantity C0..1QuantityEuLabA measured amount using UCUM
..... value[x]:valueCodeableConcept 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Setcandidate
Results Presence Absence - SNOMED CT IPS Free Setcandidate
Results Microorganism - SNOMED CT IPS Free Setcandidate

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:laboratorypreferredPattern: laboratory
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:studyTyperequiredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
from this IG
Observation.category:specialtyrequiredLabSpecialtyEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab
from this IG
Observation.codepreferredLaboratoryResultStandardEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-obsCode-eu-lab
from this IG
Observation.value[x]:valueCodeableConceptpreferredResultsCodedValuesLaboratoryUvIps
Additional Bindings Purpose Documentation
Results Blood Group - SNOMED CT IPS Free Set candidate

Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Presence Absence - SNOMED CT IPS Free Set candidate

Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Microorganism - SNOMED CT IPS Free Set candidate

Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.methodpreferredLabTechniqueEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-technique-eu-lab
from this IG
Observation.component.codepreferredResultsLaboratoryObservationUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-observations-uv-ips
Observation.component.value[x]:valueCodeableConceptpreferredResultsCodedValuesLaboratoryUvIps
Additional Bindings Purpose Documentation
Results Blood Group - SNOMED CT IPS Free Set candidate

Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Presence Absence - SNOMED CT IPS Free Set candidate

Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Microorganism - SNOMED CT IPS Free Set candidate

Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
eu-lab-1errorObservationIf observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
: (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2errorObservationIf observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
: component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()
qty-3errorObservation.value[x]:valueQuantity, Observation.component.value[x]:valueQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorObservation.value[x]:valueRatio, Observation.component.value[x]:valueRatioNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
rng-2errorObservation.value[x]:valueRange, Observation.component.value[x]:valueRangeIf present, low SHALL have a lower value than high
: low.empty() or high.empty() or (low <= high)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationLaboratory result for a simple test or for a panel/study
eu-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
eu-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
... 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionLaboratory Test Kit
Slice: Unordered, Open by value:url
... supportingInfo 0..*Reference(Resource)Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
... triggeredBy-r5 0..*(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:observation 0..*ExtensionTriggering observation.
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"observation"
..... value[x] 1..1Reference(Observation)Value of extension
.... extension:type 0..*ExtensionThe type of trigger
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"type"
..... value[x] 1..1codeValue of extension
.... extension:reason 0..*ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"reason"
..... value[x] 1..1stringValue of extension
.... url 1..1uri"http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
... certifiedRefMaterialCodeable 0..*CodeableConceptCertified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
... certifiedRefMaterialIdentifer 0..*IdentifierCertified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
... labTestKit 0..*Reference(Device)Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
... value-r5 0..1Attachment, Reference(MolecularSequence)only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
.... value[x] 1..1AttachmentValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness 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 ?!Σ1..1codeStatus of this observation (e.g. preliminary, final,...)
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 1..*CodeableConceptIPSClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:laboratory 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... category:studyType 0..*CodeableConceptThe way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: Laboratory Study Types (required)
.... category:specialty 0..*CodeableConceptThe clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Specialty (required)
... code 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Laboratory Code (preferred)
... subject Σ1..1Reference(Patient: Animal | Patient: Person | Group | Device | Location)Who and/or what the observation is about
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... focus Σ0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] Σ1..1Clinically relevant time/time-period for observation
.... effective[x]:All Types Content/Rules for all Types
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... data-absent-reason 0..1codeeffective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this result was made available
... performer Σ1..*Reference(PractitionerRole: Laboratory Report | Practitioner: Laboratory Report | Organization (IPS) | CareTeam | Patient: Person | RelatedPerson)Who is responsible for the observation
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... performerFunction 0..*CodeableConceptType of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... Slices for value[x] ΣC0..1Actual result
Slice: Unordered, Open by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
.... value[x]:valueString ΣC0..1stringActual result
.... value[x]:valueRange C0..1RangeIPSSet of values bounded by low and high
.... value[x]:valueRatio C0..1RatioEuLabA measured ratio using UCUM
.... value[x]:valueTime ΣC0..1timeActual result
.... value[x]:valueDateTime ΣC0..1dateTimeActual result
.... value[x]:valuePeriod ΣC0..1PeriodActual result
.... value[x]:valueQuantity C0..1QuantityEuLabA measured amount using UCUM
.... value[x]:valueCodeableConcept 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Setcandidate
Results Presence Absence - SNOMED CT IPS Free Setcandidate
Results Microorganism - SNOMED CT IPS Free Setcandidate
... dataAbsentReason C0..1CodeableConceptProvides a reason why the expected value is missing.
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note 0..*AnnotationComments about the observation
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Laboratory Techniques (preferred)
... specimen 0..1Reference(Specimen: Laboratory)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)Measuring instrument
... referenceRange C0..*BackboneElementProvides guide for interpretation
.... 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
.... low C0..1SimpleQuantityLow Range, if relevant
.... high C0..1SimpleQuantityHigh Range, if relevant
.... type 0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo 0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age 0..1RangeApplicable age range, if relevant
.... text 0..1stringText based reference range in an observation
... hasMember Σ0..*Reference(Observation Results: laboratory)Related resource that belongs to the Observation group
... derivedFrom Σ0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component Σ0..*BackboneElementLaboratory result
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... value-r5 0..1Attachment, Reference(MolecularSequence)only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
..... value[x] 1..1AttachmentValue of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Laboratory Observation - IPS (preferred)
.... Slices for value[x] Σ0..1Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... value[x]:valueString Σ0..1stringActual component result
..... value[x]:valueRange C0..1RangeIPSSet of values bounded by low and high
..... value[x]:valueRatio C0..1RatioEuLabA measured ratio using UCUM
..... value[x]:valueTime Σ0..1timeActual component result
..... value[x]:valueDateTime Σ0..1dateTimeActual component result
..... value[x]:valuePeriod Σ0..1PeriodActual component result
..... value[x]:valueQuantity C0..1QuantityEuLabA measured amount using UCUM
..... value[x]:valueCodeableConcept 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Setcandidate
Results Presence Absence - SNOMED CT IPS Free Setcandidate
Results Microorganism - SNOMED CT IPS Free Setcandidate
.... dataAbsentReason C0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, 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

PathConformanceValueSet / CodeURI
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Observation.statusrequiredObservationStatus
http://hl7.org/fhir/ValueSet/observation-status|4.0.1
from the FHIR Standard
Observation.categorypreferredObservationCategoryCodes
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:laboratorypreferredPattern: laboratory
http://hl7.org/fhir/ValueSet/observation-category
from the FHIR Standard
Observation.category:studyTyperequiredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
from this IG
Observation.category:specialtyrequiredLabSpecialtyEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab
from this IG
Observation.codepreferredLaboratoryResultStandardEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-obsCode-eu-lab
from this IG
Observation.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Observation.performer.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Observation.value[x]:valueCodeableConceptpreferredResultsCodedValuesLaboratoryUvIps
Additional Bindings Purpose Documentation
Results Blood Group - SNOMED CT IPS Free Set candidate

Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Presence Absence - SNOMED CT IPS Free Set candidate

Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Microorganism - SNOMED CT IPS Free Set candidate

Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips
Observation.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard
Observation.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
Observation.methodpreferredLabTechniqueEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-technique-eu-lab
from this IG
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
http://hl7.org/fhir/ValueSet/referencerange-meaning
from the FHIR Standard
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
http://hl7.org/fhir/ValueSet/referencerange-appliesto
from the FHIR Standard
Observation.component.codepreferredResultsLaboratoryObservationUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-observations-uv-ips
Observation.component.value[x]:valueCodeableConceptpreferredResultsCodedValuesLaboratoryUvIps
Additional Bindings Purpose Documentation
Results Blood Group - SNOMED CT IPS Free Set candidate

Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Presence Absence - SNOMED CT IPS Free Set candidate

Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Microorganism - SNOMED CT IPS Free Set candidate

Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips
Observation.component.dataAbsentReasonextensibleDataAbsentReason
http://hl7.org/fhir/ValueSet/data-absent-reason
from the FHIR Standard
Observation.component.interpretationextensibleObservationInterpretationCodes
http://hl7.org/fhir/ValueSet/observation-interpretation
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf 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-4errorObservationIf 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-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
eu-lab-1errorObservationIf observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
: (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2errorObservationIf observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
: component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf 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()
qty-3errorObservation.value[x]:valueQuantity, Observation.component.value[x]:valueQuantityIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
rat-1errorObservation.value[x]:valueRatio, Observation.component.value[x]:valueRatioNumerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present
: (numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())
rng-2errorObservation.value[x]:valueRange, Observation.component.value[x]:valueRangeIf present, low SHALL have a lower value than high
: low.empty() or high.empty() or (low <= high)

This structure is derived from Observation

Summary

Mandatory: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.category is sliced based on the value of pattern:$this
  • The element Observation.value[x] is sliced based on the value of type:$this (Closed)
  • The element Observation.component.value[x] is sliced based on the value of type:$this (Closed)

Maturity: 2

Differential View

This structure is derived from Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationLaboratory result for a simple test or for a panel/study
eu-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
eu-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
... Slices for extension 0..*ExtensionLaboratory Test Kit
Slice: Unordered, Open by value:url
... supportingInfo 0..*Reference(Resource)Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
... triggeredBy-r5 0..*(Complex)Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy
.... extension:observation 0..*ExtensionTriggering observation.
.... extension:type 0..*ExtensionThe type of trigger
... certifiedRefMaterialIdentifer 0..*IdentifierCertified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
... labTestKit 0..*Reference(Device)Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
... value-r5 0..1Attachment, Reference(MolecularSequence)only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]
.... value[x] 1..1AttachmentValue of extension
... status 1..1codeStatus of this observation (e.g. preliminary, final,...)
... Slices for category 1..*CodeableConceptIPSClassification of type of observation
Slice: Unordered, Open by pattern:$this
.... category:laboratory 1..1CodeableConceptClassification of type of observation
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
.... category:studyType 0..*CodeableConceptThe way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: Laboratory Study Types (required)
.... category:specialty 0..*CodeableConceptThe clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Specialty (required)
... code 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Laboratory Code (preferred)
... subject 1..1Reference(Patient: Animal | Patient: Person | Group | Device | Location)Who and/or what the observation is about
.... reference 1..1stringLiteral reference, Relative, internal or absolute URL
... effective[x] 1..1Clinically relevant time/time-period for observation
.... effective[x]:All Types Content/Rules for all Types
..... data-absent-reason 0..1codeeffective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.

.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued 0..1instantDate/Time this result was made available
... performer 1..*Reference(PractitionerRole: Laboratory Report | Practitioner: Laboratory Report | Organization (IPS) | CareTeam | Patient: Person | RelatedPerson)Who is responsible for the observation
.... performerFunction 0..*CodeableConceptType of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
... Slices for value[x] 0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueString 0..1stringActual result
.... value[x]:valueRange 0..1RangeIPSSet of values bounded by low and high
.... value[x]:valueRatio 0..1RatioEuLabA measured ratio using UCUM
.... value[x]:valueTime 0..1timeActual result
.... value[x]:valueDateTime 0..1dateTimeActual result
.... value[x]:valuePeriod 0..1PeriodActual result
.... value[x]:valueQuantity 0..1QuantityEuLabA measured amount using UCUM
.... value[x]:valueCodeableConcept 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Setcandidate
Results Presence Absence - SNOMED CT IPS Free Setcandidate
Results Microorganism - SNOMED CT IPS Free Setcandidate
... dataAbsentReason 0..1CodeableConceptProvides a reason why the expected value is missing.
... interpretation 0..*CodeableConceptIPSConcept - reference to a terminology or just text
... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Laboratory Techniques (preferred)
... specimen 0..1Reference(Specimen: Laboratory)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)Measuring instrument
... hasMember 0..*Reference(Observation Results: laboratory)Related resource that belongs to the Observation group
... component 0..*BackboneElementLaboratory result
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... value-r5 0..1Attachment, Reference(MolecularSequence)only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]
..... value[x] 1..1AttachmentValue of extension
.... code 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Laboratory Observation - IPS (preferred)
.... Slices for value[x] 0..1Quantity, CodeableConcept, string, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result
Slice: Unordered, Closed by type:$this
..... value[x]:valueString 0..1stringActual component result
..... value[x]:valueRange 0..1RangeIPSSet of values bounded by low and high
..... value[x]:valueRatio 0..1RatioEuLabA measured ratio using UCUM
..... value[x]:valueTime 0..1timeActual component result
..... value[x]:valueDateTime 0..1dateTimeActual component result
..... value[x]:valuePeriod 0..1PeriodActual component result
..... value[x]:valueQuantity 0..1QuantityEuLabA measured amount using UCUM
..... value[x]:valueCodeableConcept 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Setcandidate
Results Presence Absence - SNOMED CT IPS Free Setcandidate
Results Microorganism - SNOMED CT IPS Free Setcandidate

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Observation.category:studyTyperequiredLabStudyTypesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab
from this IG
Observation.category:specialtyrequiredLabSpecialtyEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab
from this IG
Observation.codepreferredLaboratoryResultStandardEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-obsCode-eu-lab
from this IG
Observation.value[x]:valueCodeableConceptpreferredResultsCodedValuesLaboratoryUvIps
Additional Bindings Purpose Documentation
Results Blood Group - SNOMED CT IPS Free Set candidate

Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Presence Absence - SNOMED CT IPS Free Set candidate

Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Microorganism - SNOMED CT IPS Free Set candidate

Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips
Observation.methodpreferredLabTechniqueEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-technique-eu-lab
from this IG
Observation.component.codepreferredResultsLaboratoryObservationUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-laboratory-observations-uv-ips
Observation.component.value[x]:valueCodeableConceptpreferredResultsCodedValuesLaboratoryUvIps
Additional Bindings Purpose Documentation
Results Blood Group - SNOMED CT IPS Free Set candidate

Additional conformance binding to a blood group findings value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Presence Absence - SNOMED CT IPS Free Set candidate

Additional conformance binding to a presence and absence findings (qualifier values) value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

Results Microorganism - SNOMED CT IPS Free Set candidate

Additional conformance binding to a microorganisms value set for laboratory result values from the SNOMED CT IPS free set for use globally (in SNOMED member and non-member jurisdictions).

http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips

Constraints

IdGradePath(s)DetailsRequirements
eu-lab-1errorObservationIf observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
: (status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists()
eu-lab-2errorObservationIf observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
: component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*ObservationLaboratory result for a simple test or for a panel/study
eu-lab-1: If observation status is other then "registered" or "cancelled", at least one of these Observation elements shall be provided: "value", "dataAbsentReason", "hasMember" or "component"
eu-lab-2: If observation has components and observation status is other then "registered" or "cancelled", at least one of these Observation.component elements shall be provided: "value" or "dataAbsentReason"
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionLaboratory Test Kit
Slice: Unordered, Open by value:url
... supportingInfo 0..*Reference(Resource)Other information that may be relevant to this event.
URL: http://hl7.org/fhir/StructureDefinition/workflow-supportingInfo
.... extension:observation 0..*ExtensionTriggering observation.
..... extension 0..0
..... url 1..1uri"observation"
..... value[x] 1..1Reference(Observation)Value of extension
.... extension:type 0..*ExtensionThe type of trigger
..... extension 0..0
..... url 1..1uri"type"
..... value[x] 1..1codeValue of extension
.... extension:reason 0..*ExtensionExtension
..... extension 0..0
..... url 1..1uri"reason"
..... value[x] 1..1stringValue of extension
.... url 1..1uri"http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.triggeredBy"
... certifiedRefMaterialCodeable 0..*CodeableConceptCertified Reference Material: CodeableConcept
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialCodeable
Binding: Laboratory Certified Reference Material (example)
... certifiedRefMaterialIdentifer 0..*IdentifierCertified Reference Material: Identifier
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-certifiedRefMaterialIdentifer
... labTestKit 0..*Reference(Device)Device Laboratory Test Kit
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/observation-deviceLabTestKit
... value-r5 0..1Attachment, Reference(MolecularSequence)only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
.... value[x] 1..1AttachmentValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeStatus of this observation (e.g. preliminary, final,...)
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 1..*CodeableConceptIPSClassification of type of observation
Slice: Unordered, Open by pattern:$this
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:laboratory 1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.



Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/observation-category
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: laboratory
.... category:studyType 0..*CodeableConceptThe way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: Laboratory Study Types (required)
.... category:specialty 0..*CodeableConceptThe clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
Binding: Laboratory Specialty (required)
... code 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Laboratory Code (preferred)
... subject Σ1..1Reference(Patient: Animal | Patient: Person | Group | Device | Location)Who and/or what the observation is about
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... effective[x] Σ1..1Clinically relevant time/time-period for observation
.... effective[x]:All Types Content/Rules for all Types
..... data-absent-reason 0..1codeeffective[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


.... effectiveDateTimedateTime
.... effectivePeriodPeriod
... issued Σ0..1instantDate/Time this result was made available
... performer Σ1..*Reference(PractitionerRole: Laboratory Report | Practitioner: Laboratory Report | Organization (IPS) | CareTeam | Patient: Person | RelatedPerson)Who is responsible for the observation
.... performerFunction 0..*CodeableConceptType of performance
URL: http://hl7.org/fhir/StructureDefinition/event-performerFunction
Binding: Performer Function Codes (extensible)
... Slices for value[x] ΣC0..1Actual result
Slice: Unordered, Open by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
.... value[x]:valueString ΣC0..1stringActual result
.... value[x]:valueRange C0..1RangeIPSSet of values bounded by low and high
.... value[x]:valueRatio C0..1RatioEuLabA measured ratio using UCUM
.... value[x]:valueTime ΣC0..1timeActual result
.... value[x]:valueDateTime ΣC0..1dateTimeActual result
.... value[x]:valuePeriod ΣC0..1PeriodActual result
.... value[x]:valueQuantity C0..1QuantityEuLabA measured amount using UCUM
.... value[x]:valueCodeableConcept 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Coded Values Laboratory - IPS (preferred)
Additional BindingsPurpose
Results Blood Group - SNOMED CT IPS Free Setcandidate
Results Presence Absence - SNOMED CT IPS Free Setcandidate
Results Microorganism - SNOMED CT IPS Free Setcandidate
... dataAbsentReason C0..1CodeableConceptProvides a reason why the expected value is missing.
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation 0..*CodeableConceptIPSConcept - reference to a terminology or just text
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... method 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Laboratory Techniques (preferred)
... specimen 0..1Reference(Specimen: Laboratory)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)Measuring instrument
... hasMember Σ0..*Reference(Observation Results: laboratory)Related resource that belongs to the Observation group
... component Σ0..*BackboneElementLaboratory result
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... value-r5 0..1Attachment, Reference(MolecularSequence)only for result of type Attachment
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/5.0/StructureDefinition/extension-Observation.value[x]"
..... value[x] 1..1AttachmentValue of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code 1..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Results Laboratory Observation - IPS (preferred)