Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 


Quick links

Go back to previous page

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

Core

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:

Added Send Document link to Implement a capability page and menu

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:

Updates to API error display values

Tickets: #1171

Affects: Core

Impacts: Provider and consumer systems

Description:

  • Updated API error display values to the Spine error or warning display values

Pages changed:

Access Document

Added Access Document capability to 1.5.0

Affects  Access Documents

Description:

  • Access Document has been moved from a separate specification into 1.5.0
  • Update service root URL definition to accommodate the Access Document capability API being defined as its own FHIR server
  • Add explicit error handling response for Access Document calls

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:

Document search API updates

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=
  • The syntax of the Patient _include parameter for Search for a patient’s documents was incorrect and has been updated
  • the facility parameter now uses a token instead of an identifier as its datatype
  • Updated examples to include all search parameters
  • 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.
  • Corrected description of author parameter to be a token in line with the rest of the specification

Pages changed:

Find Patient API updates

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
  • The error condition for an INVALID_IDENTIFIER_SYSTEM in Find a patient has been changed to INVALID_PARAMETER

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:

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 CapabilityStatement

Tickets:

Affects:  Access Document

Impacts: Provider and consumer systems

Description:

  • version number has been set to 1.5.0
  • 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.
  • Add minor version numbers to profiles listed in the capability statement

Pages changed:

Updates to DocumentReference population guidance

Tickets: #1152

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
  • Updated guidance for content.attachment.size

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
  • Clarification on how to set file size for documents that aren’t available

Pages changed:

Access Record Structured

Add Investigations

Tickets: #900, #902, #1018, #1021, #1024, #1043, #1047, #1051, #1061, #1063, #1143

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Added general guidance page for Investigations
  • Added description of populating the profiles for Investigations
  • 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
  • Updated linkages guidance
  • Updated problems guidance

Pages changed:

Add Outbound Referrals

Tickets: #900, #902, #1013

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
  • Referrals guidance references inbound referrals covered by uncategorised data

Pages changed:

Add Diary Entries

Tickets: #902, #1062, #1144

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:

Add immunisations not given

Tickets: #849, #977, #987

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 includeStatus part parameter to GPConnect-GetStructuredRecord-Operation-1 with a default value of false
  • updated bundle population diagram to include includeNotGiven and includeStatus 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
  • Observations representing the status of a patient’s immunisations will be returned
  • includeImmunisations.includeStatus has a default value of true
  • Updated guidance and profile definition following addition of ‘not done’ situation codes to the valueset for the vaccination procedure

Pages changed:

Add Using lists to return data guidance page

Tickets:  #1022, #1050

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • A new page has been created to incorporate the extended List guidance with some content moved from the resource population fundamentals page
  • Following curation this has been updated to reflect the new secondary list codes

Pages changed:

Updated resource population fundamentals guidance

Tickets: #1007, #1050

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

  • Moved warning codes to the returning data in lists page and replaced with a link

Pages changed:

Updated linkages guidance

Tickets:   #1007, #1042, #1147

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Diagrams updated to show additional problem and consultation linkages
  • Note added that diagrams do not include all possible linkages
  • DocumentReference added as a profile returned for referrals and the associated diagram updated
  • 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
  • Added reference to secondary lists to the guidance and diagrams

Pages changed:

Updated multi area searches guidance

Tickets:  #1004, #1023, #1030

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 multiple search parameters guidance

Tickets: 

Affects:  Access Record Structured

Impacts: Provider and consumer systems

Description:

Pages changed:

Updated List guidance

Tickets:   #1007, #1014, #1115

Affects:  Access Structured

Impacts: Provider systems

Description:

  • Updated to describe how to populate the list.date field
  • Updated the guidance for the title element, so that it referenced using the titles defined in the ‘Using lists to return data’ guidance
  • 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

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:

Updated allergies guidance

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:

Updated medication guidance

Tickets: #993, #1046(https://github.com/nhsconnect/gpconnect/issues/1046), #1127, #1129

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Removed acute-handwritten from list of supported prescription types
  • Added codes against prescription type descriptions
  • Added detail to the spec that describes how to split plans
    • Detailed how they apply to a date filter
    • Details about the repeatInformation
    • Details of how to change the ids
    • Detail from use of priorPrescription element
    • Updated the medication guidance with example
    • Removed dosageLastChanged extension from Med Statement page
  • Diagrams updated for medication resource relationships to correct intent labels typo

Pages changed:

Updated guidance for immunisations

Tickets:  #1036, #1053

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

Pages changed:

Updated uncategorised data guidance

Tickets:   #754, #1013, #1027, #1028, #1037, #1040, #1052, #1066, #1132, #1166

Affects:  Access 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
  • Updated to describe how blood pressures are recorded in GP systems and include details of which blood pressures should be exported as a triple
  • 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
  • Minor re-word for code for free text
  • Section added with additional guidance for populating the observation resource for an inbound referral and updated the profile guidance
  • Updated guidance and diagrams for hierarchical data
  • Free text which is not associated with a clinical code must only be returned in the context of a consultation (and problem when linking a consultation topic items) and not in response to only an uncategorised data request.
  • Inbound referrals referenced in scope of uncategorised data
  • Update to guidance for documents linked to inbound referrals to be sent using DocumentReference resources

Pages changed:

Updated consultations guidance

Tickets:   #983, #1009, #1029, #1037, #1145

Affects:  Access Structured

Impacts: Provider and consumer systems

Description:

  • Updated the description for confidential items in consultations to reference secondary lists
  • Changed the query response List profile guidance to reference Encounter resources instead of Lists used for the Consultation structure
  • Minor changes to the text to clarify that free text recorded in consultation use the observation resource as defined under uncategorised data
  • Detail on returning out of scope items from clinical areas as text has been added
  • Guidance for the List profile for Consultations has been updated, the problemReference extension has been corrected to relatedProblemHeader to match the profile
  • The consultations example has been updated to use the new Lists guidance

Pages changed:

Updated to Problems guidance

Tickets:  #1008, #1010, #1012, #1174

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
  • Diagram updated to show additional problem and consultation linkages
  • Note added that diagrams do not include all possible linkages
  • 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
  • The consultations example has been updated to use the new Lists guidance
  • Update to the illustration diagram to include all resources that are returned for problems

Pages changed:

API Updates

Tickets:  #904, #1165

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.
  • Part parameters have been added to the mot permitted parameter combinations
    • includeReferrals.referralSearchPeriod
    • includeDiaryEntries.diaryEntriesSearchDate
    • includeImmunisations.includeNotGiven
    • includeImmunisations.includeDissentConsent
    • includeImmunisations.includeStatus
  • The error code for access denied has been updated to use the value from the value set, ACCESS DENIED
  • 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: 

Updates to profiles

Affects:  Access Record Structured

Impacts:  Providers and consumers

Description: 

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
  • HealthcareService has been added to the CapabilityStatement

Pages changed:

Configuration of supported clinical areas

Tickets:  #1026, #1167

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
  • Guidance on populating references has been added
  • A list of configurable clinical areas has been added
  • The warning has been updated for populating an OperationOutcome
  • Empty lists with basic information are permitted to be returned for disabled clinical areas.
  • Switching off a clinical are MUST be achieved via a single configuration item or action.
  • Documents must be switched off when the Access Documents capability is switched off

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:

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