title

"PKB FHIR API"

status

"active"

experimental

<conditional>

• If this is a test server: true

• Else: false

This value can be used by clients to determine whether or not the server supports production data.

For example, it will be true on https://sandbox.patientsknowbest.com.

date

Current date and time, e.g. "2018-02-09T09:37:35+00:00"

publisher

"Patients Know Best Ltd."

kind

"instance"

implementation

Details of the installation covered by this capability statement.

• implementation: BackboneElement

  • description = "Patients Know Best"

  • url = API base URL

fhirVersion

"3.0.1"

acceptUnknown

"no"

format

"application/fhir+json"

This is correct for STU3.

implementationGuide

"http://fhir.patientsknowbest.com"

rest

Appointment

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-appointment

search

Supported parameters:

• • patient. Required. Multi-value support: none. Modifier support: [<type>].

  • date. Optional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt, ge, le].

  • _revinclude=Provenance:target

Permitted user types:

• • Patient

  • Professional

Examples:

GET /Appointment?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=2018-07-01

GET /Appointment?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=2018-07-01&_revinclude=Provenance:target

Communication

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-communication

search

Supported parameters:

• patient. Required. Multi-value support: none. Modifier support: [<type>].

• sent. Optional. Multi-value support: AND. Modifier support: none. Prefixes supported: [eq, gt, lt, ge, le].

• _revinclude=Provenance:target

Permitted user types:

• Patient

• Professional

Examples:

GET /Communication?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&sent=2018-07-01

GET /Communication?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&sent=2018-07-01&_revinclude=Provenance:target

Consent

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-consent

search

Supported parameters:

• patient. Required. Multi-value support: none. Modifier support: [<type>].

Permitted user types:

• Patient

• Professional

Examples:

GET /Consent?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a

DiagnosticReport

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-diagnosticreport

search

Supported parameters:

• category. Required. Multi-value support: none. Modifier support: none.

• patient. Required. Multi-value support: none. Modifier support: [<type>].

• date. Optional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt, ge, le].

Permitted user types:

• Patient

• Professional

Examples:

GET /DiagnosticReport?category=http://fhir.patientsknowbest.com/codesystem/diagnosticreport-category|RADIOLOGY&patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=2018-07-01

DocumentReference

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-documentreference

search

Supported parameters:

• created. Conditional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt, ge, le].

• document-status. Optional. Multi-value support: none. Modifier support: none. Definition: http://fhir.patientsknowbest.com/searchparameter/document-status

• indexed. Conditional. Multi-value support: none. Modifier support: none. Prefix support: [eq].

• patient. Conditional. Multi-value support: none. Modifier support: [<type>].

• source-organisation. Optional. Multi-value support: none. Modifier support: [<type>]. Definition: http://fhir.patientsknowbest.com/searchparameter/source-organisation

• _revinclude=Provenance:target

Permitted user types:

• Patient

• Professional

Examples:

GET /DocumentReference?indexed=2018-08-01

GET /DocumentReference?indexed=2018-08-01&document-status=http://fhir.patientsknowbest.com/codesystem/document-status|READ

GET/DocumentReference?indexed=2018-08-01&source-organisation=Organization/235a397b-1ae8-4755-9c77-1a0e2fbc5314

GET /DocumentReference?indexed=2018-08-01&_revinclude=Provenance:target

GET /DocumentReference?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a

GET /DocumentReference?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&created=2019-03-01

Encounter

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-encounter

search

Supported parameters:

• patient. Required. Multi-value support: none. Modifier support: [<type>].

• date. Optional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt].

• _revinclude=Provenance:target

Permitted user types:

• Patient

• Professional

Examples:

GET /Encounter?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a

GET /Encounter?patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=gt2019-01-01

NamingSystem

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-namingsystem

search

Supported parameters:

• value. Required. Multi-value support: none. Modifier support: [exact].

Permitted user types:

• Patient

• Professional

Examples:

GET /NamingSystem?value:exact=urn:uuid:8978a687-cf0f-4cd9-b7e9-f29e76eb5f8d

Observation

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-observation

search

Supported parameters:

• category. Required. Multi-value support: none. Modifier support: none.

• patient. Required. Multi-value support: none. Modifier support: [<type>].

• date. Optional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt, ge, le].

Permitted user types:

• Patient

• Professional

Examples:

GET /Observation?category=http://fhir.patientsknowbest.com/codesystem/observation-category|LABORATORY&patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=2018-07-01

GET /Observation?category=http://fhir.patientsknowbest.com/codesystem/observation-category|LABORATORY&patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&date=ge2018-07-01&date=le2018-07-31

OperationDefinition

read

Permitted user types:

• All

Examples:

GET /OperationDefinition/Consent--purview

Organization

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-organization

read

Permitted user types:

• Professional

Examples:

GET /Organization/235a397b-1ae8-4755-9c77-1a0e2fbc5314

Patient

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-patient

read

Permitted user types:

• Patient

• Professional

• Team Coordinator

• System

Examples:

GET /Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a

search

Supported parameters:

• identifier. Required. Multi-value support: none. Modifier support: none. Supported values: [https://fhir.nhs.uk/Id/nhs-number].

Permitted user types:

• Patient

• Professional

• Team Coordinator

• System

Examples

GET /Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9999999999

Practitioner

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-practitioner

read

Permitted user types:

• Professional

Examples:

GET /Practitioner/fe486948-b6e2-4826-9a7a-f78cf671fea9

ProcedureRequest

Profile: https://dev.patientsknowbest.com/home/fhir-api/structuredefinition/facade-procedurerequest

read

Permitted user types:

• System

Examples:

GET /ProcedureRequest/f1a841f1-6f3a-43fc-830f-e1417b4ff13d

Questionnaire

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaire

read

Permitted user types:

• System

Examples:

GET /Questionnaire/f1a841f1-6f3a-43fc-830f-e1417b4ff13d

search

Supported parameters:

• None

Permitted user types:

• System

Examples:

GET /Questionnaire

QuestionnaireResponse

Profile: http://fhir.patientsknowbest.com/structuredefinition/facade-questionnaireresponse

search

Supported parameters:

• authored. Optional. Multi-value support: AND. Modifier support: none. Prefix support: [eq, gt, lt, ge, le].

• patient. Optional. Multi-value support: none. Modifier support: [<type>].

• questionnaire. Optional. Multi-value support: none. Modifier support: [<type>].

• _include=QuestionnaireResponse:subject:Patient

Permitted user types:

• System

Examples:

GET /QuestionnaireResponse?authored=2019-08-01&patient=Patient/3d8afd18-0844-459a-b3c2-355d02e54c0a&questionnaire=Questionnaire/f1a841f1-6f3a-43fc-830f-e1417b4ff13d

operations

$date-of-last-data-point

http://fhir.patientsknowbest.com/operation/date-of-last-data-point

Permitted user types:

• System

$generate-invitation-tokens

http://fhir.patientsknowbest.com/operation/generate-invitation-tokens

Permitted user types:

• System

$group

http://fhir.patientsknowbest.com/operation/group

Permitted user types:

• Patient

• Professional

$purview

http://fhir.patientsknowbest.com/operation/purview

Permitted user types:

• Patient

• Professional

$read-receipt-query

http://fhir.patientsknowbest.com/operation/read-receipt-query

Permitted user types:

• System

$status-query

http://fhir.patientsknowbest.com/operation/status-query

Permitted user types

• System

$send-questionnaire-request

http://fhir.patientsknowbest.com/operation/send-questionnaire-request

Permitted user types:

• System