Versions Compared

Old Version 9

changes.mady.by.user Tom Pick

Saved on

compared with

New Version Current

changes.mady.by.user Louise Roy

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2

Query for the date of last data point for patients by BSN

...

  1. Generate an access token by following the OAuth 2.0 walkthrough

    1. The example below assumes you have been granted an access token of: eyJhbGxxxx

  2. Confirm the ID of the Organization

    1. The example below assumes you have an ID of: 235a397b-1ae8-4755-9c77-1a0e2fbc5314

  3. Confirm the NHS number of the patient

    1. The example below assumes an NHS number of: 9999999999

  4. Make the call as detailed below, replacing the access token, organisation ID and NHS number with your own values

    1. The invitation token will be returned

...

  1. Generate an access token by following the OAuth 2.0 walkthrough

    1. The example below assumes you have been granted an access token of: aaaaa-bbbbb

  2. Confirm the Patient reference of the Patient you are interested in

    1. The example below assumes a reference of: Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a

  3. Confirm the start of the date range you are interested in, and whether the date is inclusive (ge) or exclusive (gt)

    1. The example below assumes a start date of: ge2018-01-01

  4. Confirm the end of the date range you are interested in, and whether the date is inclusive (le) or exclusive (lt)

    1. The example below assumes an end date of: le2018-12-31

  5. Make the call as detailed below, replacing the access token and search parameters with your own values

  6. The matching Consent resources will be returned in the search results

...

  1. Generate an access token by following the OAuth 2.0 walkthrough

    • The example below assumes you have been granted an access token of: aaaaa-bbbbb

  2. Make the call as detailed below, replacing the access token with your own value

  3. Your purview will be returned in the operation response

...

  1. Generate an access token by following the OAuth 2.0 walkthrough

    1. The example below assumes you have been granted an access token of: eyJhbGxxxx

  2. Confirm the ID of the Organization

    1. The example below assumes you have an ID of: 235a397b-1ae8-4755-9c77-1a0e2fbc5314

  3. Confirm the identifier of the document

    1. The example below assumes an identifier of: 97a25402-622b-47e0-b650-bbbd08de4daf

  4. Make the call as detailed below, replacing the access token, organisation ID and document ID with your own values

    1. The read indicator will be returned

...

  1. Generate an access token by following the OAuth 2.0 walkthrough

    1. The example below assumes you have been granted an access token of: eyJhbGxxxx

  2. Confirm the ID of the Organization

    1. The example below assumes you have an ID of: 235a397b-1ae8-4755-9c77-1a0e2fbc5314

  3. Confirm the NHS number of the patient

    1. The example below assumes an NHS number of: 9999999999

  4. Make the call as detailed below, replacing the access token, organisation ID and NHS number with your own values

    1. The status information will be returned

...

{ "resourceType" : "Parameters", "parameter" : [ { "name" : "patientStatus", "part" : [ { "name" : "patientIdentifier", "valueIdentifier": { "system": "https://fhir.nhs.uk/Id/nhs-number", "value": "9999999999" } }, { "name" : "registered", "valueBoolean" : true }, { "name" : "deceased", "valueBoolean" : false }, { "name" : "dateOfBirth", "valueDate" : "1920-01-01" } ] } ] }

Trigger a questionnaire request for

...

specific Patient as a System client using national id

This example demonstrates how to trigger a questionnaire request for a specific Patient using its national ID. It also uses optional parameters to disable email notification on questionnaire response and adds an external business identifier for the request.

  1. Generate an access token by following the OAuth 2.0 walkthrough

    1. The example below assumes you have been granted an access token of: aaaaa-bbbbb

  2. Confirm the ID of the Organization (PKB clinical team)

    1. The example below assumes you have an Organization ID of: 235a397b-1ae8-4755-9c77-1a0e2fbc5314

  3. Confirm the national ID of the Patient, you can do so by searching it using their NHS numberpatient

    1. The example below assumes you have an Patient ID of: ca9db36c-1b77-4d12-9246-d78fa5d13e8cone Patient with the following NHS number: 5193233945

  4. Confirm the ID of the Questionnaire, you can do so by using the Questionnaire Search

    1. The example below assumes a Questionnaire ID of: bd17e556-20e3-4f01-8078-30e5f675b0f2

  5. Confirm the ID of the practitioner on behalf of which the communications will be sent to the patient through PKB

    1. This currently needs to be provided by PKB, the example below assumes a practitioner ID of: bdaa24d0-3cd5-469c-aa69-db676fa31bbe

  6. If you wish to add an optional Identifier to the Questionnaire Request that will be created during the operation, confirm through your own system the corresponding IDConfirm if the practitioner wants to be notified about the patient filling up a response by email

    1. The example below assumes the following identifier: {"system":"org-uuid","value":"id-value"}

  7. Make the call as detailed below, replacing the access token, Organization ID, Patient ID, Questionnaire ID, Practitioner ID and optional internal ID with your own values

    1. The questionnaire request will be created and communications will be sent to the Patient through PKB UI.

Example request

This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.

...

    1. practitioner does not want to be notified, so the Notification flag is set to EMAIL_NOTIFICATION_DISABLED

  2. Confirm the additional external business identifier you want to add to the request. This identifier must be FHIR compliant.

    1. The example below assumes the identifier is the following:

      1. system: https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest

      2. value: 294672281

  3. Make the call as detailed below, replacing the access token, Organization ID, Patient national ID, Questionnaire ID, Practitioner ID, Notification flag and additional identifier with your own values

    1. The questionnaire request will be created and communications will be sent to the Patient through PKB UI.

