Introduction
The GP Connect API 1.2.6 release contains Access Record Structured changes.
The following changes were made to clarify and correct issues in the GP Connect 1.2.6 specification on 9 March 2020:
- Change to medicationRequest extension for repeat medication information. This change was already part of the 1.2.6 release but not listed on the release note.
- Error response when a capability is disabled by the practice. This change was made to Access Record Structured in 1.2.6 to align with error handling added to Access Documents in 1.5.0.
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:
- Update version to use version 1.12 of the GPConnect-GetStructuredRecord-Operation-1
Pages changed:
- Get the FHIR® capability statement
- Get the structured FHIR® capability statement
- Retrieve a patient’s record
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:
- Get the FHIR® capability statement (Access Record Structured)
- New page defining the Access Record Structured capability statement
- Access Record Structured development overview
- Add new metadata interaction ID for the Access Record Structured capability
- Interaction IDs
- Amend naming policy to add capability based disambiguator
- Add new metadata interaction ID for the Access Record Structured capability
- General API guidance
- Update guidance on [PROVIDER_ROUTING_SEGMENT] portion of FHIR service root URLs to indicate that it SHALL be different for different capabilities, except Foundations and Appointment Management where it SHALL remain the same
- SDS - Overview and querying
- Clarify that consumers must not re-use FHIR service root URLs between capabilities as they will be different
- SDS - Registering endpoints
- Update information on format of the Service Root URL
- Cross organisation audit and provenance
- Add the new structured capability statement to the ‘when to use’ list for the requested_scope claim
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:
- GPConnect-GetStructuredRecord-Operation-1
- Retrieve a patient’s record - payload request body
- Retrieve a patient’s record - payload response body
- Retrieve a patient’s record - error handling
- Medication search criteria
Updates to Population of the codeable concept
Tickets:
Affects: Access Record Structured
Impacts: Provider and Consumer systems
Description:
- The codable concept is a fundamental data type in the FHIR specification. In the UK we have extended this data type so that it is able to carry the SNOMED ConceptId AND DescriptionId. Extending in this way means there are a number of ways that these fields could be populated. This document describes in detail how this data type MUST be populated in the UK. Following a change of approach in the SNOMED for primary care project the way in which this is specified has changed significantly. All consumer and provider suppliers need to read the updated guidance in full and ensure they thoroughly understand the different scenarios that can occur and are documented here.
Pages changed:
Change to medicationRequest extension for repeat medication information
Tickets:
Affects: Access Record Structured
Impacts: Provider and Consumer systems
Description:
- The repeat information extension has been changed to support zero values.
- Extension(numberOfRepeatPrescriptionsAllowed) and extension(numberOfRepeatPrescriptionsIssued) have been changed from positiveInt to UnsignedInt.
Pages changed:
Error response when a capability is disabled by the practice
Tickets: #945
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- Add error handling behaviour for each API endpoint when GP Connect as a whole or the Access Record Structured capability is disabled
Pages changed:
- Get the FHIR® capability statement (Access Record Structured)
- Retrieve a patient’s structured record
- Error handling guidance
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
Updated links to profiles on FHIR reference server
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