Xt-EHR Metadata Standards
0.1.0 - ci-build

Xt-EHR Metadata Standards, 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-metadata/ and changes regularly. See the Directory of published versions

Logical Model: EHDS document

Official URL: https://www.xt-ehr.eu/specifications/fhir/StructureDefinition/EHDSDocument Version: 0.1.0
Draft as of 2025-08-21 Computable Name: EHDSDocument

Common elements for all EHDS document exchange.

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDocument 0..* EHDSDataSet
Elements defined in Ancestors:identifier, subject, country, relatedPerson, authorship, lastUpdate, status, version, language, presentation
EHDS document
Instances of this logical model can be the target of a Reference
... identifier 1..* Identifier Document ID
... subject 0..1 EHDSPerson Subject
... country 0..1 CodeableConcept Country
Binding Description: (preferred): ISO 3166
.... @id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... person 0..1 EHDSPerson Identification and description of the person
.... relationship 0..1 CodeableConcept Relationship
Binding Description: (preferred): HL7 RoleCode
... authorship 1..* Base Authorship
.... author 1..1 EHDSHealthProfessional Author
.... datetime 1..1 dateTime Date and time of authoring/issuing
... lastUpdate 0..1 dateTime Date and time of the last update to the data object
... status 1..1 CodeableConcept Status of the information
... version 0..1 string Version
... language 0..1 CodeableConcept Language
Binding Description: (preferred): BCP 47
... presentation 1..* Base Presentation form
.... author 1..1 EHDSHealthProfessional Author
.... datetime 1..1 dateTime Date and time of authoring/issuing
... documentType 1..1 CodeableConcept Document type
Binding Description: (preferred): LOINC
... eventType 0..* CodeableConcept Event type
Binding Description: (preferred): LOINC, SNOMED CT, dicom-cid-33-Modality
... documentTitle 1..1 string Document title
... documentStatus 1..1 CodeableConcept Document status
Binding Description: (preferred): hl7:CompositionStatus
... period 0..1 Period Period
... issuedDateTime 1..1 dateTime Report date and time
... attestation 0..* Base Attestation
.... attester 1..1 EHDSHealthProfessional Attester
.... datetime 1..1 dateTime DateTime
... legalAuthentication 0..1 Base Legal authentication
.... legalAuthenticator 1..1 EHDSHealthProfessional Legal authenticator
.... datetime 1..1 dateTime DateTime
... authorSpecialty 0..* CodeableConcept Specialty
Binding Description: (preferred): SNOMED CT
... custodian 1..1 EHDSOrganization Document custodian
... documentFormat 0..1 CodeableConcept Document format
Binding Description: (preferred): HL7 Document Format Codes
... knowledgeResources 0..* Base Related documents and information sources
.... externalReference 0..* Reference() ...

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSDocument.countrypreferred
EHDSDocument.relatedPerson.relationshippreferred
EHDSDocument.languagepreferred
EHDSDocument.documentTypepreferred
EHDSDocument.eventTypepreferred
EHDSDocument.documentStatuspreferred
EHDSDocument.authorSpecialtypreferred
EHDSDocument.documentFormatpreferred

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EHDSDataSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDocument 0..* EHDSDataSet
Elements defined in Ancestors:identifier, subject, country, relatedPerson, authorship, lastUpdate, status, version, language, presentation
EHDS document
Instances of this logical model can be the target of a Reference
... identifier 1..* Identifier Document ID
... documentType 1..1 CodeableConcept Document type
Binding Description: (preferred): LOINC
... eventType 0..* CodeableConcept Event type
Binding Description: (preferred): LOINC, SNOMED CT, dicom-cid-33-Modality
... documentStatus 1..1 CodeableConcept Document status
Binding Description: (preferred): hl7:CompositionStatus
... period 0..1 Period Period
... issuedDateTime 1..1 dateTime Report date and time
... attestation 0..* Base Attestation
.... attester 1..1 EHDSHealthProfessional Attester
.... datetime 1..1 dateTime DateTime
... legalAuthentication 0..1 Base Legal authentication
.... legalAuthenticator 1..1 EHDSHealthProfessional Legal authenticator
.... datetime 1..1 dateTime DateTime
... authorSpecialty 0..* CodeableConcept Specialty
Binding Description: (preferred): SNOMED CT
... custodian 1..1 EHDSOrganization Document custodian
... documentFormat 0..1 CodeableConcept Document format
Binding Description: (preferred): HL7 Document Format Codes
... knowledgeResources 0..* Base Related documents and information sources
.... externalReference 0..* Reference() ...

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EHDSDocument.documentTypepreferred
EHDSDocument.eventTypepreferred
EHDSDocument.documentStatuspreferred
EHDSDocument.authorSpecialtypreferred
EHDSDocument.documentFormatpreferred
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDocument 0..* EHDSDataSet
Elements defined in Ancestors:identifier, subject, country, relatedPerson, authorship, lastUpdate, status, version, language, presentation
EHDS document
Instances of this logical model can be the target of a Reference
... identifier 1..* Identifier Document ID
... subject 0..1 EHDSPerson Subject
... country 0..1 CodeableConcept Country
Binding Description: (preferred): ISO 3166
.... @id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... person 0..1 EHDSPerson Identification and description of the person
.... relationship 0..1 CodeableConcept Relationship
Binding Description: (preferred): HL7 RoleCode
... authorship 1..* Base Authorship
.... author 1..1 EHDSHealthProfessional Author
.... datetime 1..1 dateTime Date and time of authoring/issuing
... lastUpdate 0..1 dateTime Date and time of the last update to the data object
... status 1..1 CodeableConcept Status of the information
... version 0..1 string Version
... language 0..1 CodeableConcept Language
Binding Description: (preferred): BCP 47
... presentation 1..* Base Presentation form
.... author 1..1 EHDSHealthProfessional Author
.... datetime 1..1 dateTime Date and time of authoring/issuing
... documentType 1..1 CodeableConcept Document type
Binding Description: (preferred): LOINC
... eventType 0..* CodeableConcept Event type
Binding Description: (preferred): LOINC, SNOMED CT, dicom-cid-33-Modality
... documentTitle 1..1 string Document title
... documentStatus 1..1 CodeableConcept Document status
Binding Description: (preferred): hl7:CompositionStatus
... period 0..1 Period Period
... issuedDateTime 1..1 dateTime Report date and time
... attestation 0..* Base Attestation
.... attester 1..1 EHDSHealthProfessional Attester
.... datetime 1..1 dateTime DateTime
... legalAuthentication 0..1 Base Legal authentication
.... legalAuthenticator 1..1 EHDSHealthProfessional Legal authenticator
.... datetime 1..1 dateTime DateTime
... authorSpecialty 0..* CodeableConcept Specialty
Binding Description: (preferred): SNOMED CT
... custodian 1..1 EHDSOrganization Document custodian
... documentFormat 0..1 CodeableConcept Document format
Binding Description: (preferred): HL7 Document Format Codes
... knowledgeResources 0..* Base Related documents and information sources
.... externalReference 0..* Reference() ...

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSDocument.countrypreferred
EHDSDocument.relatedPerson.relationshippreferred
EHDSDocument.languagepreferred
EHDSDocument.documentTypepreferred
EHDSDocument.eventTypepreferred
EHDSDocument.documentStatuspreferred
EHDSDocument.authorSpecialtypreferred
EHDSDocument.documentFormatpreferred

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EHDSDataSet

