FHIR Resource | PKB Entities | Supported Interactions | Example Use Cases |
Appointment | | | - Search for a patient's appointments
|
CapabilityStatement | N/A | | - Retrieve a list of functionality supported by this server. This is a technical resource to support the API.
|
Communication | | | See here for example calls.
- Search for a patient's messages
|
Consent | | | - Search for the teams a patient is currently, or has previously been, admitted to
- Search for a patient's carers
|
DiagnosticReport | | | See here for example calls.
- Search for a patient's radiology reports
|
DocumentReference | | | See here for example calls.
- Search for a patient's documents
- Read receipts - search for documents sent by your organisation, on a given date, which have been read by the patient
|
Encounter | | | See here for example calls.
- Search for a patient's encounters
|
NamingSystem | | | See here for example calls.
- Retrieve the display name of a local identifier that was returned to you in a Patient resource. You would not normally need to interact with this endpoint without having first obtained a Patient resource.
|
Observation | | | See here for example calls.
- Retrieve a patient's lab results (currently only metadata supported)
|
OperationDefinition | N/A | | See here for example calls.
- Retrieve the OperationDefinition resource for a supported operation returned in the CapabilityStatement. This is a technical resource to support the API.
|
Organization | | | See here for example calls.
- Retrieve the name of the Team an authenticated actor is a member of
|
Patient | | | See here for example calls.
- Retrieve demographics for a patient whose resource ID you already know
- Search for a patient by NHS number
|
Practitioner
| | | See here for example calls.
- Retrieve the details of the currently authenticated actor
|
Provenance | | None. | This resource cannot be searched directly. It might be returned to you in the response from another search. |
Questionnaire | | | See here for example calls.
- Retrieve a questionnaire whose resource ID you already know
- Search for a questionnaire
|
QuestionnaireResponse | | | See here for example calls.
- Search for responses to a questionnaire
|
RelatedPerson | | None. | This resource cannot be searched directly. It might be returned to you in the response from another search. |