Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 


GP Connect API 1.6.0-beta release notes

GP Connect API 1.6.0 released on 30th June 2021

Introduction

The GP Connect API 1.6.0-beta release contains:

  • Updates to support using GP Connect for GP2GP

This version is still in development and is dependant on the development of the Patient Switching Standard.

The changes that are inherited from 1.5.0-beta can be found in 1.5.0 - working release notes.

Changes may affect more than one capability. Please see the Affects label for details of the capabilities changed.

1.6.0 changes


Updates to JWT token

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • An additional reason_for_request has been added, migration
  • Additonal requested_scope values have been defined to allow retrieval of confidential and sensitive information
  • requesting_practitioner has been updated, it doesn’t need to be provided for a GP2GP record transfer
  • Added migrate patient record interaction to values for requested_scope
  • default value for requested_scope is conf/N

Pages changed:


Added migrate patient record interaction

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • A new interaction has been added for the migrating patient record use case
  • A new includeFullRecord parameter has been added with a part parameter includeSensitiveInformation
  • An error condition has been added to cover unauthorised requests for sensitive information
  • records can be returned for inactive patients
  • added interaction diagram
  • Guidance has been added on how requests for sensitive information should be authorised
  • Guidance on how to populate a response to the includeFullRecord parameter has been added
  • This interaction is unaffected by clinical area configuration and whether the structured capability has been enabled
  • Added interaction ID urn:nhs:names:services:gpconnect:fhir:operation:gpc.migratestructuredrecord-1 to GPC interactions
  • an error has been added for unrecognised parameters

Pages changed:


Added migrate document interaction

Affects:  Access Documents

Impacts: Provider and consumer systems

Description:

  • Addition of an interaction specifically for use by the Migrate a patient’s structured record use case
  • This interaction is unaffected by clinical area configuration and whether the documents capability has been enabled
  • sensitive documents can be retrieved
  • The file size limit has been increased from 5MB to 100MB.

Pages changed:


Updates to search criteria

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Guidance on how to return the full record using the migrate patient record interaction has been added

Pages changed:


Updates to capability statement

Affects:  Access Structured, Access Documents

Impacts: Provider and consumer systems

Description:

  • version number has been changed to 1.6.0
  • migrate patient record Operation has been added

Pages changed:


Updates to error codes for migrate a patient’s structured record

Tickets: #1173

Date: 16 May 2022

Affects: Access Structured

Impacts: Provider and consumer systems

Description:

  • Updated error codes for migrate a patient’s structured record request

Pages changed:



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