MyHealth@Eu Laboratory Report
0.1.1 - trial-use 150

This page is part of the MyHealth@Eu Laboratory Report (v0.1.1: Wave 8) 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

Logical Model: LabReportMyHEU - Detailed Descriptions

Active as of 2025-03-20

Definitions for the LabReport logical model.

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

0. LabReport
Definition

Laboratory Report Content as defined by the MyHealth@EU business requirement '13.01 Create the MyHealth@EU Laboratory Result Report Content'.

ShortLaboratory Result Content
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. LabReport.header
Definition

Report header

ShortReport header
Control1..1
TypeBackboneElement
Obligations
    ObligationsActor
    SHALL:handleLabReportHandler
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. LabReport.header.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    6. LabReport.header.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on LabReport.header.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 8. LabReport.header.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      10. LabReport.header.subject
      Definition

      Identification of the patient/subject and Patient/subject related contact information

      ShortPatient/subject
      Control1..1
      Typehttp://fhir.ehdsi.eu/laboratory/StructureDefinition/Subject
      Obligations
        ObligationsActor
        SHALL:handleLabReportHandler
        12. LabReport.header.payer
        Definition

        Health insurance information is not always required, however, in some jurisdictions, the insurance number is also used as the patient identifier. It is necessary not just for identification but also forms access to funding for care.

        ShortHealth insurance and payment information
        Control0..1
        Typehttp://fhir.ehdsi.eu/laboratory/StructureDefinition/Payer
        14. LabReport.header.informationRecipient
        Definition

        Intended recipient or recipients of the report, additional recipients might be identified by the ordering party, e.g. GP, other specialist

        ShortInformation recipient
        Control0..*
        Typehttp://fhir.ehdsi.eu/laboratory/StructureDefinition/Recipient
        16. LabReport.header.author
        Definition

        By whom the Laboratory result report or a subset of its results was authored

        ShortAuthor
        Control1..*
        Typehttp://fhir.ehdsi.eu/laboratory/StructureDefinition/Author
        Obligations
          ObligationsActor
          SHALL:handleLabReportHandler
          18. LabReport.header.legalAuthenticator
          Definition

          The person taking responsibility for the medical content of the document

          ShortLegal authenticator
          Control1..*
          Typehttp://fhir.ehdsi.eu/laboratory/StructureDefinition/LegalAuthenticator
          Obligations
            ObligationsActor
            SHALL:handleLabReportHandler
            20. LabReport.header.validator
            Definition

            Result validator

            ShortResult validator
            Control0..*
            Typehttp://fhir.ehdsi.eu/laboratory/StructureDefinition/Validator
            22. LabReport.header.metadata
            Definition

            Laboratory report metadata

            ShortLaboratory report metadata
            Control1..1
            TypeBackboneElement
            Obligations
              ObligationsActor
              SHALL:handleLabReportHandler
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              24. LabReport.header.metadata.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              26. LabReport.header.metadata.extension
              Definition

              May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

              ShortAdditional content defined by implementations
              Comments

              There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on LabReport.header.metadata.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 28. LabReport.header.metadata.modifierExtension
                Definition

                May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                30. LabReport.header.metadata.documentId
                Definition

                Unique identifier of the document

                ShortDocument Id
                Control1..1
                TypeIdentifier
                Obligations
                  ObligationsActor
                  SHALL:handleLabReportHandler
                  32. LabReport.header.metadata.type
                  Definition

                  A coded type of the document. Fixed value 'Laboratory report'

                  ShortDocument type
                  Control1..*
                  TypeCodeableConcept
                  Obligations
                    ObligationsActor
                    SHALL:handleLabReportHandler
                    34. LabReport.header.metadata.status
                    Definition

                    The status of the laboratory test result report. E.g., preliminary, final

                    ShortDocument status
                    Control1..1
                    TypeCodeableConcept
                    Obligations
                      ObligationsActor
                      SHALL:handleLabReportHandler
                      36. LabReport.header.metadata.dateTime
                      Definition

                      Date and time of the result report creation

                      ShortReport date and time
                      Control0..1
                      TypedateTime
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Obligations
                        ObligationsActor
                        SHALL:handleLabReportHandler
                        38. LabReport.header.metadata.title
                        Definition

                        Document title, e.g. 'Laboratory Result report'

                        ShortDocument title
                        Control1..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Obligations
                          ObligationsActor
                          SHALL:handleLabReportHandler
                          40. LabReport.header.metadata.studyType
                          Definition

                          Type (or types) of the laboratory study performed.

                          ShortStudy type
                          Control0..*
                          TypeCodeableConcept
                          42. LabReport.header.metadata.custodian
                          Definition

                          Organization that is in charge of maintaining the laboratory report

                          ShortReport custodian
                          Control0..1
                          TypeBackboneElement
                          Obligations
                            ObligationsActor
                            SHALL:handleLabReportHandler
                            44. LabReport.header.metadata.confidentiality
                            Definition

                            Level of confidentiality of the document. Implicit value is normal.

                            ShortConfidentiality
                            Control0..1
                            TypeCodeableConcept
                            Obligations
                              ObligationsActor
                              SHALL:handleLabReportHandler
                              46. LabReport.header.metadata.language
                              Definition

                              Language in which the document is written. Language is expressed by the ISO language code.

                              ShortLanguage
                              Control1..*
                              TypeCodeableConcept
                              Obligations
                                ObligationsActor
                                SHALL:handleLabReportHandler
                                48. LabReport.header.metadata.version
                                Definition

                                Version of the document

                                ShortVersion
                                NoteThis is a business version Id, not a resource version Id (see discussion)
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Obligations
                                  ObligationsActor
                                  SHALL:handleLabReportHandler
                                  50. LabReport.order
                                  Definition

                                  Order information (Laboratory Result Report could respond to multiple test orders) Order reason (Laboratory Result Report could respond to multiple reasons)

                                  ShortOrder
                                  Control1..*
                                  Typehttp://fhir.ehdsi.eu/laboratory/StructureDefinition/Order
                                  Obligations
                                    ObligationsActor
                                    SHALL:handleLabReportHandler
                                    52. LabReport.specimen
                                    Definition

                                    Specimen information

                                    ShortSpecimen information
                                    Control1..*
                                    Typehttp://fhir.ehdsi.eu/laboratory/StructureDefinition/SpecimenLab
                                    Obligations
                                      ObligationsActor
                                      SHALL:handleLabReportHandler
                                      54. LabReport.result
                                      Definition

                                      Results data elements

                                      ShortResults data elements
                                      Control1..*
                                      Typehttp://fhir.ehdsi.eu/laboratory/StructureDefinition/Result
                                      Obligations
                                        ObligationsActor
                                        SHALL:handleLabReportHandler
                                        56. LabReport.pdf
                                        Definition

                                        Entire report as issued- pdf format

                                        ShortPDF document
                                        Control0..*
                                        TypeAttachment
                                        Obligations
                                          ObligationsActor
                                          SHALL:handleLabReportHandler
                                          58. LabReport.media
                                          Definition

                                          Media attachments.

                                          ShortMedia
                                          Control0..*
                                          TypeAttachment