The formal definitions for the elements in the xdsentry resource. Also available as an XML file.
| XdsEntry |
| Definition | An entry in an XDS registry |
| Control | 1..1 |
| XdsEntry.url |
| Definition | A URL that is used to access the document content directly. If this is not provided, the document may be found be searching the repositoryId for the documentId |
| Control | 0..1 |
| Type | uri |
| XdsEntry.repositoryId |
| Definition | The globally unique identifier of the repository where the document is stored, assigned by the Document Repository. This unique identifier for the Document Repository may be used to identify and connect to the specific Document Repository where the document is stored once its metadata has been retrieved from a Document Registry |
| Control | 0..1 |
| Type | uri |
| Comments | This repositoryUniqueId is intended to respond to the following types of usage: The means to reference the Document Repository where this XDS document is stored. The repositoryUniqueId represents an immutable id for the Document Repository. The means to ensure that a XDS Document is retrieved from the appropriate Document Repository. |
| XdsEntry.mimeType |
| Definition | MIME type of the document in the Repository. |
| Control | 1..1 |
| Type | string |
| XdsEntry.format |
| Definition | Code globally uniquely specifying the format of the document. Along with the typeCode, it should provide sufficient information to allow any potential XDS Document Consumer to know if it will be able to process the document. The formatCode shall be sufficiently specific to ensure processing/display by identifying a document encoding, structure and template (e.g., for a CDA Document, the fact that it complies with a CDA schema, possibly a template and the choice of a content-specific style sheet). |
| Control | 1..1 |
| Type | Coding |
| Comments | Format codes may be specified by multiple organizations. Format codes defined by ITI shall have names with the prefix urn:ihe:iti:. Format codes defined by other IHE domains shall have names with the prefix urn:ihe:’domain initials’: Format codes defined by the Affinity Domain shall have names with the prefix urn:ad:’name of affinity domain’: Affinity Domains shall be unique. The prefixes described here are not assumed to be exhaustive. |
| XdsEntry.class |
| Definition | The code specifying the particular kind of document (e.g., Prescription, Discharge Summary, Report). It is suggested that the XDS Affinity Domain draws these values from a coding scheme providing a coarse level of granularity (about 10 to 100 entries). Shall have a single value. |
| Control | 1..1 |
| Type | Coding |
| XdsEntry.type |
| Definition | The code specifying the precise kind of document (e.g., Pulmonary History and Physical, Discharge Summary, Ultrasound Report). |
| Control | 1..1 |
| Type | Coding |
| Comments | It is suggested that the XDS Affinity Domain draw these values from a coding scheme providing a fine level of granularity. |
| XdsEntry.title |
| Definition | Represents the title of the document. |
| Control | 0..1 |
| Type | string |
| Comments | Clinical documents often do not have a title, and are collectively referred to by the display name of the classCode (e.g., a "consultation" or "progress note"). Where these display names are rendered to the clinician, or where the document has a unique title, the title component shall be used. Max length, 128 chars |
| XdsEntry.documentId |
| Definition | The globally unique identifier assigned by the document creator to this document. This unique identifier may be used in the body of other XDS Documents to reference this document. |
| Control | 1..1 |
| Type | uri |
| Comments | The length of Unique Identifier shall not exceed 128 bytes. The structure and format of this Id shall be consistent with the specification corresponding to the format attribute. (e.g., for a DICOM standard document a 64 character numeric UID, for an HL7 CDA format a serialization of the CDA Document id extension and root in the form oid#extension, where OID is a 64 digits max, and the ID is a 16 UTF-8 char max). If the oid is coded without the extension then the '^' character shall not be included. This uniqueId is intended to provide the means to reference this XDS document from within the content of another document. Neither the XDS Registry nor the Repository is aware of such references, but the Document Sources and Consumers are |
| XdsEntry.availability |
| Definition | deprecated documents can be included in some responses |
| Control | 1..1 |
| Type | code from XdsEntryAvailability |
| Comments | This attribute is always set to Approved as part of the submission of new XDS Documents. It may be changed to Deprecated under the primary responsibility of the Document Source with possible patient supervision. Although XDS supports the ability to delete documents, there is no such state as “the Document Entry is removed” (only an audit trail is kept if such a deletion is allowed). |
| XdsEntry.confidentialityCode |
| Definition | The code specifying the level of confidentiality of the XDS Document. These codes are specific to an XDS Affinity Domain. |
| Control | 1..1 |
| Type | Coding |
| Comments | Enforcement and issues related to highly sensitive documents are beyond the scope of XDS (see security section). confidentialityCode is part of a codification scheme and value set enforced by the Document Registry. |
| XdsEntry.created |
| Definition | Represents the time the author created the document in the Document Source |
| Control | 1..1 |
| Type | instant |
| XdsEntry.event |
| Definition | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. |
| Control | 0..* |
| Type | Coding |
| Comments | An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they shall not conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as “key words” for certain types of queries. |
| XdsEntry.hash |
| Definition | Hash key of the XDS Document itself |
| Control | 0..1 |
| Type | string |
| Comments | This value is computed by the Document Repository and used by the Document Registry for detecting the improper resubmission of XDS Documents. If present, shall have a single value. If this attribute is received in a Provide & Register Document Set-b [ITI-41] transaction, it shall be verified by the repository with the actual hash value of the submitted document; an XDSRepositoryMetadataError shall be returned on mismatch. |
| XdsEntry.size |
| Definition | Size in bytes of the byte stream that was provided in the Register and Provide Transaction and stored by the XDS Document Repository. This value is computed by the Document Repository and included in the Register Documents Set Transaction. |
| Control | 0..1 |
| Type | string |
| Comments | If this attribute is received in a Provide & Register Document Set-b [ITI-41] transaction, it shall be verified by the repository with the actual size of the submitted document; an XDSRepositoryMetadataError shall be returned on mismatch. |
| XdsEntry.language |
| Definition | Specifies the human language of character data in the document. The values of the attribute are language identifiers as described by the IETF (Internet Engineering Task Force) RFC 3066. |
| Control | 0..1 |
| Type | string |
| Comments | This value may further be restricted by the registry according to XDS Affinity Domain specific policy. |
| XdsEntry.folder |
| Definition | Folders that this document is registered in |
| Control | 0..* |
| Type | Resource(XdsFolder) |
| XdsEntry.patientId |
| Definition | The patientId represents the subject of care of the document. This identifier shall be from the Assigning Authority Domain supporting the XDS Affinity Domain in which the Document Registry operates. |
| Control | 1..1 |
| Type | Identifier |
| Comments | The system is the "Authority Domain Id" (enforced by the Registry), and the identifier is an Id in the above domain. |
| XdsEntry.sourcePatientId |
| Definition | The sourcePatientId represents the subject of care medical record Identifier (e.g., Patient Id) in the local patient Identifier Domain of the Document Source. |
| Control | 0..1 |
| Type | Identifier |
| Comments | The system is the "Authority Domain Id" (enforced by the Registry), and the identifier is an Id in the above domain. This sourcePatientId is not intended to be updated once the Document is registered (just as the Document content and metadata itself will not be
updated without replacing the previous document). As this sourcePatientId may have been merged by the source actor, it may no longer be in use within the Document Source (EHR-CR). It is only intended as an audit/checking mechanism and has occasional use for
Document Consumer Actors. |
| XdsEntry.patientInfo |
| Definition | This is a reference to the demographics information of the person to whose medical record this document belongs, as the Document Source knew it at the time of Submission. This information typically includes: the patient first and last name, sex,
and birth date |
| Control | 0..1 |
| Type | Resource(Person) |
| Comments | The Clinical XDS Affinity Domain policies may require more or less specific information and format. This patient information is not intended to be updated once the Document is registered (just as the Document content and metadata itself will not be updated without replacing the previous document). As sourcePatientInfo may have been updated by the source actor, it may no longer be in use within the Document Source (EHR-CR). It is only intended as an audit/checking mechanism and has occasional use for
Document Consumer actors. |
| XdsEntry.author |
| Definition | Represents the humans and/or machines that authored the document |
| Control | 1..* |
| XdsEntry.author.name |
| Definition | Represents the name of the human and/or machine that authored the document within the authorInstitution |
| Control | 0..1 |
| Type | HumanName |
| Comments | The document author may be the patient itself |
| XdsEntry.author.id |
| Definition | Represents the id of the human and/or machine that authored the document within the authorInstitution |
| Control | 0..1 |
| Type | Identifier |
| XdsEntry.author.role |
| Definition | A code that represents the role of the author with respect to the patient when the document was created. |
| Control | 0..* |
| Type | string |
| XdsEntry.author.specialty |
| Definition | Represents a specific specialty within a healthcare facility under which the human and/or machines authored the document |
| Control | 0..* |
| Type | string |
| XdsEntry.author.institution |
| Definition | Represents a specific healthcare facility under which the human and/or machines authored the document. A specific case is that of homecare. |
| Control | 0..* |
| XdsEntry.author.institution.id |
| Definition | id of facility |
| Control | 0..1 |
| Type | Identifier |
| XdsEntry.author.institution.name |
| Definition | name of facility |
| Control | 0..1 |
| Type | string |
| XdsEntry.author.contact |
| Definition | Represents the telecommunications address (e.g. email) of the document author, intended to assist with automated routing of other messages intended for the document author |
| Control | 0..* |
| Type | Contact |
| XdsEntry.authenticator |
| Definition | Represents a participant who has legally authenticated or attested the document within the authorInstitution. Legal authentication implies that a document has been signed manually or electronically by the legalAuthenticator. |
| Control | 0..1 |
| XdsEntry.authenticator.id |
| Definition | id of authenticator |
| Control | 0..1 |
| Type | Identifier |
| XdsEntry.authenticator.name |
| Definition | name of authenticator |
| Control | 0..1 |
| Type | HumanName |
| XdsEntry.facilityType |
| Definition | This code represents the type of organizational setting of the clinical encounter during which the documented act occurred |
| Control | 0..1 |
| Type | Coding |
| Comments | In some cases, the setting of the encounter is inherent in the typeCode, such as "Diabetes Clinic Progress Note". healthcareFacilityTypeCode shall be equivalent to or further specialize the value inherent in the typeCode; for example, where the typeCode is simply "Clinic Progress Note" and the value of healthcareFacilityTypeCode is "private clinic". The value shall not conflict with the value inherent in the typeCode, as such a conflict would create an ambiguous situation |
| XdsEntry.practiceSetting |
| Definition | The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology). |
| Control | 1..1 |
| Type | Coding |
| Comments | It is suggested that the XDS Affinity Domain draws these values from a coding scheme providing a coarse level of granularity (about 10 to 100 entries) |
| XdsEntry.homeCommunity |
| Definition | A globally unique identifier for a community. |
| Control | 0..1 |
| Type | uri |
| XdsEntry.service |
| Definition | Represents the time of the service being documented took place (clinically significant, but not necessarily when the document was produced or approved). |
| Control | 1..1 |
| Comments | This may be the same as the encounter time in case the service was delivered during an encounter. Encounter time is not coded in XDS metadata but may be coded in documents managed by XDS. Note: Other times, such as document creation or approval are to be recorded, if needed, within the document. |
| XdsEntry.service.start |
| Definition | Start time |
| Control | 1..1 |
| Type | dateTime |
| XdsEntry.service.stop |
| Definition | Stop time |
| Control | 0..1 |
| Type | dateTime |
| XdsEntry.comments |
| Definition | Comments associated with the Document. |
| Control | 0..1 |
| Type | string |
| Comments | Free form text with an XDS Affinity Domain specified usage. |
| To Do | Should this be removed? It is effectively for extensions |
| XdsEntry.extension |
| Definition | See Extensions |
| Control | 0..* |
| Type | Extension |
| RIM Mapping | [varies] |
| XdsEntry.text |
| Definition | Text summary of resource (for human interpretation) |
| Control | 1..1 |
| Type | Narrative |
This is an old version of FHIR retained for archive purposes. Do not use for anything else