HL7 Europe Imaging Study Report
0.1.0-ballot - ci-build 150

HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/oijauregui/ehdsimaging/tree/master and changes regularly. See the Directory of published versions

Logical Model: EHDSDocumentHeader - Detailed Descriptions

Draft as of 2025-03-21

Definitions for the EHDSDocumentHeader logical model.

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

0. EHDSDocumentHeader
Definition

EHDS refined base model for document header data elements, including the common header for all resources. Data relevant to document type and its content for administrative and searching purposes.

ShortDocument header model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSDocumentHeader.subject
Definition

Patient/subject information

ShortSubject
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient
4. EHDSDocumentHeader.authorship
Definition

Resource authoring details

ShortAuthorship
Control1..*
TypeBase
6. EHDSDocumentHeader.authorship.author
Definition

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

ShortAuthor
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
8. EHDSDocumentHeader.authorship.datetime
Definition

Date and time of the issuing the document/resource by its author.

ShortDate and time of authoring/issuing
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EHDSDocumentHeader.lastUpdate
Definition

Date and time of the last update to the document/information

ShortDate and time of the last update to the resource
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. EHDSDocumentHeader.status
Definition

Status of the resource

ShortStatus of the resource
Control1..1
TypeCodeableConcept
14. EHDSDocumentHeader.statusReason[x]
Definition

Reason for the current status of the resource.

ShortReason for the current status of the resource.
Control0..1
TypeChoice of: CodeableConcept, string
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. EHDSDocumentHeader.language
Definition

Language in which the resource is written. Language is expressed by the IETF language tag.

ShortLanguage
Control0..1
Binding

BCP 47

TypeCodeableConcept
18. EHDSDocumentHeader.version
Definition

Business version of the resource.

ShortVersion
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
20. EHDSDocumentHeader.documentId
Definition

Unique identifier of the document

ShortDocument ID
Control1..*
TypeIdentifier
22. EHDSDocumentHeader.documentType
Definition

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

ShortDocument type
Control1..1
Binding

LOINC

TypeCodeableConcept
24. EHDSDocumentHeader.documentTitle
Definition

Document title, such as Hospital Discharge Report, Laboratory Result Report, etc.

ShortDocument title
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. EHDSDocumentHeader.documentStatus
Definition

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

ShortDocument status
Control1..1
Binding

hl7:CompositionStatus

TypeCodeableConcept
28. EHDSDocumentHeader.period
Definition

Time of service that is being documented

ShortPeriod
Control0..1
TypePeriod
30. EHDSDocumentHeader.reportDateTime
Definition

Date and time of the report creation.

ShortReport date and time
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. EHDSDocumentHeader.attestation
Definition

Document attestation details

ShortAttestation
Control0..*
TypeBase
34. EHDSDocumentHeader.attestation.attester
Definition

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

ShortAttester
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
36. EHDSDocumentHeader.attestation.datetime
Definition

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

ShortDateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. EHDSDocumentHeader.legalAuthentication
Definition

Document legal authentication

ShortLegal authentication
Control0..1
TypeBase
40. EHDSDocumentHeader.legalAuthentication.legalAuthenticator
Definition

The person taking responsibility for the medical content of the document

ShortLegal authenticator
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
42. EHDSDocumentHeader.legalAuthentication.datetime
Definition

Date and time when the document was authorized.

ShortDateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. EHDSDocumentHeader.eventType
Definition

Categorization of the event covered by the document (e.g. laboratory study types, imaging study types including modality, etc.). Selection of such tags or labels depends on the use case and agreement betwen data sharing parties. This meta-data element serves primarily for searching and filtering purpuses.

ShortEvent type
Control0..*
Binding

LOINC, SNOMED CT, dicom-cid-33-Modality

TypeCodeableConcept
46. EHDSDocumentHeader.authorSpecialty
Definition

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

ShortSpecialty
Control0..*
Binding

SNOMED CT

TypeCodeableConcept
48. EHDSDocumentHeader.custodian
Definition

Organisation that is in charge of maintaining the document/report.

ShortDocument custodian
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization
50. EHDSDocumentHeader.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.

ShortDocument format
Control0..1
Binding

HL7 Document Format Codes

