GP Patient Registration

This page shows examples supported by the specification. Examples should be as comprehensive as possible to aid developers.

Subpages may be added for navigation for example for Clinical scenarios.

Background

These are a collection of use case examples specific for GP Patient Registration. This includes positive and negative acknowledgement responses. This is to illustrate how the generic and agnostic Acknowledgement Framework can support a specific project use case.

This use case uses the Messaging paradigm within FHIR.

Use Case Examples

Patient registration successful

Patient registration successful

A patient goes online to register with a GP practice. A GP administrator accepts the patient's request to register.

As a: GP Administrator
I want to: Accept registration messages from patients not currently registered at the GP Surgery
So that: I can register them without additional input from sources outside my GP IT system 

Given that: A registering individual is not currently registered at the GP Surgery
When: The registering individual submits the registration application
Then: The message is accepted by the GP IT System



An Example Of Patient Registration Request

<Bundle xmlns="http://hl7.org/fhir">
<id value="6f4256fa-cd14-4f96-899e-008643d84ff8" />
<type value="message" />
<entry>
<fullUrl value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MessageHeader" />
<resource>
<MessageHeader>
<id value="urn:uuid:772c0a20-f72f-45f0-abf0-c1c667c52bc8" />
<meta>
<versionId value="1" />
</meta>
<extension url="http://hl7.org/fhir/StructureDefinition/messageheader-response-request">
<valueCode value="always" />
</extension>
<eventCoding>
<system value="https://fhir.nhs.uk/CodeSystem/message-event" />
<code value="patient" />
<display value="Patient Demographics" />
</eventCoding>
<destination>
<name value="Leeds GP Family Practice EMIS System" />
<endpoint value="https://emis.leedsgpfamilypractice.com/api/patient/register" />
<receiver>
<reference value="urn:uuid:fb1d6acf-3ab0-4433-a425-c0b6f054779c" />
<display value="Leeds GP Family Practice" />
</receiver>
</destination>
<source>
<name value="NHSD GP Registration System" />
<version value="0.0.1" />
<contact>
<system value="email" />
<value value="helpdeskemail@nhs.net" />
</contact>
<endpoint value="https://gpregistration.digital.nhs.net/api" />
</source>
</MessageHeader>
</resource>
</entry>
<entry>
<fullUrl value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient" />
<resource>
<Patient>
<meta>
<versionId value="3" />
</meta>
<extension url="http://hl7.org/fhir/StructureDefinition/patient-birthPlace">
<valueAddress>
<country value="FRA" />
</valueAddress>
</extension>
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex">
<valueCode value="F" />
</extension>
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory">
<valueCodeableConcept>
<coding>
<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland" />
<code value="N" />
<display value="Black or Black British - African" />
</coding>
</valueCodeableConcept>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired">
<valueBoolean value="true" />
</extension>
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9999999999" />
</identifier>
<name>
<use value="usual" />
<family value="Bryson" />
<given value="Bill" />
<given value="Bob" />
</name>
<name>
<use value="old" />
<family value="Smith" />
<given value="Bill" />
<given value="Bob" />
</name>
<telecom>
<system value="email" />
<value value="bill@bryson.com" />
<rank value="1" />
</telecom>
<telecom>
<system value="phone" />
<value value="0161123456" />
<rank value="2" />
</telecom>
<telecom>
<system value="phone" />
<value value="07819194455" />
<rank value="3" />
</telecom>
<gender value="male" />
<birthDate value="1990-01-01" />
<address>
<use value="home" />
<type value="physical" />
<line value="Flat 1" />
<line value="28 Ashbrook Close" />
<city value="Ossett" />
<postalCode value="WF5 9DU" />
</address>
<contact>
<relationship>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0131" />
<code value="EP" />
<display value="Emergency contact person" />
</coding>
</relationship>
<name>
<use value="usual" />
<family value="Doe" />
<given value="John" />
</name>
<telecom>
<system value="phone" />
<value value="07123476234" />
<rank value="1" />
</telecom>
</contact>
<communication>
<language>
<coding>
<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage" />
<code value="q4" />
<display value="British Sign Language" />
</coding>
</language>
</communication>
<generalPractitioner>
<reference value="urn:uuid:f21e741d-2f77-44e0-bfdd-cb4278fe93a6" />
<display value="GP surgery" />
</generalPractitioner>
</Patient>
</resource>
</entry>
<entry>
<fullUrl value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
<resource>
<Organization>
<id value="urn:uuid:f21e741d-2f77-44e0-bfdd-cb4278fe93a6" />
<meta>
<versionId value="4" />
</meta>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="AB123" />
</identifier>
<name value="GP surgery" />
<address>
<line value="Flat 1" />
<line value="28 Ashbrook Close" />
<city value="Ossett" />
<postalCode value="WF5 9DU" />
</address>
</Organization>
</resource>
</entry>
<entry>
<fullUrl value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization" />
<resource>
<Organization>
<id value="urn:uuid:fb1d6acf-3ab0-4433-a425-c0b6f054779c" />
<meta>
<versionId value="5" />
</meta>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="AB555" />
</identifier>
<name value="Leeds GP family practice" />
<address>
<line value="Floor 5" />
<line value="10 Bond Street" />
<city value="Ossett" />
<postalCode value="WF2 5BA" />
</address>
</Organization>
</resource>
</entry>
</Bundle>
{
"resourceType": "Bundle",
"id": "6f4256fa-cd14-4f96-899e-008643d84ff8",
"type": "message",
"entry": [
{
"fullUrl": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MessageHeader",
"resource": {
"resourceType": "MessageHeader",
"meta": {
"versionId": "1"
},
"id": "urn:uuid:772c0a20-f72f-45f0-abf0-c1c667c52bc8",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/messageheader-response-request",
"valueCode": "always"
}
],
"eventCoding": {
"system": "https://fhir.nhs.uk/CodeSystem/message-event",
"code": "patient",
"display": "Patient Demographics"
},
"destination": [
{
"name": "Leeds GP Family Practice EMIS System",
"endpoint": "https://emis.leedsgpfamilypractice.com/api/patient/register",
"receiver": {
"reference": "urn:uuid:fb1d6acf-3ab0-4433-a425-c0b6f054779c",
"display": "Leeds GP Family Practice"
}
}
],
"source": {
"name": "NHSD GP Registration System",
"version": "0.0.1",
"contact": {
"system": "email",
"value": "helpdeskemail@nhs.net"
},
"endpoint": "https://gpregistration.digital.nhs.net/api"
}
}
},
{
"fullUrl": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient",
"resource": {
"resourceType": "Patient",
"meta": {
"versionId": "3"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace",
"valueAddress": {
"country": "FRA"
}
},
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex",
"valueCode": "F"
},
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-EthnicCategoryEngland",
"code": "N",
"display": "Black or Black British - African"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired",
"valueBoolean": true
}
],
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9999999999"
}
],
"name": [
{
"use": "usual",
"family": "Bryson",
"given": [
"Bill",
"Bob"
]
},
{
"use": "old",
"family": "Smith",
"given": [
"Bill",
"Bob"
]
}
],
"telecom": [
{
"system": "email",
"value": "bill@bryson.com",
"rank": 1
},
{
"system": "phone",
"value": "0161123456",
"rank": 2
},
{
"system": "phone",
"value": "07819194455",
"rank": 3
}
],
"gender": "male",
"birthDate": "1990-01-01",
"address": [
{
"use": "home",
"type": "physical",
"line": [
"Flat 1",
"28 Ashbrook Close"
],
"city": "Ossett",
"postalCode": "WF5 9DU"
}
],
"contact": [
{
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"code": "EP",
"display": "Emergency contact person"
}
]
}
],
"name": {
"use": "usual",
"family": "Doe",
"given": [
"John"
]
},
"telecom": [
{
"system": "phone",
"value": "07123476234",
"rank": 1
}
]
}
],
"communication": [
{
"language": {
"coding": [
{
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage",
"code": "q4",
"display": "British Sign Language"
}
]
}
}
],
"generalPractitioner": [
{
"reference": "urn:uuid:f21e741d-2f77-44e0-bfdd-cb4278fe93a6",
"display": "GP surgery"
}
]
}
},
{
"fullUrl": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
"resource": {
"resourceType": "Organization",
"meta": {
"versionId": "4"
},
"id": "urn:uuid:f21e741d-2f77-44e0-bfdd-cb4278fe93a6",
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "AB123"
}
],
"name": "GP surgery",
"address": [
{
"line": [
"Flat 1",
"28 Ashbrook Close"
],
"city": "Ossett",
"postalCode": "WF5 9DU"
}
]
}
},
{
"fullUrl": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Organization",
"resource": {
"resourceType": "Organization",
"meta": {
"versionId": "5"
},
"id": "urn:uuid:fb1d6acf-3ab0-4433-a425-c0b6f054779c",
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "AB555"
}
],
"name": "Leeds GP family practice",
"address": [
{
"line": [
"Floor 5",
"10 Bond Street"
],
"city": "Ossett",
"postalCode": "WF2 5BA"
}
]
}
}
]
}



