MyHealth@Eu Laboratory Report
0.0.1 - qa-preview 150

This page is part of the MyHealth@Eu Laboratory Report (v0.0.1: QA Preview) 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: SpecimenLabMyHEU - Detailed Descriptions

Draft as of 2024-04-18

Definitions for the SpecimenLab logical model.

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

0. SpecimenLab
Definition

Specimen information. Section A4 of the MyHealth@EUguideline.

ShortSpecimen information
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SpecimenLab.identifier
Definition

An identifier of the specimen which is unique within in a defined scope. Example: identifier assigned by Specimening system, identifier assigned by laboratory etc. Multiple identifiers can be used. - Preferred system(s):

ShortSpecimen identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Obligations
    ObligationsActor
    handleLabReportHandler
    4. SpecimenLab.speciesType
    Definition

    Biologic type of species for laboratory result reports bound to non-human subjects. - Preferred system(s): SNOMED CT

    ShortType of species
    Control0..*
    TypeCodeableConcept
    6. SpecimenLab.material
    Definition

    Specimen material. - Preferred system(s): SNOMED CT

    ShortMaterial
    Control0..*
    TypeCodeableConcept
    Obligations
      ObligationsActor
      handleLabReportHandler
      8. SpecimenLab.collected
      Definition

      Collection date time or period. - Preferred system(s): ISO 8601

      ShortCollection period
      Control0..*
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      10. SpecimenLab.anatomicLocation
      Definition

      Anatomic location (body location, laterality) where the material is collected, e.g. Elbow, left - Preferred system(s): SNOMED CT

      ShortAnatomic location
      Control0..*
      TypeBackboneElement
      12. SpecimenLab.anatomicLocation.location
      Definition

      The anatomical location or region of the specimen

      ShortBody location
      Control0..*
      TypeCodeableConcept
      14. SpecimenLab.anatomicLocation.laterality
      Definition

      Body side of the body location, if needed to distinguish from a similar location on the other side of the body.

      ShortLaterality
      Control0..*
      TypeCodeableConcept
      16. SpecimenLab.anatomicLocation.qualifier
      Definition

      Qualifier to refine the anatomical location. These include qualifiers for relative location, directionality, number, and plane.

      ShortSpecimen site qualifier
      Control0..*
      TypeCodeableConcept
      18. SpecimenLab.morphology
      Definition

      Morphological abnormalities of the anatomical location where the material is taken, for example wound, ulcer. - Preferred system(s): SNOMED CT

      ShortMorphology
      Control0..*
      TypeCodeableConcept
      20. SpecimenLab.sourceDevice
      Definition

      If the material is not collected directly from the patient but comes from a patient-related object, e.g. a catheter

      • Preferred system(s): SNOMED CT
      • Preferred system(s): EMDN
      ShortSource Device
      Control0..*
      TypeBackboneElement
      22. SpecimenLab.sourceDevice.type
      Definition

      If the material is not collected directly from the patient but comes from a patient-related object, e.g. a catheter

      ShortType of device
      Control0..*
      TypeCodeableConcept
      24. SpecimenLab.sourceDevice.name
      Definition

      The name of the device as given by the manufacturer

      ShortDevice Name
      Control0..*
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      26. SpecimenLab.sourceDevice.modelName
      Definition

      Model name of the device

      ShortModel Name
      Control0..*
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. SpecimenLab.sourceDevice.identifier
      Definition

      Unique device identifier

      ShortDevice Identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      30. SpecimenLab.sourceDevice.manufacturer
      Definition

      Name of device manufacturer

      ShortManufacturer
      Control0..*
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      32. SpecimenLab.collectionMethod
      Definition

      If relevant for the results, the method of obtaining the specimen.

      ShortCollection procedure/method
      Control0..*
      TypeCodeableConcept
      34. SpecimenLab.receivedDateTime
      Definition

      Date and time that the material is handed over at the laboratory or specimen collection Centre.

      ShortReceived date
      Control0..*
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

      0. SpecimenLab
      Definition

      Specimen information. Section A4 of the MyHealth@EUguideline.

      ShortSpecimen information
      Control0..*
      Is Modifierfalse
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      2. SpecimenLab.identifier
      Definition

      An identifier of the specimen which is unique within in a defined scope. Example: identifier assigned by Specimening system, identifier assigned by laboratory etc. Multiple identifiers can be used. - Preferred system(s):

      ShortSpecimen identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Obligations
        ObligationsActor
        handleLabReportHandler
        4. SpecimenLab.speciesType
        Definition

        Biologic type of species for laboratory result reports bound to non-human subjects. - Preferred system(s): SNOMED CT

        ShortType of species
        Control0..*
        TypeCodeableConcept
        6. SpecimenLab.material
        Definition

        Specimen material. - Preferred system(s): SNOMED CT

        ShortMaterial
        Control0..*
        TypeCodeableConcept
        Obligations
          ObligationsActor
          handleLabReportHandler
          8. SpecimenLab.collected
          Definition

          Collection date time or period. - Preferred system(s): ISO 8601

          ShortCollection period
          Control0..*
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          10. SpecimenLab.anatomicLocation
          Definition

          Anatomic location (body location, laterality) where the material is collected, e.g. Elbow, left - Preferred system(s): SNOMED CT

          ShortAnatomic location
          Control0..*
          TypeBackboneElement
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. SpecimenLab.anatomicLocation.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())
          14. SpecimenLab.anatomicLocation.location
          Definition

          The anatomical location or region of the specimen

          ShortBody location
          Control0..*
          TypeCodeableConcept
          16. SpecimenLab.anatomicLocation.laterality
          Definition

          Body side of the body location, if needed to distinguish from a similar location on the other side of the body.

          ShortLaterality
          Control0..*
          TypeCodeableConcept
          18. SpecimenLab.anatomicLocation.qualifier
          Definition

          Qualifier to refine the anatomical location. These include qualifiers for relative location, directionality, number, and plane.

          ShortSpecimen site qualifier
          Control0..*
          TypeCodeableConcept
          20. SpecimenLab.morphology
          Definition

          Morphological abnormalities of the anatomical location where the material is taken, for example wound, ulcer. - Preferred system(s): SNOMED CT

          ShortMorphology
          Control0..*
          TypeCodeableConcept
          22. SpecimenLab.sourceDevice
          Definition

          If the material is not collected directly from the patient but comes from a patient-related object, e.g. a catheter

          • Preferred system(s): SNOMED CT
          • Preferred system(s): EMDN
          ShortSource Device
          Control0..*
          TypeBackboneElement
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          24. SpecimenLab.sourceDevice.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())
          26. SpecimenLab.sourceDevice.type
          Definition

          If the material is not collected directly from the patient but comes from a patient-related object, e.g. a catheter

          ShortType of device
          Control0..*
          TypeCodeableConcept
          28. SpecimenLab.sourceDevice.name
          Definition

          The name of the device as given by the manufacturer

          ShortDevice Name
          Control0..*
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          30. SpecimenLab.sourceDevice.modelName
          Definition

          Model name of the device

          ShortModel Name
          Control0..*
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          32. SpecimenLab.sourceDevice.identifier
          Definition

          Unique device identifier

          ShortDevice Identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          34. SpecimenLab.sourceDevice.manufacturer
          Definition

          Name of device manufacturer

          ShortManufacturer
          Control0..*
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          36. SpecimenLab.collectionMethod
          Definition

          If relevant for the results, the method of obtaining the specimen.

          ShortCollection procedure/method
          Control0..*
          TypeCodeableConcept
          38. SpecimenLab.receivedDateTime
          Definition

          Date and time that the material is handed over at the laboratory or specimen collection Centre.

          ShortReceived date
          Control0..*
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

          0. SpecimenLab
          Definition

          Specimen information. Section A4 of the MyHealth@EUguideline.

          ShortSpecimen information
          Control0..*
          Is Modifierfalse
          Logical ModelInstances of this logical model are not marked to be the target of a Reference
          2. SpecimenLab.identifier
          Definition

          An identifier of the specimen which is unique within in a defined scope. Example: identifier assigned by Specimening system, identifier assigned by laboratory etc. Multiple identifiers can be used. - Preferred system(s):

          ShortSpecimen identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          Obligations
            ObligationsActor
            handleLabReportHandler
            4. SpecimenLab.speciesType
            Definition

            Biologic type of species for laboratory result reports bound to non-human subjects. - Preferred system(s): SNOMED CT

            ShortType of species
            Control0..*
            TypeCodeableConcept
            6. SpecimenLab.material
            Definition

            Specimen material. - Preferred system(s): SNOMED CT

            ShortMaterial
            Control0..*
            TypeCodeableConcept
            Obligations
              ObligationsActor
              handleLabReportHandler
              8. SpecimenLab.collected
              Definition

              Collection date time or period. - Preferred system(s): ISO 8601

              ShortCollection period
              Control0..*
              TypedateTime
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              10. SpecimenLab.anatomicLocation
              Definition

              Anatomic location (body location, laterality) where the material is collected, e.g. Elbow, left - Preferred system(s): SNOMED CT

              ShortAnatomic location
              Control0..*
              TypeBackboneElement
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              12. SpecimenLab.anatomicLocation.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
              14. SpecimenLab.anatomicLocation.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 SpecimenLab.anatomicLocation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 16. SpecimenLab.anatomicLocation.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())
                18. SpecimenLab.anatomicLocation.location
                Definition

                The anatomical location or region of the specimen

                ShortBody location
                Control0..*
                TypeCodeableConcept
                20. SpecimenLab.anatomicLocation.laterality
                Definition

                Body side of the body location, if needed to distinguish from a similar location on the other side of the body.

                ShortLaterality
                Control0..*
                TypeCodeableConcept
                22. SpecimenLab.anatomicLocation.qualifier
                Definition

                Qualifier to refine the anatomical location. These include qualifiers for relative location, directionality, number, and plane.

                ShortSpecimen site qualifier
                Control0..*
                TypeCodeableConcept
                24. SpecimenLab.morphology
                Definition

                Morphological abnormalities of the anatomical location where the material is taken, for example wound, ulcer. - Preferred system(s): SNOMED CT

                ShortMorphology
                Control0..*
                TypeCodeableConcept
                26. SpecimenLab.sourceDevice
                Definition

                If the material is not collected directly from the patient but comes from a patient-related object, e.g. a catheter

                • Preferred system(s): SNOMED CT
                • Preferred system(s): EMDN
                ShortSource Device
                Control0..*
                TypeBackboneElement
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                28. SpecimenLab.sourceDevice.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
                30. SpecimenLab.sourceDevice.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 SpecimenLab.sourceDevice.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 32. SpecimenLab.sourceDevice.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())
                  34. SpecimenLab.sourceDevice.type
                  Definition

                  If the material is not collected directly from the patient but comes from a patient-related object, e.g. a catheter

                  ShortType of device
                  Control0..*
                  TypeCodeableConcept
                  36. SpecimenLab.sourceDevice.name
                  Definition

                  The name of the device as given by the manufacturer

                  ShortDevice Name
                  Control0..*
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  38. SpecimenLab.sourceDevice.modelName
                  Definition

                  Model name of the device

                  ShortModel Name
                  Control0..*
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  40. SpecimenLab.sourceDevice.identifier
                  Definition

                  Unique device identifier

                  ShortDevice Identifier
                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..*
                  TypeIdentifier
                  42. SpecimenLab.sourceDevice.manufacturer
                  Definition

                  Name of device manufacturer

                  ShortManufacturer
                  Control0..*
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  44. SpecimenLab.collectionMethod
                  Definition

                  If relevant for the results, the method of obtaining the specimen.

                  ShortCollection procedure/method
                  Control0..*
                  TypeCodeableConcept
                  46. SpecimenLab.receivedDateTime
                  Definition

                  Date and time that the material is handed over at the laboratory or specimen collection Centre.

                  ShortReceived date
                  Control0..*
                  TypedateTime
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension