Xt-EHR
0.1.0 - ci-build

Xt-EHR, published by Xt-EHR. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Xt-EHR/xt-ehr-common/ and changes regularly. See the Directory of published versions

Logical Model: EHDSLaboratoryReportHeader - Detailed Descriptions

Draft as of 2024-11-13

Definitions for the EHDSLaboratoryReportHeader logical model.

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

0. EHDSLaboratoryReportHeader
Definition

A.1 - EHDS refined base model for Report header data elements

ShortLaboratory report header (model)
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSLaboratoryReportHeader.subject
Definition

Patient/subject information

ShortA.1.1 - Subject
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient
4. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation
Definition

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

ShortA.1.4 - Health insurance and payment information
Control0..1
TypeBase
6. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceCode
Definition

Unique health insurance company identification code

ShortA.1.4.1 - Health insurance code
Control0..1
TypeIdentifier
8. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceName
Definition

Full, official name of the healthcare insurance provider.

ShortA.1.4.2 - Health insurance name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceNumber
Definition

Number or code under which the insured person is registered at the insurance provider.

ShortA.1.4.3 - Health insurance number
Control0..1
TypeIdentifier
12. EHDSLaboratoryReportHeader.intendedRecipient
Definition

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.5 - Intended recipient
Control0..*
TypeReference(Patient (model), Related person (model), Health professional, Organization (model), Device (model))
14. EHDSLaboratoryReportHeader.authorship
Definition

Information about author or authors of the document

ShortA.1.6 - Authorship
Control1..*
TypeBase
16. EHDSLaboratoryReportHeader.authorship.author
Definition

Author by whom the document was/were authored. Multiple authors could be provided.

ShortA.1.6.1 - Author
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
18. EHDSLaboratoryReportHeader.authorship.datetime
Definition

Date and time of the last modification of the document by its Author.

ShortA.1.6.2 - DateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. EHDSLaboratoryReportHeader.attestation
Definition

Document attestation details

ShortA.1.7 - Attestation
Control0..*
TypeBase
22. EHDSLaboratoryReportHeader.attestation.attester
Definition

Attester who validated the document. Mulitple attesters could be provided.

ShortA.1.7.1 - Attester
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
24. EHDSLaboratoryReportHeader.attestation.datetime
Definition

Date and time of the approval of the document by Attester.

ShortA.1.7.2 - DateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. EHDSLaboratoryReportHeader.legalAuthentication
Definition

Document legal authentication

ShortA.1.8 - Legal authentication
Control0..1
TypeBase
28. EHDSLaboratoryReportHeader.legalAuthentication.legalAuthenticator
Definition

The person taking responsibility for the medical content of the document

ShortA.1.8.1 - Legal authenticator
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
30. EHDSLaboratoryReportHeader.legalAuthentication.datetime
Definition

Date and time when the document was authorized.

ShortA.1.8.2 - DateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. EHDSLaboratoryReportHeader.documentMetadata
Definition

Data relevent to document type and its content for administrative and searching purposes.

ShortA.1.9 - Document metadata
Control1..1
TypeBase
34. EHDSLaboratoryReportHeader.documentMetadata.documentId
Definition

Unique identifier of the document

ShortA.1.9.1 - Document ID
Control1..1
TypeIdentifier
36. EHDSLaboratoryReportHeader.documentMetadata.documentType
Definition

Identifies the type of document at hand, e.g. Hospital discharge report.

ShortA.1.9.2 - Document type
Control1..1
Binding

LOINC

TypeCodeableConcept
38. EHDSLaboratoryReportHeader.documentMetadata.documentStatus
Definition

The status of the Hospital discharge report. E.g., preliminary, final.

ShortA.1.9.3 - Document status
Control1..1
Binding

hl7:CompositionStatus

TypeCodeableConcept
40. EHDSLaboratoryReportHeader.documentMetadata.period
Definition

Documented period service. Typically used for searching purposes.

ShortA.1.9.4 - Period
Control0..1
TypePeriod
42. EHDSLaboratoryReportHeader.documentMetadata.reportDateAndTime
Definition

Date and time of the Hospital discharge report creation.

ShortA.1.9.5 - Report date and time
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. EHDSLaboratoryReportHeader.documentMetadata.documentTitle
Definition

Document title, fix value "Hospital discharge report".

ShortA.1.9.6 - Document title
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. EHDSLaboratoryReportHeader.documentMetadata.eventType
Definition

Clinical service type or types covered by the document (study types, modality, body part etc.)

ShortA.1.9.7 - Event type
Control0..*
Binding

SNOMED CT

TypeCodeableConcept
48. EHDSLaboratoryReportHeader.documentMetadata.specialty
Definition

Additional details about where the content was created (e.g. clinical specialty)

ShortA.1.9.8 - Specialty
Control0..*
Binding

SNOMED CT

TypeCodeableConcept
50. EHDSLaboratoryReportHeader.documentMetadata.reportCustodian
Definition

Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations].

ShortA.1.9.9 - Report custodian
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization
52. EHDSLaboratoryReportHeader.documentMetadata.documentFormat
Definition

An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

ShortA.1.9.10 - Document format
Control0..1
Binding

HL7 Document Format Codes

TypeCodeableConcept
54. EHDSLaboratoryReportHeader.documentMetadata.confidentiality
Definition

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

ShortA.1.9.11 - Confidentiality
Control0..1
Binding

hl7:Confidentiality

TypeCodeableConcept
56. EHDSLaboratoryReportHeader.documentMetadata.language
Definition

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

ShortA.1.9.12 - Language
Control0..1
Binding

ISO 639

TypeCodeableConcept
58. EHDSLaboratoryReportHeader.documentMetadata.version
Definition

Version of the document

ShortA.1.9.13 - 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

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

0. EHDSLaboratoryReportHeader
Definition

A.1 - EHDS refined base model for Report header data elements


Base definition for all types defined in FHIR type system.

ShortLaboratory report header (model)Base for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSLaboratoryReportHeader.subject
Definition

Patient/subject information

ShortA.1.1 - Subject
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient
4. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation
Definition

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

ShortA.1.4 - Health insurance and payment information
Control0..1
TypeBase
6. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceCode
Definition

Unique health insurance company identification code

ShortA.1.4.1 - Health insurance code
Control0..1
TypeIdentifier
8. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceName
Definition

Full, official name of the healthcare insurance provider.

ShortA.1.4.2 - Health insurance name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceNumber
Definition

Number or code under which the insured person is registered at the insurance provider.

ShortA.1.4.3 - Health insurance number
Control0..1
TypeIdentifier
12. EHDSLaboratoryReportHeader.intendedRecipient
Definition

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.5 - Intended recipient
Control0..*
TypeReference(Patient (model), Related person (model), Health professional, Organization (model), Device (model))
14. EHDSLaboratoryReportHeader.authorship
Definition

Information about author or authors of the document

ShortA.1.6 - Authorship
Control1..*
TypeBase
16. EHDSLaboratoryReportHeader.authorship.author
Definition

Author by whom the document was/were authored. Multiple authors could be provided.

ShortA.1.6.1 - Author
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
18. EHDSLaboratoryReportHeader.authorship.datetime
Definition

Date and time of the last modification of the document by its Author.

ShortA.1.6.2 - DateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. EHDSLaboratoryReportHeader.attestation
Definition

Document attestation details

ShortA.1.7 - Attestation
Control0..*
TypeBase
22. EHDSLaboratoryReportHeader.attestation.attester
Definition

Attester who validated the document. Mulitple attesters could be provided.

ShortA.1.7.1 - Attester
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
24. EHDSLaboratoryReportHeader.attestation.datetime
Definition

Date and time of the approval of the document by Attester.

ShortA.1.7.2 - DateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. EHDSLaboratoryReportHeader.legalAuthentication
Definition

Document legal authentication

ShortA.1.8 - Legal authentication
Control0..1
TypeBase
28. EHDSLaboratoryReportHeader.legalAuthentication.legalAuthenticator
Definition

The person taking responsibility for the medical content of the document

ShortA.1.8.1 - Legal authenticator
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
30. EHDSLaboratoryReportHeader.legalAuthentication.datetime
Definition

Date and time when the document was authorized.

ShortA.1.8.2 - DateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. EHDSLaboratoryReportHeader.documentMetadata
Definition

