Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Resources Overview

This page provides an overview of the FHIR STU3 Resources that are required to build the required API messaging. Each link will take you to the resource page detail with a link to the StructureDefinitions of each resource.

Urgent & Emergency Care Appointments API’s

The “disposition” from the patient interaction (NHS111 call etc) determines the urgency (giving the time bounds). The DOS (Directory of Services) will have been interrogated and an appropriate service for the Patient identified.

  • The time bounds and a specific service identifier are passed to the API
  • The provider system searches for free slots within the time period given, for the identified service
  • The Patient (or the 111 call handler) will review the free slots & pick one
  • The provider system will then be sent the slot details & patient detail and will book an appointment into the slot

Requirement FHIR Resource(s) Key FHIR Elements(s) Status
Patient Care Connect Patient identifier(NHSnumber)
Name
birthDate
Gender
Existing
Practitioner Care Connect Practitioner SDSUserid
Name
Existing
PractitionerRole Care Connect PractitionerRole SDSJobRoleName Existing
Organization Care Connect Organization type
name
telecom
address
contact
Existing
Location Care Connect Location status
name
alias
description
telecom
address
managing org
part of
Existing
HealthcareService HealthcareService provided by
location
name
comment
telecom
New
Slot Slot schedule
status
start
end
service category
appointment type
New
Schedule Schedule actor.reference New
Appointment Appointment status
participant.actor
reason
slot
New
DocumentReference DocumentReference TBC New

All content is available under the Open Government Licence v3.0, except where otherwise stated