| Package | ihe-de.iti.xds-vs |
| Resource Type | StructureDefinition |
| Id | DocumentEntry |
| FHIR Version | R4 |
| Source | http://www.ihe-d.de/fhir/https://build.fhir.org/ig/IHE-Germany/ITI.XDS.VS/StructureDefinition-DocumentEntry.html |
| URL | http://www.ihe-d.de/fhir/StructureDefinition/DocumentEntry |
| Version | 4.0.0-alpha1 |
| Status | draft |
| Date | 2025-08-02 |
| Name | DocumentEntry |
| Title | Document Entry (LM) |
| Realm | de |
| Authority | ihe |
| Description | 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.) |
| Copyright | IHE Deutschland e.V. |
| Type | http://www.ihe-d.de/fhir/StructureDefinition/DocumentEntry |
| Kind | logical |
| StructureDefinition | |
| DocumentEntryProfile | Document Entry (Profile) |
| StructureDefinition | |
| Author | Author (LM) |
| CXDataType | CXDataType (LM) |
| CXiDataType | CXiDataType (LM) |
| CodeDataType | CodeDataType (LM) |
| DTMDataType | DTMDataType (LM) |
| FieldDataType | FieldDataType (LM) |
| IdentifierDataType | IdentifierDataType (LM) |
| LimitedMetadataDataType | LimitedMetadataDataType (LM) |
| OIDDataType | OIDDataType (LM) |
| OIDURNDataType | OIDURNDataType (LM) |
| URIDataType | URIDataType (LM) |
| UUIDDataType | UUIDDataType (LM) |
| XCNDataType | XCNDataType (LM) |
| ValueSet | |
| IHEXDSclassCode | IHE XDS Class Code |
| IHEXDSconfidentialityCode | IHE XDS Confidentiality Code |
| IHEXDSeventCodeList | IHE XDS Event Code List |
| IHEXDSformatCodeDE | IHE XDS Format Code |
| IHEXDShealthcareFacilityTypeCode | IHE XDS Healthcare Facility Type Code |
| IHEXDSlanguageCode | IHE XDS Language Code |
| IHEXDSpracticeSettingCode | IHE XDS Practice Setting Code |
| IHEXDStypeCode | IHE XDS Type Code |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition DocumentEntry
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  DocumentEntry | 0..* | Base | 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 | 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 | 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) | |
| comments | 0..1 | string | Comments associated with the document. | |
| confidentialityCode | 1..1 | CodeDataType | The code specifying the level of confidentiality of the document. Binding: IHE XDS Confidentiality Code (required) | |
| 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 | 1..1 | CodeDataType | The code specifying the detailed technical format of the document. Binding: IHE XDS Format Code (required) | |
| hash | 0..1 | string | The hash of the contents of the document. | |
| healthcareFacilityTypeCode | 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) | |
| homeCommunityId | 0..1 | OIDURNDataType | A globally unique identifier for a community. | |
| languageCode | 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 | 1..1 | string | MIME type of the document with possible code from BCP-13 (http://tools.ietf.org/html/bcp13). | |
| objectType | 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 | 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) | |
| 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 | 1..1 | DTMDataType | The start time of the service being documented. | |
| serviceEndTime | 1..1 | DTMDataType | The stop time of the service being documented. | |
| size | 0..1 | integer | Size in bytes of the document. | |
| sourcePatientId | 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 | 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) | |
| uniqueId | 1..1 | IdentifierDataType | Globally unique identifier assigned to the document by its creator. | |
 uri | 1..1 | URIDataType | URI of document | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "DocumentEntry",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}
],
"url": "http://www.ihe-d.de/fhir/StructureDefinition/DocumentEntry",
"version": "4.0.0-alpha1",
"name": "DocumentEntry",
"title": "Document Entry (LM)",
"status": "draft",
"experimental": false,
"date": "2025-08-02",
"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": "This Logical Model describes the relevant attributes on the **Document Entry** class within IHE ITI XDS.\nMore details are to be retrieved from IHE ITI on www.ihe.net.\n(Focus for this LM is on the coded attributes.)",
"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://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"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"
}
]
},
{
"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"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDSclassCode"
}
},
{
"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"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDSconfidentialityCode"
}
},
{
"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"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDSformatCodeDE"
}
},
{
"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"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode"
}
},
{
"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"
}
],
"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"
}
]
},
{
"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"
}
]
},
{
"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"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode"
}
},
{
"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"
}
]
},
{
"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"
}
]
},
{
"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"
}
]
},
{
"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"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDStypeCode"
}
},
{
"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",
"short": "Document Entry (LM)",
"definition": "Document Entry"
},
{
"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",
"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",
"type": [
{
"code": "string"
}
]
},
{
"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",
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDSclassCode"
}
},
{
"id": "DocumentEntry.comments",
"path": "DocumentEntry.comments",
"short": "Comments associated with the document.",
"definition": "Comments associated with the document.",
"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",
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDSconfidentialityCode"
}
},
{
"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",
"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",
"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": "*",
"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",
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDSformatCodeDE"
}
},
{
"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",
"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",
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDShealthcareFacilityTypeCode"
}
},
{
"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",
"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": "*",
"type": [
{
"code": "string"
}
],
"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",
"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",
"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",
"type": [
{
"code": "string"
}
]
},
{
"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",
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/UUIDDataType"
}
]
},
{
"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",
"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",
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDSpracticeSettingCode"
}
},
{
"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": "*",
"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",
"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",
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/DTMDataType"
}
]
},
{
"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",
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/DTMDataType"
}
]
},
{
"id": "DocumentEntry.size",
"path": "DocumentEntry.size",
"short": "Size in bytes of the document.",
"definition": "Size in bytes of the document.",
"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",
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CXDataType"
}
]
},
{
"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",
"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",
"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",
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/CodeDataType"
}
],
"binding": {
"strength": "required",
"valueSet": "http://ihe-d.de/ValueSets/IHEXDStypeCode"
}
},
{
"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",
"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",
"type": [
{
"code": "http://www.ihe-d.de/fhir/StructureDefinition/URIDataType"
}
]
}
]
}
}