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

Page standards status: Informative Maturity Level: 2

Definitions for the Subject logical model.

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

0. Subject
Definition

Patient or Subject of care. Sections A1.1 and A1.2 of the eHN guideline.

ShortA1.1, A1.2 - Subject of care
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Subject.identification
Definition

A.1.1 Identification of the patient/subject

ShortA.1.1 Identification of the patient/subject
Control1..1
TypeBackboneElement
4. Subject.identification.familyName
Definition

The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present.

ShortA.1.1.1 Familyname/surname
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. Subject.identification.givenName
Definition

The given name/first name of the patient (also known as forename or first name). This field can contain more than one element.

ShortA.1.1.2 Given name
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. Subject.identification.dateOfBirth
Definition

The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601

ShortA.1.1.3 Date of birth
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. Subject.identification.identifier
Definition

An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for Czech patient. Multiple identifiers could be provided.

ShortA.1.1.4 Personal identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
12. Subject.identification.gender
Definition

This field must contain a recognised valid value for 'administrative gender'. If different, 'physiological gender' should be communicated elsewhere Preferred system(s): - Preferred system(s): HL7 Administrative Gender

ShortA.1.1.5 Gender
Control0..1
TypeCodeableConcept
14. Subject.addressTelecom
Definition

A.1.2 Patient/subject related contact information

ShortA.1.2 Patient/subject related contact information
Control0..*
TypeBackboneElement
16. Subject.addressTelecom.address
Definition

Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. - Preferred system(s): ISO 3166

ShortA.1.2.1 Address
Control0..*
TypeAddress
18. Subject.addressTelecom.telecom
Definition

Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. - Preferred system(s):

ShortA.1.2.2 Telecom
Control0..*
TypeContactPoint

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

0. Subject
Definition

Patient or Subject of care. Sections A1.1 and A1.2 of the eHN guideline.

ShortA1.1, A1.2 - Subject of care
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. Subject.identification
Definition

A.1.1 Identification of the patient/subject

ShortA.1.1 Identification of the patient/subject
Control1..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Subject.identification.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. Subject.identification.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 Subject.identification.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. Subject.identification.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. Subject.identification.familyName
    Definition

    The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present.

    ShortA.1.1.1 Familyname/surname
    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. Subject.identification.givenName
    Definition

    The given name/first name of the patient (also known as forename or first name). This field can contain more than one element.

    ShortA.1.1.2 Given name
    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. Subject.identification.dateOfBirth
    Definition

    The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601

    ShortA.1.1.3 Date of birth
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. Subject.identification.identifier
    Definition

    An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for Czech patient. Multiple identifiers could be provided.

    ShortA.1.1.4 Personal identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    TypeIdentifier
    18. Subject.identification.gender
    Definition

    This field must contain a recognised valid value for 'administrative gender'. If different, 'physiological gender' should be communicated elsewhere Preferred system(s): - Preferred system(s): HL7 Administrative Gender

    ShortA.1.1.5 Gender
    Control0..1
    TypeCodeableConcept
    20. Subject.addressTelecom
    Definition

    A.1.2 Patient/subject related contact information

    ShortA.1.2 Patient/subject related contact information
    Control0..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Subject.addressTelecom.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
    24. Subject.addressTelecom.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 Subject.addressTelecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 26. Subject.addressTelecom.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())
      28. Subject.addressTelecom.address
      Definition

      Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. - Preferred system(s): ISO 3166

      ShortA.1.2.1 Address
      Control0..*
      TypeAddress
      30. Subject.addressTelecom.telecom
      Definition

      Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. - Preferred system(s):

      ShortA.1.2.2 Telecom
      Control0..*
      TypeContactPoint

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

      0. Subject
      Definition

      Patient or Subject of care. Sections A1.1 and A1.2 of the eHN guideline.

      ShortA1.1, A1.2 - Subject of care
      Control0..*
      Is Modifierfalse
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      2. Subject.identification
      Definition

      A.1.1 Identification of the patient/subject

      ShortA.1.1 Identification of the patient/subject
      Control1..1
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      4. Subject.identification.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. Subject.identification.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 Subject.identification.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 8. Subject.identification.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. Subject.identification.familyName
        Definition

        The family name/surname/last name of the patient. This field can contain more than one element or multiple fields could be present.

        ShortA.1.1.1 Familyname/surname
        Control0..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        12. Subject.identification.givenName
        Definition

        The given name/first name of the patient (also known as forename or first name). This field can contain more than one element.

        ShortA.1.1.2 Given name
        Control0..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        14. Subject.identification.dateOfBirth
        Definition

        The date of birth of the patient [ISO TS 22220]. As age of the patient might be important for correct interpretation of the test result values, complete date of birth should be provided. - Preferred system(s): Complete date, without time, following the ISO 8601

        ShortA.1.1.3 Date of birth
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        16. Subject.identification.identifier
        Definition

        An identifier of the patient that is unique within a defined scope. Example: National ID (birth number) for Czech patient. Multiple identifiers could be provided.

        ShortA.1.1.4 Personal identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..1
        TypeIdentifier
        18. Subject.identification.gender
        Definition

        This field must contain a recognised valid value for 'administrative gender'. If different, 'physiological gender' should be communicated elsewhere Preferred system(s): - Preferred system(s): HL7 Administrative Gender

        ShortA.1.1.5 Gender
        Control0..1
        TypeCodeableConcept
        20. Subject.addressTelecom
        Definition

        A.1.2 Patient/subject related contact information

        ShortA.1.2 Patient/subject related contact information
        Control0..*
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. Subject.addressTelecom.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
        24. Subject.addressTelecom.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 Subject.addressTelecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 26. Subject.addressTelecom.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())
          28. Subject.addressTelecom.address
          Definition

          Mailing and home or office addresses. The addresses are always sequences of address parts (e.g. street address line, country, ZIP code, city) even if postal address formats may vary depending on the country. An address may or may not include a specific use code; if this attribute is not present it is assumed to be the default address useful for any purpose. - Preferred system(s): ISO 3166

          ShortA.1.2.1 Address
          Control0..*
          TypeAddress
          30. Subject.addressTelecom.telecom
          Definition

          Telecommunication contact information (addresses) associated to a person. Multiple telecommunication addresses might be provided. - Preferred system(s):

          ShortA.1.2.2 Telecom
          Control0..*
          TypeContactPoint