The formal definitions for the elements in the xdsentry2 resource. Also available as an XML file.
| XdsEntry2 |
| Definition | An entry in an XDS registry |
| Control | 1..1 |
| XdsEntry2.id |
| Definition | Document identifier as assigned by the source of the document. This identifier is version specific. This unique identifier may be used in the body of other Documents etc to reference this document. |
| Control | 1..1 |
| Type | Identifier |
| Comments | The length of the id 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 - urn:oid:, for an HL7 CDA format a serialization of the CDA Document id extension and root in the form oid^extension - hl7-att:, 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 |
| XdsEntry2.information |
| Definition | Document metadata that is used for searching for the document |
| Control | 0..1 |
| Type | DocumentInformation |
| Comments | The document metadata reflects what is in the document itself and is never updated once the entry is created |
| XdsEntry2.information.id |
| Definition | Logical Identifier for the document, assigned when created. This identifier stays constant when subsequent versions of the document are created |
| Control | 0..1 |
| Type | Identifier |
| Must Understand | true |
| Comments | see discussion in resource definition for how these relate |
| RIM Mapping | Document.id / Document.setId |
| XdsEntry2.information.versionId |
| Definition | Version specific identifier for the document, assigned when created. This identifier changes when subsequent versions of the document are created |
| Control | 0..1 |
| Type | Identifier |
| Must Understand | true |
| Comments | see discussion in resource definition for how these relate |
| RIM Mapping | Document.id |
| XdsEntry2.information.instant |
| Definition | the document creation time, when the document first came into being. Where the document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created. |
| Control | 1..1 |
| Type | instant |
| Must Understand | true |
| Requirements | Creation time is used for tracking, organizing versions and searching. |
| RIM Mapping | ./effectiveTime[type="TS"] |
| XdsEntry2.information.class |
| Definition | The code specifying the particular kind of document (e.g., Prescription, Discharge Summary, Report). |
| Control | 0..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). Shall have a single value. This should be an extension |
| XdsEntry2.information.type |
| Definition | Specifies the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note) |
| Control | 1..1 |
| Type | CodeableConcept from DocumentType |
| Must Understand | true |
| Requirements | Key metadata element describing the document, used in searching/filtering. |
| RIM Mapping | ./code |
| XdsEntry2.information.title |
| Definition | Official human-readable label for the document |
| Control | 0..1 |
| Type | string |
| Requirements | Helps humans to assess whether the document is of interest |
| Comments | It's commonly the case that clinical documents do not have a title and are collectively referred to by the display name of Document.type (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 Document.title value should be used |
| RIM Mapping | ./title |
| XdsEntry2.information.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. |
| XdsEntry2.information.subject |
| Definition | Identifies the primary subject of the document. |
| Control | 1..1 |
| Type | Resource(Person|Patient|Group|Device) |
| Must Understand | true |
| Requirements | Essential metadata for searching for the document, identifies who the document applies to |
| Comments | For clinical documents, this is usually the patient. |
| RIM Mapping | unique(./participation[typeCode="SBJ" and isNormalParticipation]/role[typeCode="PAT"])
or
unique(./participation[typeCode="SBJ" and isNormalParticipation]/role[typeCode="IDENT"]/player[determinerCode="INST" and classCode=("DEV", "ORG") and isNormalEntity()]) |
| To Do | Need to extend this to support documents with other types of subjects. Also rationalize with encounter & context elements |
| XdsEntry2.information.author |
| Definition | Identifies who is responsible for the information in the document. (Not necessarily who typed it in.) |
| Control | 1..* |
| Type | Resource(Person|Agent) |
| Requirements | Identifies who is responsible for the content. |
| RIM Mapping | ./participation[typeCode="AUT" and isNormalParticipation]/role[classCode="ASSIGNED" and isNormalRole()] |
| XdsEntry2.information.attester |
| Definition | A participant who has attested to the accuracy of the document |
| Control | 0..* |
| Requirements | Identifies responsibility for the accuracy of the document content. |
| RIM Mapping | ./participation[typeCode="AUTHEN" and isNormalParticipation] |
| XdsEntry2.information.attester.mode |
| Definition | The type of attestation the authenticator offers |
| Control | 1..1 |
| Type | code from DocumentAttestationMode |
| Requirements | Indicates the level of officialness of the attestation. |
| RIM Mapping | unique(./modeCode) |
| XdsEntry2.information.attester.time |
| Definition | When document was attested by the party |
| Control | 0..1 |
| Type | dateTime |
| Requirements | Identifies when the information in the document was deemed accurate. (Things may have changed since then.) |
| RIM Mapping | ./time[type="TS" and isNormalDatatype()] |
| XdsEntry2.information.attester.party |
| Definition | Who attested the document in the specified way |
| Control | 0..1 |
| Type | Resource(Person|Agent|Organization) |
| Requirements | Identifies who has taken on the responsibility for accuracy of the document content. |
| RIM Mapping | ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()]
or
./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()] |
| XdsEntry2.information.custodian |
| Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. |
| Control | 0..1 |
| Type | Resource(Organization) |
| Requirements | Identifies where to go to find the current version, where to report issues, etc. |
| RIM Mapping | ./participation[typeCode="RCV" and isNormalParticipation]/role[classCode="CUST" and isNormalRole and not (player)]/scoper[classCode="ORG" and determinerCode="INST" and isNormalEntity()] |
| XdsEntry2.information.event |
| Definition | The main event/act/item, such as a colonoscopy or an appendectomy, being documented |
| Control | 0..1 |
| Requirements | Provides context for the document and creates a linkage between a resource describing an event and the document created describing the event. |
| Comments | The event needs to be consistent with the type element, though can provide further information if desired |
| RIM Mapping | unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and isNormalAct]) |
| XdsEntry2.information.event.code |
| 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 | CodeableConcept |
| 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. |
| XdsEntry2.information.event.period |
| Definition | The period of time covered by the document. There is no assertion that the document is a complete representation for this period, only that it documents events during this time |
| Control | 0..1 |
| Type | Period |
| XdsEntry2.information.event.detail |
| Definition | Full details for the event(s) the document concents |
| Control | 0..* |
| Type | Resource(Any) |
| XdsEntry2.information.encounter |
| Definition | Describes the clinical encounter or type of care this document is associated with. |
| Control | 0..1 |
| Type | Resource(Admission|InterestOfCare) |
| Requirements | Provides context for the document and supports searching. |
| RIM Mapping | unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct]) |
| XdsEntry2.information.facilityType |
| Definition | This code represents the type of organizational setting of the clinical encounter during which the documented act occurred |
| Control | 0..1 |
| Type | CodeableConcept |
| 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 |
| XdsEntry2.information.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 | 0..1 |
| Type | CodeableConcept |
| 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) |
| XdsEntry2.format |
| Definition | Code globally uniquely specifying the format of the document. Along with the information.type, it should provide sufficient information to allow any potential 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. |
| XdsEntry2.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). |
| XdsEntry2.folder |
| Definition | Folders that this document is registered in |
| Control | 0..* |
| Type | Resource(XdsFolder) |
| XdsEntry2.subject |
| Definition | The subject of care information that the document is about. This is different from the documentInformation.subject because that never changes from what the document says. This value may be updated if the subject details are updated (e.g. merged) and will then differ from the original document |
| Control | 0..1 |
| Type | Resource(Person|Patient|Group|Device) |
| Comments | The system is the "Authority Domain Id" (enforced by the Registry), and the identifier is an Id in the above domain. This subject is intended to be updated after the Document is registered (where as the Document content and Document.information.subject itself will not be
updated without changing the whole document). |
| XdsEntry2.content |
| Definition | Reference to the content, along with additional information such as size, hash, language etc |
| Control | 0..1 |
| Type | Attachment |
| XdsEntry2.extension |
| Definition | See Extensions |
| Control | 0..* |
| Type | Extension |
| RIM Mapping | [varies] |
| XdsEntry2.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