HL7 Europe Laboratory Report
0.2.0-ci - ci-build 150

HL7 Europe Laboratory Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/laboratory/ and changes regularly. See the Directory of published versions

Logical Model: LabReportEhn - Detailed Descriptions

Page standards status: Informative Maturity Level: 2

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. eHN guideline model.

ShortA - Laboratory Report
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. LabReport.header
Definition

A.1 Report header data elements

ShortA.1 Report header data elements
Control1..1
TypeBackboneElement
4. LabReport.header.subject
Definition

A.1.1 Identification of the patient/subject and A.1.2 Patient/subject related contact information

ShortA.1.1 - A1.2 Patient/subject
Control1..1
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Subject
6. LabReport.header.payer
Definition

A.1.3 Health insurance and payment information

ShortA.1.3 Health insurance and payment information
Control0..1
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Payer
8. LabReport.header.informationRecipient
Definition

A.1.4 Information recipient (intended recipient or recipients of the report, additional recipients might be identified by the ordering party, e.g. GP, other specialist), if applicable

ShortA.1.4 Information recipient
Control0..1
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Recipient
10. LabReport.header.author
Definition

A.1.5 Author (by whom the Laboratory result report or a subset of its results was authored)

ShortA.1.5 Author
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Author
12. LabReport.header.legalAuthenticator
Definition

A.1.6 Legal authenticator (The person taking responsibility for the medical content of the document)

ShortA.1.6 Legal authenticator
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/LegalAuthenticator
14. LabReport.header.validator
Definition

A.1.7 Result validator

ShortA.1.7 Result validator
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Validator
16. LabReport.header.metadata
Definition

A.1.8 Laboratory report metadata

ShortA.1.8 Laboratory report metadata
Control1..1
TypeBackboneElement
18. LabReport.header.metadata.documentId
Definition

Unique identifier of the document

ShortA.1.8.0 Document Id
Control1..1
TypeIdentifier
20. LabReport.header.metadata.type
Definition

A coded type of the document. Fixed value ""Laboratory report"" - Preferred system(s): LOINC

ShortA.1.8.1 Document type
Control1..1
TypeCodeableConcept
22. LabReport.header.metadata.status
Definition

The status of the laboratory test result report. E.g., preliminary, final. - Preferred system(s): hl7:DiagnosticReportStatus

ShortA.1.8.2 Document status
Control1..1
TypeCodeableConcept
24. LabReport.header.metadata.dateTime
Definition

Date and time of the result report creation. - Preferred system(s): ISO 8601

ShortA.1.8.3 Report date and time
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. LabReport.header.metadata.title
Definition

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

ShortA.1.8.4 Document title
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. LabReport.header.metadata.studyType
Definition

Type (or types) of the laboratory study performed. - Preferred system(s): LOINC SNOMED CT

ShortA.1.8.5 Study type
Control0..*
TypeCodeableConcept
30. LabReport.header.metadata.custodian
Definition

Organisation that is in charge of maintaining the laboratory report

ShortA.1.8.6 Report custodian
Control0..1
TypeBackboneElement
32. LabReport.header.metadata.confidentiality
Definition

Level of confidentiality of the document. Implicit value is normal. - Preferred system(s): hl7:Confidentiality

ShortA.1.8.7 Confidentiality
Control0..1
TypeCodeableConcept
34. LabReport.header.metadata.language
Definition

Language in which the document is written. Language is expressed by the ISO language code.- Preferred system(s): BCP 47

ShortA.1.8.8 Language
Control0..1
TypeCodeableConcept
36. LabReport.header.metadata.version
Definition

Version of the document.

ShortA.1.8.9 Version
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
38. LabReport.order
Definition

A.2 Order information (Laboratory Result Report could respond to multiple test orders) A.3 Order reason (Laboratory Result Report could respond to multiple reasons)

ShortA.2-A.3 Order
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Order
40. LabReport.specimen
Definition

A.4 Specimen information

ShortA.4 Specimen information
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/SpecimenLab
42. LabReport.result
Definition

A.5 Results data elements

