Resources


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 ResourcePKB EntitiesSupported InteractionsExample Use Cases
Appointment
  • search
  • Search for a patient's appointments
CapabilityStatementN/A
  • capabilities
  • Retrieve a list of functionality supported by this server. This is a technical resource to support the API.
Consent
  • search
  • Search for the teams a patient is currently, or has previously been, admitted to
  • Search for a patient's carers
DiagnosticReport
  • search
See here for example calls.
  • Search for a patient's radiology reports
DocumentReference
  • 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
NamingSystem
  • 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
  • search
 See here for example calls.
  • Retrieve a patient's lab results (currently only metadata supported)
OperationDefinitionN/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
  • read
See here for example calls.
  • Retrieve the name of the Team an authenticated actor is a member of
Patient
  • 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

  • read
See here for example calls.
  • Retrieve the details of the currently authenticated actor
ProvenanceNone.This resource cannot be searched directly. It might be returned to you in the response from another search.
RelatedPersonNone.This resource cannot be searched directly. It might be returned to you in the response from another search.