0. References

1. Capabilities

API to support getting the NRLS server capability statement.

1.1 Capabilities Request Headers

The Capabilities Interaction supports the following HTTP request headers:

1.2 Capabilities Interaction (Get the NRLS CapabilityStatement)

The /metadata path on the root of the NRLS FHIR server will return the capability statement for the FHIR server.

For details of this interaction - see HL7 FHIR STU3 RESTful API.

1.3 Capabilities Response

Success:

• SHALL return a 200 OK HTTP status code on successful retrieval of the capability statement.
• SHALL return a capability statement which conforms to the standard FHIR CapabilityStatement

Error Handling:

The NRLS Server is expected to always be able to return a valid capability statement.

2. Example

2.1 Capabilities Request Query

Retrieve the capability statement from the NRLS Server, the format of the response body will be xml.

2.1.1. cURL

curl -H 'Accept: application/fhir+xml' -H 'Authorization: BEARER [token]' -X GET '[baseUrl]/metadata'

2.2 Query Response

2.2.1 Http Headers

2.2.2 Response Body

An example NRLS CapabilityStatement of kind Requirements is shown below:

2.3 C#

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