Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 


GP Connect API 1.5.0-beta release notes

GP Connect API 1.5.0-beta released on 27th February 2020

Introduction

The GP Connect API 1.5.0-beta release contains:

  • The Access Document capability, which was previously published separately, has been added into this specification.
  • Access Record Structured:
    • Support for diary entries
    • Support for immunisations not given

Changes may affect more than one capability. Please see the Affects label for details of the capabilities changed.

This release also contains updates from the following releases:

1.5.0 changes

These release notes now incorporate entries from the 1.4.0, 1.4.1, Access Documents 1.0.0 and Access Documents 1.0.1 specifications that were merged into 1.5.0

Access Document

Description:

  • A new sub-menu item for Access Record Documents has been added to the Implement a capability menu. The Access Record Documents specification includes retrieval of a structured list of documents or retrieval of individual documents.
  • The menu item links to the GP Connect versions page so the appropriate version of the new Access Record Documents specification can be selected as versions of the specifications may change independently.

Page added:


Tickets: #895

Affects:  Core

Impacts: No impact

Description:

  • Added Send DOcument to the capabilities page
  • Added a sub-menu item for Send Document to the Implement a capability menu.
  • These new items link to a Send Document page which references the GP Connect versions page so the appropriate version of the Send Document specification can be selected as versions of the specifications may change independently.

Page added:


Added interaction IDs for Access Documents API

Affects  Integrate with spine

Description:

  • Interaction ids have been added for the query and retrieval APIs
  • interaction ids have been added for the patient, organisation and practitioner APIs

Pages changed:


Merge separate Access Document 1.0.1 specification into this GP Connect API 1.5.0 specification

Tickets: #933

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • The Access Document specification will no longer be published independently of this specification (GP Connect API 1.x.x).
  • An Access Document capability has been created under this specification and the content of the previously separate Access Document has been merged in.
  • The release notes from before the merge can be viewed here:

API

Affects  Access Documents

Description:

  • Restful APIs have been defined for querying and retrieving documents
  • Restful APIs have been added for patient, organisation and practitioner
  • Consumer sessions page has been added to illustrate how APIs are used

Pages changed:

Updated Access Document capability statement

Tickets: #934

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • Version number has been updated to 1.5.0
  • Add minor version numbers to profiles listed in the capability statement
  • Reword the page to make clear it is a capability statment describing the Access Document capability only

Pages changed:


Update service root URL definition to cater for different URLs per capability

Tickets: #935

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • Update service root URL definition to accomodate the Access Document capability API being defined as its own FHIR server

Pages changed:


Change search for patient documents to use patient compartment based URL

Tickets: #941

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • Change search for patient documents to use a patient compartment based URL

  • Previously: /DocumentReference?patientId=111&queryParam=

  • Now: /Patient/111/DocumentReference?queryParam=

Pages changed:


Correct Patient _include parameter for Search for a patient’s documents

Tickets: #942

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • The syntax of the Patient _include parameter for Search for a patient’s documents was incorrect and has been updated

Pages changed:


Find Patient should return only patient records with a Regular/GMS registration type

Tickets: #938

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • Find Patient is Access Document should return only return patients who have a Regular/GMS registration type (i.e. patients where this is their registered practice)
  • Temporary, emergency and other non regular registration types must be excluded from the results
  • This behaviour applies only to Find Patient in the Access Document capability

Pages changed:


Add explicit error response codes for Access Document API

Tickets: #937

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • Add explicit error handling response for Access Document calls

Pages changed:


Error response when a capability is disabled by the practice

Tickets: #943

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • Add error handling behaviour for each API endpoint when GP Connect as a whole or the Access Document capability is disabled

Pages changed:


Updated facility search parameter to use a token

Tickets: #965

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • the facility parameter now uses a token instead of an identifier as its datatype

Pages changed:


Clarification of Bundle.fullUrl

