A Capability Statement is a set of capabilities of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® Reasonable Adjustments API. This project is being developed using an agile methodology so iterative updates to content will be added on a regular basis.
Warning: This site is provided for information only and is intended for those engaged with NHS Digital. It is advised not to develop against these specifications until a formal announcement has been made.
0. References
User Stories: - |
1. Read
GET [baseUrl]/metadata
The /metadata path on the root of the FHIR server will return the Capability Statement for the FHIR server:
By default the response will be returned in JSON, however XML is also supported.
For details of this interaction - see the HL7 FHIR RESTful API
2. Example
2.1 Request Query
Retrieve the Capability Statement from the FHIR Server, the format of the response body will be xml. Replace ‘baseUrl’ with the actual base Url of the FHIR Server.
2.1.1. cURL
curl -H 'Accept: application/fhir+xml' -X GET '[baseUrl]/metadata'
2.2 Query Response
2.2.1 Http Headers
2.3 Response Body
Important: The following draft Capability Statement will move as the Implementation Guide moves on.
Important: The following draft capability statement will move as the implementation guide moves on.
2.4 C#
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://[fhir_base]/");
client.PreferredFormat = ResourceFormat.Json;
var resource = client.CapabilityStatement();
FhirSerializer.SerializeResourceToXml(resource).Dump();