IHE Germany - Value Sets for XDS
0.3.28 - draft Germany flag

IHE Germany - Value Sets for XDS, published by IHE Deutschland e.V., Berlin, Deutschland. This guide is not an authorized publication; it is the continuous build for version 0.3.28 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE-Germany/ITI.XDS.VS/ and changes regularly. See the Directory of published versions

Logical Model: Document Entry (Profile)

Official URL: http://www.ihe-d.de/fhir/StructureDefinition/DocumentEntryProfile Version: 4.0.0-alpha1
Draft as of 2025-08-02 Maturity Level: 2 Computable Name: DocumentEntryProfile

Copyright/Legal: IHE Deutschland e.V.

Document Entry: Die zu unterstützenden Attribute werden über ein Profil festgelegt.

Usages:

  • This Logical Model Profile 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
.. DocumentEntry 0..* DocumentEntry
Elements defined in Ancestors:author, availabilityStatus, classCode, comments, confidentialityCode, creationTime, entryUUID, eventCodeList, formatCode, hash, healthcareFacilityTypeCode, homeCommunityId, languageCode, legalAuthenticator, limitedMetadata, mimeType, objectType, patientId, practiceSettingCode, referenceIdList, repositoryUniqueId, serviceStartTime, serviceEndTime, size, sourcePatientId, sourcePatientInfo, title, typeCode, uniqueId, uri
Document Entry (LM)
... author 0..1 Author The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication.
... availabilityStatus S 0..1 string The lifecycle status of the DocumentEntry, i.e. either 'urn:oasis:names:tc:ebxml-regrep:StatusType:Approved' or 'urn:oasis:names:tc:ebxml-regrep:StatusType:Deprecated'
... classCode S 1..1 CodeDataType The code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow).
... comments 0..1 string Comments associated with the document.
... confidentialityCode S 1..1 CodeDataType The code specifying the level of confidentiality of the document.
... creationTime 1..1 DTMDataType The time the author created the document.
... entryUUID 1..1 UUIDDataType A globally unique identifier used to identify the entry.
... eventCodeList 0..* CodeDataType This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented.
Binding: IHE XDS Event Code List (required)
... formatCode S 1..1 CodeDataType The code specifying the detailed technical format of the document.
... hash 0..1 string The hash of the contents of the document.
... healthcareFacilityTypeCode S 1..1 CodeDataType This code represents the type of organizational setting of the clinical encounter during which the documented act occurred.
... homeCommunityId 0..1 OIDURNDataType A globally unique identifier for a community.
... languageCode S 1..* string Specifies the human language of character data in the document.
Binding: IHE XDS Language Code (extensible)
... legalAuthenticator 0..1 XCNDataType Represents a participant within an authorInstitution who has legally authenticated or attested the document.
... limitedMetadata 0..1 LimitedMetadataDataType Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source.
... mimeType S 1..1 string MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13).
... objectType S 1..1 UUIDDataType The type of DocumentEntry; either urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1 for stable or urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248 for on-demand Document Entries
... patientId 1..1 CXDataType The patientId represents the subject of care of the document.
... practiceSettingCode S 0..1 CodeDataType The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology).
... referenceIdList 0..* CXiDataType A list of identifiers related to the document.
... repositoryUniqueId 0..1 OIDDataType The globally unique identifier of the repository where the document can be accessed.
... serviceStartTime S 1..1 DTMDataType The start time of the service being documented.
... serviceEndTime S 1..1 DTMDataType The stop time of the service being documented.
... size 0..1 integer Size in bytes of the document.
... sourcePatientId S 1..1 CXDataType The sourcePatientId represents the subject of care’s medical record identifier (e.g., Patient Id) in the local patient identifier domain of the creating entity.
... sourcePatientInfo 0..1 FieldDataType This attribute contains demographic information of the patient to whose medical record this document belongs.
... title 1..1 string The title of the document.
... typeCode S 1..1 CodeDataType The code specifying the precise type of document from the user perspective (e.g., LOINC code).
... uniqueId 1..1 IdentifierDataType Globally unique identifier assigned to the document by its creator.
... uri 1..1 URIDataType URI of document

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentEntry.eventCodeListrequiredIHEXDSeventCodeList
http://ihe-d.de/ValueSets/IHEXDSeventCodeList
From this IG
DocumentEntry.languageCodeextensibleIHEXDSlanguageCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode
From this IG