ShortA.5 Results data elements
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Result

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

0. LabReport
Definition

Laboratory Report. eHN guideline model.

ShortA - Laboratory Report
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. LabReport.header
Definition

A.1 Report header data elements

ShortA.1 Report header data elements
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. 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())
6. LabReport.header.subject
Definition

A.1.1 Identification of the patient/subject and A.1.2 Patient/subject related contact information

ShortA.1.1 - A1.2 Patient/subject
Control1..1
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Subject
8. LabReport.header.payer
Definition

A.1.3 Health insurance and payment information

ShortA.1.3 Health insurance and payment information
Control0..1
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Payer
10. LabReport.header.informationRecipient
Definition

A.1.4 Information recipient (intended recipient or recipients of the report, additional recipients might be identified by the ordering party, e.g. GP, other specialist), if applicable

ShortA.1.4 Information recipient
Control0..1
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Recipient
12. LabReport.header.author
Definition

A.1.5 Author (by whom the Laboratory result report or a subset of its results was authored)

ShortA.1.5 Author
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Author
14. LabReport.header.legalAuthenticator
Definition

A.1.6 Legal authenticator (The person taking responsibility for the medical content of the document)

ShortA.1.6 Legal authenticator
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/LegalAuthenticator
16. LabReport.header.validator
Definition

A.1.7 Result validator

ShortA.1.7 Result validator
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Validator
18. LabReport.header.metadata
Definition

A.1.8 Laboratory report metadata

ShortA.1.8 Laboratory report metadata
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. 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())
22. LabReport.header.metadata.documentId
Definition

Unique identifier of the document

ShortA.1.8.0 Document Id
Control1..1
TypeIdentifier
24. LabReport.header.metadata.type
Definition

A coded type of the document. Fixed value ""Laboratory report"" - Preferred system(s): LOINC

ShortA.1.8.1 Document type
Control1..1
TypeCodeableConcept
26. LabReport.header.metadata.status
Definition

The status of the laboratory test result report. E.g., preliminary, final. - Preferred system(s): hl7:DiagnosticReportStatus

ShortA.1.8.2 Document status
Control1..1
TypeCodeableConcept
28. LabReport.header.metadata.dateTime
Definition

Date and time of the result report creation. - Preferred system(s): ISO 8601

ShortA.1.8.3 Report date and time
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. LabReport.header.metadata.title
Definition

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

ShortA.1.8.4 Document title
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. LabReport.header.metadata.studyType
Definition

Type (or types) of the laboratory study performed. - Preferred system(s): LOINC SNOMED CT

ShortA.1.8.5 Study type
Control0..*
TypeCodeableConcept
34. LabReport.header.metadata.custodian
Definition

Organisation that is in charge of maintaining the laboratory report

ShortA.1.8.6 Report custodian
Control0..1
TypeBackboneElement
36. LabReport.header.metadata.confidentiality
Definition

Level of confidentiality of the document. Implicit value is normal. - Preferred system(s): hl7:Confidentiality

ShortA.1.8.7 Confidentiality
Control0..1
TypeCodeableConcept
38. LabReport.header.metadata.language
Definition

Language in which the document is written. Language is expressed by the ISO language code.- Preferred system(s): BCP 47

ShortA.1.8.8 Language
Control0..1
TypeCodeableConcept
40. LabReport.header.metadata.version
Definition

Version of the document.

ShortA.1.8.9 Version
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
42. LabReport.order
Definition

A.2 Order information (Laboratory Result Report could respond to multiple test orders) A.3 Order reason (Laboratory Result Report could respond to multiple reasons)

ShortA.2-A.3 Order
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Order
44. LabReport.specimen
Definition

A.4 Specimen information

ShortA.4 Specimen information
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/SpecimenLab
46. LabReport.result
Definition

A.5 Results data elements

ShortA.5 Results data elements
Control0..*
Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Result

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

0. LabReport
Definition

Laboratory Report. eHN guideline model.

ShortA - Laboratory Report
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. LabReport.header
Definition

A.1 Report header data elements