Summary

Mandatory: 1 element(9 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDocument 0..* EHDSDataSet
Elements defined in Ancestors:identifier, subject, country, relatedPerson, authorship, lastUpdate, status, version, language, presentation
EHDS document
Instances of this logical model can be the target of a Reference
... identifier 1..* Identifier Document ID
... subject 0..1 EHDSPerson Subject
... country 0..1 CodeableConcept Country
Binding Description: (preferred): ISO 3166
.... @id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... person 0..1 EHDSPerson Identification and description of the person
.... relationship 0..1 CodeableConcept Relationship
Binding Description: (preferred): HL7 RoleCode
... authorship 1..* Base Authorship
.... author 1..1 EHDSHealthProfessional Author
.... datetime 1..1 dateTime Date and time of authoring/issuing
... lastUpdate 0..1 dateTime Date and time of the last update to the data object
... status 1..1 CodeableConcept Status of the information
... version 0..1 string Version
... language 0..1 CodeableConcept Language
Binding Description: (preferred): BCP 47
... presentation 1..* Base Presentation form
.... author 1..1 EHDSHealthProfessional Author
.... datetime 1..1 dateTime Date and time of authoring/issuing
... documentType 1..1 CodeableConcept Document type
Binding Description: (preferred): LOINC
... eventType 0..* CodeableConcept Event type
Binding Description: (preferred): LOINC, SNOMED CT, dicom-cid-33-Modality
... documentTitle 1..1 string Document title
... documentStatus 1..1 CodeableConcept Document status
Binding Description: (preferred): hl7:CompositionStatus
... period 0..1 Period Period
... issuedDateTime 1..1 dateTime Report date and time
... attestation 0..* Base Attestation
.... attester 1..1 EHDSHealthProfessional Attester
.... datetime 1..1 dateTime DateTime
... legalAuthentication 0..1 Base Legal authentication
.... legalAuthenticator 1..1 EHDSHealthProfessional Legal authenticator
.... datetime 1..1 dateTime DateTime
... authorSpecialty 0..* CodeableConcept Specialty
Binding Description: (preferred): SNOMED CT
... custodian 1..1 EHDSOrganization Document custodian
... documentFormat 0..1 CodeableConcept Document format
Binding Description: (preferred): HL7 Document Format Codes
... knowledgeResources 0..* Base Related documents and information sources
.... externalReference 0..* Reference() ...

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSDocument.countrypreferred
EHDSDocument.relatedPerson.relationshippreferred
EHDSDocument.languagepreferred
EHDSDocument.documentTypepreferred
EHDSDocument.eventTypepreferred
EHDSDocument.documentStatuspreferred
EHDSDocument.authorSpecialtypreferred
EHDSDocument.documentFormatpreferred

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from EHDSDataSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDocument 0..* EHDSDataSet
Elements defined in Ancestors:identifier, subject, country, relatedPerson, authorship, lastUpdate, status, version, language, presentation
EHDS document
Instances of this logical model can be the target of a Reference
... identifier 1..* Identifier Document ID
... documentType 1..1 CodeableConcept Document type
Binding Description: (preferred): LOINC
... eventType 0..* CodeableConcept Event type
Binding Description: (preferred): LOINC, SNOMED CT, dicom-cid-33-Modality
... documentStatus 1..1 CodeableConcept Document status
Binding Description: (preferred): hl7:CompositionStatus
... period 0..1 Period Period
... issuedDateTime 1..1 dateTime Report date and time
... attestation 0..* Base Attestation
.... attester 1..1 EHDSHealthProfessional Attester
.... datetime 1..1 dateTime DateTime
... legalAuthentication 0..1 Base Legal authentication
.... legalAuthenticator 1..1 EHDSHealthProfessional Legal authenticator
.... datetime 1..1 dateTime DateTime
... authorSpecialty 0..* CodeableConcept Specialty
Binding Description: (preferred): SNOMED CT
... custodian 1..1 EHDSOrganization Document custodian
... documentFormat 0..1 CodeableConcept Document format
Binding Description: (preferred): HL7 Document Format Codes
... knowledgeResources 0..* Base Related documents and information sources
.... externalReference 0..* Reference() ...

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
EHDSDocument.documentTypepreferred
EHDSDocument.eventTypepreferred
EHDSDocument.documentStatuspreferred
EHDSDocument.authorSpecialtypreferred
EHDSDocument.documentFormatpreferred

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. EHDSDocument 0..* EHDSDataSet
Elements defined in Ancestors:identifier, subject, country, relatedPerson, authorship, lastUpdate, status, version, language, presentation
EHDS document
Instances of this logical model can be the target of a Reference
... identifier 1..* Identifier Document ID
... subject 0..1 EHDSPerson Subject
... country 0..1 CodeableConcept Country
Binding Description: (preferred): ISO 3166
.... @id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... person 0..1 EHDSPerson Identification and description of the person
.... relationship 0..1 CodeableConcept Relationship
Binding Description: (preferred): HL7 RoleCode
... authorship 1..* Base Authorship
.... author 1..1 EHDSHealthProfessional Author
.... datetime 1..1 dateTime Date and time of authoring/issuing
... lastUpdate 0..1 dateTime Date and time of the last update to the data object
... status 1..1 CodeableConcept Status of the information
... version 0..1 string Version
... language 0..1 CodeableConcept Language
Binding Description: (preferred): BCP 47
... presentation 1..* Base Presentation form
.... author 1..1 EHDSHealthProfessional Author
.... datetime 1..1 dateTime Date and time of authoring/issuing
... documentType 1..1 CodeableConcept Document type
Binding Description: (preferred): LOINC
... eventType 0..* CodeableConcept Event type
Binding Description: (preferred): LOINC, SNOMED CT, dicom-cid-33-Modality
... documentTitle 1..1 string Document title
... documentStatus 1..1 CodeableConcept Document status
Binding Description: (preferred): hl7:CompositionStatus
... period 0..1 Period Period
... issuedDateTime 1..1 dateTime Report date and time
... attestation 0..* Base Attestation
.... attester 1..1 EHDSHealthProfessional Attester
.... datetime 1..1 dateTime DateTime
... legalAuthentication 0..1 Base Legal authentication
.... legalAuthenticator 1..1 EHDSHealthProfessional Legal authenticator
.... datetime 1..1 dateTime DateTime
... authorSpecialty 0..* CodeableConcept Specialty
Binding Description: (preferred): SNOMED CT
... custodian 1..1 EHDSOrganization Document custodian
... documentFormat 0..1 CodeableConcept Document format
Binding Description: (preferred): HL7 Document Format Codes
... knowledgeResources 0..* Base Related documents and information sources
.... externalReference 0..* Reference() ...

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
EHDSDocument.countrypreferred
EHDSDocument.relatedPerson.relationshippreferred
EHDSDocument.languagepreferred
EHDSDocument.documentTypepreferred
EHDSDocument.eventTypepreferred
EHDSDocument.documentStatuspreferred
EHDSDocument.authorSpecialtypreferred
EHDSDocument.documentFormatpreferred

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from EHDSDataSet

Summary

Mandatory: 1 element(9 nested mandatory elements)

 

Other representations of profile: CSV, Excel