This structure is derived from DocumentEntry

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentEntry 0..* DocumentEntry
Elements defined in Ancestors:author, availabilityStatus, classCode, comments, confidentialityCode, creationTime, entryUUID, eventCodeList, formatCode, hash, healthcareFacilityTypeCode, homeCommunityId, languageCode, legalAuthenticator, limitedMetadata, mimeType, objectType, patientId, practiceSettingCode, referenceIdList, repositoryUniqueId, serviceStartTime, serviceEndTime, size, sourcePatientId, sourcePatientInfo, title, typeCode, uniqueId, uri
Document Entry (LM)
... availabilityStatus S 0..1 string The lifecycle status of the DocumentEntry, i.e. either 'urn:oasis:names:tc:ebxml-regrep:StatusType:Approved' or 'urn:oasis:names:tc:ebxml-regrep:StatusType:Deprecated'
... classCode S 1..1 CodeDataType The code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow).
... confidentialityCode S 1..1 CodeDataType The code specifying the level of confidentiality of the document.
... healthcareFacilityTypeCode S 1..1 CodeDataType This code represents the type of organizational setting of the clinical encounter during which the documented act occurred.
... languageCode S 1..* string Specifies the human language of character data in the document.
... mimeType S 1..1 string MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13).
... objectType S 1..1 UUIDDataType The type of DocumentEntry; either urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1 for stable or urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248 for on-demand Document Entries
... practiceSettingCode S 0..1 CodeDataType The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology).
... serviceStartTime S 1..1 DTMDataType The start time of the service being documented.
... serviceEndTime S 1..1 DTMDataType The stop time of the service being documented.
... sourcePatientId S 1..1 CXDataType The sourcePatientId represents the subject of care’s medical record identifier (e.g., Patient Id) in the local patient identifier domain of the creating entity.
... typeCode S 1..1 CodeDataType The code specifying the precise type of document from the user perspective (e.g., LOINC code).

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentEntry 0..* DocumentEntry
Elements defined in Ancestors:author, availabilityStatus, classCode, comments, confidentialityCode, creationTime, entryUUID, eventCodeList, formatCode, hash, healthcareFacilityTypeCode, homeCommunityId, languageCode, legalAuthenticator, limitedMetadata, mimeType, objectType, patientId, practiceSettingCode, referenceIdList, repositoryUniqueId, serviceStartTime, serviceEndTime, size, sourcePatientId, sourcePatientInfo, title, typeCode, uniqueId, uri
Document Entry (LM)
... author 0..1 Author The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication.
... availabilityStatus S 0..1 string The lifecycle status of the DocumentEntry, i.e. either 'urn:oasis:names:tc:ebxml-regrep:StatusType:Approved' or 'urn:oasis:names:tc:ebxml-regrep:StatusType:Deprecated'
... classCode S 1..1 CodeDataType The code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow).
... comments 0..1 string Comments associated with the document.
... confidentialityCode S 1..1 CodeDataType The code specifying the level of confidentiality of the document.
... creationTime 1..1 DTMDataType The time the author created the document.
... entryUUID 1..1 UUIDDataType A globally unique identifier used to identify the entry.
... eventCodeList 0..* CodeDataType This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented.
Binding: IHE XDS Event Code List (required)
... formatCode S 1..1 CodeDataType The code specifying the detailed technical format of the document.
... hash 0..1 string The hash of the contents of the document.
... healthcareFacilityTypeCode S 1..1 CodeDataType This code represents the type of organizational setting of the clinical encounter during which the documented act occurred.
... homeCommunityId 0..1 OIDURNDataType A globally unique identifier for a community.
... languageCode S 1..* string Specifies the human language of character data in the document.
Binding: IHE XDS Language Code (extensible)
... legalAuthenticator 0..1 XCNDataType Represents a participant within an authorInstitution who has legally authenticated or attested the document.
... limitedMetadata 0..1 LimitedMetadataDataType Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source.
... mimeType S 1..1 string MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13).
... objectType S 1..1 UUIDDataType The type of DocumentEntry; either urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1 for stable or urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248 for on-demand Document Entries
... patientId 1..1 CXDataType The patientId represents the subject of care of the document.
... practiceSettingCode S 0..1 CodeDataType The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology).
... referenceIdList 0..* CXiDataType A list of identifiers related to the document.
... repositoryUniqueId 0..1 OIDDataType The globally unique identifier of the repository where the document can be accessed.
... serviceStartTime S 1..1 DTMDataType The start time of the service being documented.
... serviceEndTime S 1..1 DTMDataType The stop time of the service being documented.
... size 0..1 integer Size in bytes of the document.
... sourcePatientId S 1..1 CXDataType The sourcePatientId represents the subject of care’s medical record identifier (e.g., Patient Id) in the local patient identifier domain of the creating entity.
... sourcePatientInfo 0..1 FieldDataType This attribute contains demographic information of the patient to whose medical record this document belongs.
... title 1..1 string The title of the document.
... typeCode S 1..1 CodeDataType The code specifying the precise type of document from the user perspective (e.g., LOINC code).
... uniqueId 1..1 IdentifierDataType Globally unique identifier assigned to the document by its creator.
... uri 1..1 URIDataType URI of document

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentEntry.eventCodeListrequiredIHEXDSeventCodeList
http://ihe-d.de/ValueSets/IHEXDSeventCodeList
From this IG
DocumentEntry.languageCodeextensibleIHEXDSlanguageCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode
From this IG

