Resource mapping summary

This page summarises the resources currently supported in our production environments.

Please see the subpages for full details of each resource.

Details of upcoming additions and improvements to our supported resources can be found in the Roadmap section of this site.

FHIR Resource	PKB Entities	Supported Interactions	Example Use Cases
Appointment	[[Appointment]] [[Appointment Participant]]	search	See here for example calls. Search for a patient's appointments
CapabilityStatement	N/A	capabilities	Retrieve a list of functionality supported by this server. This is a technical resource to support the API.
Communication	[[Conversation]] [[Message]]	search	See here for example calls. Search for a patient's messages
Consent	[[Consent Record]]	search	See here for example calls. Search for the teams a patient is currently, or has previously been, admitted to Search for a patient's carers
DiagnosticReport	[[Radiology Report]]	search	See here for example calls. Search for a patient's radiology reports
DocumentReference	[[Document]]	search	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	[[Encounter]] [[Encounter Event]]	search	See here for example calls. Search for a patient's encounters
NamingSystem	[[Local ID Type]] [[Organisation Level ID Type]] [[Team Level ID Type]]	search	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	[[Lab Result]]	search	See here for example calls. Retrieve a patient's lab results (currently only metadata supported)
OperationDefinition	N/A	read	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	[[Organisation]] [[Team]]	read	See here for example calls. Retrieve the name of the Team an authenticated actor is a member of
Patient	[[Patient]] [[National ID]] [[Local ID]] [[Organisation Level ID]] [[Team Level ID]] [[Contact]]	read search	See here for example calls. Retrieve demographics for a patient whose resource ID you already know Search for a patient by NHS number
Practitioner	[[Professional]]	read	See here for example calls. Retrieve the details of the currently authenticated actor
Provenance	[[Source]]	None.	This resource cannot be searched directly. It might be returned to you in the response from another search.
RelatedPerson	[[Patient]] (when acting as a carer)	None.	This resource cannot be searched directly. It might be returned to you in the response from another search.