How it works

    What to send

    FieldRequirementExample or purpose

    Request and response examples

    Ready to try

    Request body
    Response

    Reading this response

    What to do next

    Getting a CORS error?

    Download the medication and investigation guide with its local server and extract the ZIP.

    With Node.js 18 or newer installed, open a terminal in the extracted folder and run:

    node server.cjs

    Open the local URL printed in the terminal (by default http://127.0.0.1:3000) and use the guide there. Keep the terminal running; press Ctrl+C to stop.

    Field rules and important details
      About these examples

      The investigation names and partial JSON upload response come from the example supplied with this guide. The captured response is shown with the signed link and hospital metadata removed. Other responses illustrate the Application API contract; they are not additional live results.

      Use Try this call to send your own data and view a real response. No request runs when you read the guide or open the tester. All 18 integration investigation and medication catalogue routes, including aliases, are covered here.

      Opening and sharing this guide

      This HTML works on its own. If a browser blocks an API request, extract the complete bundle and open start.cmd to use the local helper (Node.js 18+). Add hospital credentials in the Hospitals tab. Set the shared API base URL in the Hospitals tab, then select a hospital in a call. Saved hospitals and the active selection persist in this browser.

      Hospitals

      Manage credentials and choose the hospital used for API calls.

      Changes save automatically.

      No hospitals saved

      Choose Add hospital to save a Hospital ID and API key.

      Credentials are saved in this browser. Use a trusted device.

      API playground

      Try this call

      Request

      Response

      Live API result
      Send a request to see the result.
      Your response will appear here.