Tickets: #967

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • Clarification has been added on use of URLs in Bundle.fullUrl. They MUST be used even when not resolvable as these are intended for use by consumers when resolving references in the bundle and not for retrieving resources..

Pages changed:


Updates to search for patient’s documents examples

Tickets: #972, #968

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • updated created parameter to use a valid date
  • added examples of search parameters

Pages changed:


Access Record Structured

Add immunisations not given

Tickets: #849

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • added includeNotGiven part parameter to GPConnect-GetStructuredRecord-Operation-1 with a default value of false
  • added includeDissentConsent part parameter to GPConnect-GetStructuredRecord-Operation-1 with a default value of false
  • updated bundle population diagram to include includeNotGiven and includeDissentConsent part parameters
  • Updated immunisation guidance to include details of inclusion of immunisation not given for providers
  • Added guidance for consumers for handling immunisations not given
  • Updated immunization profile to include additional guidance and valuesets

Pages changed:


Add Investigations

Tickets: #902

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Added general guidance page for Investigations
  • Added description of populating the profiles for Diary Entries
  • Updated pages referring to clinical areas to include Investigations
  • Added includeInvestigations and investigationSearchPeriod part parameter to GPConnect-GetStructuredRecord-Operation-1
  • added error handling guidance for investigationSearchPeriod
  • updated bundle population diagram to include Investigations

Add Outbound Referrals

Tickets: #902

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Added general guidance page for Outbound Referrals
  • Added description of populating the profiles for Outbound Referrals
  • Updated pages referring to clinical areas to include Outbound Referrals
  • Added includeReferrals and referralSearchPeriod part parameter to GPConnect-GetStructuredRecord-Operation-1
  • added error handling guidance for referralSearchPeriod
  • updated bundle population diagram to include Outbound Referrals

Add Diary Entries

Tickets: #902

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Added general guidance page for Diary Entries
  • Added description of populating the ProcedureRequest profile for Diary Entries
  • Added example for Diary Entries
  • Updated pages referring to clinical areas to include Diary Entries
  • added includeDiaryEntries parameter and diaryEntriesSearchDate part parameter to GPConnect-GetStructuredRecord-Operation-1
  • added error handling guidance for diaryEntriesSearchDate
  • updated bundle population diagram to include diary entries

Pages changed:


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: 


Updates to profiles

Affects:  Access Record Structured

Impacts:  Providers and consumers

Description: 

Pages changed: 


Correction to Consultation List guidance

Tickets:  #983

Affects:  Access Record Structured

Impacts:  Providers and consumers

Description: 

  • the problemReference extension has been corrected to be relatedProblemHeader

Pages changed:


Updates to structured capability statement

Affects:  Access Record Structured

Impacts:  Providers and consumers

Description: 

  • update version number in CapabilityStatement to 1.5.0
  • update minor version numbers in profile listing
  • update OperationDefinition minor version number

Pages changed:


Updated capability statement

Tickets:

Affects:  Foundations

Impacts: Provider and consumer systems

Description:

  • Version number has been updated to 1.5.0

Pages changed:


Not permitted parameters list has been updated to include diary entries, immunisations and referrals

Affects:  Access Record Structured

Impacts:  Providers and consumers

Description: 

  • Part parameters have been added
    • includeReferrals.referralSearchPeriod
    • includeDiaryEntries.diaryEntriesSearchDate
    • includeImmunisations.includeNotGiven
    • includeImmunisations.includeDissentConsent

Pages changed:


Updates to investigations examples

Tickets:

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Removed includeMedication and includeAllergies parameters from both requests
  • Corrected duplicate id being used across multiple Observation resources
  • added type to Observation.related
  • removed use of Bundle.identifier

Pages changed:


Update issued on 31st July 2020

The following changes were made to clarify and correct issues in the GP Connect 1.5.0 specification

Core

Tickets:

Affects:  Core

Impacts: Provider and consumer systems

