What

Enables you to pull out all medications sent from any source. See the Validation and Business rules section for further details on what is included in the Aggregated endpoint.

Prerequisites

• You must have an identifier (national id or PKB public id) for the patient. If you don’t already have an identifier, see the Patient demographic retrieval page.

• You must have access to the data in the patient’s PKB record.

  • The patient’s PKB record must be in your PKB organisation.

  • You must have access to the relevant privacy labels within the patient’s PKB record.

How to

• Follow the instructions here for obtaining a token for the Aggregated FHIR endpoint.

  • FHIR client id: issued by PKB once development dates have been agreed

  • FHIR client secret: issued by PKB once development dates have been agreed

  • Grant_type: client_credentials

  • Content-type: application/x-www-form-urlencoded

  • Endpoint

• Call the base URL with the MedicationStatement resource, using the patient’s national id or PKB public id (with the corresponding system) in the subject search parameter.

  • https://hl7.org/fhir/R4/search.html

  • National ID Example: https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/MedicationStatement?subject:Patient.identifier=https://fhir.nhs.uk/Id/nhs-number%7C9996650251

  • Public ID Example: https://aggregated-fhir.sandbox.patientsknowbest.com/fhir/MedicationStatement?subject:Patient.identifier=http://fhir.patientsknowbest.com/id/public-id%7C8cfd31f2-b027-4aa5-ae27-0df7489434eb

• A FHIR bundle is returned to you in json format with all of the patient’s medications that are in their PKB record.

Useful links

• Further information on connectivity and endpoints.

• PKB uses the MedicationStatement FHIR resource. You can read the full capability statement here.

• Read more about how PKB maps any non-FHIR medication data (HL7 or UI entered) to FHIR.