Example request

This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.

curl -X POST --header "Accept: application/fhir+json" --header "Content-Type: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" --header "X-Org-Public-Id: 235a397b-1ae8-4755-9c77-1a0e2fbc5314" "https://sandbox.patientsknowbest.com/fhir/Questionnaire/bd17e556-20e3-4f01-8078-30e5f675b0f2/$send-questionnaire-request" --data "{ \"resourceType\":\"Parameters\", \"parameter\":[ { \"name\":\"target\", \"valueReference\":{ \"identifier\":{ \"system\":\"https://fhir.nhs.uk/Id/nhs-number\", \"value\":\"5193233945\" } } }, { \"name\":\"requestor\", \"valueReference\":{ \"reference\":\"Practitioner/bdaa24d0-3cd5-469c-aa69-db676fa31bbe\" } }, { \"name\":\"notificationFlag\", \"valueCode\":\"EMAIL_NOTIFICATION_DISABLED\" }, { \"name\":\"targetadditionalIdentifier\", \"valueReferencevalueIdentifier\":{ \"referencesystem\":\"Patient/ca9db36c-1b77-4d12-9246-d78fa5d13e8c\"}},{\"namehttps://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest\", \"value\":\"requestor294672281\" ,\"valueReference\":{\"reference\":\"Practitioner/bdaa24d0-3cd5-469c-aa69-db676fa31bbe\"}},{\"name\":\"additionalIdentifier\",\"valueIdentifier\":{\"system\":\"org-uuid\",\"value\":\"id-value\"}}]}

Pretty-printed request body

...

} } ] }"

Pretty-printed request body

Code Block
{
  "resourceType":"Parameters",
  "parameter":[
     {
        "name":"target",
         "valueReference":{
            "identifier":{
               "system":"https://fhir.nhs.uk/Id/nhs-number",
               "value":"5193233945"
            }
         }
     },
     {
        "name":"targetrequestor",
        "valueReference":{
           "reference":"PatientPractitioner/ca9db36cbdaa24d0-1b773cd5-4d12469c-9246aa69-d78fa5d13e8cdb676fa31bbe"
        }
     },
     {
         "name":"requestornotificationFlag",
        "valueReference":{
           "referencevalueCode":"Practitioner/bdaa24d0-3cd5-469c-aa69-db676fa31bbe"
   EMAIL_NOTIFICATION_DISABLED"
    }      },
     {
         "name":"additionalIdentifier",
         "valueIdentifier":{
              "system":"org-uuidhttps://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest",
              "value":"id-value294672281"
         }
      }
  ]
}

Example response

Note: whilst every effort has been made to ensure that the examples are correct and useful, they do not form part of the official specification.

Code Block
{
   "resourceType":"Parameters",
   "parameter":[
      {
         "name":"request",
         "valueReference":{
            "reference":"ProcedureRequest/2f292349-6893-4813-868b-ec00e8318c8c"
         }
      }
   ]
}

Trigger questionnaire requests for all Patients in a team as a System client using team id

This example demonstrates how to trigger questionnaire requests for all Patients within a team. Please note we currently only support this operation for teams of 32 patients or less.

  1. Generate an access token by following the OAuth 2.0 walkthrough

    1. The example below assumes you have been granted an access token of: aaaaa-bbbbb

  2. Confirm the ID of the Organization (organisation)

    1. The example below assumes you have an organisation ID of: 235a397b-1ae8-4755-9c77-1a0e2fbc5314

  3. Confirm the ID of the Organization (team)

    1. The example below assumes you have an team ID of: ca9db36c-1b77-4d12-9246-d78fa5d13e8c

  4. Confirm the ID of the Questionnaire, you can do so by using the Questionnaire Search

    1. The example below assumes a Questionnaire ID of: bd17e556-20e3-4f01-8078-30e5f675b0f2

  5. Confirm the ID of the practitioner on behalf of which the communications will be sent to the patient through PKB

    1. This currently needs to be provided by PKB, the example below assumes a practitioner ID of: bdaa24d0-3cd5-469c-aa69-db676fa31bbe

  6. Make the call as detailed below, replacing the access token, both Organization IDs, Patient ID, Questionnaire ID and Practitioner ID with your own values

    1. The questionnaire requests will be created and communications will be sent to all the Patients in the Organization through PKB UI.

...

curl -X POST --header "Accept: application/fhir+json" --header "Content-Type: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" --header "X-Org-Public-Id: 235a397b-1ae8-4755-9c77-1a0e2fbc5314" "https://sandbox.patientsknowbest.com/fhir/Questionnaire/bd17e556-20e3-4f01-8078-30e5f675b0f2/$send-questionnaire-request" --data "{\"resourceType\":\"Parameters\",\"parameter\":[{\"name\":\"target\",\"valueReference\":{\"reference\":\"Organization/ca9db36c-1b77-4d12-9246-d78fa5d13e8c\"}},{\"name\":\"requestor\",\"valueReference\":{\"reference\":\"Practitioner/bdaa24d0-3cd5-469c-aa69-db676fa31bbe\"}}]}

Pretty-printed request body

...