4.3 Additional Document Sharing Requirements
This section includes profile specific requirements.
4.3.1 Submission Metadata Attribute Optionality
This section lists which metadata attributes an actor shall provide when initiating a Submission Type Transaction.
The Actor/Transaction pairs addressed by this section are as follows:
Table 4.3.1-1: Sending Actor/Transaction Pairs
| Actor | Transaction | Shortname |
| XDS Document Source | Provide and Register Document Set-b [ITI-41] | XDS DS |
| XDS Document Repository | Register Document Set-b [ITI-42] | XDS DR |
| XDM Portable Media Creator | Distribute Document Set on Media [ITI-32] | XDM MC |
| XDR Document Source | Provide and Register Document Set-b [ITI-41] | XDR DS |
| XDR Metadata-Limited Document Source | Provide and Register Document Set-b [ITI-41] | XDR MS |
| XDS On-Demand Document Source | Register On-Demand Document Entry [ITI-61] | XDS OD |
For each actor/transaction pair across the top of Table 4.3.1-3, and each metadata attribute row, the cell indicates the requirement for that actor when creating a submission request using the paired transaction. The requirements are expressed through these codes:
Table 4.3.1-2: Sending Actor Metadata Attribute Optionality Code Definitions
| Code | Meaning |
| R | Required – A value for the attribute shall be supplied by the sending actor when sending the submission |
| R2 | Required if Known – A value for the attribute shall be supplied by the sending actor when sending the submission unless the actor does not have any value for the attribute |
| O | Optional – The sending actor may or may not supply a value for this attribute |
| X | Prohibited – when sending a submission, a value for the attribute shall not be supplied by the sending actor. |
Table 4.3.1-3: Sending Actor Metadata Attribute Optionality
| Metadata Element | Metadata Attribute | XDS DS | XDS DR | XDM MC | XDR DS | XDR MS | XDS OD |
| DocumentEntry | author | R2 | R2 | R2 | R2 | R2 | R2 |
| DocumentEntry | availabilityStatus | O | O | O | O | O | O |
| DocumentEntry | classCode | R | R | R2 | R | R2 | R |
| DocumentEntry | comments | O | O | O | O | O | O |
| DocumentEntry | confidentialityCode | R | R | R2 | R | R2 | R |
| DocumentEntry | creationTime | R | R | R2 | R | R2 | X |
| DocumentEntry | entryUUID | R | R | R | R | R | R |
| DocumentEntry | eventCodeList | O | O | O | O | O | O |
| DocumentEntry | formatCode | R | R | R2 | R | R2 | R |
| DocumentEntry | hash | O | R | R | O | O | X |
| DocumentEntry |
healthcareFacility
|
R | R | R2 | R | R2 | R |
| DocumentEntry | homeCommunityId | O | O | O | O | O | O |
| DocumentEntry | languageCode | R | R | R2 | R | R2 | R |
| DocumentEntry | legalAuthenticator | O | O | O | O | O | O |
| DocumentEntry | limitedMetadata | X | X | O | X | R | X |
| DocumentEntry | mimeType | R | R | R | R | R | R |
| DocumentEntry | objectType | R | R | R | R | R | R |
| DocumentEntry | patientId | R | R | R2 | R | R2 | R |
| DocumentEntry | practiceSettingCode | R | R | R2 | R | R2 | R |
| DocumentEntry | referenceIdList | O | O | O | O | O | O |
| DocumentEntry | repositoryUniqueId | O | R | O | O | O | R |
| DocumentEntry | serviceStartTime | R2 | R2 | R2 | R2 | R2 | O |
| DocumentEntry | serviceStopTime | R2 | R2 | R2 | R2 | R2 | O |
| DocumentEntry | size | O | R | R | O | O | X |
| DocumentEntry | sourcePatientId | R | R | R2 | R | R2 | R |
| DocumentEntry | sourcePatientInfo | O | O | R2 | O | R2 | O |
| DocumentEntry | title | O | O | O | O | O | O |
| DocumentEntry | typeCode | R | R | R2 | R | R2 | R |
| DocumentEntry | uniqueId | R | R | R | R | R | R |
| DocumentEntry | URI | O | O | R | O | O | O |
| SubmissionSet | author | R2 | R2 | R2 | R2 | R2 | R2 |
| SubmissionSet | availabilityStatus | O | O | O | O | O | O |
| SubmissionSet | comments | O | O | O | O | O | O |
| SubmissionSet | contentTypeCode | R | R | R2 | R | R2 | R |
| SubmissionSet | entryUUID | R | R | R | R | R | R |
| SubmissionSet | homeCommunityId | O | O | O | O | O | O |
| SubmissionSet | intendedRecipient | O | O | R2 | R2 | R2 | O |
| SubmissionSet | limitedMetadata | X | X | O | X | R | X |
| SubmissionSet | patientId | R | R | R2 | R | R2 | R |
| SubmissionSet | sourceId | R | R | R | R | R | R |
| SubmissionSet | submissionTime | R | R | R | R | R | R |
| SubmissionSet | title | O | O | O | O | O | O |
| SubmissionSet | uniqueId | R | R | R | R | R | R |
| Folder | availabilityStatus | O | O | O | O | O | O |
| Folder | codeList | R | R | R2 | R | R2 | R |
| Folder | comments | O | O | O | O | O | O |
| Folder | entryUUID | R | R | R | R | R | R |
| Folder | homeCommunityId | O | O | O | O | O | O |
| Folder | lastUpdateTime | O | O | O | O | O | O |
| Folder | limitedMetadata | X | X | O | X | R | X |
| Folder | patientId | R | R | R2 | R | R2 | R |
| Folder | title | R | R | O | R | O | R |
| Folder | uniqueId | R | R | R | R | R | R |
4.3.2 Requirements on Query Type Transactions
4.3.2.1 Query Type Metadata Attribute Optionality
This section lists which attributes shall contain content in a response to a query transaction. The query transactions covered in Table 4.3.2.1-1. The content of the query request can be found within the referenced transaction.
Table 4.2.3.2.1-1 Responding Actor/Transaction Pairs
| Actor | Transaction | Shortname |
| XDS Document Registry | Registry Stored Query [ITI-18] | XDS DR |
| XCA Initiating Gateway | Registry Stored Query [ITI-18] | XCA IG |
| XCA Responding Gateway | Cross-Gateway Query [ITI-38] | XCA RG |
| MPQ Document Registry | Multi-Patient Stored Query [ITI-51] | MPQ DR |
For each actor/transaction pair across the top of the table, and each metadata attribute row, the cells indicates the requirement for that actor when creating a query response to the paired transaction. The requirements are expressed through these codes:
Table 4.3.2.1-2: Responding Actor Metadata Attribute Optionality Code Definitions
| Code | Meaning |
| R | Required – A value for the attribute shall be supplied by the responding actor when responding to a query |
| R2 | Required if Known – A value for the attribute shall be supplied by the responding actor when responding to the query if a value is available to the actor. For the Document Registry it must supply the value specified in the submission request. |
| O | Optional – The responding actor may or may not supply a value for this attribute. For the Document Registry it must supply the value specified in the submission request. |
| X | Prohibited – When responding to a query, a value for the attribute shall not be supplied by the responding actor. |
| R3 | Required for Stable DocumentEntries and not allowed for On-Demand DocumentEntries. |
Table 4.3.2.1-3: Responding Actor Metadata Attribute Optionality
| Metadata Element | Metadata Attribute | XDS DR | XCA IG | XCA RG | MPQ DR |
| DocumentEntry | author | R2 | R2 | R2 | R2 |
| DocumentEntry | availabilityStatus | R | R | R | R |
| DocumentEntry | classCode | R | R | R | R |
| DocumentEntry | comments | O | O | O | O |
| DocumentEntry | confidentialityCode | R | R | R | R |
| DocumentEntry | creationTime | R3 | R3 | R3 | R3 |
| DocumentEntry | entryUUID | R | R | R | R |
| DocumentEntry | eventCodeList | O | O | O | O |
| DocumentEntry | formatCode | R | R | R | R |
| DocumentEntry | hash | R3 | R3 | R3 | R3 |
| DocumentEntry | healthcareFacilityTypeCode | R | R | R | R |
| DocumentEntry | homeCommunityId | O | R | R | O |
| DocumentEntry | languageCode | R | R | R | R |
| DocumentEntry | legalAuthenticator | O | O | O | O |
| DocumentEntry | limitedMetadata | X | X | X | X |
| DocumentEntry | mimeType | R | R | R | R |
| DocumentEntry | objectType | R | R | R | R |
| DocumentEntry | patientId | R | R | R | R |
| DocumentEntry | practiceSettingCode | R | R | R | R |
| DocumentEntry | referenceIdList | O | O | O | O |
| DocumentEntry | repositoryUniqueId | R | R | R | R |
| DocumentEntry | serviceStartTime | R2 | R2 | R2 | R2 |
| DocumentEntry | serviceStopTime | R2 | R2 | R2 | R2 |
| DocumentEntry | size | R3 | R3 | R3 | R3 |
| DocumentEntry | sourcePatientId | R | R | R | R |
| DocumentEntry | sourcePatientInfo | O | O | O | O |
| DocumentEntry | title | O | O | O | O |
| DocumentEntry | typeCode | R | R | R | R |
| DocumentEntry | uniqueId | R | R | R | R |
| DocumentEntry | URI | O | O | O | O |
| SubmissionSet | author | R2 | R2 | R2 | R2 |
| SubmissionSet | availabilityStatus | R | R | R | R |
| SubmissionSet | comments | O | O | O | O |
| SubmissionSet | contentTypeCode | R | R | R | R |
| SubmissionSet | entryUUID | R | R | R | R |
| SubmissionSet | homeCommunityId | O | R | R | O |
| SubmissionSet | intendedRecipient | O | O | O | O |
| SubmissionSet | limitedMetadata | X | X | X | X |
| SubmissionSet | patientId | R | R | R | R |
| SubmissionSet | sourceId | R | R | R | R |
| SubmissionSet | submissionTime | R | R | R | R |
| SubmissionSet | title | O | O | O | O |
| SubmissionSet | uniqueId | R | R | R | R |
| Folder | availabilityStatus | R | R | R | R |
| Folder | codeList | R | R | R | R |
| Folder | comments | O | O | O | O |
| Folder | entryUUID | R | R | R | R |
| Folder | homeCommunityId | O | R | R | O |
| Folder | lastUpdateTime | O | O | O | O |
| Folder | limitedMetadata | X | X | X | X |
| Folder | patientId | R | R | R | R |
| Folder | title | R | R | R | R |
| Folder | uniqueId | R | R | R | R |