4 Metadata used in Document Sharing profiles
This section describes the metadata that is used in IHE profiles designed for sharing documents (Document Sharing profiles). The Document Sharing profiles are implementing the Document Sharing concept outlined in the ITI whitepaper entitled Health Information Exchange: Enabling Document Sharing Using IHE Profiles available on the IHE website (https://profiles.ihe.net/ITI/). This section assumes understanding of the concepts presented in the white paper.
ITI Document Sharing profiles which use this metadata include:
- Cross-Enterprise Document Sharing (XDS.b)
- Cross-Enterprise Document Reliable Interchange (XDR)
- Cross-Enterprise Document Media Interchange (XDM)
- Multi-Patient Queries (MPQ)
- Cross-Community Access (XCA)
It is likely that future ITI profiles will also use Document Sharing metadata. Profiles from IHE domains other than ITI that use or constrain this metadata are not listed here. Those profiles will document their use of this metadata.
Document Sharing profiles manage two aspects of the documents being shared, the metadata about the document and the contents of the document.
Metadata encodes the properties of Documents, the environments they come from, circumstances of their submission, terms to reference in queries, and grouping with other Documents. If you think of a document as a book in a library, the index card in the library’s card catalog is the document metadata.
A Document is a byte sequence managed by actors in one or more IHE Document Sharing profiles. There is no concept of equivalent Documents. If the byte sequence is different, then the Documents are different.
Note that this definition of a Document is stricter than document definitions in DICOM®, HL7, HL7 CDA®, XML, and elsewhere. Those standards have concepts like "insignificant whitespace". Documents with different byte sequences, that those standards consider equivalent, will be treated as different Documents by IHE Document Sharing.
This stricter definition of a Document enables the Document Sharing actors to manage any document format, without the need to include a parser that understands the details of all the different document formats. It also enables most document indexing, registration, etc. to be done using metadata alone, without examining the document contents.
Section 4 first explains the metadata at a conceptual level (Section 4.1), then at an implementation level (Section 4.2) and then provides some profile- and transaction-specific metadata constraints and considerations (Section 4.3).
Content Profiles may impose restrictions on metadata attributes. See Section 5 for the restrictions imposed by ITI Content Profiles.
-
4.2 ebRIM Representation
- 4.2.1 Metadata Object Types
- 4.2.2 Association Types
-
4.2.3 Metadata Attributes
-
4.2.3.1 General Information about Metadata Attributes
- 4.2.3.1.1 Attribute Value Length
- 4.2.3.1.2 Creating Coded Attributes
- 4.2.3.1.3 Creating External Identifiers
- 4.2.3.1.4 Creating Author Attributes
- 4.2.3.1.5 UUIDs
- 4.2.3.1.6 Extra Metadata Attributes
- 4.2.3.1.7 Metadata Attribute Data types
- 4.2.3.1.8 General format of DocumentEntry, Folder and SubmissionSet attribute tables
- 4.2.3.1.9 Metadata Attribute Cardinality
- 4.2.3.1.10 classificationScheme vs. classificationNode
-
4.2.3.2 DocumentEntry Attributes
- 4.2.3.2.1 DocumentEntry.author
- 4.2.3.2.2 DocumentEntry.availabilityStatus
- 4.2.3.2.3 DocumentEntry.classCode
- 4.2.3.2.4 DocumentEntry.comments
- 4.2.3.2.5 DocumentEntry.confidentialityCode
- 4.2.3.2.6 DocumentEntry.creationTime
- 4.2.3.2.7 DocumentEntry.entryUUID
- 4.2.3.2.8 DocumentEntry.eventCodeList
- 4.2.3.2.9 DocumentEntry.formatCode
- 4.2.3.2.10 DocumentEntry.hash
- 4.2.3.2.11 DocumentEntry.healthcareFacilityTypeCode
- 4.2.3.2.12 DocumentEntry.homeCommunityId
- 4.2.3.2.13 DocumentEntry.languageCode
- 4.2.3.2.14 DocumentEntry.legalAuthenticator
- 4.2.3.2.15 DocumentEntry.mimeType
- 4.2.3.2.16 DocumentEntry.patientId
- 4.2.3.2.17 DocumentEntry.practiceSettingCode
- 4.2.3.2.18 DocumentEntry.repositoryUniqueId
- 4.2.3.2.19 DocumentEntry.serviceStartTime
- 4.2.3.2.20 DocumentEntry.serviceStopTime
- 4.2.3.2.21 DocumentEntry.size
- 4.2.3.2.22 DocumentEntry.sourcePatientId
- 4.2.3.2.23 DocumentEntry.sourcePatientInfo
- 4.2.3.2.24 DocumentEntry.title
- 4.2.3.2.25 DocumentEntry.typeCode
- 4.2.3.2.26 DocumentEntry.uniqueId
- 4.2.3.2.27 DocumentEntry.URI
- 4.2.3.2.28 DocumentEntry.referenceIdList
- 4.2.3.2.29 DocumentEntry.limitedMetadata
- 4.2.3.2.30 DocumentEntry.objectType
-
4.2.3.3 SubmissionSet Attributes
- 4.2.3.3.1 SubmissionSet.author
- 4.2.3.3.2 SubmissionSet.availabilityStatus
- 4.2.3.3.3 SubmissionSet.comments
- 4.2.3.3.4 SubmissionSet.contentTypeCode
- 4.2.3.3.5 SubmissionSet.entryUUID
- 4.2.3.3.6 SubmissionSet.homeCommunityId
- 4.2.3.3.7 SubmissionSet.intendedRecipient
- 4.2.3.3.8 SubmissionSet.patientId
- 4.2.3.3.9 SubmissionSet.sourceId
- 4.2.3.3.10 SubmissionSet.submissionTime
- 4.2.3.3.11 SubmissionSet.title
- 4.2.3.3.12 SubmissionSet.uniqueId
- 4.2.3.3.13 SubmissionSet.limitedMetadata
- 4.2.3.4 Folder Attributes
-
4.2.3.1 General Information about Metadata Attributes
- 4.2.4 Success and Error Reporting
- 4.2.5 Metadata Vocabulary
5 IHE Content Specifications
This section follows the documentation pattern found in the IHE PCC Technical Framework. The reader should be familiar with the IHE PCC Technical Framework.
-
5.1 Basic Patient Privacy Consents Module
- 5.1.1 References
-
5.1.2 Patient Privacy Consent Acknowledgment Document Specification
1.3.6.1.4.1.19376.1.5.3.1.1.7 – With no Scanned Document Part
- 5.1.2.1 XDS Metadata
-
5.1.2.2 Specification
- 5.1.2.2.1 Patient Privacy Acknowledgement Service Events 1.3.6.1.4.1.19376.1.5.3.1.2.6
- 5.1.2.2.2 <documentationOf typeCode='DOC'>
- 5.1.2.2.3 <serviceEvent classCode='ACT' moodCode='EVN'>
- 5.1.2.2.4 <templateId root='1.3.6.1.4.1.19376.1.5.3.1.2.6'/>
- 5.1.2.2.5 <id root=' ' />
- 5.1.2.2.6 <code code=' ' displayName=' ' codeSystem=' ' codeSystemName=' '/>
- 5.1.2.2.7 <effectiveTime><low value=' '/><high value=' '/></effectiveTime>
- 5.1.3 Patient Privacy Consent Acknowledgment Document Specification 1.3.6.1.4.1.19376.1.5.3.1.1.7.1 – With Scanned Document
-
5.2 Scanned Documents Content Module
- 5.2.1 Referenced Standards
- 5.2.2 XDS Metadata
- 5.2.3 Specification
-
5.2.3.1 ClinicalDocument child-less elements
- 5.2.3.2 ClinicalDocument/recordTarget
- 5.2.3.3 ClinicalDocument/author (original)
- 5.2.3.4 ClinicalDocument/author (scanner)
- 5.2.3.5 ClinicalDocument/dataEnterer
- 5.2.3.6 ClinicalDocument/custodian
- 5.2.3.7 ClinicalDocument/legalAuthenticator
- 5.2.3.8 ClinicalDocument/documentationOf
- 5.2.3.9 ClinicalDocument/component/nonXMLBody
- 5.2.4 Complete Example (Wrapped PDF)
-
5.4 XDW Workflow Content Module
- 5.4.1 Referenced Standards
- 5.4.2 Discussion of Content Standards
- 5.4.3 Content Specification
- 5.4.4Complete Example
-
5.4.5 Workflow Document Management
- 5.4.5.1 Workflow Document Lifecycle Management
- 5.4.5.2 Associations Types
- 5.4.5.3 Create workflow
- 5.4.5.4 Update Workflow Document
- 5.4.5.5 Association of a clinical document to a task and <taskEvent>
- 5.4.5.6 Get the Workflow Document and a clinical document associated to the workflow
- 5.4.5.7 Use of the eventCodeList to manage the status of a Workflow Document
- 5.4.5.8 Parameters for Required Queries
- 5.4.6 XDS Metadata
-
5.5 Document Digital Signature (DSG) Document Content
- 5.5.1 References
- 5.5.2 Signature Specification
- 5.5.3 Detached Signature
- 5.5.4 Enveloping Signature
- 5.5.5 Signature Verification
- 5.5.6 Document Sharing Metadata
- 5.5.7 Security Considerations
6 IHE Namespaces, Concept Domains, and Vocabularies
This section references the namespaces, concept domains, and identifiers defined or referenced by the IHE ITI Technical Framework, and the vocabularies defined or referenced herein.