TypeCodeableConcept
52. EHDSDocumentHeader.confidentiality
Definition

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

ShortConfidentiality
Control0..1
Binding

hl7:Confidentiality

TypeCodeableConcept
54. EHDSDocumentHeader.knowledgeResources
Definition

Related documents and information sources

ShortRelated documents and information sources
Control0..*
TypeBase
56. EHDSDocumentHeader.knowledgeResources.externalReference
Definition

...

Short...
Control0..*
TypeRelatedArtifact
58. EHDSDocumentHeader.knowledgeResources.relatedTo
Definition

...

Short...
Control0..*
TypeReference

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

0. EHDSDocumentHeader
Definition

EHDS refined base model for document header data elements, including the common header for all resources. Data relevant to document type and its content for administrative and searching purposes.

ShortDocument header model
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSDocumentHeader.documentId
Definition

Unique identifier of the document

ShortDocument ID
Control1..*
TypeIdentifier
4. EHDSDocumentHeader.documentType
Definition

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

ShortDocument type
Control1..1
Binding

LOINC

TypeCodeableConcept
6. EHDSDocumentHeader.documentTitle
Definition

Document title, such as Hospital Discharge Report, Laboratory Result Report, etc.

ShortDocument title
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. EHDSDocumentHeader.documentStatus
Definition

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

ShortDocument status
Control1..1
Binding

hl7:CompositionStatus

TypeCodeableConcept
10. EHDSDocumentHeader.period
Definition

Time of service that is being documented

ShortPeriod
Control0..1
TypePeriod
12. EHDSDocumentHeader.reportDateTime
Definition

Date and time of the report creation.

ShortReport date and time
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. EHDSDocumentHeader.attestation
Definition

Document attestation details

ShortAttestation
Control0..*
TypeBase
16. EHDSDocumentHeader.attestation.attester
Definition

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

ShortAttester
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
18. EHDSDocumentHeader.attestation.datetime
Definition

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

ShortDateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. EHDSDocumentHeader.legalAuthentication
Definition

Document legal authentication

ShortLegal authentication
Control0..1
TypeBase
22. EHDSDocumentHeader.legalAuthentication.legalAuthenticator
Definition

The person taking responsibility for the medical content of the document

ShortLegal authenticator
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
24. EHDSDocumentHeader.legalAuthentication.datetime
Definition

Date and time when the document was authorized.

ShortDateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. EHDSDocumentHeader.eventType
Definition

Categorization of the event covered by the document (e.g. laboratory study types, imaging study types including modality, etc.). Selection of such tags or labels depends on the use case and agreement betwen data sharing parties. This meta-data element serves primarily for searching and filtering purpuses.

ShortEvent type
Control0..*
Binding

LOINC, SNOMED CT, dicom-cid-33-Modality

TypeCodeableConcept
28. EHDSDocumentHeader.authorSpecialty
Definition

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

ShortSpecialty
Control0..*
Binding

SNOMED CT

TypeCodeableConcept
30. EHDSDocumentHeader.custodian
Definition

Organisation that is in charge of maintaining the document/report.

ShortDocument custodian
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization
32. EHDSDocumentHeader.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.

ShortDocument format
Control0..1
Binding

HL7 Document Format Codes

TypeCodeableConcept
34. EHDSDocumentHeader.confidentiality
Definition

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

ShortConfidentiality
Control0..1
Binding

hl7:Confidentiality

TypeCodeableConcept
36. EHDSDocumentHeader.knowledgeResources
Definition

Related documents and information sources

ShortRelated documents and information sources
Control0..*
TypeBase
38. EHDSDocumentHeader.knowledgeResources.externalReference
Definition

...

Short...
Control0..*
TypeRelatedArtifact
40. EHDSDocumentHeader.knowledgeResources.relatedTo
Definition

...

Short...
Control0..*
TypeReference

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

0. EHDSDocumentHeader
Definition

EHDS refined base model for document header data elements, including the common header for all resources. Data relevant to document type and its content for administrative and searching purposes.

ShortDocument header model
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. EHDSDocumentHeader.subject
Definition

Patient/subject information

ShortSubject
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSPatient
4. EHDSDocumentHeader.authorship
Definition

