Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Operation guidance

Details of which operations a FHIR® server should expose to be a fully compliant GP Connect solution

FHIR® operations

Mechanism

  • RESTful APIs in line with the FHIR® standard (with limited/targeted usage of custom operations as/if required)

Interactions

All InteractionIDs are expected to follow the following format urn:nhs:names:services:[program]:[standard]:[mechanism]:[operation]:[subject].

  • program = gpconnect
  • standard = fhir
  • mechanism = [ rest, operation ]
    • rest for RESTful API interactions
    • operation for custom Operation API interactions
  • operation
    • RESTful style API = [ create, read, update, delete, search ] + any more specific actions (for example, cancel)
    • Remote Procedure Call (RPC) style API = [ gpc.getcarerecord, gpc.registerpatient ]
  • subject = [ resourceType, operationName ]
    • Resource Type is the name of a FHIR resource, such as Patient, Appointment, Organization
    • Operation Name is the name of a custom FHIR operation, such as gpc.getcarerecord

Foundations capability interactions

Operation InteractionID Http Verb Example URL Pattern
Read Metadata urn:nhs:names:services:gpconnect:fhir:rest:read:metadata GET [base]/metadata

The remaining interactions of the Foundations capability pack are not available at this specification version.

Access Record HTML capability interactions

Operation InteractionID Http Verb Example URL Pattern
Get Care Record urn:nhs:names:services:gpconnect:fhir:operation:gpc.getcarerecord POST [base]/Patient/$gpc.getcarerecord

Access Record Structured capability interactions

Access Record Structured interactions are not available at this specification version.

Appointments capability interactions

Appointments interactions are not available at this specification version.

Task capability interactions

Task interactions are not available at this specification version.


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