• API Hub
  • Search loading...

    API Hub

    Explore and Make use of Nationally Defined Messaging APIs

     

    Foundation Resources

    The FHIR profiles and interactions required for the Foundation capability pack

    The following profiled FHIR resources are used in the current version of the Foundation capabilities, see “API Use Cases” in the menu on the left. Full details of profiled FHIR resources and worked examples are available on the FHIR Reference Server.


    Find a patient / Read a patient

    Request

    N/A - No FHIR resource is sent within the request.

    Response


    Find a practitioner / Read a practitioner

    Request

    N/A - No FHIR resource is sent within the request.

    Response


    Find an organisation / Read an organisation

    Request

    N/A - No FHIR resource is sent within the request.

    Response


    Read a location

    Request

    N/A - No FHIR resource is sent within the request.

    Response


    Register a patient

    Request

    Response


    Errors

    If there is a problem with the request or an error occurs during processing of the request then the provider should return an HTTP error along with an “OperationOutcome” resource within the response payload. Details of the required error responses are available on the Error handling guidance page within the specification.

    Response


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