Use case for getting the GP Connect FHIR server's capability statement
Prerequisites
Consumer
The consumer system:
- SHALL have previously resolved the organisation’s FHIR endpoint base URL through the Spine Directory Service
API usage
Request operation
FHIR relative request
GET /metadata
FHIR absolute request
GET https://[proxy_server]/https://[provider_server]/[fhir_base]/metadata
Request headers
Consumers SHALL include the following additional HTTP request headers:
| Header | Value |
|---|---|
Ssp-TraceID |
Consumer’s TraceID (i.e. GUID/UUID) |
Ssp-From |
Consumer’s ASID |
Ssp-To |
Provider’s ASID |
Ssp-InteractionID |
urn:nhs:names:services:gpconnect:fhir:rest:read:metadata-1 |
Payload request body
N/A
Error handling
Provider systems are expected to always be able to return a valid capability statement.
Request response
Response Headers
Provider systems are not expected to add any specific headers beyond that described in the HTTP and FHIR® standards.
Payload response body
Provider systems:
- SHALL return a
200OK HTTP status code on successful retrival of the capability statement - SHALL return a capability statement which conforms to the standard FHIR CapabilityStatement
An example GP Connect CapabilityStatement is shown below ready for customisation and embedding into GP Connect assured provider systems. Providers should use this CapabilityStatement as a base for their own CapabilityStatement, replacing the element in square brackets ([ & ]) with specific information of their implementation. The main version at the top of the CapabilityStatement should represent the GP Connect specification version which the FHIR server implements.
<CapabilityStatement xmlns="http://hl7.org/fhir">
<version value="1.0.0" />
<name value="GP Connect" />
<status value="active" />
<date value="2018-02-23" />
<publisher value="[Provider Software Vendor Name]" />
<contact>
<name value="[Provider Software Vendor Contact Name]" />
</contact>
<description value="This server implements the GP Connect API version 1.0.0" />
<copyright value="Copyright NHS Digital 2016" />
<kind value="capability" />
<software>
<name value="[Provider Software Name]" />
<version value="[Provider Software Verson]" />
<releaseDate value="[Provider Software Release Date]" />
</software>
<fhirVersion value="3.0.1" />
<acceptUnknown value="both" />
<format value="application/fhir+xml" />
<format value="application/fhir+json" />
<profile>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Location-1"/>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-OperationOutcome-1"/>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"/>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1"/>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Practitioner-1"/>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Appointment-1"/>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Schedule-1"/>
<reference value="https://fhir.nhs.uk/STU3/StructureDefinition/GPConnect-Slot-1"/>
</profile>
<rest>
<mode value="server" />
<security>
<cors value="true" />
</security>
<resource>
<type value="Patient" />
<interaction>
<code value="read" />
</interaction>
<interaction>
<code value="search-type" />
</interaction>
<searchParam>
<name value="identifier" />
<type value="token" />
<documentation value="NHS Number (i.e. https://fhir.nhs.uk/Id/nhs-number|123456789)" />
</searchParam>
</resource>
<resource>
<type value="Organization" />
<interaction>
<code value="read" />
</interaction>
<interaction>
<code value="search-type" />
</interaction>
<searchParam>
<name value="identifier" />
<type value="token" />
<documentation value="ODS Code (i.e. https://fhir.nhs.uk/Id/ods-organization-code|Y12345)" />
</searchParam>
</resource>
<resource>
<type value="Practitioner" />
<interaction>
<code value="read" />
</interaction>
<interaction>
<code value="search-type" />
</interaction>
<searchParam>
<name value="identifier" />
<type value="token" />
<documentation value="SDS User Id (i.e. https://fhir.nhs.uk/Id/sds-user-id|999999)" />
</searchParam>
</resource>
<resource>
<type value="Location" />
<interaction>
<code value="read" />
</interaction>
</resource>
<resource>
<type value="Appointment" />
<interaction>
<code value="read" />
</interaction>
<interaction>
<code value="create" />
</interaction>
<interaction>
<code value="update" />
</interaction>
<interaction>
<code value="search-type" />
</interaction>
<updateCreate value="false" />
<searchParam>
<name value="identifier" />
<type value="token" />
<documentation value="NHS Number (i.e. https://fhir.nhs.uk/Id/nhs-number|123456789)" />
</searchParam>
</resource>
<resource>
<type value="Slot" />
<interaction>
<code value="search-type" />
</interaction>
<searchParam>
<name value="start" />
<type value="date" />
</searchParam>
<searchParam>
<name value="end" />
<type value="date" />
</searchParam>
<searchParam>
<name value="status" />
<type value="token" />
</searchParam>
<searchParam>
<name value="searchFilter" />
<type value="token" />
</searchParam>
</resource>
<operation>
<name value="gpc.registerpatient" />
<definition>
<reference value="https://fhir.nhs.uk/STU3/OperationDefinition/GPConnect-RegisterPatient-Operation-1" />
</definition>
</operation>
</rest>
</CapabilityStatement>
Consumer systems:
- SHOULD, request the capability statement from the FHIR server endpoint in order to ascertain details of the implementation of GP Connect capabilities delivered by the FHIR server
- SHOULD cache capability statement information retrieved from an endpoint at run-time on a per-session basis
C# client request to get the capability statement
Tip: C# code snippets utilise Ewout Kramer’s fhir-net-api library which is the official .NET API for HL7® FHIR®.
var client = new FhirClient("http://gpconnect.aprovider.nhs.net/GP001/STU3/1/");
client.PreferredFormat = ResourceFormat.Json;
var resource = client.CapabilityStatement();
FhirSerializer.SerializeResourceToXml(resource).Dump();
