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: OrderLabEhn - Detailed Descriptions

Page standards status: Informative Maturity Level: 2

Definitions for the Order logical model.

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

0. Order
Definition

Order information and reason. Sections A2 and A3 of the eHN guideline.

ShortA2, A3 - Order
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Order.orderDetails
Definition

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

ShortA.2 Order information
Control0..1
TypeBackboneElement
4. Order.orderDetails.identifier
Definition

An identifier of the laboratory test order. Laboratory Result Report may respond to multiple orders.

ShortA.2.1 Order Id
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
6. Order.orderDetails.dateTime
Definition

Date and time of the order placement. - Preferred system(s): ISO 8601

ShortA.2.2 Order date and time
Control0..*
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. Order.orderDetails.orderPlacerIdentifier
Definition

The health professional identification number. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the license or registration number. In case when order placer is not a health professional, e.g. by patients themselves where applicable, appropriate personal identifier should be used.

ShortA.2.3 Order placer identifier
Control0..*
TypeIdentifier
10. Order.orderDetails.orderPlacerName
Definition

Person name.

ShortA.2.4 Order placer name
Control0..*
TypeHumanName
12. Order.orderDetails.orderPlacerContacts
Definition

Contact details of order placer (address and telecom details).

ShortA.2.5 Order placer contact details
Control0..*
TypeBackboneElement
14. Order.orderDetails.orderPlacerOrganization
Definition

Order placer organization information.

ShortA.2.6 Order placer organization
Control0..*
TypeOrganization
16. Order.reason
Definition

A.3 Order reason (Laboratory Result Report could respond to multiple reasons)

ShortA.3 Order reason
Control0..*
TypeBackboneElement
18. Order.reason.code
Definition

Health conditions affecting the health of the patient and are important to be known for a health professional during a health encounter. Clinical conditions of the subject relevant for the results interpretation.

  • Preferred system(s): ICD-10 (ICD-11 when available)
  • Preferred system(s): SNOMED CT
  • Preferred system(s): Orphacode
ShortA.3.1 Problem / diagnosis / condition description
Control0..*
TypeCodeableConcept

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

0. Order
Definition

Order information and reason. Sections A2 and A3 of the eHN guideline.

ShortA2, A3 - Order
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Order.orderDetails
Definition

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

ShortA.2 Order information
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Order.orderDetails.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. Order.orderDetails.identifier
Definition

An identifier of the laboratory test order. Laboratory Result Report may respond to multiple orders.

ShortA.2.1 Order Id
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
8. Order.orderDetails.dateTime
Definition

Date and time of the order placement. - Preferred system(s): ISO 8601

ShortA.2.2 Order date and time
Control0..*
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Order.orderDetails.orderPlacerIdentifier
Definition

The health professional identification number. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the license or registration number. In case when order placer is not a health professional, e.g. by patients themselves where applicable, appropriate personal identifier should be used.

ShortA.2.3 Order placer identifier
Control0..*
TypeIdentifier
12. Order.orderDetails.orderPlacerName
Definition

Person name.

ShortA.2.4 Order placer name
Control0..*
TypeHumanName
14. Order.orderDetails.orderPlacerContacts
Definition

Contact details of order placer (address and telecom details).

ShortA.2.5 Order placer contact details
Control0..*
TypeBackboneElement
16. Order.orderDetails.orderPlacerOrganization
Definition

Order placer organization information.

ShortA.2.6 Order placer organization
Control0..*
TypeOrganization
18. Order.reason
Definition

A.3 Order reason (Laboratory Result Report could respond to multiple reasons)

ShortA.3 Order reason
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. Order.reason.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. Order.reason.code
Definition

Health conditions affecting the health of the patient and are important to be known for a health professional during a health encounter. Clinical conditions of the subject relevant for the results interpretation.

  • Preferred system(s): ICD-10 (ICD-11 when available)
  • Preferred system(s): SNOMED CT
  • Preferred system(s): Orphacode
ShortA.3.1 Problem / diagnosis / condition description
Control0..*
TypeCodeableConcept

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

0. Order
Definition

Order information and reason. Sections A2 and A3 of the eHN guideline.

ShortA2, A3 - Order
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Order.orderDetails
Definition

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

ShortA.2 Order information
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Order.orderDetails.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. Order.orderDetails.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 Order.orderDetails.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. Order.orderDetails.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. Order.orderDetails.identifier
    Definition

    An identifier of the laboratory test order. Laboratory Result Report may respond to multiple orders.

    ShortA.2.1 Order Id
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    12. Order.orderDetails.dateTime
    Definition

    Date and time of the order placement. - Preferred system(s): ISO 8601

    ShortA.2.2 Order date and time
    Control0..*
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. Order.orderDetails.orderPlacerIdentifier
    Definition

    The health professional identification number. Either an internal identifier assigned by a healthcare provider institution or (preferably) a national health professional ID such as the license or registration number. In case when order placer is not a health professional, e.g. by patients themselves where applicable, appropriate personal identifier should be used.

    ShortA.2.3 Order placer identifier
    Control0..*
    TypeIdentifier
    16. Order.orderDetails.orderPlacerName
    Definition

    Person name.

    ShortA.2.4 Order placer name
    Control0..*
    TypeHumanName
    18. Order.orderDetails.orderPlacerContacts
    Definition

    Contact details of order placer (address and telecom details).

    ShortA.2.5 Order placer contact details
    Control0..*
    TypeBackboneElement
    20. Order.orderDetails.orderPlacerOrganization
    Definition

    Order placer organization information.

    ShortA.2.6 Order placer organization
    Control0..*
    TypeOrganization
    22. Order.reason
    Definition

    A.3 Order reason (Laboratory Result Report could respond to multiple reasons)

    ShortA.3 Order reason
    Control0..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. Order.reason.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. Order.reason.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 Order.reason.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 28. Order.reason.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. Order.reason.code
      Definition

      Health conditions affecting the health of the patient and are important to be known for a health professional during a health encounter. Clinical conditions of the subject relevant for the results interpretation.

      • Preferred system(s): ICD-10 (ICD-11 when available)
      • Preferred system(s): SNOMED CT
      • Preferred system(s): Orphacode
      ShortA.3.1 Problem / diagnosis / condition description
      Control0..*
      TypeCodeableConcept