Skip to main content

MediKIT API specs

This site describes all the available APIs that MediKIT exposes for external parties.

URL structure​

In these docs, a number of URL placeholders are used to describe the API endpoints. These placeholders are defined as follows:

  • <BASE_URL>: The base URL of the MediKIT API (in a specific environment).
  • <TENANT_ID>: The ID of the tenant to which the request is made.
  • <PATIENT_ID>: The ID of the patient to which the request is made.
  • <RESOURCE_TYPE>: The type of the resource to which the request is made.
  • <TENANT_BASE_URL>: The base URL of the MediKIT API for a specific tenant: <BASE_URL>/<TENANT_ID>.

Requests​

These docs briefly mention the actual format of the requests made to the API. Detailed, interactive examples can be found in the sample requests repository.

Data​

Unless otherwise specified, all data is returned in FHIR R4 JSON.