Hybrid / Intermediary Exchange
1.0.0 - STU 1 US

This page is part of the Hybrid / Intermediary Exchange (v1.0.0: STU1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

: Exchange Routing CapabilityStatement - Intermediary - XML Representation

Active as of 2022-05-17

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="exchange-routing-intermediary"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2>ExchangeRoutingIntermediaryCapabilityStatement</h2><div><p>This CapabilityStatement describes the expected capabilities of an intermediary server that conforms to the conventions of the Hybrid / Intermediary Exchange FHIR implementation guide.</p>
</div><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td><div><p>When participating in exchanges described in the Hybrid / Intermediary FHIR IG, the intermediary server <strong>SHALL</strong> pass FHIR resources returned by the destination server to the originator unchanged. 1. Implement RESTful behavior according to the FHIR specification. 1. Support the JSON source format.
When participating in exchanges described in the Hybrid / Intermediary FHIR IG, the intermediary server, the intermediary server <strong>SHOULD</strong>: 1. Support the XML source format.</p>
</div></td></tr><tr><td>Transaction</td><td></td></tr><tr><td>System History</td><td></td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title="GET a resource (read interaction)">Read</b></th><th><b title="GET all set of resources of the type (search interaction)">Search</b></th><th><b title="PUT a new resource version (update interaction)">Update</b></th><th><b title="POST a new resource (create interaction)">Create</b></th></tr></table></div>
  </text>
  <url
       value="http://hl7.org/fhir/us/exchange-routing/CapabilityStatement/exchange-routing-intermediary"/>
  <version value="1.0.0"/>
  <name value="ExchangeRoutingIntermediaryCapabilityStatement"/>
  <title value="Exchange Routing Intermediary Capability Statement"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2022-05-17T00:00:00-05:00"/>
  <publisher value="HL7 International - FHIR Infrastructure"/>
  <contact>
    <name value="HL7 International - FHIR Infrastructure"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <contact>
    <name value="Frank McKinney"/>
    <telecom>
      <system value="email"/>
      <value value="frank.mckinney@pocp.com"/>
    </telecom>
  </contact>
  <description
               value="This CapabilityStatement describes the expected capabilities of an intermediary server that conforms to the conventions of the Hybrid / Intermediary Exchange FHIR implementation guide."/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
      <display value="United States of America"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="xml"/>
  <format value="json"/>
  <patchFormat value="application/json-patch+json"/>
  <implementationGuide
                       value="http://hl7.org/fhir/us/exchange-routing/ImplementationGuide/exchange-routing"/>
  <rest>
    <mode value="server"/>
    <documentation
                   value="When participating in exchanges described in the Hybrid / Intermediary FHIR IG, the intermediary server **SHALL** pass FHIR resources returned by the destination server to the originator unchanged. 1. Implement RESTful behavior according to the FHIR specification. 1. Support the JSON source format. 
When participating in exchanges described in the Hybrid / Intermediary FHIR IG, the intermediary server, the intermediary server **SHOULD**: 1. Support the XML source format."/>
    <security>
      <description
                   value="1. Communication security implemented by the intermediary server SHALL conform with the guidelines stated in [FHIR Security](https://www.hl7.org/fhir/security.html) for all exchanges covered in this IG. When using TLS: the inbound gateway intermediary SHALL hold the TLS certificate for the destination’s public FHIR service base URL the certificates exchanged by the destination system, and any delegated intermediaries SHALL reflect their servers’ private URLs. 
1. Security tokens generated by the destination for use by the originator SHALL be forwarded by the intermediary server to the originating client. 
1. The intermediary server MAY implement the [HL7 / UDAP Security for Scalable Registration, Authentication, and Authorization FHIR Implementation Guide](http://hl7.org/fhir/us/udap-security/2021Sep). 1. For general security considerations refer to [FHIR Security and Privacy Considerations](https://www.hl7.org/fhir/secpriv-module.html)."/>
    </security>
  </rest>
</CapabilityStatement>