Description:

  • The statement saying that all references SHALL be relative has been removed due to DocumentReference resources using full URLs for document locations

Pages changed:


Access Document

Updates to CapabilityStatement

Tickets:

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • CapabilityStatement for Access Document has been updated so that correct types are used for search parameters
  • subject, type and facility have been removed from search parameters
  • the read interaction has been removed from Patient.

Pages changed:


Example updates

Tickets:

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • An error was fixed with the date in the example of searching for a patient’s documents

Pages changed:


Clarification of Bundle.fullUrl population

Tickets:

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • Guidance has been added to Bundle.fullUrl in the Access Document capability

Pages changed:


Updates to find patient API

Tickets:

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • The error condition for an INVALID_IDENTIFIER_SYSTEM in Find a patient has been changed to INVALID_PARAMETER

Pages changed:


Updates to document search API

Tickets:

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • The facility parameter was updated to use a token instead of an identifier when searching for a patient’s documents.
  • Practitioner and PractitionerRole resources for supplementary actors have been added to the response payload
  • The type and facility search parameters have been removed from the search API in the Access Documents capability
  • The description parameter has been updated to state it’s a keyword based search and that DocumentReference.type and DocumentReference.title will be searched.

Pages changed:


Updates to DocumentReference population guidance

Tickets:

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • Guidance for the DocumentReference profile has been updated, the MIME type for the document is now recorded in content.attachment.contentType. This replaces the use of content.format.
  • DocumentReference.context.practiceSetting guidance updated so text can be used where code is outside of refset
  • DocumentReference.identifier guidance has been updated in line with use of identifier attributes in Access Record Structured
  • DocumentReference.content.attachment.title SHOULD be populated with a reason when a document is unavailable

Pages changed:


Access Record Structured

Updates to Retrieve a patient’s structured record API

Tickets:

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Not permitted parameter combinations have been updated to include diary entries and referral
  • Access denied has been updated to use the value from the value set, ACCESS DENIED

Pages changed:


Updates to examples

Tickets:

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Issues in the diary entry example have been fixed
  • Updates were made to the investigations examples in the Access Record Structured capability
  • The consultations example has been updated to use the new Lists guidance

Pages changed:


Updates to Consultation List profile guidance

Tickets:

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Guidance for the List profile for Consultations has been updated, the problemReference extension has been corrected to relatedProblemHeader to match the profile

Pages changed:


Update to multiple search parameters guidance

Tickets:  #1004

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Guidance has been extended for requests using multiple search parameters
  • Common search definitions have been added

Pages changed:


Update to Lists guidance

Tickets:  #1007

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • The definition of Lists has been extended to introduce secondary lists to describe the bundle content
  • Guidance for populating lists with warning codes has been updated to reflect the additional lists
  • A new page has been created to incorporate the extended List guidance with some content moved from the resource population fundamentals page
  • The linkages page has been updated and extended to reflect these changes

Pages changed:


Update to Problems guidance

Tickets:  #1008, #1010

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • The list of clinical item references has been updated to include consultations / encounters
  • Guidance for out of scope items (complete diary entries and test requests outside of investigations) which are linked to problems

Pages changed:


Update to Problem Header profile guidance

Tickets:  #1012

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Update to the actualProblem extension guidance to include all clinical areas for this specification
  • Update to the relatedClinicalItems extension guidance to include all clinical areas for this specification

Pages changed:


Update to Consultation guidance

Tickets:  #1009

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Detail on returning out of scope items from clinical areas as text has been added

Pages changed:


Update to include Inbound Referrals in Uncategorised Data

Tickets:  #1013

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Inbound referrals referenced in scope of uncategorised data
  • Referrals guidance references inbound referrals covered by uncategorised data

Pages changed:


Update to doduments returned in Access Record Structured

Tickets: 

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • A note has been added to the linkages page to state that consumers must have implemented the Access Document capability to retrieve documents linked from returned DocumentReference resources
  • The documents guidance page has been updated to state that consumers must have implemented the Access Document capability to retrieve documents linked from returned DocumentReference resources

