Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 


GP Connect API 1.2.6 release notes

GP Connect API 1.2.6 released on 14th February 2019

Introduction

The GP Connect API 1.2.6 release contains:

1.2.6 changes

Impacts provider and consumer systems

Foundations

Change version number in CapabilityStatement to 1.2.6

Tickets:  #877

Affects:  Foundations

Impacts: Provider systems

Description:

  • Update version number in CapabilityStatement to 1.2.6

Pages changed:


Updated version number in references to GPConnect-GetStructuredRecord-Operation-1

Tickets:  #877

Affects:  Foundations

Impacts: Provider systems

Description:

Pages changed:


Access Record Structured

Create structured capability statement to allow for future separation of Appointments and Structured capabilities

Tickets:  #668

Affects:  Access Record Structured

Impacts: Provider systems

Description:

  • Create new capability statement to describe the Access Record Structured capability only
  • Leave the existing ‘combined’ capability statement in the Foundations capability as-is for the moment to allow a phased transition for Access Record Structured consumer systems. The ‘combined’ capability statement will also continue to remain in place for Appointment Management consumers.
  • Add guidance to indicate that the provider service root URL may be different for Access Record Structured than for the other capabilities
  • added _history to links for profiles so that correct minor version is referenced on the FHIR reference server

Pages changed:


Update to error handling for parameters

Tickets:  #904

Affects:  Access Record Structured

Impacts:  Providers and consumers

Description: 

  • An error condition has been added that states part parameters must not be included without a value
  • Clarification stating that it is valid to include an empty Parameters.parameter in the case where it has only specified with optional part parameters.

Pages changed: 


Update to cross care setting identifier

Tickets:  #917

Affects:  Access Record Structured

Impacts:  Providers and consumers

Description: 

  • Cross care setting identifiers are now scoped by a provider specific namespace
  • identifiers are no longer constrained to be GUIDs
  • multiple identifiers may be included in a response

Pages changed: 


Changes to includeMedication.includePrescriptionIssues

Tickets:  #904

Affects:  Access Record Structured

Impacts:  Providers and consumers

Description: 

  • Cardinality for includeMedication.includePrescriptionIssues in GPConnect-GetStructuredRecord-Operation-1 has been changed to 0..1
  • Optionality for includeMedication.includePrescriptionIssues has been set to Optional in the Payload request body parameter table
  • Payload response body has been updated to indicate that issues will be returned by default
  • An error has been removed from the error handling table regarding returning an error when the includeMedication.includePrescriptionIssues part parameter hasn’t been included in the request
  • bundle population illustrated diagram has been updated to reflect the change to the includeMedication.includePrescriptionIssues parameter
  • Medication guidance has been updated to include guidance around requesting prescription issues

Pages changed: 


Impacts provider systems

Core

Practice based enablement switch

Tickets:  #837

Affects:  Core, Appointment Management, Access Record Structured

Impacts: Provider systems

Description:

  • Change the existing practice based enablement switch requirements from MAY to SHALL
  • Clarify that the switches must be disabled by default
  • Explicitly state that enablement switches requirement auditing (previously relied on catch all ‘audit and provenance’ requirements)

Pages changed:


No impact

Core

Correct SSP OperationOutcome JSON error examples

Tickets:  #661

Affects:  Core

Impacts: Consumer systems

Description:

  • The SSP OperationOutcome examples were incorrect
  • Update the examples with actual error payloads that are produced by the SSP

Pages changed:


Uplift specification versioning page in line with new usage of pre-release labels

Tickets:  #886

Affects:  Core

Impacts: (no impact)

Description:

  • Pre-release labels are now used to indicate the maturity of the GP Connect API rather than the maturity of an individual specification version
  • This has been updated on the specification versioning page

Pages changed:


Refresh the Demonstrator page

Tickets:  #497

Affects:  Core

Impacts: (no impact)

Description:

Refresh and simplify the Demonstrator page wording and diagrams.

Pages changed:


Minor update to XML / JSON FAQ question

Tickets:  #910

Affects:  Core

Impacts: (no impact)

Description:

Generalise the wording of the information on the serialisation format choice for consumers to remove mention of suppliers by name.

Pages changed:


Access Record Structured

Tickets:  #918

Affects:  Access Record Structured

Impacts:  N/A

Description: 

  • links to profiles on the reference server have been updated throughout the specification to use the _history parameter to reference the correct version of the profile


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