Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 


Quick links

GP Connect API 1.2.8 release notes

GP Connect API 1.2.8 released on 1 October 2021

Introduction

The GP Connect API 1.2.8 release contains Appointment Management changes to support service filtering.

1.2.8 changes

Core

FHIR profile changes

Tickets:  #1083

Affects:  Core, Foundations, Appointments

Impacts: Provider systems, consumer systems

Description:

  • FHIR profile changes to support this release

Profiles added:

Profiles changed:

  • GPConnect-Schedule-1
    • Change existing HealthcareService participant to be of type [CareConnect-GPC-HealthcareService-1]
  • GPConnect-Appointment-1
    • Change existing HealthcareService actor to be of type CareConnect-GPC-HealthcareService-1

Add new interaction IDs for Healthcare Service endpoints

Tickets:  #1098

Affects:  Core, Foundations

Impacts: Provider systems

Description:

  • Add two new Spine interaction IDs for the new healthcare service endpoints:
    • Find a healthcare service
    • Read a healthcare service

Pages changed:

Foundations

Get the FHIR capability statement

Tickets:  #1079, #1092

Affects:  Foundations

Impacts: Provider systems

Description:

  • Update version number in CapabilityStatement to 1.2.8
    • Note: this change only applies to the capability statement listed in the pages changed section, and not to the capability statements associated with other capabilities.
  • Add Read a healthcare service endpoint definition
  • Add Find a healthcare service endpoint definition
  • Update Search for free slots endpoint definition
    • Add Schedule:actor:HealthcareService include parameter
    • Add service.identifier search parameter
    • Add extension to carry the service filtering enablement status
  • Add new HealthcareService profile

Pages changed:

Read a healthcare service

Tickets:  #1090

Affects:  Foundations

Impacts: Provider systems, consumer systems

Description:

  • New read healthcare service endpoint to return services from the service list in the organisation configuration for service filtering

Pages added:

Pages changed:

  • FHIR® resources
    • Add read a healthcare service section
    • Add DOS service ID to common identifier systems list
    • General page refresh

Find a healthcare service

Tickets:  #1091

Affects:  Foundations

Impacts: Provider systems, consumer systems

Description:

  • New find a healthcare service endpoint to return services from the service list in the organisation configuration for service filtering

Pages added:

Pages changed:

Appointment Management

Service filtering introduction

Tickets:  #1093

Affects:  Appointment Management

Impacts: Provider systems, consumer systems

Description:

  • Introduce the problem and solution
  • Provide information on intended rollout and scope of use

Pages added:

User stories

Tickets:  #1117

Affects:  Appointment Management

Impacts: Provider systems, consumer systems

Description:

  • Add service filtering user stories to business requirements page

Pages added:

Provider system configuration

Tickets:  #1080, #1081

Affects:  Appointment Management

Impacts: Provider systems

Description:

  • Global supplier-controlled feature visibility switch to support the rollout of service filtering
  • Organisation configuration screen(s) for service filtering, allowing users to:
    • create and maintain a list of services (service IDs and names) provided by their organisation
    • link schedules and services
    • switch on (or switch off) service filtering

Pages added:

Consumer display requirements

Tickets:  #1094

Affects:  Appointment Management

Impacts: Consumer systems

Description:

  • Add service name to the mandatory fields for a consumer to display in:
    • Search for free slots
    • Retrieve a patient’s appointments
  • Add new consumer display requirements for, including service name:
    • Book appointment (this was implied previously but not explicitly stated)

Pages changed:

FHIR resources

Tickets:  #1082

Affects:  Appointment Management

Impacts: Provider systems, Consumer systems

Description:

  • Update the FHIR resource page to include the new HealthcareService resource profile
  • Re-organise the page by splitting the previous diagram into two:
    • Diagram to show resources when searching for free slots
    • Diagram to show resource relationships when booking and managing appointments

Pages changed:

Service discovery

Tickets:  #1095, #1109

Affects:  Appointment Management

Impacts: Consumer systems

Description:

  • Update the Directory of services section of the service discovery page:
    • Add the logic to determine the ODS code to use for GP Connect (mirroring the UEC Appointment Booking specification’s GP Connect workflow example)
    • Add a section on service filtering

Pages changed:

Search for free slots

Tickets:  #1084

Affects:  Appointment Management

Impacts: Provider systems, consumer systems

Description:

  • Introduce new service.identifier request parameter to search on DOS service ID
    • sent by consumers that have used Directory of Services (DOS) to locate a service to book at
  • Introduce new _include parameter to return HealthcareService resources in the response bundle
    • may be sent by any consumer, regardless of the service discovery method

  • Describe the behaviour of the parameters with respect to the service filtering organisation switch

  • Define a new filtering status extension and populate when the consumer sent the service.identifier parameter in the request

  • Define new error condition where a consumer has searched on DOS service ID, but the service ID is not present in the provider organisation’s service list

  • Add new payload examples

Pages changed:

Retrieve a patient’s appointments

Tickets:  #1085

Affects:  Appointment Management

Impacts: Provider systems, consumer systems

Description:

  • Add requirement to return a HealthcareService reference in Appointment resources, where
    • the appointment is linked to a service
    • and the organisation switch is ON
  • Update payload example

Pages changed:

Read an appointment

Tickets:  #1086

Affects:  Appointment Management

Impacts: Provider systems, consumer systems

Description:

  • Add requirement to return a HealthcareService reference in the Appointment resource, where
    • the appointment is linked to a service
    • and the organisation switch is ON
  • Update example

Pages changed:

Book an appointment

Tickets:  #1087

Affects:  Appointment Management

Impacts: Provider systems, consumer systems

Description:

  • Add requirement for consumer to send a HealthcareService reference (where available) in the Appointment resource in the request payload

  • Add requirement for provider to return a HealthcareService reference in the Appointment resource response payload, where
    • the appointment is linked to a service
    • and the organisation switch is ON
  • Reformat example

Pages changed:

Amend an appointment

Tickets:  #1088

Affects:  Appointment Management

Impacts: Provider systems, consumer systems

Description:

  • Add requirement for provider to return a HealthcareService reference in the Appointment resource response payload, where
    • the appointment is linked to a service
    • and the organisation switch is ON
  • Reformat example

Pages changed:

Cancel an appointment

Tickets:  #1089

Affects:  Appointment Management

Impacts: Provider systems, consumer systems

Description:

  • Add requirement for provider to return a HealthcareService reference in the Appointment resource response payload, where
    • the appointment is linked to a service
    • and the organisation switch is ON
  • Reformat example

Pages changed:

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