An Example of Patient Registration Request successfully received

<Bundle xmlns="http://hl7.org/fhir">
<id value="2adbf7c4-8f21-4159-8681-3f41bc06215c" />
<type value="message" />
<entry>
<fullUrl value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MessageHeader" />
<resource>
<MessageHeader>
<id value="urn:uuid:7c451367-d637-4fe7-9eab-140e743b88b3" />
<meta>
<versionId value="1" />
</meta>
<extension url="http://hl7.org/fhir/StructureDefinition/messageheader-response-request">
<valueCode value="never" />
</extension>
<eventCoding>
<system value="https://fhir.nhs.uk/CodeSystem/message-event" />
<code value="patient" />
<display value="Patient Demographics" />
</eventCoding>
<destination>
<name value="NHS England GP Registration System" />
<endpoint value="https://gpregistration.digital.nhs.net/api" />
<receiver>
<reference value="urn:uuid:0971b53c-7b9e-4d6e-afd2-e9408c5c3a6c" />
<display value="NHS England GP Registration System" />
</receiver>
</destination>
<source>
<name value="Leeds GP Family Practice EMIS System" />
<version value="0.0.5" />
<contact>
<system value="email" />
<value value="helpdeskemail@emis.net" />
</contact>
<endpoint value="https://emis.leedsgpfamilypractice.com/api/patient/register" />
</source>
<response>
<identifier value="6f4256fa-cd14-4f96-899e-008643d84ff8" />
<code value="ok" />
<details>
<reference value="urn:uuid:6b7617b1-a988-41bc-967a-0a8ba0fa36f1" />
</details>
</response>
</MessageHeader>
</resource>
</entry>
<entry>
<fullUrl value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome" />
<resource>
<OperationOutcome>
<id value="urn:uuid:8283e341-67ae-48e7-b3ae-2c6a0a824b2c" />
<meta>
<versionId value="3" />
</meta>
<issue>
<severity value="information" />
<code value="informational" />
<details>
<coding>
<system value="https://fhir.nhs.uk/CodeSystem/AcknowledgementFrameworkResponseCode" />
<code value="TECHNICAL_SUCCESS" />
<display value="Request successfully received" />
</coding>
</details>
</issue>
</OperationOutcome>
</resource>
</entry>
</Bundle>
{
"resourceType": "Bundle",
"id": "2adbf7c4-8f21-4159-8681-3f41bc06215c",
"type": "message",
"entry": [
{
"fullUrl": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MessageHeader",
"resource": {
"resourceType": "MessageHeader",
"meta": {
"versionId": "1"
},
"id": "urn:uuid:7c451367-d637-4fe7-9eab-140e743b88b3",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/messageheader-response-request",
"valueCode": "never"
}
],
"eventCoding": {
"system": "https://fhir.nhs.uk/CodeSystem/message-event",
"code": "patient",
"display": "Patient Demographics"
},
"destination": [
{
"name": "NHS England GP Registration System",
"endpoint": "https://gpregistration.digital.nhs.net/api",
"receiver": {
"reference": "urn:uuid:0971b53c-7b9e-4d6e-afd2-e9408c5c3a6c",
"display": "NHS England GP Registration System"
}
}
],
"source": {
"name": "Leeds GP Family Practice EMIS System",
"version": "0.0.5",
"contact": {
"system": "email",
"value": "helpdeskemail@emis.net"
},
"endpoint": "https://emis.leedsgpfamilypractice.com/api/patient/register"
},
"response": {
"identifier": "6f4256fa-cd14-4f96-899e-008643d84ff8",
"code": "ok",
"details": {
"reference": "urn:uuid:6b7617b1-a988-41bc-967a-0a8ba0fa36f1"
}
}
}
},
{
"fullUrl": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome",
"resource": {
"resourceType": "OperationOutcome",
"meta": {
"versionId": "3"
},
"id": "urn:uuid:8283e341-67ae-48e7-b3ae-2c6a0a824b2c",
"issue": [
{
"severity": "information",
"code": "informational",
"details": {
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/AcknowledgementFrameworkResponseCode",
"code": "TECHNICAL_SUCCESS",
"display": "Request successfully received"
}
]
}
}
]
}
}
]
}