Data relevent to document type and its content for administrative and searching purposes.

ShortA.1.9 - Document metadata
Control1..1
TypeBase
34. EHDSLaboratoryReportHeader.documentMetadata.documentId
Definition

Unique identifier of the document

ShortA.1.9.1 - Document ID
Control1..1
TypeIdentifier
36. EHDSLaboratoryReportHeader.documentMetadata.documentType
Definition

Identifies the type of document at hand, e.g. Hospital discharge report.

ShortA.1.9.2 - Document type
Control1..1
Binding

LOINC

TypeCodeableConcept
38. EHDSLaboratoryReportHeader.documentMetadata.documentStatus
Definition

The status of the Hospital discharge report. E.g., preliminary, final.

ShortA.1.9.3 - Document status
Control1..1
Binding

hl7:CompositionStatus

TypeCodeableConcept
40. EHDSLaboratoryReportHeader.documentMetadata.period
Definition

Documented period service. Typically used for searching purposes.

ShortA.1.9.4 - Period
Control0..1
TypePeriod
42. EHDSLaboratoryReportHeader.documentMetadata.reportDateAndTime
Definition

Date and time of the Hospital discharge report creation.

ShortA.1.9.5 - Report date and time
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. EHDSLaboratoryReportHeader.documentMetadata.documentTitle
Definition

Document title, fix value "Hospital discharge report".

ShortA.1.9.6 - Document title
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. EHDSLaboratoryReportHeader.documentMetadata.eventType
Definition

Clinical service type or types covered by the document (study types, modality, body part etc.)

ShortA.1.9.7 - Event type
Control0..*
Binding

SNOMED CT

TypeCodeableConcept
48. EHDSLaboratoryReportHeader.documentMetadata.specialty
Definition

Additional details about where the content was created (e.g. clinical specialty)

ShortA.1.9.8 - Specialty
Control0..*
Binding

SNOMED CT

TypeCodeableConcept
50. EHDSLaboratoryReportHeader.documentMetadata.reportCustodian
Definition

Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations].

ShortA.1.9.9 - Report custodian
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization
52. EHDSLaboratoryReportHeader.documentMetadata.documentFormat
Definition

An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

ShortA.1.9.10 - Document format
Control0..1
Binding

HL7 Document Format Codes

TypeCodeableConcept
54. EHDSLaboratoryReportHeader.documentMetadata.confidentiality
Definition

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

ShortA.1.9.11 - Confidentiality
Control0..1
Binding

hl7:Confidentiality

TypeCodeableConcept
56. EHDSLaboratoryReportHeader.documentMetadata.language
Definition

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

ShortA.1.9.12 - Language
Control0..1
Binding

ISO 639

TypeCodeableConcept
58. EHDSLaboratoryReportHeader.documentMetadata.version
Definition

Version of the document

ShortA.1.9.13 - 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

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

0. EHDSLaboratoryReportHeader
Definition

A.1 - EHDS refined base model for Report header data elements

ShortLaboratory report header (model)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSLaboratoryReportHeader.subject
Definition

Patient/subject information

ShortA.1.1 - Subject
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient
4. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation
Definition

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

ShortA.1.4 - Health insurance and payment information
Control0..1
TypeBase
6. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceCode
Definition

Unique health insurance company identification code

ShortA.1.4.1 - Health insurance code
Control0..1
TypeIdentifier
8. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceName
Definition

Full, official name of the healthcare insurance provider.

ShortA.1.4.2 - Health insurance name
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EHDSLaboratoryReportHeader.healthInsuranceAndPaymentInformation.healthInsuranceNumber
Definition

Number or code under which the insured person is registered at the insurance provider.

ShortA.1.4.3 - Health insurance number
Control0..1
TypeIdentifier
12. EHDSLaboratoryReportHeader.intendedRecipient
Definition

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.5 - Intended recipient
Control0..*
TypeReference(Patient (model), Related person (model), Health professional, Organization (model), Device (model))
14. EHDSLaboratoryReportHeader.authorship
Definition

Information about author or authors of the document

ShortA.1.6 - Authorship
Control1..*
TypeBase
16. EHDSLaboratoryReportHeader.authorship.author
Definition

Author by whom the document was/were authored. Multiple authors could be provided.

