Hybrid / Intermediary Exchange
1.0.0 - CI Build United States of America flag

Hybrid / Intermediary Exchange, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-exchange-routing-ig/ and changes regularly. See the Directory of published versions

: Exchange Routing CapabilityStatement - Intermediary - XML Representation

Page standards status: Trial-use Maturity Level: 1

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"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement exchange-routing-intermediary</b></p><a name="exchange-routing-intermediary"> </a><a name="hcexchange-routing-intermediary"> </a><h2 id="title">Exchange Routing Intermediary Capability Statement</h2><ul><li>Implementation Guide Version: 1.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: <code>application/json-patch+json</code></li><li>Published on: 2022-05-17 00:00:00-0500 </li><li>Published by: HL7 International / FHIR Infrastructure </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id="shallIGs">SHALL Support the Following Implementation Guides</h3><ul><li>http://hl7.org/fhir/us/exchange-routing/ImplementationGuide/exchange-routing</li></ul><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><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><div class="lead"><em>Security</em></div><blockquote><div><ol>
<li>Communication security implemented by the intermediary server SHALL conform with the guidelines stated in <a href="https://www.hl7.org/fhir/security.html">FHIR Security</a> 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.</li>
<li>Security tokens generated by the destination for use by the originator SHALL be forwarded by the intermediary server to the originating client.</li>
<li>The intermediary server MAY implement the <a href="http://hl7.org/fhir/us/udap-security/2021Sep">HL7 / UDAP Security for Scalable Registration, Authentication, and Authorization FHIR Implementation Guide</a>. 1. For general security considerations refer to <a href="https://www.hl7.org/fhir/secpriv-module.html">FHIR Security and Privacy Considerations</a>.</li>
</ol>
</div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div></div></div></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="1">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/exchange-routing/ImplementationGuide/exchange-routing"/>
      </extension>
    </valueInteger>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/exchange-routing/ImplementationGuide/exchange-routing"/>
      </extension>
    </valueCode>
  </extension>
  <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="David Pyke"/>
    <telecom>
      <system value="email"/>
      <value value="david@pyke.ca"/>
    </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>