ShortA.1 Report header data elements
Control1..1
TypeBackboneElement
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

    A.1.1 Identification of the patient/subject and A.1.2 Patient/subject related contact information

    ShortA.1.1 - A1.2 Patient/subject
    Control1..1
    Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Subject
    12. LabReport.header.payer
    Definition

    A.1.3 Health insurance and payment information

    ShortA.1.3 Health insurance and payment information
    Control0..1
    Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Payer
    14. LabReport.header.informationRecipient
    Definition

    A.1.4 Information recipient (intended recipient or recipients of the report, additional recipients might be identified by the ordering party, e.g. GP, other specialist), if applicable

    ShortA.1.4 Information recipient
    Control0..1
    Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Recipient
    16. LabReport.header.author
    Definition

    A.1.5 Author (by whom the Laboratory result report or a subset of its results was authored)

    ShortA.1.5 Author
    Control0..*
    Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Author
    18. LabReport.header.legalAuthenticator
    Definition

    A.1.6 Legal authenticator (The person taking responsibility for the medical content of the document)

    ShortA.1.6 Legal authenticator
    Control0..*
    Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/LegalAuthenticator
    20. LabReport.header.validator
    Definition

    A.1.7 Result validator

    ShortA.1.7 Result validator
    Control0..*
    Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Validator
    22. LabReport.header.metadata
    Definition

    A.1.8 Laboratory report metadata

    ShortA.1.8 Laboratory report metadata
    Control1..1
    TypeBackboneElement
    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

      ShortA.1.8.0 Document Id
      Control1..1
      TypeIdentifier
      32. LabReport.header.metadata.type
      Definition

      A coded type of the document. Fixed value ""Laboratory report"" - Preferred system(s): LOINC

      ShortA.1.8.1 Document type
      Control1..1
      TypeCodeableConcept
      34. LabReport.header.metadata.status
      Definition

      The status of the laboratory test result report. E.g., preliminary, final. - Preferred system(s): hl7:DiagnosticReportStatus

      ShortA.1.8.2 Document status
      Control1..1
      TypeCodeableConcept
      36. LabReport.header.metadata.dateTime
      Definition

      Date and time of the result report creation. - Preferred system(s): ISO 8601

      ShortA.1.8.3 Report date and time
      Control1..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      38. LabReport.header.metadata.title
      Definition

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

      ShortA.1.8.4 Document title
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      40. LabReport.header.metadata.studyType
      Definition

      Type (or types) of the laboratory study performed. - Preferred system(s): LOINC SNOMED CT

      ShortA.1.8.5 Study type
      Control0..*
      TypeCodeableConcept
      42. LabReport.header.metadata.custodian
      Definition

      Organisation that is in charge of maintaining the laboratory report

      ShortA.1.8.6 Report custodian
      Control0..1
      TypeBackboneElement
      44. LabReport.header.metadata.confidentiality
      Definition

      Level of confidentiality of the document. Implicit value is normal. - Preferred system(s): hl7:Confidentiality

      ShortA.1.8.7 Confidentiality
      Control0..1
      TypeCodeableConcept
      46. LabReport.header.metadata.language
      Definition

      Language in which the document is written. Language is expressed by the ISO language code.- Preferred system(s): BCP 47

      ShortA.1.8.8 Language
      Control0..1
      TypeCodeableConcept
      48. LabReport.header.metadata.version
      Definition

      Version of the document.

      ShortA.1.8.9 Version
      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
      50. LabReport.order
      Definition

      A.2 Order information (Laboratory Result Report could respond to multiple test orders) A.3 Order reason (Laboratory Result Report could respond to multiple reasons)

      ShortA.2-A.3 Order
      Control0..*
      Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Order
      52. LabReport.specimen
      Definition

      A.4 Specimen information

      ShortA.4 Specimen information
      Control0..*
      Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/SpecimenLab
      54. LabReport.result
      Definition

      A.5 Results data elements

      ShortA.5 Results data elements
      Control0..*
      Typehttp://hl7.eu/fhir/laboratory/StructureDefinition/Result