FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/exchange-routing-intermediary

Packagehl7.fhir.us.exchange-routing
TypeCapabilityStatement
Idexchange-routing-intermediary
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/exchange-routing/https://build.fhir.org/ig/HL7/fhir-exchange-routing-ig/CapabilityStatement-exchange-routing-intermediary.html
URLhttp://hl7.org/fhir/us/exchange-routing/CapabilityStatement/exchange-routing-intermediary
Version1.0.0
Statusactive
Date2022-05-17T00:00:00-05:00
NameExchangeRoutingIntermediaryCapabilityStatement
TitleExchange Routing Intermediary Capability Statement
Realmus
Authorityhl7
DescriptionThis CapabilityStatement describes the expected capabilities of an intermediary server that conforms to the conventions of the Hybrid / Intermediary Exchange FHIR implementation guide.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement exchange-routing-intermediary

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

Source

{
  "resourceType": "CapabilityStatement",
  "id": "exchange-routing-intermediary",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/exchange-routing/ImplementationGuide/exchange-routing"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/exchange-routing/ImplementationGuide/exchange-routing"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/exchange-routing/CapabilityStatement/exchange-routing-intermediary",
  "version": "1.0.0",
  "name": "ExchangeRoutingIntermediaryCapabilityStatement",
  "title": "Exchange Routing Intermediary Capability Statement",
  "status": "active",
  "experimental": false,
  "date": "2022-05-17T00:00:00-05:00",
  "publisher": "HL7 International / FHIR Infrastructure",
  "contact": [
    {
      "name": "HL7 International / FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    },
    {
      "name": "David Pyke",
      "telecom": [
        {
          "system": "email",
          "value": "david@pyke.ca"
        }
      ]
    }
  ],
  "description": "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": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "xml",
    "json"
  ],
  "patchFormat": [
    "application/json-patch+json"
  ],
  "implementationGuide": [
    "http://hl7.org/fhir/us/exchange-routing/ImplementationGuide/exchange-routing"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "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. \nWhen 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": "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. \n1. Security tokens generated by the destination for use by the originator SHALL be forwarded by the intermediary server to the originating client. \n1. 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)."
      }
    }
  ]
}