FAQs - Care Plans (Extracting Data) REST API

Question	Response
Can you pull out care plans that were sent in via HL7?	Yes, if the care plan was sent in html format. If the care plan was sent in as a PDF, then no, the content cannot be extracted.
Which care plan versions are extracted?	The most recent version of all care plans created in the UI by a patient, professional, or carer, and the most recent version of any html care plans sent to PKB via HL7.
Do any symptoms, measurements, or tests get extracted with the care plan?	No, only the care plan content (action, red, amber, and green sections) are extracted. If you want additional data, there are other APIs to extract the specific data points you’re interested in.
If there’s a change to a care plan, can PKB alert us of this so we know we need to pull the new version?	No. PKB does not notify of any changes. Using the API to poll at certain intervals, checking for updates is necessary.
Can I pull all care plans for multiple patients at the same time, or all patients in a PKB team?	No. The API works by extracting all care plans for a single patient at a time.
Can I specify that I only want to pull the care plans that my team created?	No. The API works by extracting all of the care plans for a single patient and cannot be filtered.
What format is the response in?	The care plan responses are presented in html format.
There is a ‘Treatment Plan’ API and a ‘Care Plan’ API. What is the difference?	The API for pulling Treatment Plans allows you to pull the contents of the plans, as well as the details. The API for pulling Care Plans only provides you with the details of the plans, and not the html content.
What access do I need to be able to use the APIs?	Care plans can be pulled from PKB with either Patient, Clinician or Coordinator granted access. This means the access you use to pull care plans could be restricted to either individual patient records, or to all patient data accessible to a specific clinician or a specific team coordinator.
For the parameter “id” what id is it that is required?	It is the PKB Patient ID which needs to be provided. This ID can be obtained using one of the Users REST APIs. For example, you could use the GET/v2-beta/users/byNationalId/{nationalId}/{nationalIdType} API to exchange an individual patients NHS number for their PKB Patient ID.