Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

GP Connect API 1.3.1-beta release notes

GP Connect API 1.3.1-beta released on 11th September 2019

Introduction

The GP Connect API 1.3.1-beta release contains updates to the additional profiles and extended API for accessing the Access Record Structured capability.

1.3.1-beta changes

Access Record Structured


Updates to Overview

Affects:  Access Record Structured

Description:

  • Added use case “3.41 Health Visitors appointment during pregnancy - antenatal” to Business Requirements page
  • Removed Design Decision page. Information on this page was moved into the relevant areas of the specification
  • Added Data Quality to Known Issues page

Pages changed:


Updates to Linkages and search criteria

Affects:  Access Record Structured

Description:

  • Split into two pages
  • Added diagram key
  • Include List (Query Response) in the descriptions and diagrams of FHIR profiles returned on query
  • Added diagrams for all clinical areas in FHIR profiles returned on query
  • Added clarification on handling the same profile returned for two searches in the same API call
  • Reworded description of search criteria for clarity
  • Added reference to Caldicott Principles for Scale of Search

Pages changed:


Updates to Resource population fundamentals

Affects:  Access Record Structured

Description:

  • Added a description of the cross care setting identifier
  • Updated wording throughout for more clarity
  • Removed “Data Awaiting Filing” warning code

Pages changed:


Updates to Medications and Medical Devices

Affects:  Access Record Structured

Description:

  • Renamed section from Medications to Medications and Medical Devices
  • Added clarification for populating MedicationStatement.prescribingagency
  • Added clarification for populating MedicationStatement.effective
  • Set MedicationStatement.ReasonCode and MedicationStatement.ReasonReference to do not populate
  • Added clearer guidance on the different population rules for MedicationRequest Intent = plan and MedicationRequest Intent = order.
  • Set MedicationRequest.ReasonCode and MedicationRequest.ReasonReference to do not populate
  • Added clarification for populating MedicationRequest.dispenseRequest.validityPeriod
  • Added clarification for populating MedicationRequest.dispenseRequest.performer
  • Added guidance on how to populate MedicationRequest.identifier with EPS line item id

Pages changed:


Updates to API

Affects  Access Record Structured

Description:

  • The response section has been updated to reflect the resources that are returned for each clinical area
  • A link to the valueset for the includeStatus and includeSignificance parameters has been added
  • clarification of how OperationOutcomes are returned for unrecognised parameters
  • clarification of which date field is used for consultationSearchPeriod and uncategorisedDataSearchPeriod
  • bundle population diagram has been updated to reflect the resources that are returned for each clinical area
  • clarification of accept header in HTTP request - application/fhir+json not application/json+fhir
  • A link has been added to the use cases for the Access Record Structured API
  • The cardinality for the includeProblems parameter has been updated to 0..*
  • includeStatus has been renamed to filterStatus
  • includeSignificance has been renamed to filterSignificance
  • providers must reject requests that contain no valid parameters

Updates to examples

Affects:  Access Record Structured

Description:

  • uncategorised data example has been updated to conform to profile
  • immunisation example has been updated to conform to profile
  • consultation and problems example has been updated

Pages changed:

List

Affects:  Access Record Structured

Description:

  • SNOMED codes have been added for immunisations and uncategorised data
  • A table has been added to List.code with guidance on how the SNOMED codes should be used along with their display names

Pages changed:


Problems

Affects:  Access Record Structured

Description:

  • An example has been added for unsupported clinical items
  • clarification of how reference should be populated for unsupported items
  • Added guidance for problems linking to problems
  • Added guidance for confidential items
  • Changed ProblemHeader to ProblemHeader (Condition) throughout specification
  • Moved related consultations from context to relatedclinicalcontent

Pages changed:


Consultations

Affects:  Access Record Structured

Description:

  • An example has been added for unsupported clinical items
  • clarification of how reference should be populated for unsupported items
  • Reworded parts of guidance for clarification
  • Added guidance for confidential items
  • Added guidance for draft consultations
  • Updated encounter.status to support draft consultations
  • Renamed List(category) to List(Heading)
  • Merged Observation - narrative into uncategorised data

Pages changed:


Immunisations

Affects:  Access Record Structured

Description:

  • Definitions for immunisation and vaccination have been added to the guidance page
  • Explicit reference added for use of a nullFlavor code for the vaccine product
  • Paragraph for immunisation notes reworded and retitled from Data type incompatibility
  • recordedDate extension description expanded
  • vaccineCode element updated to specify the use of UNK nullFavor code
  • encounter element data type corrected
  • doseQuantity element optionality corrected to be required
  • primarySource, reportOrigin, location and practitioner element definitions expanded
  • vaccinationProtocol element cardinality corrected

Pages changed:


Uncategorised data

Affects:  Access Record Structured

Description:

  • Added guidance for uncategorised items in a hierarchy
  • Reworded parts of guidance for clarity
  • Removed blood pressure specific guidance
  • Added clarification for observation.code
  • Added clarification for observation.effectivedatetime
  • Set observation.dataabsetreason, observation.interpretation, observation.bodysite, observation.method, observation.specimen and observation.related to do not populate

Pages changed:


Forwards and backwards compatibility

Affects  Access Record Structured

Description:

  • The guidance on forwards and backwards compatibility has now been moved into a separate page
  • additional guidance on how OperationOutcome should be populated
  • an example of a populated OperationOutcome has been added
  • a table has been added with which parameters are supported in which versions of the GP Connect API specification
  • backwards compatibility has been added

Pages changed:


Diagrams

Affects  Access Record Structured

Description:

  • Updated logical models to follow a common format
  • Enlarged and increased resolution of diagrams so they are easier to read
  • Added hyperlinks to diagrams so that can be opened on their own page
Tags:

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