...
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
Confirm the NHS number of the patient you want to search for
The example below assumes an NHS number of: 9999999999
Make the call as detailed below, replacing the access token and NHS number with your own values
The Patient resource will be returned in the search results
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/Patient?identifier=https://fhir.nhs.uk/Id/nhs-number%7C9999999999"
Retrieve a specific Patient
...
Generate an access token by following the OAuth2 OAuth 2.0 walkthrough
The example below assumes you have been granted an access token of: aaaaa-bbbbb
Confirm the patient's ID. For example, by searching by NHS number as in the example above.
The example assumes a Patient ID of: 3d8afd18-0844-459a-b3c2-355d02e54c0a
Make the call as detailed below, replacing the patient ID with your own value.
The Patient resource will be returned
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a"
...
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": "Patient",
"id": "3d8afd18-0844-459a-b3c2-355d02e54c0a",
"extension": [
{
"url": "http://fhir.patientsknowbest.com/structuredefinition/sharing-disabled",
"valueBoolean": false
}
],
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
],
"name": [
{
"family": "Clark",
"given": [
"Louie"
],
"prefix": [
"Dr"
]
}
],
"telecom": [
{
"system": "email",
"value": "louie.clark@example.com"
},
{
"system": "phone",
"value": "07123456789"
}
],
"gender": "male",
"birthDate": "2000-01-01",
"deceasedBoolean": false,
"address": [
{
"line": [
"1 Main Street"
],
"city": "London",
"state": "London",
"postalCode": "W1A 1AA",
"country": "GB-ENG"
}
]
} |
Retrieve the OperationDefinition for the Purview operation
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" "https://sandbox.patientsknowbest.com/fhir/OperationDefinition/Consent--purview"
Search for a patient's appointments, starting on or after a given date, including their source information
...
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
Confirm the Patient reference of the patient
The example below assumes a reference of: Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a
Confirm the date of interest
The example below assumes a date of: 2018-08-01
Make the call as detailed below, replacing the access token and search parameters with your own values
The matching Appointment resources will be returned in the search results
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/Appointment?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=ge2018-08-01&_revinclude=Provenance:target"
...
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
Confirm the Patient reference of the Patient you are interested in
The example below assumes a reference of: Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a
Make the call as detailed below, replacing the access token and search parameters with your own values
The matching Communication resources will be returned in the search results
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/Communication?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a"
...
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
Confirm the Patient reference of the Patient you are interested in
The example below assumes a reference of: Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a
Make the call as detailed below, replacing the access token and search parameters with your own values
The matching Consent resources will be returned in the search results
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/Consent?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a"
...
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
Confirm the Patient reference of the desired Patient
The example below assumes a reference of: Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a
Make the call as detailed below, replacing the access token and search parameters with your own values
The matching DiagnosticReport resources will be returned in the search results
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/DiagnosticReport?category=http://fhir.patientsknowbest.com/codesystem/diagnosticreport-category|RADIOLOGY&patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a"
...
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
Confirm the Organization reference of your own organisation
The example below assumes a reference of: Organization/235a397b-1ae8-4755-9c77-1a0e2fbc5314
Confirm the date of interest
The example below assumes a date of: 2018-08-01
Make the call as detailed below, replacing the access token and search parameters with your own values
The matching DocumentReference resources will be returned in the search results
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/DocumentReference?source-organisation=Organization/235a397b-1ae8-4755-9c77-1a0e2fbc5314&indexed=2018-08-01&document-status=http://fhir.patientsknowbest.com/codesystem/document-status|READ"
...
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
Confirm the Patient reference of the Patient you are interested in
The example below assumes a reference of: Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a
Make the call as detailed below, replacing the access token and search parameters with your own values
The matching Encounter resources will be returned in the search results
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/Encounter?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a"
...
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
Confirm the system of the NamingSystem you are interested in (for example, as returned in the identifier element from a query to the Patient resource)
The example below assumes a system of: urn:uuid:8978a687-cf0f-4cd9-b7e9-f29e76eb5f8d
Make the call as detailed below, replacing the access token and search parameters with your own values
The matching NamingSystem resource will be returned in the search results
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/NamingSystem?value:exact=urn:uuid:8978a687-cf0f-4cd9-b7e9-f29e76eb5f8d"
...
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
Confirm the Patient reference of the desired Patient
The example below assumes a reference of: Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a
Make the call as detailed below, replacing the access token and search parameters with your own values
The matching Observation resources will be returned in the search results
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/Observation?category=http://fhir.patientsknowbest.com/codesystem/observation-category|LABORATORY&patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a"
...
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
Confirm the ID of the Organization
The example below assumes an ID of: 235a397b-1ae8-4755-9c77-1a0e2fbc5314
Make the call as detailed below, replacing the access token and ID with your own values
The Organization resource will be returned
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/Organization/235a397b-1ae8-4755-9c77-1a0e2fbc5314"
...
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
Confirm the ID of the Practitioner
The example below assumes an ID of: fe486948-b6e2-4826-9a7a-f78cf671fea9
Make the call as detailed below, replacing the access token and ID with your own values
The Practitioner resource will be returned
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" "https://sandbox.patientsknowbest.com/fhir/Practitioner/fe486948-b6e2-4826-9a7a-f78cf671fea9"
...
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
Confirm the ID of the Organisation whose ProcedureRequest you are fetching
The example below assumes you have an ID of: 235a397b-1ae8-4755-9c77-1a0e2fbc5314
Confirm the ID of the ProcedureRequest
The example below assumes you have an ID of: 2f292349-6893-4813-868b-ec00e8318c8c
Make the call as detailed below, replacing the access token and ProcedureRequest ID with your own values
The matching ProcedureRequest resource will be returned
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" --header "X-Org-Public-Id: 235a397b-1ae8-4755-9c77-1a0e2fbc5314" "https://sandbox.patientsknowbest.com/fhir/ProcedureRequest/2f292349-6893-4813-868b-ec00e8318c8c"
...
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":"ProcedureRequest",
"id":"2f292349-6893-4813-868b-ec00e8318c8c",
"meta":{
"lastUpdated":"2022-05-27T07:01:10+00:00"
},
"extension":[
{
"url":"http://hl7.org/fhir/StructureDefinition/procedurerequest-questionnaireRequest",
"valueReference":{
"reference":"Questionnaire/bd17e556-20e3-4f01-8078-30e5f675b0f2",
"display": "IBD Control PROM"
}
}
],
"identifier":[
{
"system":"org-uuid",
"value":"id-value"
}
],
"status":"active",
"intent":"order",
"code":{
"text":"Questionnaire"
},
"subject":{
"reference":"Patient/ca9db36c-1b77-4d12-9246-d78fa5d13e8c",
"display": "Mr Test Patient"
},
"authoredOn":"2022-05-27T07:01:10+00:00"
} |
Search for all questionnaires as a System client
...
Generate an access token by following the OAuth 2.0 walkthrough
The example below assumes you have been granted an access token of: eyJhbGxxxx
Confirm the ID of the Organisation whose questionnaires you are fetching
The example below assumes you have an ID of: 235a397b-1ae8-4755-9c77-1a0e2fbc5314
Make the call as detailed below, replacing the access token and organisation ID with your own values
The matching Questionnaire resources will be returned
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer eyJhbGxxxx" --header "X-Org-Public-Id: 235a397b-1ae8-4755-9c77-1a0e2fbc5314" "https://sandbox.patientsknowbest.com/fhir/Questionnaire"
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": "Bundle",
"id": "06197768-3adc-4cb6-b64c-7a0f9cd2fbf2",
"meta": {
"lastUpdated": "2019-08-27T10:48:35.114+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "/Questionnaire"
}
],
"entry": [
{
"fullUrl": "https://sandbox.patientsknowbest.com/fhir/Questionnaire/f1a841f1-6f3a-43fc-830f-e1417b4ff13d",
"resource": {
"resourceType": "Questionnaire",
"id": "f1a841f1-6f3a-43fc-830f-e1417b4ff13d",
"meta": {
"lastUpdated": "2019-06-08T19:21:59.797Z",
"security": [
{
"system": "http://fhir.patientsknowbest.com/codesystem/privacy-label",
"code": "GENERAL_HEALTH"
}
]
},
"title": "IBD Control PROM",
"status": "active",
"date": "2019-06-07T19:29:42Z",
"item": [
{
"linkId": "1",
"text": "1. Do you believe that:",
"type": "display"
},
{
"linkId": "2",
"text": "a. Your IBD has been well controlled in the past two weeks?",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "3",
"text": "b. Your current treatment is useful in controlling your IBD?",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "4",
"text": "(if you are not taking any treatment, please tick this box)",
"type": "choice",
"repeats": true,
"option": [
{
"valueString": "Not taking any treatment"
}
]
},
{
"linkId": "5",
"text": "2. Over the past 2 weeks, have your bowel symptoms been getting worse, getting better or not changed?",
"type": "choice",
"option": [
{
"valueString": "Better"
},
{
"valueString": "No change"
},
{
"valueString": "Worse"
}
]
},
{
"linkId": "6",
"text": "3 In the past 2 weeks, did you:",
"type": "display"
},
{
"linkId": "7",
"text": "a. Miss any planned activities because of IBD? (e.g. attending school/college, going to work or a social event)",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "8",
"text": "b. Wake up at night because of symptoms of IBD?",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "9",
"text": "c. Suffer from significant pain or discomfort?",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "10",
"text": "d. Often feel lacking in energy (fatigued) (by ‘often’ we mean more than half of the time)",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "11",
"text": "e. Feel anxious or depressed because of your IBD?",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "12",
"text": "f. Think you needed a change to your treatment?",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "13",
"text": "4 At your next clinic visit, would you like to discuss:",
"type": "display"
},
{
"linkId": "14",
"text": "a. Alternative types of drug for controlling IBD",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "15",
"text": "b. Ways to adjust your own treatment",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "16",
"text": "c. Side effects or difficulties with using your medicines",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "17",
"text": "d. New symptoms that have developed since your last visit",
"type": "choice",
"option": [
{
"valueString": "Yes"
},
{
"valueString": "No"
},
{
"valueString": "Not sure"
}
]
},
{
"linkId": "18",
"text": "5 How would you rate the OVERALL control of your IBD in the past two weeks?",
"type": "choice",
"option": [
{
"valueString": "0- Worst possible control"
},
{
"valueString": "1"
},
{
"valueString": "2"
},
{
"valueString": "3"
},
{
"valueString": "4"
},
{
"valueString": "5"
},
{
"valueString": "6"
},
{
"valueString": "7"
},
{
"valueString": "8"
},
{
"valueString": "9"
},
{
"valueString": "10- Best possible control"
}
]
}
]
},
"search": {
"mode": "match"
}
}
]
} |
Search for responses to a specific questionnaire, completed by a specific patient as a System client
...
Generate an access token by following the OAuth 2.0 walkthrough
The example below assumes you have been granted an access token of: eyJhbGxxxx
Confirm the ID of the Organisation whose questionnaires you are fetching
The example below assumes you have an ID of: 235a397b-1ae8-4755-9c77-1a0e2fbc5314
Confirm the Questionnaire reference
The example below assumes a reference of: Questionnaire/f1a841f1-6f3a-43fc-830f-e1417b4ff13d
Confirm the Patient reference
The example below assumes a reference of: Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a
Make the call as detailed below, replacing the access token and search parameters with your own values
The matching QuestionnaireResponse resources will be returned
...
This example is written for http://sandbox.patientsknowbest.com; replace the URL as needed if you are connecting to a different environment.
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer eyJhbGxxxx" --header "X-Org-Public-Id: 235a397b-1ae8-4755-9c77-1a0e2fbc5314" "https://sandbox.patientsknowbest.com/fhir/QuestionnaireResponse?questionnaire=Questionnaire/f1a841f1-6f3a-43fc-830f-e1417b4ff13d&patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a"
...
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": "Bundle",
"id": "6d7847cc-408d-48db-9c3e-6bc847058d13",
"meta": {
"lastUpdated": "2019-08-27T10:48:35.114+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "/QuestionnaireResponse?questionnaire=Questionnaire/f1a841f1-6f3a-43fc-830f-e1417b4ff13d&patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a"
}
],
"entry": [
{
"fullUrl": "https://sandbox.patientsknowbest.com/fhir/QuestionnaireResponse/9badcf07-1357-45c0-9520-52e3b13ddee5",
"resource": {
"resourceType": "QuestionnaireResponse",
"id": "9badcf07-1357-45c0-9520-52e3b13ddee5",
"meta": {
"lastUpdated": "2019-06-10T11:12:13.123Z",
"security": [
{
"system": "http://fhir.patientsknowbest.com/codesystem/privacy-label",
"code": "GENERAL_HEALTH"
}
]
},
"questionnaire": {
"reference": "Questionnaire/f1a841f1-6f3a-43fc-830f-e1417b4ff13d",
"display": "IBD Control PROM"
},
"subject": {
"reference": "Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a",
"display": "Mr Test Patient"
},
"authored": "2019-06-10T11:12:13.123Z",
"item": [
{
"linkId": "2",
"text": "a. Your IBD has been well controlled in the past two weeks?",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "3",
"text": "b. Your current treatment is useful in controlling your IBD?",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "4",
"text": "(if you are not taking any treatment, please tick this box)",
"answer": [
{
"valueString": "Not taking any treatment"
}
]
},
{
"linkId": "5",
"text": "2. Over the past 2 weeks, have your bowel symptoms been getting worse, getting better or not changed?",
"answer": [
{
"valueString": "Better"
}
]
},
{
"linkId": "7",
"text": "a. Miss any planned activities because of IBD? (e.g. attending school/college, going to work or a social event)",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "8",
"text": "b. Wake up at night because of symptoms of IBD?",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "9",
"text": "c. Suffer from significant pain or discomfort?",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "10",
"text": "d. Often feel lacking in energy (fatigued) (by ‘often’ we mean more than half of the time)",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "11",
"text": "e. Feel anxious or depressed because of your IBD?",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "12",
"text": "f. Think you needed a change to your treatment?",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "14",
"text": "a. Alternative types of drug for controlling IBD",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "15",
"text": "b. Ways to adjust your own treatment",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "16",
"text": "c. Side effects or difficulties with using your medicines",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "17",
"text": "d. New symptoms that have developed since your last visit",
"answer": [
{
"valueString": "Yes"
}
]
},
{
"linkId": "18",
"text": "5 How would you rate the OVERALL control of your IBD in the past two weeks?",
"answer": [
{
"valueString": "0- Worst possible control"
}
]
}
]
},
"search": {
"mode": "match"
}
}
]
} |