Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Foundation | CapabilityStatement

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.

0. References

1. Read

The /metadata path on the root of the FHIR server will return the CapabilityStatement 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 'https://directory.spineservices.nhs.uk/STU3/metadata'

2.2 Query Response

2.2.1 Http Headers

2.3 Response Body

2.4 C#

var client = new FhirClient("http://[fhir_base]/");
client.PreferredFormat = ResourceFormat.Json;
var resource = client.CapabilityStatement();
FhirSerializer.SerializeResourceToXml(resource).Dump();

All content is available under the Open Government Licence v3.0, except where otherwise stated