Patient resource implementation guidance
Important: This site is under active development by NHS Digital and is intended to provide all the technical resources you need to successfully develop applications using the FHIR® CDS API.
Patient: Implementation Guidance
Usage
The CareConnect-Patient-1 profile will be used to carry details about an individual receiving care or other health-related services.
Detailed implementation guidance for a Patient resource in the context of the Encounter Report is given below:
| Name | Cardinality | Type | CareConnect Documentation |
|---|---|---|---|
id |
0..1 |
id | Logical id of this artifact |
meta |
0..1 |
Meta | Metadata about the resource |
implicitRules |
0..1 |
uri | A set of rules under which this content was created |
language |
0..1 |
code | Language of the resource content. Common Languages [Extensible but limited to All Languages] |
text |
0..1 |
Narrative | Text summary of the resource, for human interpretation |
contained |
0..* |
Resource | Contained, inline Resources |
extension (ethnicCategory) |
0..1 |
Extension | Ethnic Category URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1 |
extension (religiousAffiliation) |
0..1 |
Extension | Religious affiliation URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1 |
extension (patient-cadavericDonor) |
0..1 |
Extension | Flag indicating whether the patient authorized the donation of body parts after death URL: http://hl7.org/fhir/stu3/StructureDefinition/patient-cadavericDonor |
extension (residentialStatus) |
0..1 |
Extension | The residential status of the patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1 |
extension (treatmentCategory) |
0..1 |
Extension | The treatment category for this patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1 |
extension (nhsCommunication) |
0..* |
Extension | NHS communication preferences for a resource URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1 |
extension (birthPlace) |
0..1 |
Extension | Birth Place: The registered place of birth of the patient. URL: http://hl7.org/fhir/stu3/StructureDefinition/birthPlace |
extension (nominatedPharmacy) |
0..1 |
Extension | A patient's nominated pharmacy URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1 |
extension (deathNotificationStatus) |
0..1 |
Extension | Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1 |
modifierExtension |
0..* |
Extension | Extensions that cannot be ignored |
identifier |
0..* |
Identifier | An identifier for this patient |
identifier (nhsNumber) |
0..1 |
Identifier | The patient's NHS number |
extension (nhsNumberVerificationStatus) |
1..1 |
Extension | NHS number verification status URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1 |
use |
0..1 |
Code | usual | official | temp | secondary (If known) Binding (required): Identifies the purpose for this identifier, if known. (http://hl7.org/fhir/stu3/valueset-identifier-use.html) |
type |
0..1 |
CodeableConcept | Description of identifier Binding (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/stu3/valueset-identifier-type.html) |
system |
1..1 |
Uri | The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number |
value |
1..1 |
String | The value that is unique |
period |
0..1 |
Period | Time period when id is/was valid for use |
assigner |
0..1 |
Reference(CareConnectOrganization) | Organization that issued id (may be just text) |
active |
0..1 |
Boolean | Whether this patient's record is in active use |
name |
0..* |
HumanName | A name associated with the patient |
name (official) |
1..1 |
HumanName | A name associated with the patient |
use |
1..1 |
Code | usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official The use of a human name (https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-NameUse-1) |
text |
0..1 |
String | Text representation of the full name |
family |
1..1 |
String | TFamily name (often called 'Surname') |
given |
0..* |
String | Given names (not always 'first'). Includes middle names |
prefix |
0..* |
String | Parts that come before the name |
suffix |
0..* |
String | Parts that come after the name |
period |
0..1 |
Period | Time period when name was/is in use |
telecom |
0..* |
ContactPoint | A contact detail for the individual |
gender |
0..1 |
Code | male | female | other | unknown Binding (required): The gender of a person used for administrative purposes. (https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-AdministrativeGender-1) |
birthDate |
0..1 |
Date | The date of birth for the individual |
deceased[x] |
0..1 |
Boolean | dateTime | Indicates if the individual is deceased or not |
address |
0..* |
Address | Addresses for the individual |
maritalStatus |
0..1 |
CodeableConcept | Marital (civil) status of a patient Binding (required): The domestic partnership status of a person. (https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-MaritalStatus-1) |
multipleBirth[x] |
0..1 |
Boolean | Integer | Whether patient is part of a multiple birth |
photo |
0..* |
Attachment | Image of the patient |
contact |
0..* |
BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient |
generalPractitioner |
0..* |
Reference(CareConnectOrganization | CareConnectPractitioner) | Patient's nominated primary care provider |
managingOrganization |
0..1 |
Reference(CareConnectOrganization) | Organization that is the custodian of the patient record |
link |
0..* |
BackoneElement | Link to another patient resource that concerns the same actual person |
