GP Connect - Access Document

This guidance is under active development by NHS Digital and content may be added or updated on a regular basis.

Get the FHIR capability statement

Use case

Get the Access Document FHIR capability statement.

API specification

See GP Connect Access Document - FHIR API.

Interaction diagram

documents-get-capability-statement-interaction-diagram

Payload response body

Provider systems:

  • 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

An example Access Document capability statement is shown below ready for customisation and embedding into assured provider systems. Providers should use this capability statement as a base for their own Access Document capability statement, 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 API specification version that the Access Document FHIR server implements.

Consumer systems:

  • SHOULD request the capability statement from the Access Document FHIR server endpoint in order to ascertain details of the implementation delivered by the FHIR server, this includes checking the version number specified in CapabilityStatement.version
  • MAY also cache the Access Document capability statement information retrieved from an endpoint to reduce the number of future calls they make to the target organization’s Access Document FHIR server.
back to top