An Example of Patient successfully registered

<Bundle xmlns="http://hl7.org/fhir">
<id value="c96c137d-3089-4165-8a2b-f9518d745a64" />
<type value="message" />
<entry>
<fullUrl value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-MessageHeader" />
<resource>
<MessageHeader>
<id value="urn:uuid:7c451367-d637-4fe7-9eab-140e743b88b3" />
<meta>
<versionId value="1" />
</meta>
<extension url="http://hl7.org/fhir/StructureDefinition/messageheader-response-request">
<valueCode value="never" />
</extension>
<eventCoding>
<system value="https://fhir.nhs.uk/CodeSystem/message-event" />
<code value="patient" />
<display value="Patient Demographics" />
</eventCoding>
<destination>
<name value="NHS England GP Registration System" />
<endpoint value="https://gpregistration.digital.nhs.net/api" />
<receiver>
<reference value="urn:uuid:0971b53c-7b9e-4d6e-afd2-e9408c5c3a6c" />
<display value="NHS England GP Registration System" />
</receiver>
</destination>
<source>
<name value="Leeds GP Family Practice EMIS System" />
<version value="0.0.5" />
<contact>
<system value="email" />
<value value="helpdeskemail@emis.net" />
</contact>
<endpoint value="https://emis.leedsgpfamilypractice.com/api/patient/register" />
</source>
<response>
<identifier value="6f4256fa-cd14-4f96-899e-008643d84ff8" />
<code value="ok" />
<details>
<reference value="urn:uuid:6b7617b1-a988-41bc-967a-0a8ba0fa36f1" />
</details>
</response>
</MessageHeader>
</resource>
</entry>
<entry>
<fullUrl value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome" />
<resource>
<OperationOutcome>
<id value="urn:uuid:8283e341-67ae-48e7-b3ae-2c6a0a824b2c" />
<meta>
<versionId value="3" />
</meta>
<issue>
<severity value="information" />
<code value="informational" />
<details>
<coding>
<system value="https://fhir.nhs.uk/CodeSystem/AcknowledgementFrameworkResponseCode" />
<code value="BUSINESS_SUCCESS" />
<display value="Business request successfully actioned" />
</coding>
</details>
</issue>
</OperationOutcome>
</resource>
</entry>
</Bundle>
{
"resourceType": "Bundle",
"id": "c96c137d-3089-4165-8a2b-f9518d745a64",
"type": "message",
"entry": [
{
"fullUrl": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-MessageHeader",
"resource": {
"resourceType": "MessageHeader",
"meta": {
"versionId": "1"
},
"id": "urn:uuid:7c451367-d637-4fe7-9eab-140e743b88b3",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/messageheader-response-request",
"valueCode": "never"
}
],
"eventCoding": {
"system": "https://fhir.nhs.uk/CodeSystem/message-event",
"code": "patient",
"display": "Patient Demographics"
},
"destination": [
{
"name": "NHS England GP Registration System",
"endpoint": "https://gpregistration.digital.nhs.net/api",
"receiver": {
"reference": "urn:uuid:0971b53c-7b9e-4d6e-afd2-e9408c5c3a6c",
"display": "NHS England GP Registration System"
}
}
],
"source": {
"name": "Leeds GP Family Practice EMIS System",
"version": "0.0.5",
"contact": {
"system": "email",
"value": "helpdeskemail@emis.net"
},
"endpoint": "https://emis.leedsgpfamilypractice.com/api/patient/register"
},
"response": {
"identifier": "6f4256fa-cd14-4f96-899e-008643d84ff8",
"code": "ok",
"details": {
"reference": "urn:uuid:6b7617b1-a988-41bc-967a-0a8ba0fa36f1"
}
}
}
},
{
"fullUrl": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-OperationOutcome",
"resource": {
"resourceType": "OperationOutcome",
"meta": {
"versionId": "3"
},
"id": "urn:uuid:8283e341-67ae-48e7-b3ae-2c6a0a824b2c",
"issue": [
{
"severity": "information",
"code": "informational",
"details": {
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/AcknowledgementFrameworkResponseCode",
"code": "BUSINESS_SUCCESS",
"display": "Business request successfully actioned"
}
]
}
}
]
}
}
]
}