Safeguard API for Smart FOX
4.2.3-current - ci-build

Safeguard API for Smart FOX - Local Development build (v4.2.3-current) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## 3:4.5 FHIR Maps

Editor, please Add Section 4.5

## 3:4.5 FHIR Representation of Document Sharing Metadata

This section documents the mapping between IHE Document Sharing Metadata and the FHIR Resources.

### 3:4.5.1 Metadata Object Types mapped to FHIR

For details on FHIR resources and data types see HL7 FHIR http://hl7.org/fhir/R4/index.html.

Some Document Sharing Metadata attributes must be treated as `contained` FHIR Resources. These are indicated in with a "Note 1” and the word `contained`. The details of the FHIR `contained` mechanism is found at http://hl7.org/fhir/R4/references.html#contained.

When encoding XDS identifiers into FHIR Resource data elements of type Identifier, the FHIR notation of OIDs and UUIDs uses the system identifier of `urn:ietf:rfc:3986`. For more details and examples, see ITI TF-2: Appendix E.3 “FHIR Identifier Type”.

#### 3:4.5.1.1 DocumentEntry Metadata Attributes

​The documented mapping of the metadata elements associated with a Document Sharing DocumentEntry object attributes.

Note: FHIR contains an informative mapping that is intended to be equivalent and can be found at http://hl7.org/fhir/R4/documentreference-mappings.html#xds. For the purposes of IHE MHD conformance the mapping documented here (in IHE) are normative.

#### 3:4.5.1.2 DocumentReference StructureDefinition

The conformance requirements are different between a Provide Document Bundle ITI-65 transaction and a Find Document References ITI-67 transaction, and between Minimal Metadata, Comprehensive Metadata, and UnContained References.

The conformance requirements are different between Comprehensive, minimal, and UnContained References. The canonical URI is found as the "Defining URL:":

- Comprehensive DocumentReference Metadata
- Comprehensive DocumentReference UnContained References
- Minimal DocumentReference Metadata
- Minimal DocumentReference does not include `contained` requirements

Resources are not required to carry the meta.profile element and may only carry the profile element defined for the Provide Document Bundle [ITI-65] transaction, as the Receiver is not required to add the profile tags. The value of the meta.profile is a soft indicator of conformance expectation. Receivers may choose to validate actual conformance and fail transactions due to non-conformance.

### 3:4.5.2 SubmissionSet Metadata Attributes

​The documented mapping of the metadata elements associated with a Document Sharing SubmissionSet object attributes.

#### 3:4.5.2.1 SubmissionSet List StructureDefinition

The conformance requirements are different between Comprehensive, Minimal, and UnContained References. The canonical URI is found as the "Defining URL:":

- Comprehensive SubmissionSet Metadata
- Comprehensive SubmissionSet UnContained References
- Minimal SubmissionSet Metadata
- Minimal SubmissionSet Metadata does not include `contained` requirements

Resources are not required to carry the meta.profile element and may only carry the profile element defined for the Provide Document Bundle ITI-65 transaction, as the Receiver is not required to add the profile tags. The value of the meta.profile is a soft indicator of conformance expectation. Receivers may choose to validate actual conformance and fail transactions due to non-conformance.

### 3:4.5.3 Folder Metadata Attributes

​The documented mapping of the metadata elements associated with a Document Sharing Folder object attributes.

Note that FHIR List Resource in the FHIR core specification does not include a Mapping to XDS.

#### 3:4.5.3.1 Folder StructureDefinition

The conformance requirements are different between Comprehensive and Minimal metadata. The canonical URI is found as the "Defining URL:":

- Comprehensive Folder Metadata
- Comprehensive Folder Metadata does not include `contained` requirements
- Minimal Folder Metadata
- Minimal Folder Metadata does not include `contained` requirements

Resources are not required to carry the meta.profile element and may only carry the profile element defined for the Provide Document Bundle ITI-65 transaction, as the Receiver is not required to add the profile tags. The value of the meta.profile is a soft indicator of conformance expectation. Receivers may choose to validate actual conformance and fail transactions due to non-conformance.