GP Connect - Access Record Structured

This guidance is under active development by NHS Digital and content may be added or updated on a regular basis.

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
Important: The link to pre-published site needs updated once published.
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: 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, FoundationsImpacts: Provider and consumer systemsDescription:
  • version number has been changed to 1.6.2
  • CareConnect-GPC-Practitioner-1 profile version updated to 1.3
  • CareConnect-GPC-ProcedureRequest-1 profile version updated to 1.4
Pages changed:

Resources may contain a ‘no disclosure to patient’ security label

Affects:  Access Documents, Access Record StructuredImpacts: N/ADescription: Pages changed:

CareConnect-SDSJobRoleName-1 CodeSystem updated with additional job roles

Affects:  Access Documents, Access Record StructuredImpacts: Provider and consumer systemsDescription:
  • A number of additional job roles have been added to the CareConnect-SDSJobRoleName-1 CodeSystem
Pages changed:
  • N/A
Affects:  Access Documents, Access Record Structured, Appointments, FoundationsImpacts: N/ADescription: Pages changed:Profiles now linking directly to Simplifier: Pages in Access Document, Appointment and Foundation capabilities that have been updated:

Access Documents

Clarify documents search API author parameter can not be used to search by practitioner

Affects:  Access DocumentsImpacts: Consumer systemsDescription:
  • 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 DocumentsImpacts: Consumer systemsDescription:
  • 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 DocumentsImpacts: Provider and consumer systemsDescription:
  • 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 StructuredImpacts: N/ADescription: Pages changed:
  • Almost all pages with the odd exception. Exceptions include the API endpoints

Correct syntax in examples

Affects:  Access Record StructuredImpacts: N/ADescription:
  • Correct syntax in examples
Pages changed:

Update dose syntax to support Information Standards Notice DAPB4013

Affects:  Access Record StructuredImpacts: Provider and consumer systemsDescription:
  • 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 StructuredImpacts: Provider and consumer systemsDescription:
  • 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 StructuredImpacts: Provider and consumer systemsDescription: Pages changed:
Affects:  Access Record StructuredImpacts: N/ADescription:
  • 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 StructuredImpacts: N/ADescription: Pages changed:

Clarify allergy/intolerance category use

Affects:  Access Record StructuredImpacts: Provider systemsDescription:
  • AllergyIntolerance.category MUST use medication when allergy type is not distinguishable between medication and environment
Pages changed:

Allow ProcedureRequest.supportingInfo to reference a Resource

Affects:  Access Record StructuredImpacts: N/ADescription:
  • ProcedureRequest.supportingInfo can reference a Resource, facilitating the linking of a document
Pages changed:

Clarify MedicationStatement.dateAsserted

Affects:  Access Record StructuredImpacts: N/ADescription:
  • Clarified MedicationStatement.dateAsserted should be the date the authorisation is entered onto the record
Pages changed:

DiagnosticReport.identifier may be the lab report ID

Affects:  Access Record StructuredImpacts: Provider and consumer systemsDescription:
  • 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:

Clarify overarching principles for MedicationRequest element population

Affects:  Access Record StructuredImpacts: Provider and consumer systemsDescription: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 intent of plan the associated MedicationStatement would be the parent profile. For a MedicationRequest with intent of order, the associated MedicationStatement and MedicationRequest with intent of plan are 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 StructuredImpacts: N/ADescription:
  • 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 StructuredImpacts: Provider and consumer systemsDescription:
  • 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 StructuredImpacts: N/ADescription:
  • 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 StructuredImpacts: Provider and consumer systemsDescription:
  • Clarified how MedicationRequest.dispenseRequest.quantity and MedicationRequest.dispenseRequest.quantityText should be used
Pages changed:

Binding strength for VaccinationProcedure reduced to preferred

Affects:  Access Record StructuredImpacts: Provider and consumer systemsDescription: Pages changed:
  • N/A

Update MedicationRequest.medication and MedicationStatement.medication datatype

Affects:  Access Record StructuredImpacts: Provider and consumer systemsDescription:
  • 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 StructuredImpacts: N/ADescription:
  • HealthcareService has been listed as an administrative resource
Pages changed:

Remove problem significance filter

Affects:  Access Record StructuredImpacts: Provider and consumer systemsDescription:
  • The 'Problems' section of the record was able to be filtered by the significance of the problem via the filterSignificance part parameter. The functionality is not required and has been removed, leaving only a problem's status as a filter for problems. The description of the OperationDefinition has been updated accordingly along with a description of how to handle the situation, should requests be made including the parameter. A link to the existing forward compatibility section has been included
  • Updated requirements catalogue to remove significance filter
Pages changed:

Relax requirement for individual areas of the record to be turned on or off at a global level

Affects:  Access Record StructuredImpacts: Provider systemsDescription:
  • 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:

New requirement for resolved allergies to be returned as transfer-degraded drug allergies

Affects:  Access Record StructuredImpacts: Provider systemsDescription:
  • Resolved allergies are returned within a specific list for ended allergies. The allergy resources returned within the list should be returned as transfer-degraded drug allergies using the appropriate coding system. This change mitigates against the scenario where the resolved attribution is lost during transfer as transfer-degraded resources are not able to be used by decision support.
Pages changed:

Ensure OperationDefinition aligns with profile

Affects:  Access Record StructuredImpacts: Provider and consumer systemsDescription:
  • The description of the OperationDefinition for the retrieve a patient's record API has been updated to ensure it aligns with the profile definition. The filterPrescriptionType part parameter isn't supported by the API but does exist on the profile. As a result, it has been added to the description and made clear it isn't supported. How to handle the situation, should requests be made including the parameter, has been described and a link to existing forward compatibility section has been included
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, FoundationsImpacts: Provider and consumer systemsDescription:
  • version number has been changed to 1.6.1
Pages changed:

Access Document

Updates to guidance for access to deceased patients’ documents

Tickets: #1168Date: 05/04/2023Affects: Access DocumentsImpacts: Provider and consumer systemsDescription:
  • 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 DocumentsImpacts: Provider and consumer systemsDescription:
  • 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 StructuredImpacts: Provider and consumer systemsDescription:
  • 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

Tickets: #1176, #1180Date: 23 June 2022Affects: Access StructuredImpacts: Provider and consumer systemsDescription:
  • 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: #1177Date: 27 June 2022Affects: Access StructuredImpacts: Provider and consumer systemsDescription:
  • Corrected the code system identifier for the Problem Header condition.category
Pages changed:

Updated common identifier systems

Affects: Access Record StructuredImpacts: Provider and consumer systemsDescription: Pages changed:
back to top