Resource authoring details

ShortAuthorship
Control1..*
TypeBase
6. EHDSDocumentHeader.authorship.author
Definition

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

ShortAuthor
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
8. EHDSDocumentHeader.authorship.datetime
Definition

Date and time of the issuing the document/resource by its author.

ShortDate and time of authoring/issuing
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. EHDSDocumentHeader.lastUpdate
Definition

Date and time of the last update to the document/information

ShortDate and time of the last update to the resource
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. EHDSDocumentHeader.status
Definition

Status of the resource

ShortStatus of the resource
Control1..1
TypeCodeableConcept
14. EHDSDocumentHeader.statusReason[x]
Definition

Reason for the current status of the resource.

ShortReason for the current status of the resource.
Control0..1
TypeChoice of: CodeableConcept, string
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. EHDSDocumentHeader.language
Definition

Language in which the resource is written. Language is expressed by the IETF language tag.

ShortLanguage
Control0..1
Binding

BCP 47

TypeCodeableConcept
18. EHDSDocumentHeader.version
Definition

Business version of the resource.

ShortVersion
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
20. EHDSDocumentHeader.documentId
Definition

Unique identifier of the document

ShortDocument ID
Control1..*
TypeIdentifier
22. EHDSDocumentHeader.documentType
Definition

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

ShortDocument type
Control1..1
Binding

LOINC

TypeCodeableConcept
24. EHDSDocumentHeader.documentTitle
Definition

Document title, such as Hospital Discharge Report, Laboratory Result Report, etc.

ShortDocument title
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. EHDSDocumentHeader.documentStatus
Definition

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

ShortDocument status
Control1..1
Binding

hl7:CompositionStatus

TypeCodeableConcept
28. EHDSDocumentHeader.period
Definition

Time of service that is being documented

ShortPeriod
Control0..1
TypePeriod
30. EHDSDocumentHeader.reportDateTime
Definition

Date and time of the report creation.

ShortReport date and time
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. EHDSDocumentHeader.attestation
Definition

Document attestation details

ShortAttestation
Control0..*
TypeBase
34. EHDSDocumentHeader.attestation.attester
Definition

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

ShortAttester
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
36. EHDSDocumentHeader.attestation.datetime
Definition

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

ShortDateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. EHDSDocumentHeader.legalAuthentication
Definition

Document legal authentication

ShortLegal authentication
Control0..1
TypeBase
40. EHDSDocumentHeader.legalAuthentication.legalAuthenticator
Definition

The person taking responsibility for the medical content of the document

ShortLegal authenticator
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSHealthProfessional
42. EHDSDocumentHeader.legalAuthentication.datetime
Definition

Date and time when the document was authorized.

ShortDateTime
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. EHDSDocumentHeader.eventType
Definition

Categorization of the event covered by the document (e.g. laboratory study types, imaging study types including modality, etc.). Selection of such tags or labels depends on the use case and agreement betwen data sharing parties. This meta-data element serves primarily for searching and filtering purpuses.

ShortEvent type
Control0..*
Binding

LOINC, SNOMED CT, dicom-cid-33-Modality

TypeCodeableConcept
46. EHDSDocumentHeader.authorSpecialty
Definition

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

ShortSpecialty
Control0..*
Binding

SNOMED CT

TypeCodeableConcept
48. EHDSDocumentHeader.custodian
Definition

Organisation that is in charge of maintaining the document/report.

ShortDocument custodian
Control1..1
Typehttps://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSOrganization
50. EHDSDocumentHeader.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.

ShortDocument format
Control0..1
Binding

HL7 Document Format Codes

TypeCodeableConcept
52. EHDSDocumentHeader.confidentiality
Definition

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

ShortConfidentiality
Control0..1
Binding

hl7:Confidentiality

TypeCodeableConcept
54. EHDSDocumentHeader.knowledgeResources
Definition

Related documents and information sources

ShortRelated documents and information sources
Control0..*
TypeBase
56. EHDSDocumentHeader.knowledgeResources.externalReference
Definition

...

Short...
Control0..*
TypeRelatedArtifact
58. EHDSDocumentHeader.knowledgeResources.relatedTo
Definition

...

Short...
Control0..*
TypeReference