Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 


GP Connect API 1.3.0-beta release notes

GP Connect API 1.3.0-beta released on 28th June 2019

Introduction

The GP Connect API 1.3.0-beta release introduces additional profiles and an extended API for accessing the Access Record Structured capability.

1.3.0 changes

Access Record Structured

Addition of FHIR® resources to support consultations, problems, immunizations and uncategorised data

Affects  Access Record Structured

Description:

  • The following FHIR® resources have been added:
    • Observation
    • Encounter
    • ProblemHeader
    • Immunization

Pages changed:

Addition of pages for development introduction

Affects  Access Record Structured

Description: Added details oabout how records are structured in GP systems, how we have used FHIR to model the different clinical areas and which areas will be covered in this release.

Pages changed: Development Introduction

Addition of pages for resource populationfundamentals

Affects  Access Record Structured

Description: Includes additions for:

  • populating the codable concept guidance is now more prominent
  • Added definitions of optionality and use of the ‘Must support’ flag in the FHIR&reg profiles.
  • Moved the guidance on populating the list profile here
  • Updated the lists of code and identifier system

Pages changed: Resource population fundamentals

Addition of page describing linkages and search criteria

Affects  Access Record Structured

Description:

  • How FHIR profiles are linked together
  • Search Criteria and scale of searches

Pages changed:

Addition of guidance on how to populate consultation resources

Affects  Access Record Structured

Description:

  • Overview of populating consultations
  • Population of Encounter profile
  • Population of List profiles

Pages changed:

Addition of guidance on how to populate problem resources

Affects  Access Record Structured

Description:

  • Overview of populating problems
  • Population of ProblemHeader profile

Pages changed:

Addition of guidance on how to populate immunization resources

Affects  Access Record Structured

Description:

  • Overview of populating immunisations
  • Population of Immunizaton profile

Pages changed:

Addition of guidance on how to populate uncategorised data resources

Affects  Access Record Structured

Description:

  • Overview of populating uncategorised data
  • Population of Observation profile

Pages changed:

Updates to CareConnect-GPC-List-1 profile

Affects  Access Record Structured

Description:

  • Update to support multiple warning messages
  • Added in extension to support problem references to consultations

Pages changed:

Parameters added to OperationDefinition GPConnect-GetStructuredRecord-Operation-1 to support retrieval of new resources

Affects  Access Record Structured

Description:

  • The following parameters have been added to the GPConnect-GetStructuredRecord-Operation-1 to support the retrieval of the new FHIR profiles:
  • includeConsultations
    • consultationSearchPeriod
    • includeNumberOfMostRecent
  • includeProblems
    • includeStatus
    • includeSignificance
  • includeImmunisations
  • includeUncategorised
    • uncategorisedSearchPeriod

Pages changed:

Introduction of forwards compatibility support by providers

Affects  Access Record Structured

Description:

  • This version of the GP Connect API specification requires a mechanism for handling forwards compatibility due to the introduction of new profiles. Providers are now required to warn consumers about parameters that were unrecognised.
  • Consumers must check for the presence of warnings about unrecognised parameters

Pages changed:

Update to error handling

Affects  Access Record Structured

Description:

  • Error handling for the Access Record Structured capability has been updated so that:
    • providers no longer reject requests that included unrecognised parameters.
    • date search parameters for consultations and uncategorised data containing future dates are rejected
    • searches containing unrecognised clinical status and clinical significance values for problem searches are rejected
    • searches containing both a consultation search period and number of recent consultations are rejected

Pages changed:

Update to GPConnect-GetStructuredRecord-Operation-1 response

Affects  Access Record Structured

Description:

  • sections have been added on how providers must respond to request for new parameters.
  • bundle population diagram has been updated to include new FHIR® resources

Pages changed:

Reorganisation of Access Record Structured capability menu

Affects  Access Record Structured

Description:

  • The menu for the Access Record Structured capability has been reorganised by clinical area to aid navigation.

Update to design decisions page

Affects  Access Record Structured

Description:

  • page has been updated to include decisions on new search parameters

Pages changed:

  • Access Record Structured design

Update to business requirements

Affects  Access Record Structured

Description: Catalogue and business requirements updated to include all new areas covered.

Pages changed:

Foundations

Updated capability statement

Affects  Foundations

Description:

  • Version number has been updated to 1.3.0
  • References to additional FHIR® profiles have been added
  • Consumers should now check the version number to support forwards compatibility.

Pages changed:


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