NHS England FHIR Implementation Guide (deprecated)

Important Announcement regarding this Implementation Guide
  • As of 04/10/2023, this implementation guide has been deprecated and all development on the legacy NHS England FHIR Implementation Guide assets has ceased.
  • Therefore, vendors looking to start new implementations or looking to update existing implementations should use the new NHS England Implementation Guide. Vendors continuing to implement legacy NHS England FHIR Implementation Guide based solutions do so at their own risk and on the understanding that no maintenance or support will be available.

Patient

Patient

{
"resourceType": "Patient",
"id": "6aa13139-201b-4a54-9608-b49331a46d90",
"meta": {
"versionId": "2",
"security": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code": "U",
"display": "unrestricted"
}
]
},
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NominatedPharmacy",
"valueReference": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "Y12345"
}
}
},
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PreferredDispenserOrganization",
"valueReference": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "Y23456"
}
}
},
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicalApplianceSupplier",
"valueReference": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "Y34567"
}
}
},
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus",
"extension": [
{
"url": "deathNotificationStatus",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus",
"version": "1.0.0",
"code": "2",
"display": "Formal - death notice received from Registrar of Deaths"
}
]
}
},
{
"url": "systemEffectiveDate",
"valueDateTime": "2010-10-22T00:00:00+00:00"
}
]
},
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSCommunication",
"extension": [
{
"url": "language",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage",
"version": "1.0.0",
"code": "fr",
"display": "French"
}
]
}
},
{
"url": "interpreterRequired",
"valueBoolean": true
}
]
},
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference",
"extension": [
{
"url": "PreferredWrittenCommunicationFormat",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat",
"code": "12",
"display": "Braille"
}
]
}
},
{
"url": "PreferredContactMethod",
"valueCodeableConcept": {
"coding": [
{
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod",
"code": "1",
"display": "Letter"
}
]
}
},
{
"url": "PreferredContactTimes",
"valueString": "Not after 7pm"
}
]
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace",
"valueAddress": {
"city": "Manchester",
"district": "Greater Manchester",
"country": "GBR"
}
}
],
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9000000009"
}
],
"name": [
{
"id": "123",
"use": "usual",
"family": "Smith",
"given": [
"Jane"
],
"prefix": [
"Mrs"
],
"suffix": [
"MBE"
],
"period": {
"start": "2020-01-01",
"end": "2021-12-31"
}
}
],
"telecom": [
{
"id": "789",
"system": "phone",
"value": "01632960587",
"use": "home",
"period": {
"start": "2020-01-01",
"end": "2021-12-31"
}
},
{
"id": "OC789",
"system": "other",
"_system": {
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem",
"valueCoding": {
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem",
"code": "textphone",
"display": "Minicom (Textphone)"
}
}
]
},
"value": "01632960587",
"use": "home",
"period": {
"start": "2020-01-01",
"end": "2021-12-31"
}
}
],
"gender": "female",
"birthDate": "2010-10-22",
"deceasedDateTime": "2010-10-22T00:00:00+00:00",
"address": [
{
"id": "456",
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey",
"extension": [
{
"url": "type",
"valueCoding": {
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType",
"code": "PAF"
}
},
{
"url": "value",
"valueString": "12345678"
}
]
}
],
"use": "home",
"line": [
"1 Trevelyan Square",
"Boar Lane",
"City Centre",
"Leeds",
"West Yorkshire"
],
"postalCode": "LS1 6AE",
"period": {
"start": "2020-01-01",
"end": "2021-12-31"
}
},
{
"id": "T456",
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey",
"extension": [
{
"url": "type",
"valueCoding": {
"system": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType",
"code": "PAF"
}
},
{
"url": "value",
"valueString": "12345678"
}
]
}
],
"use": "temp",
"text": "Student Accommodation",
"line": [
"1 Trevelyan Square",
"Boar Lane",
"City Centre",
"Leeds",
"West Yorkshire"
],
"postalCode": "LS1 6AE",
"period": {
"start": "2020-01-01",
"end": "2021-12-31"
}
}
],
"multipleBirthInteger": 1,
"contact": [
{
"id": "C123",
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0131",
"code": "C",
"display": "Emergency Contact"
}
]
}
],
"telecom": [
{
"system": "phone",
"value": "01632960587"
}
],
"period": {
"start": "2020-01-01",
"end": "2021-12-31"
}
}
],
"generalPractitioner": [
{
"id": "254406A3",
"type": "Organization",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "Y12345",
"period": {
"start": "2020-01-01",
"end": "2021-12-31"
}
}
}
]
}
<Patient xmlns="http://hl7.org/fhir">
<id value="6aa13139-201b-4a54-9608-b49331a46d90" />
<meta>
<versionId value="2" />
<security>
<system value="http://terminology.hl7.org/CodeSystem/v3-Confidentiality" />
<code value="U" />
<display value="unrestricted" />
</security>
</meta>
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NominatedPharmacy">
<valueReference>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="Y12345" />
</identifier>
</valueReference>
</extension>
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PreferredDispenserOrganization">
<valueReference>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="Y23456" />
</identifier>
</valueReference>
</extension>
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicalApplianceSupplier">
<valueReference>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="Y34567" />
</identifier>
</valueReference>
</extension>
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus">
<extension url="deathNotificationStatus">
<valueCodeableConcept>
<coding>
<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus" />
<version value="1.0.0" />
<code value="2" />
<display value="Formal - death notice received from Registrar of Deaths" />
</coding>
</valueCodeableConcept>
</extension>
<extension url="systemEffectiveDate">
<valueDateTime value="2010-10-22T00:00:00+00:00" />
</extension>
</extension>
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSCommunication">
<extension url="language">
<valueCodeableConcept>
<coding>
<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage" />
<version value="1.0.0" />
<code value="fr" />
<display value="French" />
</coding>
</valueCodeableConcept>
</extension>
<extension url="interpreterRequired">
<valueBoolean value="true" />
</extension>
</extension>
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference">
<extension url="PreferredWrittenCommunicationFormat">
<valueCodeableConcept>
<coding>
<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat" />
<code value="12" />
<display value="Braille" />
</coding>
</valueCodeableConcept>
</extension>
<extension url="PreferredContactMethod">
<valueCodeableConcept>
<coding>
<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod" />
<code value="1" />
<display value="Letter" />
</coding>
</valueCodeableConcept>
</extension>
<extension url="PreferredContactTimes">
<valueString value="Not after 7pm" />
</extension>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/patient-birthPlace">
<valueAddress>
<city value="Manchester" />
<district value="Greater Manchester" />
<country value="GBR" />
</valueAddress>
</extension>
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9000000009" />
</identifier>
<name id="123">
<use value="usual" />
<family value="Smith" />
<given value="Jane" />
<prefix value="Mrs" />
<suffix value="MBE" />
<period>
<start value="2020-01-01" />
<end value="2021-12-31" />
</period>
</name>
<telecom id="789">
<system value="phone" />
<value value="01632960587" />
<use value="home" />
<period>
<start value="2020-01-01" />
<end value="2021-12-31" />
</period>
</telecom>
<telecom id="OC789">
<system value="other">
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem">
<valueCoding>
<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem" />
<code value="textphone" />
<display value="Minicom (Textphone)" />
</valueCoding>
</extension>
</system>
<value value="01632960587" />
<use value="home" />
<period>
<start value="2020-01-01" />
<end value="2021-12-31" />
</period>
</telecom>
<gender value="female" />
<birthDate value="2010-10-22" />
<deceasedDateTime value="2010-10-22T00:00:00+00:00" />
<address id="456">
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey">
<extension url="type">
<valueCoding>
<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType" />
<code value="PAF" />
</valueCoding>
</extension>
<extension url="value">
<valueString value="12345678" />
</extension>
</extension>
<use value="home" />
<line value="1 Trevelyan Square" />
<line value="Boar Lane" />
<line value="City Centre" />
<line value="Leeds" />
<line value="West Yorkshire" />
<postalCode value="LS1 6AE" />
<period>
<start value="2020-01-01" />
<end value="2021-12-31" />
</period>
</address>
<address id="T456">
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey">
<extension url="type">
<valueCoding>
<system value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType" />
<code value="PAF" />
</valueCoding>
</extension>
<extension url="value">
<valueString value="12345678" />
</extension>
</extension>
<use value="temp" />
<text value="Student Accommodation" />
<line value="1 Trevelyan Square" />
<line value="Boar Lane" />
<line value="City Centre" />
<line value="Leeds" />
<line value="West Yorkshire" />
<postalCode value="LS1 6AE" />
<period>
<start value="2020-01-01" />
<end value="2021-12-31" />
</period>
</address>
<multipleBirthInteger value="1" />
<contact id="C123">
<relationship>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0131" />
<code value="C" />
<display value="Emergency Contact" />
</coding>
</relationship>
<telecom>
<system value="phone" />
<value value="01632960587" />
</telecom>
<period>
<start value="2020-01-01" />
<end value="2021-12-31" />
</period>
</contact>
<generalPractitioner id="254406A3">
<type value="Organization" />
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="Y12345" />
<period>
<start value="2020-01-01" />
<end value="2021-12-31" />
</period>
</identifier>
</generalPractitioner>
</Patient>
Patient

