GP Connect API 1.2.7 released on 5th May 2020

Introduction

The GP Connect API 1.2.7 release contains priority Foundations and Appointment Management changes to support appointment booking.

1.2.7 changes

Foundations

Change version number in CapabilityStatement to 1.2.7

Tickets:  #905

Affects:  Foundations

Impacts: Provider systems

Description:

• Update version number in CapabilityStatement to 1.2.7

Pages changed:

• Get the FHIR® capability statement

---

Register patient flow fails when patient is active but not PDS traced

Tickets:  #921

Affects:  Foundations

Impacts: Provider systems, Consumer systems

Description:

The Find Patient/Register Patient flow can fail where an active patient’s NHS number has not been verified (via a PDS trace or cross check, or via NHAIS tracing):

1. Consumer system calls Find Patient.
2. Provider system matches an active patient record, but which has not been PDS traced, and so returns an empty bundle.
3. Consumer system receives the empty bundle, and so calls Register Patient.
4. Provider system receives the Register Patient call, starts registration process, finds an active patient and so returns a DUPLICATE_REJECTED error.
5. Consumer cannot continue to book an appointment for this patient.

In order to prevent the above flow from failing, where a Find Patient call matches an active patient record with an NHS number that has not been verified, the provider system shall now attempt to verify the patient’s NHS number on PDS.

Important: This issue was detected in an ‘extended hours hub’ organisation where PDS tracing was enabled some time after the organisation had opened and consequently a number of active patients had never been PDS traced or synchronised. It is not expected this logic will be frequently used in GP practices since PDS is generally well established and most if not all patients will have been traced on PDS (or indirectly via NHAIS).

Pages changed:

• Find a patient
  • Add provider system unverified record requirements

---

Appointment Management

Populate slot type and schedule type in Slot, Schedule and Appointment resources

Tickets:  #912

Affects:  Appointment Management

Impacts: Provider systems, Consumer systems

Description:

• Expose the practice defined free text ‘slot type’ and ‘schedule type’ (also known as session name or rota type)
• This is to bring GP Connect in line with other external interfaces and applications such as the NHS App, IM1, plus patient facing websites
• Add requirement on consumer system to display the new fields
• serviceCategory.text and serviceType.text FHIR fields will be used to transport the fields

Profiles changed:

• GPConnect-Schedule-1
  • Align cardinality of serviceCategory with base resource
• GPConnect-Slot-1
  • Align cardinality of serviceType with base resource
• GPConnect-Appointment-1
  • Align cardinality of serviceCategory with base resource
  • Align cardinality of serviceType with base resource

Pages changed:

• Search for free slots
  • Add consumer requirement to display slot type and schedule type
  • Add provider requirement to populate slot type, and where available schedule type
  • Add Schedule.serviceCategory and Slot.serviceType fields in payload response example
  • Remove Schedule.comment field from payload response example
• Retrieve a patient’s appointments
  • Add consumer display requirements (the same same those in Search for free slots)
  • Add provider requirement to populate slot type, and where available schedule type
  • Add Appointment.serviceCategory and Appointment.serviceType fields in payload response example
• Read an appointment
  • Add provider requirement to populate slot type, and where available schedule type
  • Add Appointment.serviceCategory and Appointment.serviceType fields in payload response example
• Book an appointment
  • Update multiple adjacent slot booking requirements
  • Add provider requirement to populate slot type, and where available schedule type
  • Add Appointment.serviceCategory and Appointment.serviceType fields in payload response example
• Amend an appointment
  • Add provider requirement to populate slot type, and where available schedule type
  • Add Appointment.serviceCategory and Appointment.serviceType fields in payload response example
• Cancel an appointment
  • Add provider requirement to populate slot type, and where available schedule type
  • Add Appointment.serviceCategory and Appointment.serviceType fields in payload response example