ShortA.1.6.1 - Author
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
18. EHDSLaboratoryReportHeader.authorship.datetime
Definition

Date and time of the last modification of the document by its Author.

ShortA.1.6.2 - DateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. EHDSLaboratoryReportHeader.attestation
Definition

Document attestation details

ShortA.1.7 - Attestation
Control0..*
TypeBase
22. EHDSLaboratoryReportHeader.attestation.attester
Definition

Attester who validated the document. Mulitple attesters could be provided.

ShortA.1.7.1 - Attester
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
24. EHDSLaboratoryReportHeader.attestation.datetime
Definition

Date and time of the approval of the document by Attester.

ShortA.1.7.2 - DateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. EHDSLaboratoryReportHeader.legalAuthentication
Definition

Document legal authentication

ShortA.1.8 - Legal authentication
Control0..1
TypeBase
28. EHDSLaboratoryReportHeader.legalAuthentication.legalAuthenticator
Definition

The person taking responsibility for the medical content of the document

ShortA.1.8.1 - Legal authenticator
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
30. EHDSLaboratoryReportHeader.legalAuthentication.datetime
Definition

Date and time when the document was authorized.

ShortA.1.8.2 - DateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. EHDSLaboratoryReportHeader.documentMetadata
Definition

Data relevent to document type and its content for administrative and searching purposes.

ShortA.1.9 - Document metadata
Control1..1
TypeBase
34. EHDSLaboratoryReportHeader.documentMetadata.documentId
Definition

Unique identifier of the document

ShortA.1.9.1 - Document ID
Control1..1
TypeIdentifier
36. EHDSLaboratoryReportHeader.documentMetadata.documentType
Definition

Identifies the type of document at hand, e.g. Hospital discharge report.

ShortA.1.9.2 - Document type
Control1..1
Binding

LOINC

TypeCodeableConcept
38. EHDSLaboratoryReportHeader.documentMetadata.documentStatus
Definition

The status of the Hospital discharge report. E.g., preliminary, final.

ShortA.1.9.3 - Document status
Control1..1
Binding

hl7:CompositionStatus

TypeCodeableConcept
40. EHDSLaboratoryReportHeader.documentMetadata.period
Definition

Documented period service. Typically used for searching purposes.

ShortA.1.9.4 - Period
Control0..1
TypePeriod
42. EHDSLaboratoryReportHeader.documentMetadata.reportDateAndTime
Definition

Date and time of the Hospital discharge report creation.

ShortA.1.9.5 - Report date and time
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. EHDSLaboratoryReportHeader.documentMetadata.documentTitle
Definition

Document title, fix value "Hospital discharge report".

ShortA.1.9.6 - Document title
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
46. EHDSLaboratoryReportHeader.documentMetadata.eventType
Definition

Clinical service type or types covered by the document (study types, modality, body part etc.)

ShortA.1.9.7 - Event type
Control0..*
Binding

SNOMED CT

TypeCodeableConcept
48. EHDSLaboratoryReportHeader.documentMetadata.specialty
Definition

Additional details about where the content was created (e.g. clinical specialty)

ShortA.1.9.8 - Specialty
Control0..*
Binding

SNOMED CT

TypeCodeableConcept
50. EHDSLaboratoryReportHeader.documentMetadata.reportCustodian
Definition

Organisation that is in charge of maintaining the report [this element will include organisation ID, name, address etc., as other elements describing organisations].

ShortA.1.9.9 - Report custodian
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization
52. EHDSLaboratoryReportHeader.documentMetadata.documentFormat
Definition

An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

ShortA.1.9.10 - Document format
Control0..1
Binding

HL7 Document Format Codes

TypeCodeableConcept
54. EHDSLaboratoryReportHeader.documentMetadata.confidentiality
Definition

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

ShortA.1.9.11 - Confidentiality
Control0..1
Binding

hl7:Confidentiality

TypeCodeableConcept
56. EHDSLaboratoryReportHeader.documentMetadata.language
Definition

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

ShortA.1.9.12 - Language
Control0..1
Binding

ISO 639

TypeCodeableConcept
58. EHDSLaboratoryReportHeader.documentMetadata.version
Definition

Version of the document

ShortA.1.9.13 - 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