Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

PDS Change of GP

The FHIR profiles used for the PDS Change of GP event message bundle

PDS Change of GP event messages are generated by the Spine and published to the NEMS when the registered GP within a patients PDS record is changed. The event message contains details of the previous and current registered GP Practice for the patient as per the guidance below.

FHIR Profiles

The PDS Change of GP event message bundle is expected to include a combination of the following resources to support the event header and data item requirements:

PDS Change of GP Event Message Bundle
EMS-Bundle-1
EMS-MessageHeader-1
CareConnect-Organization-1
EMS-HealthcareService-1
CareConnect-EMS-Patient-1
EMS-Communication-1
EMS-PDS-GPRegistration-EpisodeOfCare-1

Onward Delivery

The delivery of the PDS Change of GP event messages to subscribers via MESH will use the following WorkflowID within the MESH control file. This WorkflowID will need to be added to the receiving MESH mailbox configuration before event messages can be received.

MESH WorkflowID CHILDHEALTH_GPCHANGE_UPDATE

Bundle structure

PDS Change of GP Bundle (open in new TAB)

The CareConnect-EMS-Patient-1 resource generalPractitioner element references the organization resource representing the patient’s current GP practice.

The EMS-PDS-GPRegistration-EpisodeOfCare-1 resource managingOrganization element references the organization resource which was the patients previous GP practice.

PDS Change of GP Message Life Cycle

The PDS Change of GP event message is always a new event and there is no concept of update or delete for the event message.

If a subscriber receives multiple PDS Change of GP event messages for the same patient, the latest event message as indicated by the timestamp element within the MessageHeader resource should be considered the source of truth for the patients GP details.

Resource population requirements and guidance

The following requirements and resource population guidance should be followed in addition to the requirements and guidance outlined in the Events Management Service specification.

EMS-MessageHeader-1

The MessageHeader resource included as part of the event message SHALL conform to the EMS-MessageHeader-1 constrained FHIR profile and the additional population guidance as per the table bellow:

Element Cardinality Additional Guidance
extension(eventMessageType) 1..1 Fixed value: new
event 1..1 Fixed Value: PDS001 (PDS Change of GP)
focus 1..1 This will reference the “EMS-Communication-1” resource which contains information relating to the event message.
timestamp 1..1 This timestamp indicates when the message was sent. This date can be used to infer the start date of the new GP registration as the GP system will update the Spine when the patient is registered with the practice.

EMS-Communication-1

The Communication resource included in the event message SHALL conform to the EMS-Communication-1 constrained FHIR profile and the additional population guidance as per the table below:

Element Cardinality Additional Guidance
status 1..1 Fixed value: completed
payload 1..1 This will reference the patient resource representing the patient who is the focus of this event.

CareConnect-EMS-Patient-1

The patient resource included in the event message SHALL conform to the CareConnect-EMS-Patient-1 constrained FHIR profile and the additional population guidance as per the table below:

Element Cardinality Additional Guidance
meta.versionId 1..1 This element will contain the serial change number (SCN) of the patient record within Spine at the time this event was published.
identifier 1..1 Patient NHS Number SHALL be included within the nhsNumber identifier slice
generalPractitioner 1..1 References to an organization representing the new GP Practice which is the current primary care provider for the patient.

The generalPractitioner element does not contain a date indicating when the patient was registered at their new GP practice. The timestamp within the MessageHeader resource may be considered the effective date for the new GP Practice as this is the date when the patients GP registration was changed to the new GP on the Spine.

CareConnect-Organization-1

Within the bundle there will be multiple organization resources, including one for the patient’s current GP Practice and one for the patient’s previous GP Practice. Other Organization resources may be included where referenced from within other resources in the bundle. The Organization resources included in the bundle SHALL conform to the CareConnect-Organization-1 constrained FHIR profile and the additional population guidance as per the table below:

Element Cardinality Additional Guidance
identifier 1..1 The organization ODS code SHALL be included within the odsOrganizationCode identifier slice
name 1..1 A human readable name for the organization SHALL be included in the organization resource
partOf 1..1 Reference to the commissioning organization

EMS-PDS-GPRegistration-EpisodeOfCare-1

The EpisodeOfCare resource included in the event message SHALL conform to the EMS-PDS-GPRegistration-EpisodeOfCare-1 constrained FHIR profile and the additional population guidance as per the table below:

Element Cardinality Additional Guidance
status 1..1 Fixed value: finished
extension(systemEffectivePeriod).valuePeriod.start 0..1 The PDS system date on which the old GP Practice registration was added to PDS.
extension(systemEffectivePeriod).valuePeriod.end 0..1 The PDS system date on which the old GP Practice registration was ended on the PDS.
period.start 0..1 Date on which the old GP practice assumed responsibility for the patient.
period.end 0..1 Date on which the old GP Practice stopped being responsible for the patient.
Tags: fhir

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