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
Official URL: http://www.ihe-d.de/fhir/StructureDefinition/DocumentEntry | Version: 4.0.0-alpha1 | |||
Draft as of 2025-08-02 | Maturity Level: 2 | Computable Name: DocumentEntry | ||
Copyright/Legal: IHE Deutschland e.V. |
This Logical Model describes the relevant attributes on the Document Entry class within IHE ITI XDS. More details are to be retrieved from IHE ITI on www.ihe.net. (Focus for this LM is on the coded attributes.)
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Document Entry (LM) | |
![]() ![]() ![]() |
0..1 | Author | The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication. | |
![]() ![]() ![]() |
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' | |
![]() ![]() ![]() |
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). Binding: IHE XDS Class Code (required) | |
![]() ![]() ![]() |
0..1 | string | Comments associated with the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the level of confidentiality of the document. Binding: IHE XDS Confidentiality Code (required) | |
![]() ![]() ![]() |
1..1 | DTMDataType | The time the author created the document. | |
![]() ![]() ![]() |
1..1 | UUIDDataType | A globally unique identifier used to identify the entry. | |
![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the detailed technical format of the document. Binding: IHE XDS Format Code (required) | |
![]() ![]() ![]() |
0..1 | string | The hash of the contents of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | This code represents the type of organizational setting of the clinical encounter during which the documented act occurred. Binding: IHE XDS Healthcare Facility Type Code (required) | |
![]() ![]() ![]() |
0..1 | OIDURNDataType | A globally unique identifier for a community. | |
![]() ![]() ![]() |
1..* | string | Specifies the human language of character data in the document. Binding: IHE XDS Language Code (extensible) | |
![]() ![]() ![]() |
0..1 | XCNDataType | Represents a participant within an authorInstitution who has legally authenticated or attested the document. | |
![]() ![]() ![]() |
0..1 | LimitedMetadataDataType | Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source. | |
![]() ![]() ![]() |
1..1 | string | MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13). | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
1..1 | CXDataType | The patientId represents the subject of care of the document. | |
![]() ![]() ![]() |
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). Binding: IHE XDS Practice Setting Code (required) | |
![]() ![]() ![]() |
0..* | CXiDataType | A list of identifiers related to the document. | |
![]() ![]() ![]() |
0..1 | OIDDataType | The globally unique identifier of the repository where the document can be accessed. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The start time of the service being documented. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The stop time of the service being documented. | |
![]() ![]() ![]() |
0..1 | integer | Size in bytes of the document. | |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..1 | FieldDataType | This attribute contains demographic information of the patient to whose medical record this document belongs. | |
![]() ![]() ![]() |
1..1 | string | The title of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the precise type of document from the user perspective (e.g., LOINC code). Binding: IHE XDS Type Code (required) | |
![]() ![]() ![]() |
1..1 | IdentifierDataType | Globally unique identifier assigned to the document by its creator. | |
![]() ![]() ![]() |
1..1 | URIDataType | URI of document | |
![]() |
Path | Conformance | ValueSet | URI |
DocumentEntry.classCode | required | IHEXDSclassCodehttp://ihe-d.de/ValueSets/IHEXDSclassCode From this IG | |
DocumentEntry.confidentialityCode | required | IHEXDSconfidentialityCodehttp://ihe-d.de/ValueSets/IHEXDSconfidentialityCode From this IG | |
DocumentEntry.eventCodeList | required | IHEXDSeventCodeListhttp://ihe-d.de/ValueSets/IHEXDSeventCodeList From this IG | |
DocumentEntry.formatCode | required | IHEXDSformatCodeDEhttp://ihe-d.de/ValueSets/IHEXDSformatCodeDE From this IG | |
DocumentEntry.healthcareFacilityTypeCode | required | IHEXDShealthcareFacilityTypeCodehttp://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode From this IG | |
DocumentEntry.languageCode | extensible | IHEXDSlanguageCodehttp://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode From this IG | |
DocumentEntry.practiceSettingCode | required | IHEXDSpracticeSettingCodehttp://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode From this IG | |
DocumentEntry.typeCode | required | IHEXDStypeCodehttp://ihe-d.de/ValueSets/IHEXDStypeCode From this IG |
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Document Entry (LM) | |
![]() ![]() ![]() |
0..1 | Author | The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication. | |
![]() ![]() ![]() |
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' | |
![]() ![]() ![]() |
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). Binding: IHE XDS Class Code (required) | |
![]() ![]() ![]() |
0..1 | string | Comments associated with the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the level of confidentiality of the document. Binding: IHE XDS Confidentiality Code (required) | |
![]() ![]() ![]() |
1..1 | DTMDataType | The time the author created the document. | |
![]() ![]() ![]() |
1..1 | UUIDDataType | A globally unique identifier used to identify the entry. | |
![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the detailed technical format of the document. Binding: IHE XDS Format Code (required) | |
![]() ![]() ![]() |
0..1 | string | The hash of the contents of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | This code represents the type of organizational setting of the clinical encounter during which the documented act occurred. Binding: IHE XDS Healthcare Facility Type Code (required) | |
![]() ![]() ![]() |
0..1 | OIDURNDataType | A globally unique identifier for a community. | |
![]() ![]() ![]() |
1..* | string | Specifies the human language of character data in the document. Binding: IHE XDS Language Code (extensible) | |
![]() ![]() ![]() |
0..1 | XCNDataType | Represents a participant within an authorInstitution who has legally authenticated or attested the document. | |
![]() ![]() ![]() |
0..1 | LimitedMetadataDataType | Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source. | |
![]() ![]() ![]() |
1..1 | string | MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13). | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
1..1 | CXDataType | The patientId represents the subject of care of the document. | |
![]() ![]() ![]() |
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). Binding: IHE XDS Practice Setting Code (required) | |
![]() ![]() ![]() |
0..* | CXiDataType | A list of identifiers related to the document. | |
![]() ![]() ![]() |
0..1 | OIDDataType | The globally unique identifier of the repository where the document can be accessed. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The start time of the service being documented. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The stop time of the service being documented. | |
![]() ![]() ![]() |
0..1 | integer | Size in bytes of the document. | |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..1 | FieldDataType | This attribute contains demographic information of the patient to whose medical record this document belongs. | |
![]() ![]() ![]() |
1..1 | string | The title of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the precise type of document from the user perspective (e.g., LOINC code). Binding: IHE XDS Type Code (required) | |
![]() ![]() ![]() |
1..1 | IdentifierDataType | Globally unique identifier assigned to the document by its creator. | |
![]() ![]() ![]() |
1..1 | URIDataType | URI of document | |
![]() |
Path | Conformance | ValueSet | URI |
DocumentEntry.classCode | required | IHEXDSclassCodehttp://ihe-d.de/ValueSets/IHEXDSclassCode From this IG | |
DocumentEntry.confidentialityCode | required | IHEXDSconfidentialityCodehttp://ihe-d.de/ValueSets/IHEXDSconfidentialityCode From this IG | |
DocumentEntry.eventCodeList | required | IHEXDSeventCodeListhttp://ihe-d.de/ValueSets/IHEXDSeventCodeList From this IG | |
DocumentEntry.formatCode | required | IHEXDSformatCodeDEhttp://ihe-d.de/ValueSets/IHEXDSformatCodeDE From this IG | |
DocumentEntry.healthcareFacilityTypeCode | required | IHEXDShealthcareFacilityTypeCodehttp://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode From this IG | |
DocumentEntry.languageCode | extensible | IHEXDSlanguageCodehttp://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode From this IG | |
DocumentEntry.practiceSettingCode | required | IHEXDSpracticeSettingCodehttp://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode From this IG | |
DocumentEntry.typeCode | required | IHEXDStypeCodehttp://ihe-d.de/ValueSets/IHEXDStypeCode From this IG |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Document Entry (LM) | |
![]() ![]() ![]() |
0..1 | Author | The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication. | |
![]() ![]() ![]() |
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' | |
![]() ![]() ![]() |
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). Binding: IHE XDS Class Code (required) | |
![]() ![]() ![]() |
0..1 | string | Comments associated with the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the level of confidentiality of the document. Binding: IHE XDS Confidentiality Code (required) | |
![]() ![]() ![]() |
1..1 | DTMDataType | The time the author created the document. | |
![]() ![]() ![]() |
1..1 | UUIDDataType | A globally unique identifier used to identify the entry. | |
![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the detailed technical format of the document. Binding: IHE XDS Format Code (required) | |
![]() ![]() ![]() |
0..1 | string | The hash of the contents of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | This code represents the type of organizational setting of the clinical encounter during which the documented act occurred. Binding: IHE XDS Healthcare Facility Type Code (required) | |
![]() ![]() ![]() |
0..1 | OIDURNDataType | A globally unique identifier for a community. | |
![]() ![]() ![]() |
1..* | string | Specifies the human language of character data in the document. Binding: IHE XDS Language Code (extensible) | |
![]() ![]() ![]() |
0..1 | XCNDataType | Represents a participant within an authorInstitution who has legally authenticated or attested the document. | |
![]() ![]() ![]() |
0..1 | LimitedMetadataDataType | Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source. | |
![]() ![]() ![]() |
1..1 | string | MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13). | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
1..1 | CXDataType | The patientId represents the subject of care of the document. | |
![]() ![]() ![]() |
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). Binding: IHE XDS Practice Setting Code (required) | |
![]() ![]() ![]() |
0..* | CXiDataType | A list of identifiers related to the document. | |
![]() ![]() ![]() |
0..1 | OIDDataType | The globally unique identifier of the repository where the document can be accessed. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The start time of the service being documented. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The stop time of the service being documented. | |
![]() ![]() ![]() |
0..1 | integer | Size in bytes of the document. | |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..1 | FieldDataType | This attribute contains demographic information of the patient to whose medical record this document belongs. | |
![]() ![]() ![]() |
1..1 | string | The title of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the precise type of document from the user perspective (e.g., LOINC code). Binding: IHE XDS Type Code (required) | |
![]() ![]() ![]() |
1..1 | IdentifierDataType | Globally unique identifier assigned to the document by its creator. | |
![]() ![]() ![]() |
1..1 | URIDataType | URI of document | |
![]() |
Path | Conformance | ValueSet | URI |
DocumentEntry.classCode | required | IHEXDSclassCodehttp://ihe-d.de/ValueSets/IHEXDSclassCode From this IG | |
DocumentEntry.confidentialityCode | required | IHEXDSconfidentialityCodehttp://ihe-d.de/ValueSets/IHEXDSconfidentialityCode From this IG | |
DocumentEntry.eventCodeList | required | IHEXDSeventCodeListhttp://ihe-d.de/ValueSets/IHEXDSeventCodeList From this IG | |
DocumentEntry.formatCode | required | IHEXDSformatCodeDEhttp://ihe-d.de/ValueSets/IHEXDSformatCodeDE From this IG | |
DocumentEntry.healthcareFacilityTypeCode | required | IHEXDShealthcareFacilityTypeCodehttp://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode From this IG | |
DocumentEntry.languageCode | extensible | IHEXDSlanguageCodehttp://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode From this IG | |
DocumentEntry.practiceSettingCode | required | IHEXDSpracticeSettingCodehttp://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode From this IG | |
DocumentEntry.typeCode | required | IHEXDStypeCodehttp://ihe-d.de/ValueSets/IHEXDStypeCode From this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Document Entry (LM) | |
![]() ![]() ![]() |
0..1 | Author | The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication. | |
![]() ![]() ![]() |
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' | |
![]() ![]() ![]() |
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). Binding: IHE XDS Class Code (required) | |
![]() ![]() ![]() |
0..1 | string | Comments associated with the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the level of confidentiality of the document. Binding: IHE XDS Confidentiality Code (required) | |
![]() ![]() ![]() |
1..1 | DTMDataType | The time the author created the document. | |
![]() ![]() ![]() |
1..1 | UUIDDataType | A globally unique identifier used to identify the entry. | |
![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the detailed technical format of the document. Binding: IHE XDS Format Code (required) | |
![]() ![]() ![]() |
0..1 | string | The hash of the contents of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | This code represents the type of organizational setting of the clinical encounter during which the documented act occurred. Binding: IHE XDS Healthcare Facility Type Code (required) | |
![]() ![]() ![]() |
0..1 | OIDURNDataType | A globally unique identifier for a community. | |
![]() ![]() ![]() |
1..* | string | Specifies the human language of character data in the document. Binding: IHE XDS Language Code (extensible) | |
![]() ![]() ![]() |
0..1 | XCNDataType | Represents a participant within an authorInstitution who has legally authenticated or attested the document. | |
![]() ![]() ![]() |
0..1 | LimitedMetadataDataType | Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source. | |
![]() ![]() ![]() |
1..1 | string | MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13). | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
1..1 | CXDataType | The patientId represents the subject of care of the document. | |
![]() ![]() ![]() |
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). Binding: IHE XDS Practice Setting Code (required) | |
![]() ![]() ![]() |
0..* | CXiDataType | A list of identifiers related to the document. | |
![]() ![]() ![]() |
0..1 | OIDDataType | The globally unique identifier of the repository where the document can be accessed. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The start time of the service being documented. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The stop time of the service being documented. | |
![]() ![]() ![]() |
0..1 | integer | Size in bytes of the document. | |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..1 | FieldDataType | This attribute contains demographic information of the patient to whose medical record this document belongs. | |
![]() ![]() ![]() |
1..1 | string | The title of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the precise type of document from the user perspective (e.g., LOINC code). Binding: IHE XDS Type Code (required) | |
![]() ![]() ![]() |
1..1 | IdentifierDataType | Globally unique identifier assigned to the document by its creator. | |
![]() ![]() ![]() |
1..1 | URIDataType | URI of document | |
![]() |
Path | Conformance | ValueSet | URI |
DocumentEntry.classCode | required | IHEXDSclassCodehttp://ihe-d.de/ValueSets/IHEXDSclassCode From this IG | |
DocumentEntry.confidentialityCode | required | IHEXDSconfidentialityCodehttp://ihe-d.de/ValueSets/IHEXDSconfidentialityCode From this IG | |
DocumentEntry.eventCodeList | required | IHEXDSeventCodeListhttp://ihe-d.de/ValueSets/IHEXDSeventCodeList From this IG | |
DocumentEntry.formatCode | required | IHEXDSformatCodeDEhttp://ihe-d.de/ValueSets/IHEXDSformatCodeDE From this IG | |
DocumentEntry.healthcareFacilityTypeCode | required | IHEXDShealthcareFacilityTypeCodehttp://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode From this IG | |
DocumentEntry.languageCode | extensible | IHEXDSlanguageCodehttp://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode From this IG | |
DocumentEntry.practiceSettingCode | required | IHEXDSpracticeSettingCodehttp://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode From this IG | |
DocumentEntry.typeCode | required | IHEXDStypeCodehttp://ihe-d.de/ValueSets/IHEXDStypeCode From this IG |
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Document Entry (LM) | |
![]() ![]() ![]() |
0..1 | Author | The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication. | |
![]() ![]() ![]() |
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' | |
![]() ![]() ![]() |
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). Binding: IHE XDS Class Code (required) | |
![]() ![]() ![]() |
0..1 | string | Comments associated with the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the level of confidentiality of the document. Binding: IHE XDS Confidentiality Code (required) | |
![]() ![]() ![]() |
1..1 | DTMDataType | The time the author created the document. | |
![]() ![]() ![]() |
1..1 | UUIDDataType | A globally unique identifier used to identify the entry. | |
![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the detailed technical format of the document. Binding: IHE XDS Format Code (required) | |
![]() ![]() ![]() |
0..1 | string | The hash of the contents of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | This code represents the type of organizational setting of the clinical encounter during which the documented act occurred. Binding: IHE XDS Healthcare Facility Type Code (required) | |
![]() ![]() ![]() |
0..1 | OIDURNDataType | A globally unique identifier for a community. | |
![]() ![]() ![]() |
1..* | string | Specifies the human language of character data in the document. Binding: IHE XDS Language Code (extensible) | |
![]() ![]() ![]() |
0..1 | XCNDataType | Represents a participant within an authorInstitution who has legally authenticated or attested the document. | |
![]() ![]() ![]() |
0..1 | LimitedMetadataDataType | Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source. | |
![]() ![]() ![]() |
1..1 | string | MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13). | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
1..1 | CXDataType | The patientId represents the subject of care of the document. | |
![]() ![]() ![]() |
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). Binding: IHE XDS Practice Setting Code (required) | |
![]() ![]() ![]() |
0..* | CXiDataType | A list of identifiers related to the document. | |
![]() ![]() ![]() |
0..1 | OIDDataType | The globally unique identifier of the repository where the document can be accessed. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The start time of the service being documented. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The stop time of the service being documented. | |
![]() ![]() ![]() |
0..1 | integer | Size in bytes of the document. | |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..1 | FieldDataType | This attribute contains demographic information of the patient to whose medical record this document belongs. | |
![]() ![]() ![]() |
1..1 | string | The title of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the precise type of document from the user perspective (e.g., LOINC code). Binding: IHE XDS Type Code (required) | |
![]() ![]() ![]() |
1..1 | IdentifierDataType | Globally unique identifier assigned to the document by its creator. | |
![]() ![]() ![]() |
1..1 | URIDataType | URI of document | |
![]() |
Path | Conformance | ValueSet | URI |
DocumentEntry.classCode | required | IHEXDSclassCodehttp://ihe-d.de/ValueSets/IHEXDSclassCode From this IG | |
DocumentEntry.confidentialityCode | required | IHEXDSconfidentialityCodehttp://ihe-d.de/ValueSets/IHEXDSconfidentialityCode From this IG | |
DocumentEntry.eventCodeList | required | IHEXDSeventCodeListhttp://ihe-d.de/ValueSets/IHEXDSeventCodeList From this IG | |
DocumentEntry.formatCode | required | IHEXDSformatCodeDEhttp://ihe-d.de/ValueSets/IHEXDSformatCodeDE From this IG | |
DocumentEntry.healthcareFacilityTypeCode | required | IHEXDShealthcareFacilityTypeCodehttp://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode From this IG | |
DocumentEntry.languageCode | extensible | IHEXDSlanguageCodehttp://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode From this IG | |
DocumentEntry.practiceSettingCode | required | IHEXDSpracticeSettingCodehttp://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode From this IG | |
DocumentEntry.typeCode | required | IHEXDStypeCodehttp://ihe-d.de/ValueSets/IHEXDStypeCode From this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Base | Document Entry (LM) | |
![]() ![]() ![]() |
0..1 | Author | The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication. | |
![]() ![]() ![]() |
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' | |
![]() ![]() ![]() |
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). Binding: IHE XDS Class Code (required) | |
![]() ![]() ![]() |
0..1 | string | Comments associated with the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the level of confidentiality of the document. Binding: IHE XDS Confidentiality Code (required) | |
![]() ![]() ![]() |
1..1 | DTMDataType | The time the author created the document. | |
![]() ![]() ![]() |
1..1 | UUIDDataType | A globally unique identifier used to identify the entry. | |
![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the detailed technical format of the document. Binding: IHE XDS Format Code (required) | |
![]() ![]() ![]() |
0..1 | string | The hash of the contents of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | This code represents the type of organizational setting of the clinical encounter during which the documented act occurred. Binding: IHE XDS Healthcare Facility Type Code (required) | |
![]() ![]() ![]() |
0..1 | OIDURNDataType | A globally unique identifier for a community. | |
![]() ![]() ![]() |
1..* | string | Specifies the human language of character data in the document. Binding: IHE XDS Language Code (extensible) | |
![]() ![]() ![]() |
0..1 | XCNDataType | Represents a participant within an authorInstitution who has legally authenticated or attested the document. | |
![]() ![]() ![]() |
0..1 | LimitedMetadataDataType | Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source. | |
![]() ![]() ![]() |
1..1 | string | MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13). | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
1..1 | CXDataType | The patientId represents the subject of care of the document. | |
![]() ![]() ![]() |
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). Binding: IHE XDS Practice Setting Code (required) | |
![]() ![]() ![]() |
0..* | CXiDataType | A list of identifiers related to the document. | |
![]() ![]() ![]() |
0..1 | OIDDataType | The globally unique identifier of the repository where the document can be accessed. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The start time of the service being documented. | |
![]() ![]() ![]() |
1..1 | DTMDataType | The stop time of the service being documented. | |
![]() ![]() ![]() |
0..1 | integer | Size in bytes of the document. | |
![]() ![]() ![]() |
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. | |
![]() ![]() ![]() |
0..1 | FieldDataType | This attribute contains demographic information of the patient to whose medical record this document belongs. | |
![]() ![]() ![]() |
1..1 | string | The title of the document. | |
![]() ![]() ![]() |
1..1 | CodeDataType | The code specifying the precise type of document from the user perspective (e.g., LOINC code). Binding: IHE XDS Type Code (required) | |
![]() ![]() ![]() |
1..1 | IdentifierDataType | Globally unique identifier assigned to the document by its creator. | |
![]() ![]() ![]() |
1..1 | URIDataType | URI of document | |
![]() |
Path | Conformance | ValueSet | URI |
DocumentEntry.classCode | required | IHEXDSclassCodehttp://ihe-d.de/ValueSets/IHEXDSclassCode From this IG | |
DocumentEntry.confidentialityCode | required | IHEXDSconfidentialityCodehttp://ihe-d.de/ValueSets/IHEXDSconfidentialityCode From this IG | |
DocumentEntry.eventCodeList | required | IHEXDSeventCodeListhttp://ihe-d.de/ValueSets/IHEXDSeventCodeList From this IG | |
DocumentEntry.formatCode | required | IHEXDSformatCodeDEhttp://ihe-d.de/ValueSets/IHEXDSformatCodeDE From this IG | |
DocumentEntry.healthcareFacilityTypeCode | required | IHEXDShealthcareFacilityTypeCodehttp://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode From this IG | |
DocumentEntry.languageCode | extensible | IHEXDSlanguageCodehttp://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode From this IG | |
DocumentEntry.practiceSettingCode | required | IHEXDSpracticeSettingCodehttp://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode From this IG | |
DocumentEntry.typeCode | required | IHEXDStypeCodehttp://ihe-d.de/ValueSets/IHEXDStypeCode From this IG |