FHIR_CapabilityStatement

Overview

This test applies to test systems that have implemented one or more IHE Profiles based on HL7®© FHIR or FHIRcast®©.  

  • The test primarily applies to FHIR Servers, who will publish a FHIR CapabilityStatement that documents the capabilities (behaviors) of its server implementation.  See ITI TF-2: Appendix Z.3.  
  • Some IHE Profiles may also require that client actors publish a CapabilityStatement to document the FHIR Resources it supports, e.g. this is required for IHE RAD IRA actors, including Report Creator.

IHE publishes CapabilityStatements aligned with profile requirements on the  Artifacts page of the FHIR Implementation Guide (IG) for that profile (e.g. for the IHE ITI PIXm profile, see https://profiles.ihe.net/ITI/PIXm/artifacts.html).

==> During the Connectathon Preparatory phase: You will create a FHIR or FHIRcast CapabilityStatement Resource that represents the FHIR capabilities in your system/product, i.e. CapabilityStatement.kind has value "instance".  You will upload it as a sample into Gazelle Test Management.  Finally, you will use Gazelle External Validation Service (EVS) to validate your CapabilityStatement.

==> Later during Connectathon: 

  • Connectathon test "01_CapabilityStmt_ResourceCheck" describes handling of FHIR CapabilityStatements during the IHE Connectathon.
  • If your test system implements FHIR Server capabilities, we expect you to be able to respond to a FHIR capabilities interaction (https://www.hl7.org/fhir/http.html#capabilities) to make your CapabilityStatement available to test partners and monitors.  Connectathon monitors will have tools to enable them to retrieve and review the CapabilityStatement for your test system.

Reference:  IHE (ITI) Appendix Z on HL7 FHIR, Section Z.3: "HL7 FHIR allows service implementers to publish a CapabilityStatement Resource describing the resources, transport, formats, and operations that can be performed on a series of resources for the service instance. The CapabilityStatement Resource is described in FHIR:  http://hl7.org/fhir/CapabilityStatement.html.   Actors providing http server functionality shall publish a CapabilityStatement on the metadata endpoint as described in FHIR http://hl7.org/fhir/R4/http.html#capabilities."

Instructions for the Preparatory phase:

 

First, create a Sample entry in Gazelle Test Management for your CapabilityStatement:

  1. Create a CapabilityStatement Resource that represents the FHIR capabilities in your test system/product.  
  2. Upload the XML or JSON file for the CapabilityStatement Resource into the Sample Exchange area of Gazelle Test Management under. On the Samples to share tab, upload your file under the FHIR CapabilityStatement entry.    Though most systems will have one CapabilityStatment, you may upload more than one file.
    1. Important note:  Unlike other samples, you will not validate the CapabilityStatement within the Samples UI.  See next step...

Second, validate your CapabilityStatement using Gazelle EVSClient:

  1. Access Gazelle EVS, menu 'IHE --> FHIR - IG-based'
  2. Under that menu, upload your CapabilityStatement into the tool and select the correct validator from the dropdown list.
  3. The validation result should show "Passed".

Evaluation

  • The EVS creates a Permanent link to your results
  • To record your results for this test in Gazelle Test Management, paste the Permanent link(s) to your EVS validation results into the proper test instance as evidence.

NOTE:  You will be asked to provide this CapabilityStatement during Connectathon, and Monitors will examine it then, so it is to your benefit to do this preparation in advance of Connectathon.