Release notes
Previous versions and their release notes can be found below, including links direclty to the respective version of the specification.
1.6.2
DRAFT THIS VERSION
The GP Connect API 1.6.2 release contains numerous changes intended to improve and clarify guidance for both providers and consumers. The more notable changes include:
- Update dose syntax to support Information Standards Notice DAPB4013
- Resources may contain a ‘no disclosure to patient’ security label
- Test groups, test reports and test reports may have many filing comments
- Profiles link through to Simplifier
The changes that are inherited from 1.6.1 can be found in 1.6.1 release notes.
Changes may affect more than one capability. Please see the Affects label for details of the capabilities changed.
General
Updates to capability statement
Affects: Access Documents, Access Record Structured, Foundations
Impacts: Provider and consumer systems
Description:
- version number has been changed to 1.6.2
CareConnect-GPC-Practitioner-1profile version updated to 1.3CareConnect-GPC-ProcedureRequest-1profile version updated to 1.4
Pages changed:
- Get the FHIR® capability statement for Access Document
- Get the FHIR® capability statement for Access Record Structured
- Get the FHIR® capability statement for Foundations
Practitioner.name.family cardinality has been relaxed to optional
Affects: Access Documents, Access Record Structured, Foundations
Impacts: Provider and consumer systems
Description:
- The cardinality of Practitioner.name.family has been relaxed to be optional
Pages changed:
Resources may contain a ‘no disclosure to patient’ security label
Affects: Access Documents, Access Record Structured
Impacts: N/A
Description:
- Resources may have Meta.security populated with a security label indicating information is not to be disclosed to the patient
Pages changed:
- FHIR resources
- AllergyIntolerance
- DiagnosticReport
- Diary entry
- DocumentReference
- Encounter
- Immunization
- MedicationRequest
- MedicationStatement
- Observation
- ProblemHeader (Condition)
- ProcedureRequest
- ReferralRequest
- Specimen
CareConnect-SDSJobRoleName-1 CodeSystem updated with additional job roles
Affects: Access Documents, Access Record Structured
Impacts: Provider and consumer systems
Description:
- A number of additional job roles have been added to the CareConnect-SDSJobRoleName-1 CodeSystem
Pages changed:
- N/A
Profiles link directly to Simplifier
Affects: Access Documents, Access Record Structured, Appointments, Foundations
Impacts: N/A
Description:
- The majority of the Access Record Structured Implementation Guide (IG) that was hosted on developer.nhs.uk has been migrated to this IG (on Simplifier), see the change below. The Links to profiles in other sections of the IG hosted on developer.nhs.uk have been updated to link to the profile hosted on Simplifier within the GP Connect Data Model | FHIR STU3 Representation
Pages changed:
Profiles now linking directly to Simplifier:
- Searchset Bundle
- AllergyIntolerance
- DiagnosticReport
- Diary entry
- DocumentReference
- Encounter
- Immunization
- MedicationRequest
- MedicationStatement
- Observation
- ProblemHeader (Condition)
- ProcedureRequest
- ReferralRequest
- Specimen
Pages in Access Document, Appointment and Foundation capabilities that have been updated:
- Access Documents use case - find a patient
- Appointments Managment
- Appointments data library
- Appointments use case - amend an appointment
- Appointments use case - book an appointment
- Appointments use case - cancel an appointment
- Appointments use case - retrieve appointments
- Appointments use case - search for free slots
- Foundations data library
- Foundations design
- Foundations use case - find a patient
- Foundations use case - find a practitioner
- Foundations use case - find an organisation
- Foundations use case - read a location
- Foundations use case - read a patient
- Foundations use case - read a practitioner
- Foundations use case - read an organisation
- Foundations use case - register a patient
Access Documents
Clarify documents search API author parameter can not be used to search by practitioner
Affects: Access Documents
Impacts: Consumer systems
Description:
- Documents search API author parameter only searches for organisation authors
Pages changed:
Clarify 100MB file size is not a limit for migrate a document
Affects: Access Documents
Impacts: Consumer systems
Description:
- Clarify 100MB file size is not a limit for the migrate a document API response
Pages changed:
Updates to guidance for access to deceased patients’ documents
Affects: Access Documents
Impacts: Provider and consumer systems
Description:
- Clarify that providers MAY provide access to deceased patient’s documents and how they SHOULD respond
- Clarify error response when access attempted outside of access period for Access Document ‘Find a patient’ API
- Clarify error response when access attempted outside of access period for Access Document ‘Search for a patient’s document’ API
- Clarify error response when access attempted outside of access period for Access Document ‘Retrieve a document’ API
Pages changed:
Access Record Structured
IG has been migrated to Simplifier
Affects: Access Record Structured
Impacts: N/A
Description:
- The vast majority of pages within the Access Record Structured IG on the
developer.nhs.ukdomain have been migrated to this IG for GP Connect Access Record Structured - Pages that have not yet been migrated include the API endpoints
Pages changed:
- Almost all pages with the odd exception. Exceptions include the API endpoints
Correct syntax in examples
Affects: Access Record Structured
Impacts: N/A
Description:
- Correct syntax in examples
Pages changed:
Update dose syntax to support Information Standards Notice DAPB4013
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- Dose syntax has been updated to provide compliance with Information Standards Notice ISN DAPB4013
Pages changed:
Clarify handling for MedicationRequest with intent of order when plan has been discontinued
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- The guidance for a MedicationRequest’s status in a scenario where a MedicationRequest with intent of order that is part of a discontinued plan has been clarified i.e. it should not be updated to stopped
Pages changed:
Update Specimen collection.extension[fastingStatus] to include coded concept
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- Specimen collection.extension[fastingStatus] has been updated to be returned as a coding using relevantClincialInformation ValueSet alongside the text
Pages changed:
Add links to clarify guidance for multiple clinical area searches
Affects: Access Record Structured
Impacts: N/A
Description:
- Additional links to existing guidance have been added to the guidance for multiple clinical area searches on patient record retrieval
Pages changed:
Clarify list population for Consultations and Problems
Affects: Access Record Structured
Impacts: N/A
Description:
- Clarify list population for Consultations and Problems within the response payload, based on the info from the Linkages page
Pages changed:
Clarify allergy/intolerance category use
Affects: Access Record Structured
Impacts: Provider systems
Description:
- AllergyIntolerance.category MUST use
medicationwhen allergy type is not distinguishable betweenmedicationandenvironment
Pages changed:
Allow ProcedureRequest.supportingInfo to reference a Resource
Affects: Access Record Structured
Impacts: N/A
Description:
- ProcedureRequest.supportingInfo can reference a Resource, facilitating the linking of a document
Pages changed:
Clarify MedicationStatement.dateAsserted
Affects: Access Record Structured
Impacts: N/A
Description:
- Clarified MedicationStatement.dateAsserted should be the date the authorisation is entered onto the record if the information source is unclear
Pages changed:
DiagnosticReport.identifier may be the lab report ID
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- If the lab report ID uses the NHS PMIP Report Numbers CodeSystem and it could be used by consumers to match lab reports it can be included in DiagnosticReport.identifier
Pages changed:
Test groups, test reports and test results may have many filing comments
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- Test groups, test reports and test results are not limited to a single filing comment. Guidance and diagrams have been updated to reflect this
Pages changed:
Clarify overarching principles for MedicationRequest element population
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
There are two pre-existing overarching principles for populating MedicationRequest. The first is that all mandatory fields MUST be populated and has not changed. The second is how to populate fields that are duplicated in parent profiles, this has changed.
Previously, it was stated:
"Required fields MUST always be populated where the data exists in the system apart from where a lexically identical value exists for an equivalent data item in one of the parent profiles. For a MedicationRequest with
intentofplanthe associated MedicationStatement would be the parent profile. For a MedicationRequest withintentoforder, the associated MedicationStatement and MedicationRequest withintentofplanare both considered parent profiles."
This has been updated to state:
"Required fields MUST be populated where the data exists in the system"
Pages changed:
Remove potentially confusing statement from Medication.code
Affects: Access Record Structured
Impacts: N/A
Description:
- A potentially confusing statement has been removed from the Medication.code element guidance. The (already linked) CodeableConcept guidance document is more prominent
Pages changed:
Clarify how legacy MedicationRequest.prescriptionType data should be handled
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- How to handle MedicationRequest.prescriptionType when no data is available has been clarified
Pages changed:
Fix typo on medication resource relationship diagrams
Affects: Access Record Structured
Impacts: N/A
Description:
- Medication resource relationship diagrams have been corrected so all cardinalities are numeric
Pages changed:
Clarify use of MedicationRequest.dispenseRequest.quantity and MedicationRequest.dispenseRequest.quantityText
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- Clarified how MedicationRequest.dispenseRequest.quantity and MedicationRequest.dispenseRequest.quantityText should be used
Pages changed:
Binding strength for VaccinationProcedure reduced to preferred
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- The binding strength of the VaccinationProcedure extension element for the Immunization profile has been reduced from required to preferred
Pages changed:
- N/A
Update MedicationRequest.medication and MedicationStatement.medication datatype
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- MedicationRequest and MedicationStatement profiles have had the constraint on the medication element relaxed so they align with the base profile i.e. medication can be either a reference or a CodeableConcept. This is to accommodate use cases such as updating the record where only a single medication is needed and a CodeableConcept would mean a separate Medication resource is not needed as there would be no other references to it. The guidance is for both consumers and suppliers to treat the element as if it is a reference.
Pages changed:
Add HealthcareService to list of administrative resources
Affects: Access Record Structured
Impacts: N/A
Description:
- HealthcareService has been listed as an administrative resource
Pages changed:
Remove problem significance filter
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- The problems section of the record was able to be filtered by the significance of the problem via the
filterSignificancepart parameter. This has been removed, leaving only a problem’s status as a filter for problems - Updated requirements catalogue to remove significance filter
Pages changed:
- API version compatibility
- Problem guidance
- Requirements catalogue
- Retrieve a patient’s record in structured format
- Search
Relax requirement for individual areas of the record to be turned on or off at a global level
Affects: Access Record Structured
Impacts: Provider systems
Description:
- The requirement for individual areas of the record to be able to be turned on or off at a global level i.e. applicable to all sites, has been relaxed. Provider systems must continue to support toggling individual areas of the record at a site/practice level, along with responding to requests for areas that have been turned off continues to be the same.
Pages changed:
1.6.1
The GP Connect API 1.6.1-beta release contains:
- changes to enable access to deceased patients records
- making the migrate patient endpoint optional for existing suppliers on the GP IT Futures framework
The changes that are inherited from 1.6.0-beta can be found in 1.6.0 release notes.
Changes may affect more than one capability. Please see the Affects label for details of the capabilities changed.
General
Updates to capability statement
Affects: Access Documents, Access Record Structured, Foundations
Impacts: Provider and consumer systems
Description:
- version number has been changed to 1.6.1
Pages changed:
- Get the FHIR® capability statement for Access Document
- Get the FHIR® capability statement for Access Record Structured
- Get the FHIR® capability statement for Foundations
Access Document
Updates to guidance for access to deceased patients’ documents
Tickets: #1168
Date: 05/04/2023
Affects: Access Documents
Impacts: Provider and consumer systems
Description:
- Updated guidance for providers to allow access to documents for deceased patients
Pages changed:
Migrate patient document interaction is optional for existing suppliers on the GP IT Futures framework and required for New Market Entrants
Affects: Access Documents
Impacts: Provider and consumer systems
Description:
- Added note to state the migrate patient’s document interaction MAY be implemented by existing suppliers on the GP IT Futures framework and MUST be implemented by New Market Entrants
Pages changed:
Access Record Structured
Migrate patient record interaction is optional for existing suppliers on the GP IT Futures framework and required for New Market Entrants
Affects: Access Structured
Impacts: Provider and consumer systems
Description:
- Added note to state the migrate patient’s structured record interaction MAY be implemented by existing suppliers on the GP IT Futures framework and MUST be implemented by New Market Entrants
Pages changed:
Amended referralRequest element descriptions
Date: 23 June 2022
Affects: Access Structured
Impacts: Provider and consumer systems
Description:
- Changed the identifier system for the UBRN including references within examples
- Extended the description for the onBehalfOf element
Pages changed:
Problem Header example category
Tickets: #1177
Date: 27 June 2022
Affects: Access Structured
Impacts: Provider and consumer systems
Description:
- Corrected the code system identifier for the Problem Header condition.category
Pages changed:
Updated common identifier systems
Affects: Access Record Structured
Impacts: Provider and consumer systems
Description:
- Added common identifier system for:
- EPS short form prescription identifier - https://fhir.nhs.uk/Id/eps-line-item-identifier
- e-RS UBRN - https://fhir.nhs.uk/Id/UBRN
- Updated common identifier system:
- for EPS order items - https://fhir.nhs.uk/Id/prescriptions-order-item-number
- removing cross care setting identifier
Pages changed: