Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 


GP Connect API 1.2.1 release notes

GP Connect 1.2.1 released on 21 Sept 2018

Introduction

The GP Connect 1.2.1 release contains fixes and clarifications to Appointment Management and Access Record Structured.

Please see below for further details.

1.2.1 changes

Core specification

  • Glossary
    • Definition of Federation elaborated
  • FHIR API guidance
    • Add clarification on lastUpdated. Also removed lastUpdated from examples through the specification.

Foundations

Appointment Management

  • Appointment Management FHIR® resources
    • Remove Extension-GPConnect-DeliveryChannel-1 from GPConnect-Schedule-1 profile
    • Add Extension-GPConnect-DeliveryChannel-2 to GPConnect-Slot-1 profile
    • Add Extension-GPConnect-DeliveryChannel-2 to GPConnect-Appointment-1 profile
    • Add Extension-GPConnect-PractitionerRole-1 extension to GPConnect-Appointment-1 profile
  • Appointment Management Overview
    • Create link to Glossary page for definition of Federation
  • Appointment Management Information Governance
    • Elaborated wording for ‘S-Flagged’ Patients - to be handled by Provider systems as Patient Not Found
  • Retrieve a patient’s appointments
    • Update example response payload with deliveryChannel and practitionerRole extensions
  • Search for free slots
    • Update example response payload to remove deliveryChannel extension from GPConnect-Schedule-1 profile
    • Update example response payload to add deliveryChannel extension from GPConnect-Slot-1 profile
    • Correct searchFilter parameters table to use the correct code system for organisation type
  • Read an appointment
    • Update example response payload with deliveryChannel and practitionerRole extensions
  • Book an appointment
    • Update example response payload with deliveryChannel and practitionerRole extensions
  • Amend an appointment
    • Update example response payload with deliveryChannel and practitionerRole extensions
  • Cancel an appointment
    • Update example response payload with deliveryChannel and practitionerRole extensions
  • Slot availability management
    • Add table to clarify provider rules to apply when combinations of searchFilter parameters are passed by the consumer
Appointments requirements clarifications

During engagement with stakeholders building against GP Connect 1.2.1 the following updates were made to clarify requirements:

  • Book an appointment
    • Clarify that bookingOrganisation.identifier element shall carry an ODS code (previously stated as must support in the Organization profile)
    • Clarify that bookingOrganisation.type shall not be populated if an organization type was not passed to the searchFilter
    • Add violation of Slot Availability Management rules to error handling examples
  • Amend an appointment
    Cancel an appointment

Access Record Structured

  • Business requirements
    • Remove warning message for unreconciled data
    • Numbered acceptance criteria
  • Medication guidance
    • Supply amendment reason in statusReason.reason, not in detectedIssue
    • Clarify guidance for degraded medications
  • List
    • Correct ‘General practice services’ to ‘General practice service’ for extension[clinicalSetting] element in line with SNOMED term
    • Change guidance so data awaiting filing is not returned to the consumer
  • FHIR® resources overview
    • Add code system identifier for Resip UK Gemscript Drug Codes
  • AllergyIntolerance resource
    • Add versionId and lastUpdated to not in use list
  • Medication resource
    • Add versionId and lastUpdated to not in use list
    • Add package to not in use list
  • MedicationStatement resource
    • Add versionId and lastUpdated to not in use list
    • Clarification on PrescribingAgency
    • Amend status element population guidance
    • Amend effective (period) element population guidance
  • MedicationRequest resource
    • Add versionId and lastUpdated to not in use list
    • Amend status element population guidance
    • Amend dispenseRequest.validityPeriod element population guidance
  • List resource
    • Add versionId and lastUpdated to not in use list
  • Bundle resource
    • Add versionId and lastUpdated to not in use list
  • Retrieve a patient’s structured record
    • Add clarifications regarding Bundle order

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