Pages changed:


Update issued on 1st October 2020

The following changes were made to clarify and correct issues in the GP Connect 1.5.0 specification

Known issues with the specification are documented on the Known issues page


Access Record Structured

Update to Investigations diagrams

Tickets:  #1021

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Diagrams changed to reflect filling comments are referenced from the diagnostic report and not the other direction

Pages changed:


Empty list guidance

Tickets:  #900

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Corrected the empty reason code for investigations and referrals

Pages changed:


Filing comments for a test result

Tickets:  #1024

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Guidance for the filling comments observation profile has been updated to reference population of elements where the comments relate to a single test result

Pages changed:


Clarification around partial and unknown dates for date searches

Tickets:  #949

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Clarification has been added around how information with partial or unknown dates should be returned for clinical areas which have date search parameters

Pages changed:


Configuration of supported clinical areas

Tickets:  #1026

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • A page has been added with guidance on how provider systems MUST be able to configure which clinical areas are available
  • The API has been updated to state how unavailable clinical areas are returned
  • Guidance on unavailable clinical areas has been added to the Linkages page

Pages changed:


Confidential items in consultations

Tickets:  #1029

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Updated the description for confidential items in consultations to reference secondary lists

Pages changed:


Fixed issue in requests in multi area searches page

Tickets:  #1030, #1023

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Example requests have been updated to be valid requests. The example now says 365 days instead of 1 year.

Pages changed:


Updated the guidance around blood pressure following the curation outcomes

Tickets:  #1027, #1028

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Updated to describe how bp’s are recorded in GP systems and include details of which blood pressures should be exported as a triple.

Pages changed:


Updated the guidance around fasting status in investigations specimens

Tickets:  #1018

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Updated to describe how to populate the fasting status with data from EDIFACT.

Pages changed:


Updated the guidance on how and when to populate list.date

Tickets:  #1014

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Updated to describe how to populate the list.date field.

Pages changed:


Updated the guidance on using lists to return data

Tickets:  #1022

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Following curation this has been updated to reflect the new secondary list codes

Pages changed:


Uncategorised data value units

Tickets:  #754

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Added a note to the Uncategorised data observation page that suppliers MUST use the units from the FHIR spec vital signs page.

Pages changed:


Immunisations not given

Tickets:  #977, #987

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Updated guidance and profile definition following addition of ‘not done’ situation codes to the valueset for the vaccination procedure

Pages changed:


Corrected author search parameter type

Tickets:  #1032

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • Corrected description of author parameter to be a token in line with the rest of the specification

Pages changed:


Updates following last release

The following changes were made to clarify and correct issues in the GP Connect 1.5.0 specification:

Updates to Access Record Structured profile versions

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • The versions for profiles have been uplifted following curation
    • Condition - ProblemHeader
    • Observation
  • The CapabilityStatement has been updated to use the updated versions

Pages changed:


Updates to Access Documents profile versions

Affects:  Access Documents

Impacts: Provider and consumer systems

Description:

  • The versions for profiles have been uplifted
    • DocumentReference
  • The CapabilityStatement has been updated to use the updated versions

Pages changed:


Document retrieval file size limit

Affects:  Access Documents

Impacts: Provider and consumer systems

Description:

  • A file size limit has been introduced to the Access Documents capability, documents over 5mb will not be retrievable.
  • An error will be returned by the provider system if a document larger than 5mb is requested

Pages changed:


Clarification on file size population

Affects:  Access Documents

Impacts: Provider and consumer systems

Description:

  • Clarification on how to set file size for documents that aren’t available

Pages changed:


Updates to clinical area configuration

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • A list of configurable clinical areas has been added
  • The warning has been updated for populating an OperationOutcome
  • Guidance on populating references has been added

