Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Patient | Urgent & Emergency Care Appointments

A Patient as used in Appointment booking.

Introduction

This resource is contained within the Appointment resource.

References to FHIR Profiles

Key FHIR Elements

The following FHIR elements are key to this implementation:

See example resource.

The Patient resource MUST include the following data items*:

*If you DO NOT have an NHS Number for the Patient, then you MUST NOT provide an identifier.

Element Cardinality Description Example(s)  
id [1..1] An id which is unique within the containing Appointment resource. 123  
identifier [0..1] The Patient’s identifier    
identifier(nhsNumber) [0..1] The Patient’s NHS number    
identifier(nhsNumber).extension [1..1] A Care Connect extension that fixes this identifier to be an NHS Number see example  
identifier(nhsNumber).use [0..1] Shows that this identifier is a nationally recognised one Fixed value: official  
identifier(nhsNumber).system [1..1] Shows that the value is an NHS Number Fixed value: https://fhir.nhs.uk/Id/nhs-number  
identifier(nhsNumber).value [1..1] The Patient’s NHS Number 11122233333  
name [1..1] The Patient’s name. This element is very important if no NHS number is being supplied. see example  
telecom [1..1] The number the patient can be contacted on see example  
gender [1..1] The patient’s gender. This element is very important if no NHS number is being supplied. male | female | other | unknown  
birthdate [1..1] The patient’s date of birth. This element is very important if no NHS number is being supplied. 1974-12-31  
address [1..1] Patient’s full address. This element is very important if no NHS number is being supplied. see example  

Example resource

{
    "resourceType": "Patient",
    "meta": {
        "profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"
    },
    "id": "P1",
    "identifier": [
        {
            "extension": [
                {
                    "url": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1",
                    "valueCodeableConcept": {
                        "coding": [
                            {
                                "system": "https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1",
                                "code": "01",
                                "display": "Number present and verified"
                            }
                        ]
                    }
                }
            ],
            "use": "official",
            "system": "https://fhir.nhs.uk/Id/nhs-number",
            "value": "9476719931"
        }
    ],
    "name": [
        {
            "use": "official",
            "prefix": "Mr",
            "given": "John",
            "family": "Smith"
        }
    ],
    "telecom": [
        {
            "system": "phone",
            "value": "01234 567 890",
            "use": "home",
            "rank": 1
        }
    ],
    "gender": "male",
    "birthDate": "1974-12-25",
    "address": [
        {
            "use": "home",
            "text": "123 High Street, Leeds LS1 4HR",
            "line": [
                "123 High Street",
                "Leeds"
            ],
            "city": "Leeds",
            "postalCode": "LS1 4HR"
        }
    ]
}

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