IHE Germany - Value Sets for XDS
0.3.28 - draft
IHE Germany - Value Sets for XDS
0.3.28 - draft
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
| Draft as of 2025-08-02 | Maturity Level: 2 |
Definitions for the DocumentEntryProfile logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. DocumentEntry | |
| Definition | Document Entry |
| Short | Document Entry (LM) |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. DocumentEntry.author | |
| Definition | The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication. |
| Short | The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/Author |
| 4. DocumentEntry.availabilityStatus | |
| Definition | Availability Status |
| Short | 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' |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 6. DocumentEntry.classCode | |
| Definition | Class Code |
| Short | The code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow). |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 8. DocumentEntry.comments | |
| Definition | Comments associated with the document. |
| Short | Comments associated with the document. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. DocumentEntry.confidentialityCode | |
| Definition | Confidentiality Code |
| Short | The code specifying the level of confidentiality of the document. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 12. DocumentEntry.creationTime | |
| Definition | The time the author created the document. |
| Short | The time the author created the document. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/DTMDataType |
| 14. DocumentEntry.entryUUID | |
| Definition | A globally unique identifier used to identify the entry. |
| Short | A globally unique identifier used to identify the entry. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/UUIDDataType |
| 16. DocumentEntry.eventCodeList | |
| Definition | Class Code |
| Short | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. |
| Control | 0..* |
| Binding | The codes SHALL be taken from IHE XDS Event Code List (required to http://ihe-d.de/ValueSets/IHEXDSeventCodeList) |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| 18. DocumentEntry.formatCode | |
| Definition | Format Code |
| Short | The code specifying the detailed technical format of the document. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 20. DocumentEntry.hash | |
| Definition | The hash of the contents of the document. |
| Short | The hash of the contents of the document. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. DocumentEntry.healthcareFacilityTypeCode | |
| Definition | Healthcare Facility Type Code** |
| Short | This code represents the type of organizational setting of the clinical encounter during which the documented act occurred. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 24. DocumentEntry.homeCommunityId | |
| Definition | A globally unique identifier for a community. |
| Short | A globally unique identifier for a community. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/OIDURNDataType |
| 26. DocumentEntry.languageCode | |
| Definition | Language Code |
| Short | Specifies the human language of character data in the document. |
| Control | 1..* |
| Binding | Unless not suitable, these codes SHALL be taken from IHE XDS Language Code (extensible to http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode) |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 28. DocumentEntry.legalAuthenticator | |
| Definition | Represents a participant within an authorInstitution who has legally authenticated or attested the document. |
| Short | Represents a participant within an authorInstitution who has legally authenticated or attested the document. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/XCNDataType |
| 30. DocumentEntry.limitedMetadata | |
| Definition | Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source. |
| Short | Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/LimitedMetadataDataType |
| 32. DocumentEntry.mimeType | |
| Definition | MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13). |
| Short | MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 34. DocumentEntry.objectType | |
| Definition | 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 |
| Short | 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 |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/UUIDDataType |
| Must Support | true |
| 36. DocumentEntry.patientId | |
| Definition | The patientId represents the subject of care of the document. |
| Short | The patientId represents the subject of care of the document. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CXDataType |
| 38. DocumentEntry.practiceSettingCode | |
| Definition | Practice Setting Code |
| Short | The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology). |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 40. DocumentEntry.referenceIdList | |
| Definition | A list of identifiers related to the document. |
| Short | A list of identifiers related to the document. |
| Control | 0..* |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CXiDataType |
| 42. DocumentEntry.repositoryUniqueId | |
| Definition | The globally unique identifier of the repository where the document can be accessed. |
| Short | The globally unique identifier of the repository where the document can be accessed. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/OIDDataType |
| 44. DocumentEntry.serviceStartTime | |
| Definition | The start time of the service being documented. |
| Short | The start time of the service being documented. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/DTMDataType |
| Must Support | true |
| 46. DocumentEntry.serviceEndTime | |
| Definition | The stop time of the service being documented. |
| Short | The stop time of the service being documented. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/DTMDataType |
| Must Support | true |
| 48. DocumentEntry.size | |
| Definition | Size in bytes of the document. |
| Short | Size in bytes of the document. |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 50. DocumentEntry.sourcePatientId | |
| Definition | 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. |
| Short | 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. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CXDataType |
| Must Support | true |
| 52. DocumentEntry.sourcePatientInfo | |
| Definition | This attribute contains demographic information of the patient to whose medical record this document belongs. |
| Short | This attribute contains demographic information of the patient to whose medical record this document belongs. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/FieldDataType |
| 54. DocumentEntry.title | |
| Definition | The title of the document. |
| Short | The title of the document. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. DocumentEntry.typeCode | |
| Definition | Type Code |
| Short | The code specifying the precise type of document from the user perspective (e.g., LOINC code). |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 58. DocumentEntry.uniqueId | |
| Definition | Globally unique identifier assigned to the document by its creator. |
| Short | Globally unique identifier assigned to the document by its creator. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/IdentifierDataType |
| 60. DocumentEntry.uri | |
| Definition | URI of document |
| Short | URI of document |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/URIDataType |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DocumentEntry | |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. DocumentEntry.availabilityStatus | |
| Must Support | true |
| 4. DocumentEntry.classCode | |
| Must Support | true |
| 6. DocumentEntry.confidentialityCode | |
| Must Support | true |
| 8. DocumentEntry.formatCode | |
| Must Support | true |
| 10. DocumentEntry.healthcareFacilityTypeCode | |
| Must Support | true |
| 12. DocumentEntry.languageCode | |
| Must Support | true |
| 14. DocumentEntry.mimeType | |
| Must Support | true |
| 16. DocumentEntry.objectType | |
| Must Support | true |
| 18. DocumentEntry.practiceSettingCode | |
| Must Support | true |
| 20. DocumentEntry.serviceStartTime | |
| Must Support | true |
| 22. DocumentEntry.serviceEndTime | |
| Must Support | true |
| 24. DocumentEntry.sourcePatientId | |
| Must Support | true |
| 26. DocumentEntry.typeCode | |
| Must Support | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DocumentEntry | |
| Definition | Document Entry |
| Short | Document Entry (LM) |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. DocumentEntry.author | |
| Definition | The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication. |
| Short | The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/Author |
| 4. DocumentEntry.availabilityStatus | |
| Definition | Availability Status |
| Short | 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' |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 6. DocumentEntry.classCode | |
| Definition | Class Code |
| Short | The code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow). |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 8. DocumentEntry.comments | |
| Definition | Comments associated with the document. |
| Short | Comments associated with the document. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. DocumentEntry.confidentialityCode | |
| Definition | Confidentiality Code |
| Short | The code specifying the level of confidentiality of the document. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 12. DocumentEntry.creationTime | |
| Definition | The time the author created the document. |
| Short | The time the author created the document. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/DTMDataType |
| 14. DocumentEntry.entryUUID | |
| Definition | A globally unique identifier used to identify the entry. |
| Short | A globally unique identifier used to identify the entry. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/UUIDDataType |
| 16. DocumentEntry.eventCodeList | |
| Definition | Class Code |
| Short | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. |
| Control | 0..* |
| Binding | The codes SHALL be taken from IHE XDS Event Code List (required to http://ihe-d.de/ValueSets/IHEXDSeventCodeList) |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| 18. DocumentEntry.formatCode | |
| Definition | Format Code |
| Short | The code specifying the detailed technical format of the document. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 20. DocumentEntry.hash | |
| Definition | The hash of the contents of the document. |
| Short | The hash of the contents of the document. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. DocumentEntry.healthcareFacilityTypeCode | |
| Definition | Healthcare Facility Type Code** |
| Short | This code represents the type of organizational setting of the clinical encounter during which the documented act occurred. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 24. DocumentEntry.homeCommunityId | |
| Definition | A globally unique identifier for a community. |
| Short | A globally unique identifier for a community. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/OIDURNDataType |
| 26. DocumentEntry.languageCode | |
| Definition | Language Code |
| Short | Specifies the human language of character data in the document. |
| Control | 1..* |
| Binding | Unless not suitable, these codes SHALL be taken from IHE XDS Language Code (extensible to http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode) |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 28. DocumentEntry.legalAuthenticator | |
| Definition | Represents a participant within an authorInstitution who has legally authenticated or attested the document. |
| Short | Represents a participant within an authorInstitution who has legally authenticated or attested the document. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/XCNDataType |
| 30. DocumentEntry.limitedMetadata | |
| Definition | Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source. |
| Short | Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/LimitedMetadataDataType |
| 32. DocumentEntry.mimeType | |
| Definition | MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13). |
| Short | MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 34. DocumentEntry.objectType | |
| Definition | 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 |
| Short | 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 |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/UUIDDataType |
| Must Support | true |
| 36. DocumentEntry.patientId | |
| Definition | The patientId represents the subject of care of the document. |
| Short | The patientId represents the subject of care of the document. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CXDataType |
| 38. DocumentEntry.practiceSettingCode | |
| Definition | Practice Setting Code |
| Short | The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology). |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 40. DocumentEntry.referenceIdList | |
| Definition | A list of identifiers related to the document. |
| Short | A list of identifiers related to the document. |
| Control | 0..* |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CXiDataType |
| 42. DocumentEntry.repositoryUniqueId | |
| Definition | The globally unique identifier of the repository where the document can be accessed. |
| Short | The globally unique identifier of the repository where the document can be accessed. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/OIDDataType |
| 44. DocumentEntry.serviceStartTime | |
| Definition | The start time of the service being documented. |
| Short | The start time of the service being documented. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/DTMDataType |
| Must Support | true |
| 46. DocumentEntry.serviceEndTime | |
| Definition | The stop time of the service being documented. |
| Short | The stop time of the service being documented. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/DTMDataType |
| Must Support | true |
| 48. DocumentEntry.size | |
| Definition | Size in bytes of the document. |
| Short | Size in bytes of the document. |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 50. DocumentEntry.sourcePatientId | |
| Definition | 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. |
| Short | 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. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CXDataType |
| Must Support | true |
| 52. DocumentEntry.sourcePatientInfo | |
| Definition | This attribute contains demographic information of the patient to whose medical record this document belongs. |
| Short | This attribute contains demographic information of the patient to whose medical record this document belongs. |
| Control | 0..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/FieldDataType |
| 54. DocumentEntry.title | |
| Definition | The title of the document. |
| Short | The title of the document. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 56. DocumentEntry.typeCode | |
| Definition | Type Code |
| Short | The code specifying the precise type of document from the user perspective (e.g., LOINC code). |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType |
| Must Support | true |
| 58. DocumentEntry.uniqueId | |
| Definition | Globally unique identifier assigned to the document by its creator. |
| Short | Globally unique identifier assigned to the document by its creator. |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/IdentifierDataType |
| 60. DocumentEntry.uri | |
| Definition | URI of document |
| Short | URI of document |
| Control | 1..1 |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/URIDataType |