...
The advanced questionnaires FHIR resources are in FHIR version 4. This is because Questionnaires and QuestionnaireResponses will be read from our aggregated endpoint.
FHIRWALL_BASE_The PKB Sandbox URL is used throughout this page as a placeholder URL. Since this feature is still in development, the final URL is not yet available. This page will be updated with the correct URL once it is availableshould be replaced in your API calls to match the required environment.
| Table of Contents | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
Endpoint | Method | RequestBody | Auth header |
|---|---|---|---|
FHIRWALL_BASE_URLhttps://aggregated-fhir.sandbox.patietnsknowbest.com/fhir/Questionnaire/questionnaireID/$send-questionnaire-request | POST | parameters: 0..* target 0..1 additionalIdentifier
| Authorization: Bearer <Keycloak token> x-team-id: <UUID> |
...
Example request URL
| Code Block |
|---|
POST FHIRWALL_BASE_URLhttps://aggregated-fhir.sandbox.patietnsknowbest.com/fhir/Questionnaire/questionnaireId/$send-questionnaire-request |
...
curl -X POST --header "Accept: application/fhir+json" --header "Content-Type: application/fhir+json" --header "Authorization: Bearer aaaaa-bbbbb" --header “x-team-id: 235a397b-1ae8-4755-9c77-1a0e2fbc5314” "FHIRWALL_URLhttps://aggregated-fhir.sandbox.patietnsknowbest.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\":\"additionalIdentifier\", \"valueIdentifier\":{ \"system\":\"https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest\", \"value\":\"12345\" } } ] }"
...
This section will contain the search parameters that can be used to retrieve Questionnaire resources and an example workflow.
| Code Block |
|---|
GET [baseURL]GET https://aggregated-fhir.sandbox.patietnsknowbest.com/fhir/Questionnaire |
The following search parameters can be used to search for Questionnaire resources:
...
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer eyJhbGxxxx" --header "x-team-id: 235a397b-1ae8-4755-9c77-1a0e2fbc5314" “FHIRWALL_URL“https://aggregated-fhir.sandbox.patietnsknowbest.com/fhir/Questionnaire/"
Differences between the current and new API calls
...
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer eyJhbGxxxx" --header "x-team-id: 235a397b-1ae8-4755-9c77-1a0e2fbc5314" “FHIRWALL_URL“https://aggregated-fhir.sandbox.patietnsknowbest.com/fhir/Questionnaire/"
Summary of the differences
...
This section will contain the search parameters that can be used to retrieve QuestionnaireResponse resources and an example workflow.
| Code Block |
|---|
GET [baseURL]https://aggregated-fhir.sandbox.patietnsknowbest.com/fhir/QuestionnaireResponse |
The following search parameters can be used to search for QuestionnaireResponse resources:
...
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer eyJhbGxxxx" --header “x-team-id: 235a397b-1ae8-4755-9c77-1a0e2fbc5314” "FHIRWALL_URLhttps://aggregated-fhir.sandbox.patietnsknowbest.com/fhir/QuestionnaireResponse?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a"
...
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer eyJhbGxxxx" --header “x-team-id: 235a397b-1ae8-4755-9c77-1a0e2fbc5314” "FHIRWALL_URLhttps://aggregated-fhir.sandbox.patietnsknowbest.com/fhir/QuestionnaireResponse?based-on:ServiceRequest.identifier=https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/ServiceRequest%7C12345&_include=QuestionnaireResponse:basedOn:ServiceRequest"
...
curl -X GET --header "Accept: application/fhir+json" --header "Authorization: Bearer eyJhbGxxxx" --header “x-team-id: 235a397b-1ae8-4755-9c77-1a0e2fbc5314” "FHIRWALL_URLhttps://aggregated-fhir.sandbox.patietnsknowbest.com/fhir/QuestionnaireResponse?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a"
...