Pages changed:


Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • The includeDissentConsent part parameter has been updated to includeStatus
  • Observations representing the status of a patient’s immunisations will be returned

Pages changed:


Updated guidance for immunisations

Tickets:  #1036, #1053, #987,

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Medication records for immunisations are treated as medications and returned against medication not immunisation requests
  • Guidance on notes population updated to remove reference to free text manufacturer
  • Extended scope from inclusion of consent and dissent information to cover any coded information recorded within an immunisation module or categorised as immunisation data in the GP system

Pages changed:


Bundle.id must now be populated

Affects:  Access Structured, Access Document

Impacts: Provider and consumer systems

Description:

  • Bundle.id must now be populated.

Pages changed:


Updates to capability statement

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • CareConnect-GPC-MedicationRequest-1 version has been updated to 1.6
  • CareConnect-GPC-Observation-1 has been updated to 1.6
  • CareConnect-GPC-Condition-ProblemHeader-1 has been updated to 1.6

Pages changed:


Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

Pages changed:


Updated examples for includeNumberOfMostRecent part parameter

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • All examples of includeNumberOfMostRecent have been updated to use valuePositiveInt inline with the specification

Pages changed:


Clarification of clinical area configuration

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • The use of OperationOutcome has been corrected so that a single OperationOutcome is returned with multiple issue elements when clinical areas have been switched off.
  • Clarification that ‘Documents’ controls whether DocumentReference resources are returned as part of the structured response.
  • Documents must be switched off when the Access Documents capability is switched off
  • issue.diagnostics and issue.details.text MUST contain ‘DocumentReferences’ when they have been turned off
  • Switching off a clinical are MUST be achieved via a single configuration item or action.

Pages changed:


Added HealthcareService to CapabilityStatement

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • HealthcareService has been added to the CapabilityStatement

Pages changed:


Updated the profile description of uncategorised data observation

Tickets:  #1052, #1040

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Updated to reflect the range of data that can be used to populate the component element
  • Updated the performer element to include organization in reference types

Pages changed:


Add notes on \n to EDIFACT section

Tickets: #1051

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Add a line to say to use \n to keep line breaks in textual results. Updated pathology guidance page to specify use of \n to maintain line breaks.

Pages changed:


Remove warning codes from resource pop fundamentals

Tickets: #1050

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Removed and replaced with a link to the returning data in lists page.

Pages changed:


Investigations - How to handle Confidential items inside a report

Tickets: #1047

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Users in providing systems can flag reports results and headers as confidential within a diagnosticReport. Updated confidential items text to reflect this.

Pages changed:


Updated diagrams for linkages between resources

Tickets:   #1042, #1044

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Diagrams updated to show correct relationship of linkages for filing comments
  • Diagrams updated to show additional problem and consultation linkages

Pages changed:


Change how to deal with split plans due to a change in dose

Tickets: #1046

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Add detail to the spec that describes how to split plans.

    Also detail how it applies to a date filter. Details about the repeatInformation. Details of how to change the ids. Use of priorPrescription element.

    Updated the medication guidance with example and removed dosageLastChanged extension from Med Statement page

Pages changed:


List of Lists - Path header/result as a problem

Tickets: #1043

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • it is possible to flag test result headers/results as Problems.

Currently the specification states that only the DiagnosticReport can be linked to a Problem, should this be updated to state that the child resources can also be linked

Updated the linkages page to say the DiagnosticReport must be linked as a related clinical item when any containing element is made a problem.

Pages changed:


Corrected allergies example

Tickets: #1038

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Corrected third allergies example to use correct value for note field
  • Updated descriptions for examples two and three to reflect content of example

Pages changed:


Clarification of clinical area configuration

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Rewording to clarify the use of OperationOutcome when clinical areas have been switched off.
  • Empty lists with basic information are permitted to be returned for disabled clinical areas.
  • References MUST be populated with “[Clinical area] items have been disabled.”

Pages changed:



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