Introduction
The GP Connect 1.2.2 release contains a number of fixes observed during supplier development, and an elaboration of the GP Connect model for branch surgeries for consuming systems. It also removes the Task capability placeholders from the specification.
GP Connect 1.2.2 was originally released as a release candidate on the 24 Oct 2018. A number of fixes were made in the interim based on supplier feedback.
Please see below for further details.
Following feedback from and in agreement with stakeholders engaged in developing GP Connect 1.2.2 provider and consumer solutions, the following changes were made to clarify and correct issues in the GP Connect 1.2.2 specification on 15 Jan 2018:
Subsequently, the following clarification was made on 4 Feb 2018:
- #620 Remove use of work and old address for Register Patient
1.2.2 changes
List expected error codes for Register a Patient & Retrieve a patient’s structured record
Tickets: #587
Affects: Foundations, Access Record Structured
Description:
- Add error codes for Register a patient & Retrieve a patient’s structured record
Pages changed:
- Register a patient
- Add expected error codes associated with errors
- Retrieve a patient’s structured record
- Add expected error codes associated with errors
- Error handling guidance
- Add DUPLICATE_REJECTED error
Clarify PDS message types that may be used in Register a Patient
Tickets: #589
Affects: Foundations
Description:
- Clarify the PDS message types that may be used for the NHS number verification step in Register a Patient.
Pages changed:
Clarify multi slot booking requirements
Tickets: #588
Affects: Appointment Management
Description:
- Improve wording of multi slot booking requirements
- Add clause to require slots to be on the same delivery channel
- Add error condition relating to multi slot bookings for Book an appointment
Pages changed:
1.2.2-rc changes
Core
Improve branch surgery model explanation
Tickets: #561
Affects: Core, Foundations, Appointment Management
Description:
- Improve branch surgery information (currently fragmented across different pages) and explain the implications for GP Connect consumers.
Pages changed:
- Branch surgeries
- Add new page
- Design decisions
- Add branch surgeries section with link through to branch surgeries page
Simplify Address data type population requirement
Tickets: #567
Affects: Core, Foundations, Appointment Management
Description:
- Remove requirement to populate Address.text in order to simplify address consumption.
- Add requirement to populate Address.use for patient addresses
- Update example payloads accordingly
Pages changed:
- FHIR Resource guidance
- Update requirement
- Read a location
- Update example
- Read an organisation
- Update example
- Find an organisation
- Update example
- Read a patient
- Update example
- Find a patient
- Update example
Add ContactPoint data type population requirement
Tickets: #579
Affects: Core, Foundations, Appointment Management
Description:
- Add explicit requirements for the population of ContactPoint data type in line with consumer expectations set by the examples
Pages changed:
- FHIR Resource guidance
- Update requirement
OperationOutcome Spine error response codes
Tickets: #554
Affects: Core
Description:
- Update underlying Spine-ErrorOrWarningCode-1 valueset with missing error codes: INVALID_PATIENT_DEMOGRAPHICS, NOT_IMPLEMENTED, REFERENCE_NOT_FOUND
Profiles changed:
Remove OperationDefinitions from the specification (cosmetic)
Tickets: #564
Affects: Foundations, Access Record Structured
Description:
- OperationDefinitions are now on the FHIR server so in order to remove duplication they have been removed from the specification.
Pages changed:
- Register a patient
- Access Record Structured Operation definition (page removed)
Profiles changed:
Remove first of type page (cosmetic)
Tickets: #487
Affects: Core
Description:
- Remove first of type page as the information is being moved to the NHS Digital corporate website
Pages changed:
- First of type (page removed)
Foundations & Appointment Management
Foundation & Appointments resources - element population exclusions and general population guidance
Affects: Foundations, Appointment Management
Description:
-
Re-state and link to general FHIR resource population requirements on each Foundations and Appointment Management use case page
-
Tidy up population requirements in each use case, applying consistency to those common elements explicitly listed such as name, gender, birthDate, identifier, address and telecom
-
Explicitly list Patient.nhsCommunication and Practitioner.nhsCommunication for population
-
Add requirement to NOT populate the following elements:
- Patient.ethnicCategory
- Patient.religiousAffiliation
- Patient.patient-cadavericDonor
- Patient.residentialStatus
- Patient.treatmentCategory
- Patient.birthPlace
- Patient.maritalStatus
- Patient.multipleBirthBoolean
- Practitioner.telecom
- Practitioner.address
- Practitioner.birthDate
- Practitioner.photo
- Practitioner.qualification
- Schedule.specialty
- Slot.specialty
- Appointment.specialty
- Appointment.reason
- Organization.contact
- Organization.endpoint
- Location.endpoint
Pages changed:
- Find a patient
- Read a patient
- Find a practitioner
- Read a practitioner
- Find an organisation
- Read an organisation
- Read a location
- Register a patient
- Retrieve a patient’s appointments
- Search for free slots
- Read an appointment
- Book an appointment
- Amend an appointment
- Cancel an appointment
Profiles changed:
Populate Location.managingOrganization
Tickets: #560
Affects: Foundations, Appointment Management
Description:
-
Add explicit requirement to populate Location.managingOrganization in alignment with branch surgery model
-
Also remove requirement to populate ODS ‘site’ code in Location.identifier
-
Update example payloads accordingly.
Pages changed:
Populate Patient.managingOrganization
Tickets: #570
Affects: Foundations
-
Add explicit requirement to populate Patient.managingOrganization (Note: this is not necessarily the patient’s registered practice)
-
Update example payloads accordingly.
Pages changed:
Register a patient requirements clarifications
Tickets: #553
Affects: Foundations
Description:
- Improve register a patient requirements:
- Clarify field population requirements for consumers
- Clarify provider responsibilities with respect to:
- PDS interaction
- duplicate record prevention
- and local record requirements.
Pages changed:
Organization resource in Search For Free Slots Bundle
Tickets: #559
Affects: Appointment Management
Description:
- Add known issue relating to returned Organization resource in Search for free slots Bundle not being supported by a corresponding _include request parameter
- Add requirement for providers to support the _include:recurse=Location:managingOrganization parameter in preparation for future fix.
- Add requirement for providers to continue to return the Organization, regardless of parameters, except where no slots are returned in the Bundle
- Add requirement for consumers to NOT populate the above parameter at the current time.
Pages changed:
Consumer information regarding unintended changes to fields for Amend & Cancel
Tickets: #581
Affects: Appointment Management
Description:
- Add warning to Amend and Cancel appointment to encourage consumers not to recreate the Appointment resource themselves, in order to prevent inadvertent changes, and their request being rejected by the provider system
Pages changed:
Uplift CapabilityStatement version number to 1.2.2
Tickets: #576
Affects: Foundations
Description:
- Change the version number in the CapabilityStatement to 1.2.2 in line with new specification release
Pages changed:
Patient contacts
Tickets: #583
Affects: Foundations
Description:
- Elaborate requirements for Patient.contact
Pages changed:
Access Record Structured
Implement medication date filter
Affects: Access Record Structured
Description:
- Implement new medication date filter logic based only on a start date, in order to always return medications that are active on the current date
Pages changed:
- MedicationStatement resource
- Update definition of effective element
- Retrieve a patient’s structured record
- Update request response requirements to implement new search filter logic
- Add search filter diagrams to illustrate its operation
- Business requirements
- Update requirements to support new date filter logic
Profiles changed:
CareConnect-ListCode-1 missing value
Tickets: #573
Affects: Access Record Structured
Description:
- Correct missing entry “Ended allergies” from the CareConnect-ListCode-1 valueset
Profiles changed:
List & Bundle meta.profile cardinality
Affects: Access Record Structured
Description:
- Change meta.profile element cardinality to 1..* for CareConnect-GPC-List-1 and GPConnect-StructuredRecord-Bundle-1
Pages changed:
Profiles changed:
Add Access Record Structured error handling scenarios
Tickets: #580
Affects: Access Record Structured
Description:
- Add additional error handling scenarios:
- the patient has dissented to sharing their clinical record
- the request is for the record of an inactive or deceased patient
- the request is for the record of a non-Regular/GMS patient (i.e. the patient’s registered practice is somewhere else)
Pages changed:
Fix typo in GPConnect-GetStructureRecord-Operation
Tickets: #565
Affects: Access Record Structured
Description:
- Fixed typo in the output Bundle profile URL of the Access Record Structured operation definition.
Profiles changed:
Task Management
Remove Task Management capability placeholders (cosmetic)
Tickets: #507
Affects: Task Management
Description:
- Remove Task Management capability placeholder in the specification.
Pages changed:
- Getting started
- Remove Task capability placeholder
- Capabilities
- Remove Task capability placeholder
- Security guidance
- Remove Task from list of endpoints