This structure is derived from DocumentEntry

Summary

Must-Support: 13 elements

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentEntry 0..* DocumentEntry
Elements defined in Ancestors:author, availabilityStatus, classCode, comments, confidentialityCode, creationTime, entryUUID, eventCodeList, formatCode, hash, healthcareFacilityTypeCode, homeCommunityId, languageCode, legalAuthenticator, limitedMetadata, mimeType, objectType, patientId, practiceSettingCode, referenceIdList, repositoryUniqueId, serviceStartTime, serviceEndTime, size, sourcePatientId, sourcePatientInfo, title, typeCode, uniqueId, uri
Document Entry (LM)
... author 0..1 Author The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication.
... availabilityStatus S 0..1 string The lifecycle status of the DocumentEntry, i.e. either 'urn:oasis:names:tc:ebxml-regrep:StatusType:Approved' or 'urn:oasis:names:tc:ebxml-regrep:StatusType:Deprecated'
... classCode S 1..1 CodeDataType The code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow).
... comments 0..1 string Comments associated with the document.
... confidentialityCode S 1..1 CodeDataType The code specifying the level of confidentiality of the document.
... creationTime 1..1 DTMDataType The time the author created the document.
... entryUUID 1..1 UUIDDataType A globally unique identifier used to identify the entry.
... eventCodeList 0..* CodeDataType This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented.
Binding: IHE XDS Event Code List (required)
... formatCode S 1..1 CodeDataType The code specifying the detailed technical format of the document.
... hash 0..1 string The hash of the contents of the document.
... healthcareFacilityTypeCode S 1..1 CodeDataType This code represents the type of organizational setting of the clinical encounter during which the documented act occurred.
... homeCommunityId 0..1 OIDURNDataType A globally unique identifier for a community.
... languageCode S 1..* string Specifies the human language of character data in the document.
Binding: IHE XDS Language Code (extensible)
... legalAuthenticator 0..1 XCNDataType Represents a participant within an authorInstitution who has legally authenticated or attested the document.
... limitedMetadata 0..1 LimitedMetadataDataType Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source.
... mimeType S 1..1 string MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13).
... objectType S 1..1 UUIDDataType The type of DocumentEntry; either urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1 for stable or urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248 for on-demand Document Entries
... patientId 1..1 CXDataType The patientId represents the subject of care of the document.
... practiceSettingCode S 0..1 CodeDataType The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology).
... referenceIdList 0..* CXiDataType A list of identifiers related to the document.
... repositoryUniqueId 0..1 OIDDataType The globally unique identifier of the repository where the document can be accessed.
... serviceStartTime S 1..1 DTMDataType The start time of the service being documented.
... serviceEndTime S 1..1 DTMDataType The stop time of the service being documented.
... size 0..1 integer Size in bytes of the document.
... sourcePatientId S 1..1 CXDataType The sourcePatientId represents the subject of care’s medical record identifier (e.g., Patient Id) in the local patient identifier domain of the creating entity.
... sourcePatientInfo 0..1 FieldDataType This attribute contains demographic information of the patient to whose medical record this document belongs.
... title 1..1 string The title of the document.
... typeCode S 1..1 CodeDataType The code specifying the precise type of document from the user perspective (e.g., LOINC code).
... uniqueId 1..1 IdentifierDataType Globally unique identifier assigned to the document by its creator.
... uri 1..1 URIDataType URI of document

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentEntry.eventCodeListrequiredIHEXDSeventCodeList
http://ihe-d.de/ValueSets/IHEXDSeventCodeList
From this IG
DocumentEntry.languageCodeextensibleIHEXDSlanguageCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode
From this IG

Differential View