Patient - Jack Dawkins

{
"resourceType": "Patient",
"id": "18d69a47-1a29-4de5-a942-7fd278f09dad",
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
],
"name": [
{
"use": "official",
"family": "Dawkins",
"given": [
"Jack"
]
}
],
"gender": "male",
"birthDate": "1965-02-28",
"address": [
{
"use": "home",
"postalCode": "AB12 3CD"
}
],
"generalPractitioner": [
{
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "B81001"
}
}
]
}
<Patient xmlns="http://hl7.org/fhir">
<id value="18d69a47-1a29-4de5-a942-7fd278f09dad" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9912003888" />
</identifier>
<name>
<use value="official" />
<family value="Dawkins" />
<given value="Jack" />
</name>
<gender value="male" />
<birthDate value="1965-02-28" />
<address>
<use value="home" />
<postalCode value="AB12 3CD" />
</address>
<generalPractitioner>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="B81001" />
</identifier>
</generalPractitioner>
</Patient>
Patient

Patient - Richard Smith

{
"resourceType": "Patient",
"id": "440a0906-8638-4acd-b6b1-cd13159cebc7",
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9871223456"
},
{
"system": "https://fhir.nhs.uk/Id/nhs-login-sub",
"value": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
],
"name": [
{
"use": "official",
"family": "SMITH",
"given": [
"Richard"
]
}
],
"telecom": [
{
"system": "email",
"value": "rsmith@test.com"
},
{
"system": "phone",
"use": "mobile",
"value": "01131231234"
}
],
"gender": "male",
"birthDate": "1970-09-11",
"address": [
{
"postalCode": "LS17 7DF"
}
],
"generalPractitioner": [
{
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "B81001"
}
}
]
}
<Patient xmlns="http://hl7.org/fhir">
<id value="440a0906-8638-4acd-b6b1-cd13159cebc7" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9871223456" />
</identifier>
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-login-sub" />
<value value="3fa85f64-5717-4562-b3fc-2c963f66afa6" />
</identifier>
<name>
<use value="official" />
<family value="SMITH" />
<given value="Richard" />
</name>
<telecom>
<system value="email" />
<value value="rsmith@test.com" />
</telecom>
<telecom>
<system value="phone" />
<value value="01131231234" />
<use value="mobile" />
</telecom>
<gender value="male" />
<birthDate value="1970-09-11" />
<address>
<postalCode value="LS17 7DF" />
</address>
<generalPractitioner>
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="B81001" />
</identifier>
</generalPractitioner>
</Patient>
Patient
back to top