Hybrid / Intermediary Exchange
1.0.0 - CI Build

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

## CapabilityStatement: Exchange Routing CapabilityStatement - Intermediary

Official URL: http://hl7.org/fhir/us/exchange-routing/CapabilityStatement/exchange-routing-intermediary | Version: 1.0.0
Standards status: Trial-use | Maturity Level: 1 | Computable Name: ExchangeRoutingIntermediaryCapabilityStatement

This CapabilityStatement describes the expected capabilities of an intermediary server that conforms to the conventions of the Hybrid / Intermediary Exchange FHIR implementation guide.

### FHIR Resource Content

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.

### FHIR RESTful Capabilities

- Intermediary server SHALL support the JSON source format.
- Intermediary serer SHOULD support the XML source format.

### Security

- Communication security implemented by the intermediary server SHALL conform with the guidelines stated in FHIR Security 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.
- Intermediary server SHALL implement Transport Layer Security (TLS) for all exchanges covered in this IG.
- Security tokens generated and returned by the destination SHALL be forwarded by the intermediary server to the originating client.
- Intermediary server MAY implement the HL7 / UDAP Security for Scalable Registration, Authentication, and Authorization FHIR Implementation Guide.
- For general security considerations refer to FHIR Security and Privacy Considerations.

Raw OpenAPI-Swagger Definition file | Download

## Exchange Routing Intermediary Capability Statement

- Implementation Guide Version: 1.0.0
- FHIR Version: 4.0.1
- Supported Formats: `xml`, `json`
- Supported Patch Formats: `application/json-patch+json`
- Published on: 2022-05-17 00:00:00-0500
- Published by: HL7 International / FHIR Infrastructure

> Note to Implementers: FHIR Capabilities

> 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.

### SHALL Support the Following Implementation Guides

- http://hl7.org/fhir/us/exchange-routing/ImplementationGuide/exchange-routing

## FHIR RESTful Capabilities

### Mode: `server`

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

> 1. Communication security implemented by the intermediary server SHALL conform with the guidelines stated in FHIR Security 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.
> 2. Security tokens generated by the destination for use by the originator SHALL be forwarded by the intermediary server to the originating client.
> 3. The intermediary server MAY implement the HL7 / UDAP Security for Scalable Registration, Authentication, and Authorization FHIR Implementation Guide. 1. For general security considerations refer to FHIR Security and Privacy Considerations.

Summary of System-wide Interactions