Prerequisites

Consumer

The consumer system:

• SHALL have previously resolved the organisation’s FHIR endpoint base URL through the Spine Directory Service
• SHALL have previously traced the patient’s NHS number using the Personal Demographics Service or an equivalent service
• SHALL have previously resolved the logical ID of the patient on the server using the NHS number

API use case

This specification describes a single use cases. For complete details and background, please see the Foundations Capability Bundle.

Security

• GP Connect utilises TLS Mutual Authentication for system level authorization
• GP Connect utilises a JSON Web Tokens (JWT) to transmit clinical audit and provenance details

API usage

Request operation

FHIR relative request

GET /Patient/[id]

FHIR absolute request

GET https://[proxy_server]/https://[provider_server]/[fhir_base]/Patient/[id]

Request headers

Consumers SHALL include the following additional HTTP request headers:

Payload request body

N/A

Error handling

Provider systems SHALL return an GPConnect-OperationOutcome-1 resource that provides additional detail when one or more data fields are corrupt or a specific business rule/constraint is breached.

For example the:

• logical identifier of the resource is not valid/can’t be found on the server

Refer to Development - FHIR API Guidance - Error Handling for details of error codes.

Request response

Response headers

Provider systems are not expected to add any specific headers beyond that described in the HTTP and FHIR® standards.

Payload response body

Provider systems:

• SHALL return a 200 OK HTTP status code on successful execution of the operation.
• SHALL return Patient resources that conform to the CareConnect-GPC-Patient-1 profile.
• SHALL include the URI of the CareConnect-GPC-Patient-1 profile StructureDefinition in the Patient.meta.profile element of the returned Patient resource.
• SHALL include the versionId of the current version of the Patient resource.
• SHALL include all relevant business identifier details (that is, NHS number) for the Patient resource.
• SHALL supply gender, name and birth date where these are available (as indicated by the Must-Support FHIR property)
• SHALL populate the preferred branch surgery within the registration details extension of the patient resource with a reference to a location resource which represents the patients preferred branch surgery including ODS Site Code where available OR the GP Practice where they are registered if there is no preferred branch surgery including the Organization ODS Code identifier.
• The patient resource SHALL contain at least a single name element. The patient resource SHALL contain a single instance of the name element with the use of official. This official name should contain the name registered on the spine which is returned by a PDS lookup for the patient.

{
    "resourceType": "Patient",
    "id": "2",
    "meta": {
        "versionId": "1469448000000",
        "lastUpdated": "2016-07-25T12:00:00.000+00:00",
        "profile": [
            "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1"
        ]
    },
    "extension": [{
					"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-RegistrationDetails-1",
					"extension": [
						{
							"url": "preferredBranchSurgery",
							"valueReference": {
								"reference": "Location/785b4ff5-aced-4bdf-b7ed-34f92131ce97"
							}
						}
					]
				}],
    "identifier": [
        {
            "extension": [
                {
                    "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-CareConnect-GPC-NHSNumberVerificationStatus-1",
                    "valueCodeableConcept": {
                        "coding": [
                            {
                                "system": "https://fhir.nhs.uk/CareConnect-NHSNumberVerificationStatus-1",
                                "code": "01",
                                "display": "Number present and verified"
                            }
                        ]
                    }
                }
            ],
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9476719931"
        }
    ],
    "active": true,
    "name": [
        {
            "use": "official",
            "text": "Minnie DAWES",
            "family": "Jackson",
            "given": ["Jane"],
            "prefix": ["Miss"]
        }
    ],
    "telecom": [
        {
            "system": "phone",
            "value": "01454587554",
            "use": "home"
        }
    ],
    "gender": "female",
    "birthDate": "1952-05-31",
    "address": [
        {
            "use": "home",
            "type": "physical",
            "text": "Trevelyan Square, Boar Ln, Leeds, LS1 6AE"
			"address": {
				"line": [
					"Trevelyan Square",
					"Boar Ln",
					"Leeds"
				],
				"postalCode": "LS1 6AE"
			}
        }
    ]
}

Examples

C#

var client = new FhirClient("http://gpconnect.aprovider.nhs.net/GP001/STU3/1/");
client.PreferredFormat = ResourceFormat.Json;
var resource = client.Read<Patient>("Patient/2");
FhirSerializer.SerializeResourceToXml(resource).Dump();

Java

FhirContext ctx = new FhirContext().forStu3();
IGenericClient client = ctx.newRestfulGenericClient("http://gpconnect.aprovider.nhs.net/GP001/STU3/1/");
Patient patient = client.read().resource(Patient.class).withId("2").execute();