• API Hub
  • 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

    Aim(s)

    • Appointment Management

    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 syle API = [ create, read, update, delete, search ] + any more specific actions (i.e. cancel).
      • RPC style API = [ gpc.getcarerecord, gpc.registerpatient ]
    • Subject = [ resourceType, operationName ]
      • Resource Type is the name of a FHIR resource (i.e. Patient, Appointment, Organization etc).
      • Operation Name is the name of a custom FHIR operation (i.e. gpc.getcarerecord)

    Foundations capability interactions

    Operation InteractionID Http Verb Example URL Pattern
    Read Metadata urn:nhs:names:services:gpconnect:fhir:rest:read:metadata-1 GET [base]/metadata
    Read Patient urn:nhs:names:services:gpconnect:fhir:rest:read:patient-1 GET [base]/Patient/[id]
    Patient Search urn:nhs:names:services:gpconnect:fhir:rest:search:patient-1 GET [base]/Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|[nhsNumber]
    Read Practitioner urn:nhs:names:services:gpconnect:fhir:rest:read:practitioner-1 GET [base]/Practitioner/[id]
    Practitioner Search urn:nhs:names:services:gpconnect:fhir:rest:search:practitioner-1 GET [base]/Practitioner?identifier=https://fhir.nhs.uk/Id/sds-user-id|[sdsUserID]
    Read Organisation urn:nhs:names:services:gpconnect:fhir:rest:read:organization-1 GET [base]/Organization/[id]
    Organisation Search urn:nhs:names:services:gpconnect:fhir:rest:search:organization-1 GET [base]/Organization?identifier=https://fhir.nhs.uk/Id/ods-organization-code|[odsCode]
    Read Location urn:nhs:names:services:gpconnect:fhir:rest:read:location-1 GET [base]/Location/[id]
    Register Patient urn:nhs:names:services:gpconnect:fhir:operation:gpc.registerpatient-1 POST [base]/Patient/$gpc.registerpatient

    Appointments capability interactions

    Operation InteractionID Http Verb Example URL Pattern
    Search for free slots urn:nhs:names:services:gpconnect:fhir:rest:search:slot-1 POST [base]/Slot
    Read Appointment urn:nhs:names:services:gpconnect:fhir:rest:read:appointment-1 GET [base]/Appointment/[id]
    Create Appointment urn:nhs:names:services:gpconnect:fhir:rest:create:appointment-1 POST [base]/Appointment
    Amend Appointment urn:nhs:names:services:gpconnect:fhir:rest:update:appointment-1 PUT [base]/Appointment/[id]
    Cancel Appointment urn:nhs:names:services:gpconnect:fhir:rest:cancel:appointment-1 PUT [base]/Appointment/[id]
    Get Patient Appointments urn:nhs:names:services:gpconnect:fhir:rest:search:patient_appointments-1 GET [base]/Patient/[id]/Appointment

    Access Record HTML capability interactions

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

    Access Record Structured capability interactions

    Access Record Structured 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