This structure is derived from DocumentEntry

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentEntry 0..* DocumentEntry
Elements defined in Ancestors:author, availabilityStatus, classCode, comments, confidentialityCode, creationTime, entryUUID, eventCodeList, formatCode, hash, healthcareFacilityTypeCode, homeCommunityId, languageCode, legalAuthenticator, limitedMetadata, mimeType, objectType, patientId, practiceSettingCode, referenceIdList, repositoryUniqueId, serviceStartTime, serviceEndTime, size, sourcePatientId, sourcePatientInfo, title, typeCode, uniqueId, uri
Document Entry (LM)
... availabilityStatus S 0..1 string The lifecycle status of the DocumentEntry, i.e. either 'urn:oasis:names:tc:ebxml-regrep:StatusType:Approved' or 'urn:oasis:names:tc:ebxml-regrep:StatusType:Deprecated'
... classCode S 1..1 CodeDataType The code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow).
... confidentialityCode S 1..1 CodeDataType The code specifying the level of confidentiality of the document.
... healthcareFacilityTypeCode S 1..1 CodeDataType This code represents the type of organizational setting of the clinical encounter during which the documented act occurred.
... languageCode S 1..* string Specifies the human language of character data in the document.
... mimeType S 1..1 string MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13).
... objectType S 1..1 UUIDDataType The type of DocumentEntry; either urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1 for stable or urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248 for on-demand Document Entries
... practiceSettingCode S 0..1 CodeDataType The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology).
... serviceStartTime S 1..1 DTMDataType The start time of the service being documented.
... serviceEndTime S 1..1 DTMDataType The stop time of the service being documented.
... sourcePatientId S 1..1 CXDataType The sourcePatientId represents the subject of care’s medical record identifier (e.g., Patient Id) in the local patient identifier domain of the creating entity.
... typeCode S 1..1 CodeDataType The code specifying the precise type of document from the user perspective (e.g., LOINC code).

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentEntry 0..* DocumentEntry
Elements defined in Ancestors:author, availabilityStatus, classCode, comments, confidentialityCode, creationTime, entryUUID, eventCodeList, formatCode, hash, healthcareFacilityTypeCode, homeCommunityId, languageCode, legalAuthenticator, limitedMetadata, mimeType, objectType, patientId, practiceSettingCode, referenceIdList, repositoryUniqueId, serviceStartTime, serviceEndTime, size, sourcePatientId, sourcePatientInfo, title, typeCode, uniqueId, uri
Document Entry (LM)
... author 0..1 Author The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication.
... availabilityStatus S 0..1 string The lifecycle status of the DocumentEntry, i.e. either 'urn:oasis:names:tc:ebxml-regrep:StatusType:Approved' or 'urn:oasis:names:tc:ebxml-regrep:StatusType:Deprecated'
... classCode S 1..1 CodeDataType The code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow).
... comments 0..1 string Comments associated with the document.
... confidentialityCode S 1..1 CodeDataType The code specifying the level of confidentiality of the document.
... creationTime 1..1 DTMDataType The time the author created the document.
... entryUUID 1..1 UUIDDataType A globally unique identifier used to identify the entry.
... eventCodeList 0..* CodeDataType This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented.
Binding: IHE XDS Event Code List (required)
... formatCode S 1..1 CodeDataType The code specifying the detailed technical format of the document.
... hash 0..1 string The hash of the contents of the document.
... healthcareFacilityTypeCode S 1..1 CodeDataType This code represents the type of organizational setting of the clinical encounter during which the documented act occurred.
... homeCommunityId 0..1 OIDURNDataType A globally unique identifier for a community.
... languageCode S 1..* string Specifies the human language of character data in the document.
Binding: IHE XDS Language Code (extensible)
... legalAuthenticator 0..1 XCNDataType Represents a participant within an authorInstitution who has legally authenticated or attested the document.
... limitedMetadata 0..1 LimitedMetadataDataType Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source.
... mimeType S 1..1 string MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13).
... objectType S 1..1 UUIDDataType The type of DocumentEntry; either urn:uuid:7edca82f-054d-47f2-a032-9b2a5b5186c1 for stable or urn:uuid:34268e47-fdf5-41a6-ba33-82133c465248 for on-demand Document Entries
... patientId 1..1 CXDataType The patientId represents the subject of care of the document.
... practiceSettingCode S 0..1 CodeDataType The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology).
... referenceIdList 0..* CXiDataType A list of identifiers related to the document.
... repositoryUniqueId 0..1 OIDDataType The globally unique identifier of the repository where the document can be accessed.
... serviceStartTime S 1..1 DTMDataType The start time of the service being documented.
... serviceEndTime S 1..1 DTMDataType The stop time of the service being documented.
... size 0..1 integer Size in bytes of the document.
... sourcePatientId S 1..1 CXDataType The sourcePatientId represents the subject of care’s medical record identifier (e.g., Patient Id) in the local patient identifier domain of the creating entity.
... sourcePatientInfo 0..1 FieldDataType This attribute contains demographic information of the patient to whose medical record this document belongs.
... title 1..1 string The title of the document.
... typeCode S 1..1 CodeDataType The code specifying the precise type of document from the user perspective (e.g., LOINC code).
... uniqueId 1..1 IdentifierDataType Globally unique identifier assigned to the document by its creator.
... uri 1..1 URIDataType URI of document

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentEntry.eventCodeListrequiredIHEXDSeventCodeList
http://ihe-d.de/ValueSets/IHEXDSeventCodeList
From this IG
DocumentEntry.languageCodeextensibleIHEXDSlanguageCode
http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode
From this IG

This structure is derived from DocumentEntry

Summary

Must-Support: 13 elements

Maturity: 2

 

Other representations of profile: CSV, Excel