| Package | ihe-de.iti.xds-vs |
| Type | StructureDefinition |
| Id | DocumentEntryProfile |
| FHIR Version | R4 |
| Source | http://www.ihe-d.de/fhir/https://build.fhir.org/ig/IHE-Germany/ITI.XDS.VS/StructureDefinition-DocumentEntryProfile.html |
| URL | http://www.ihe-d.de/fhir/StructureDefinition/DocumentEntryProfile |
| Version | 4.0.0-alpha1 |
| Status | draft |
| Date | 2025-04-14 |
| Name | DocumentEntryProfile |
| Title | Document Entry (Profile) |
| Realm | de |
| Authority | ihe |
| Description | **Document Entry**: Die zu unterstützenden Attribute werden über ein Profil festgelegt. |
| Copyright | IHE Deutschland e.V. |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/DocumentEntry |
| Kind | logical |
No resources found
| StructureDefinition | |
| DocumentEntry | Document Entry (LM) |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition DocumentEntryProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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. |
| formatCode | S | 1..1 | CodeDataType | The code specifying the detailed technical format 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). |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "DocumentEntryProfile",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://www.ihe-d.de/fhir/ImplementationGuide/ihe-de.iti.xds-vs"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://www.ihe-d.de/fhir/ImplementationGuide/ihe-de.iti.xds-vs"
}
]
}
}
],
"url": "http://www.ihe-d.de/fhir/StructureDefinition/DocumentEntryProfile",
"version": "4.0.0-alpha1",
"name": "DocumentEntryProfile",
"title": "Document Entry (Profile)",
"status": "draft",
"experimental": false,
"date": "2025-04-14",
"publisher": "IHE Deutschland e.V., Berlin, Deutschland",
"contact": [
{
"name": "IHE Deutschland e.V., Berlin, Deutschland",
"telecom": [
{
"system": "url",
"value": "http://www.ihe-d.de"
},
{
"system": "email",
"value": "info@ihe-d.de"
}
]
}
],
"description": "**Document Entry**: Die zu unterstützenden Attribute werden über ein Profil festgelegt.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "DE",
"display": "Germany"
}
]
}
],
"copyright": "IHE Deutschland e.V.",
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://www.ihe-d.de/fhir/StructureDefinition/DocumentEntry",
"baseDefinition": "http://www.ihe-d.de/fhir/StructureDefinition/DocumentEntry",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.0-alpha1"
}
],
"element": [
{
"id": "DocumentEntry",
"path": "DocumentEntry",
"short": "Document Entry (LM)",
"definition": "Document Entry",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "DocumentEntry.author",
"path": "DocumentEntry.author",
"short": "The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication.",
"definition": "The humans and/or machines that authored the document. This attribute contains the sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty and authorTelecommunication.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentEntry.author",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/Author"
}
]
},
{
"id": "DocumentEntry.availabilityStatus",
"path": "DocumentEntry.availabilityStatus",
"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'",
"definition": "**Availability Status**",
"min": 0,
"max": "1",
"base": {
"path": "DocumentEntry.availabilityStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.classCode",
"path": "DocumentEntry.classCode",
"short": "The code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow).",
"definition": "**Class Code**",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.classCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.comments",
"path": "DocumentEntry.comments",
"short": "Comments associated with the document.",
"definition": "Comments associated with the document.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentEntry.comments",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "DocumentEntry.confidentialityCode",
"path": "DocumentEntry.confidentialityCode",
"short": "The code specifying the level of confidentiality of the document.",
"definition": "**Confidentiality Code**",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.confidentialityCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.creationTime",
"path": "DocumentEntry.creationTime",
"short": "The time the author created the document.",
"definition": "The time the author created the document.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.creationTime",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/DTMDataType"
}
]
},
{
"id": "DocumentEntry.entryUUID",
"path": "DocumentEntry.entryUUID",
"short": "A globally unique identifier used to identify the entry.",
"definition": "A globally unique identifier used to identify the entry.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.entryUUID",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/UUIDDataType"
}
]
},
{
"id": "DocumentEntry.eventCodeList",
"path": "DocumentEntry.eventCodeList",
"short": "This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented.",
"definition": "**Class Code**",
"min": 0,
"max": "*",
"base": {
"path": "DocumentEntry.eventCodeList",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDSeventCodeList"
}
},
{
"id": "DocumentEntry.formatCode",
"path": "DocumentEntry.formatCode",
"short": "The code specifying the detailed technical format of the document.",
"definition": "**Format Code**",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.formatCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.hash",
"path": "DocumentEntry.hash",
"short": "The hash of the contents of the document.",
"definition": "The hash of the contents of the document.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentEntry.hash",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "DocumentEntry.healthcareFacilityTypeCode",
"path": "DocumentEntry.healthcareFacilityTypeCode",
"short": "This code represents the type of organizational setting of the clinical encounter during which the documented act occurred.",
"definition": "Healthcare Facility Type Code**",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.healthcareFacilityTypeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.homeCommunityId",
"path": "DocumentEntry.homeCommunityId",
"short": "A globally unique identifier for a community.",
"definition": "A globally unique identifier for a community.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentEntry.homeCommunityId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/OIDURNDataType"
}
]
},
{
"id": "DocumentEntry.languageCode",
"path": "DocumentEntry.languageCode",
"short": "Specifies the human language of character data in the document.",
"definition": "**Language Code**",
"min": 1,
"max": "*",
"base": {
"path": "DocumentEntry.languageCode",
"min": 1,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://www.ihe-d.de/fhir/ValueSet/IHEXDSlanguageCode"
}
},
{
"id": "DocumentEntry.legalAuthenticator",
"path": "DocumentEntry.legalAuthenticator",
"short": "Represents a participant within an authorInstitution who has legally authenticated or attested the document.",
"definition": "Represents a participant within an authorInstitution who has legally authenticated or attested the document.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentEntry.legalAuthenticator",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/XCNDataType"
}
]
},
{
"id": "DocumentEntry.limitedMetadata",
"path": "DocumentEntry.limitedMetadata",
"short": "Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source.",
"definition": "Indicates whether the DocumentEntry was created using the less rigorous requirements of metadata as defined for the Metadata-Limited Document Source.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentEntry.limitedMetadata",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/LimitedMetadataDataType"
}
]
},
{
"id": "DocumentEntry.mimeType",
"path": "DocumentEntry.mimeType",
"short": "MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13).",
"definition": "MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13).",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.mimeType",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.objectType",
"path": "DocumentEntry.objectType",
"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",
"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",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.objectType",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/UUIDDataType"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.patientId",
"path": "DocumentEntry.patientId",
"short": "The patientId represents the subject of care of the document.",
"definition": "The patientId represents the subject of care of the document.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.patientId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CXDataType"
}
]
},
{
"id": "DocumentEntry.practiceSettingCode",
"path": "DocumentEntry.practiceSettingCode",
"short": "The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology).",
"definition": "**Practice Setting Code**",
"min": 0,
"max": "1",
"base": {
"path": "DocumentEntry.practiceSettingCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.referenceIdList",
"path": "DocumentEntry.referenceIdList",
"short": "A list of identifiers related to the document.",
"definition": "A list of identifiers related to the document.",
"min": 0,
"max": "*",
"base": {
"path": "DocumentEntry.referenceIdList",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CXiDataType"
}
]
},
{
"id": "DocumentEntry.repositoryUniqueId",
"path": "DocumentEntry.repositoryUniqueId",
"short": "The globally unique identifier of the repository where the document can be accessed.",
"definition": "The globally unique identifier of the repository where the document can be accessed.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentEntry.repositoryUniqueId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/OIDDataType"
}
]
},
{
"id": "DocumentEntry.serviceStartTime",
"path": "DocumentEntry.serviceStartTime",
"short": "The start time of the service being documented.",
"definition": "The start time of the service being documented.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.serviceStartTime",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/DTMDataType"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.serviceEndTime",
"path": "DocumentEntry.serviceEndTime",
"short": "The stop time of the service being documented.",
"definition": "The stop time of the service being documented.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.serviceEndTime",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/DTMDataType"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.size",
"path": "DocumentEntry.size",
"short": "Size in bytes of the document.",
"definition": "Size in bytes of the document.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentEntry.size",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "DocumentEntry.sourcePatientId",
"path": "DocumentEntry.sourcePatientId",
"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.",
"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.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.sourcePatientId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CXDataType"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.sourcePatientInfo",
"path": "DocumentEntry.sourcePatientInfo",
"short": "This attribute contains demographic information of the patient to whose medical record this document belongs.",
"definition": "This attribute contains demographic information of the patient to whose medical record this document belongs.",
"min": 0,
"max": "1",
"base": {
"path": "DocumentEntry.sourcePatientInfo",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/FieldDataType"
}
]
},
{
"id": "DocumentEntry.title",
"path": "DocumentEntry.title",
"short": "The title of the document.",
"definition": "The title of the document.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.title",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "DocumentEntry.typeCode",
"path": "DocumentEntry.typeCode",
"short": "The code specifying the precise type of document from the user perspective (e.g., LOINC code).",
"definition": "**Type Code**",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"mustSupport": true
},
{
"id": "DocumentEntry.uniqueId",
"path": "DocumentEntry.uniqueId",
"short": "Globally unique identifier assigned to the document by its creator.",
"definition": "Globally unique identifier assigned to the document by its creator.",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.uniqueId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/IdentifierDataType"
}
]
},
{
"id": "DocumentEntry.uri",
"path": "DocumentEntry.uri",
"short": "URI of document",
"definition": "URI of document",
"min": 1,
"max": "1",
"base": {
"path": "DocumentEntry.uri",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/URIDataType"
}
]
}
]
},
"differential": {
"element": [
{
"id": "DocumentEntry",
"path": "DocumentEntry"
},
{
"id": "DocumentEntry.availabilityStatus",
"path": "DocumentEntry.availabilityStatus",
"mustSupport": true
},
{
"id": "DocumentEntry.classCode",
"path": "DocumentEntry.classCode",
"mustSupport": true
},
{
"id": "DocumentEntry.confidentialityCode",
"path": "DocumentEntry.confidentialityCode",
"mustSupport": true
},
{
"id": "DocumentEntry.formatCode",
"path": "DocumentEntry.formatCode",
"mustSupport": true
},
{
"id": "DocumentEntry.healthcareFacilityTypeCode",
"path": "DocumentEntry.healthcareFacilityTypeCode",
"mustSupport": true
},
{
"id": "DocumentEntry.languageCode",
"path": "DocumentEntry.languageCode",
"mustSupport": true
},
{
"id": "DocumentEntry.mimeType",
"path": "DocumentEntry.mimeType",
"mustSupport": true
},
{
"id": "DocumentEntry.objectType",
"path": "DocumentEntry.objectType",
"mustSupport": true
},
{
"id": "DocumentEntry.practiceSettingCode",
"path": "DocumentEntry.practiceSettingCode",
"mustSupport": true
},
{
"id": "DocumentEntry.serviceStartTime",
"path": "DocumentEntry.serviceStartTime",
"mustSupport": true
},
{
"id": "DocumentEntry.serviceEndTime",
"path": "DocumentEntry.serviceEndTime",
"mustSupport": true
},
{
"id": "DocumentEntry.sourcePatientId",
"path": "DocumentEntry.sourcePatientId",
"mustSupport": true
},
{
"id": "DocumentEntry.typeCode",
"path": "DocumentEntry.typeCode",
"mustSupport": true
}
]
}
}