CH LAB-Report (R4)
1.0.0 - trial-use Switzerland flag

This page is part of the CH LAB-Report (R4) (v1.0.0: STU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: ChLabObservationResultsLaboratory - Detailed Descriptions

Active as of 2024-12-18

Definitions for the ch-lab-observation-results-laboratory resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Observation
Definition

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 references the atomic results of the study as "has-member" child observations

ShortLaboratory result for a simple test or for a panel/study
Comments

Represents either a lab simple observation or the group of observations produced by a laboratory study.

Impose ProfileThis profile also requires that the instance also conform this additional profile:
Invariantseu-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" ((status in ('registered'|'cancelled')) or value.exists() or hasMember.exists() or component.exists() or dataAbsentReason.exists())
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" (component.exists() implies (status in ('registered'|'cancelled')) or component.value.exists() or component.dataAbsentReason.exists())
2. Observation.extension
Definition

The laboratory test kit used for this test.

ShortLaboratory Test Kit
SlicingThis element introduces a set of slices on Observation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Observation.extension:supportingInfo
    Slice NamesupportingInfo
    Control0..*
    TypeExtension(Supporting info) (Extension Type: Reference(Resource))
    6. Observation.extension:triggeredBy-r5
    Slice NametriggeredBy-r5
    Control0..*
    TypeExtension(Extension Definition for Observation.triggeredBy for Version 5.0) (Complex Extension)
    8. Observation.extension:triggeredBy-r5.extension:observation
    Slice Nameobservation
    ShortTriggering observation.
    10. Observation.extension:triggeredBy-r5.extension:type
    Slice Nametype
    ShortThe type of trigger
    12. Observation.extension:certifiedRefMaterialCodeable
    Slice NamecertifiedRefMaterialCodeable
    Control0..*
    TypeExtension(Certified Reference Material: CodeableConcept) (Extension Type: CodeableConcept)
    14. Observation.extension:certifiedRefMaterialIdentifer
    Slice NamecertifiedRefMaterialIdentifer
    Control0..*
    TypeExtension(Certified Reference Material: Identifier) (Extension Type: Identifier)
    16. Observation.extension:labTestKit
    Slice NamelabTestKit
    Control0..*
    TypeExtension(Device Laboratory Test Kit) (Extension Type: Reference(Device))
    18. Observation.extension:value-r5
    Slice Namevalue-r5
    Shortonly for result of type Attachment
    Control0..1
    TypeExtension(Extension Definition for Observation.value[x] for Version 5.0) (Extension Type: Choice of: Attachment, Reference(MolecularSequence))
    20. Observation.extension:value-r5.value[x]
    TypeAttachment
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    22. Observation.status
    ShortStatus of this observation (e.g. preliminary, final,...)
    24. Observation.category
    Definition

    A code that classifies the general type of observation being made. In this profile, fixed to "laboratory".

    Comments

    "laboratory" includes laboratory medicine and pathology

    Control1..?
    SlicingThis element introduces a set of slices on Observation.category. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ $this
    • 26. Observation.category:laboratory
      Slice Namelaboratory
      Control1..1
      Pattern Value{
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/observation-category",
          "code" : "laboratory"
        }]
      }
      28. Observation.category:studyType
      Slice NamestudyType
      ShortThe way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
      Control0..*
      BindingThe codes SHALL be taken from Laboratory Study Types
      (required to http://hl7.eu/fhir/laboratory/ValueSet/lab-studyType-eu-lab)
      30. Observation.category:specialty
      Slice Namespecialty
      ShortThe clinical domain of the laboratory performing the observation (e.g. microbiology, toxicology, chemistry)
      Control0..*
      BindingThe codes SHALL be taken from Laboratory Specialty
      (required to http://hl7.eu/fhir/laboratory/ValueSet/lab-specialty-eu-lab)
      32. Observation.code
      Definition

      Describes what was observed. Sometimes this is called the observation "name". In this profile this code represents either a simple laboratory test or a laboratory study with multiple child observations

      Comments

      In the context of this Observation-laboratory-uv-ips profile, when the observation plays the role of a grouper of member sub-observations, the code represent the group (for instance a panel code). In case no code is available, at least a text shall be provided.

      BindingThe codes SHOULD be taken from Laboratory Code
      (preferred to http://hl7.eu/fhir/laboratory/ValueSet/lab-obsCode-eu-lab)
      34. Observation.subject
      Control1..?
      TypeReference(Patient: Animal, Patient: Person, Group, Device, Location)
      36. Observation.subject.reference
      Control1..?
      38. Observation.effective[x]
      Control1..?
      TypeChoice of: dateTime, Period, Timing, instant
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      40. Observation.effective[x].extension:data-absent-reason
      Slice Namedata-absent-reason
      Definition

      Provides a reason why the effectiveTime is missing.

      Shorteffective[x] absence reason
      Control0..1
      TypeExtension(Data Absent Reason) (Extension Type: code)
      42. Observation.issued
      ShortDate/Time this result was made available
      44. Observation.performer
      Control1..?
      TypeReference(CH LAB-Report PractitionerRole, CH LAB-Report Practitioner, CH Core Organization, CareTeam, CH LAB-Report Patient, RelatedPerson)
      46. Observation.performer.extension:performerFunction
      Slice NameperformerFunction
      Control0..*
      TypeExtension(Performer function) (Extension Type: CodeableConcept)
      48. Observation.value[x]
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      SlicingThis element introduces a set of slices on Observation.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
      • type @ $this
      • 50. Observation.value[x]:valueString
        Slice NamevalueString
        Control0..1
        Typestring
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        52. Observation.value[x]:valueBoolean
        Slice NamevalueBoolean
        Control0..1
        Typeboolean
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        54. Observation.value[x]:valueRange
        Slice NamevalueRange
        Control0..1
        TypeRange(Range (IPS))
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        56. Observation.value[x]:valueRatio
        Slice NamevalueRatio
        Control0..1
        TypeRatio(Ratio (Eu Lab))
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        58. Observation.value[x]:valueTime
        Slice NamevalueTime
        Control0..1
        Typetime
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        60. Observation.value[x]:valueDateTime
        Slice NamevalueDateTime
        Control0..1
        TypedateTime
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        62. Observation.value[x]:valuePeriod
        Slice NamevaluePeriod
        Control0..1
        TypePeriod
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        64. Observation.value[x]:valueQuantity
        Slice NamevalueQuantity
        Control0..1
        TypeQuantity(Quantity (Eu Lab))
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        66. Observation.value[x]:valueCodeableConcept
        Slice NamevalueCodeableConcept
        Control0..1
        BindingThe codes SHOULD be taken from Results Coded Values Laboratory - IPS
        (preferred to http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips)
        TypeCodeableConcept
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        68. Observation.dataAbsentReason
        ShortProvides a reason why the expected value is missing.
        70. Observation.method
        Definition

        Laboratory technigue that has been used

        Comments

        Laboratory technique (method of measurement) are integral parts of the test specification of some laboratory test coding systems (e.g. NPU), in LOINC hovewer measurement principle is not always present in the test definition. In some cases however knowledge of the used measurment techique is important for proper interpretation of the test result. That's why it is important to explicitly include informaiton about measurement method is such cases.

        BindingThe codes SHOULD be taken from Laboratory Techniques
        (preferred to http://hl7.eu/fhir/laboratory/ValueSet/lab-technique-eu-lab)
        72. Observation.specimen
        Comments

        When the specimen is applicable and known it shall be documented

        TypeReference(CH LAB-Report Specimen)
        74. Observation.device
        ShortMeasuring instrument
        76. Observation.hasMember
        Definition

        A reference to another Observation profiled by ch-lab-observation-results-laboratory. The target observation (for instance an individual test member of a panel) is considered as a sub-observation of the current one, which plays the role of a grouper.

        Comments

        This element is used in the context of international patient summary when there is a need to group a collection of observations, because they belong to the same panel, or because they share a common interpretation comment, or a common media attachment (illustrative image or graph). In these cases, the current observation is the grouper, and its set of sub-observations are related observations using the type "has-member". For a discussion on the ways Observations can be assembled in groups together see Observation Grouping.

        TypeReference(CH LAB-Report Observation Results: Laboratory Report)
        78. Observation.component
        ShortLaboratory result
        80. Observation.component.extension
        SlicingThis element introduces a set of slices on Observation.component.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 82. Observation.component.extension:value-r5
          Slice Namevalue-r5
          Shortonly for result of type Attachment
          Control0..1
          TypeExtension(Extension Definition for Observation.value[x] for Version 5.0) (Extension Type: Choice of: Attachment, Reference(MolecularSequence))
          84. Observation.component.extension:value-r5.value[x]
          TypeAttachment
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          86. Observation.component.value[x]
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          SlicingThis element introduces a set of slices on Observation.component.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
          • type @ $this
          • 88. Observation.component.value[x]:valueString
            Slice NamevalueString
            Control0..1
            Typestring
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            90. Observation.component.value[x]:valueBoolean
            Slice NamevalueBoolean
            Control0..1
            Typeboolean
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            92. Observation.component.value[x]:valueRange
            Slice NamevalueRange
            Control0..1
            TypeRange(Range (IPS))
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            94. Observation.component.value[x]:valueRatio
            Slice NamevalueRatio
            Control0..1
            TypeRatio(Ratio (Eu Lab))
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            96. Observation.component.value[x]:valueTime
            Slice NamevalueTime
            Control0..1
            Typetime
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            98. Observation.component.value[x]:valueDateTime
            Slice NamevalueDateTime
            Control0..1
            TypedateTime
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            100. Observation.component.value[x]:valuePeriod
            Slice NamevaluePeriod
            Control0..1
            TypePeriod
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            102. Observation.component.value[x]:valueQuantity
            Slice NamevalueQuantity
            Control0..1
            TypeQuantity(Quantity (Eu Lab))
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            104. Observation.component.value[x]:valueCodeableConcept
            Slice NamevalueCodeableConcept
            Control0..1
            BindingThe codes SHOULD be taken from Results Coded Values Laboratory - IPS
            (preferred to http://hl7.org/fhir/uv/ips/ValueSet/results-coded-values-laboratory-uv-ips)
            TypeCodeableConcept
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]