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.

Immunization

vaccination-covid19-1st-dose

{
"resourceType": "Immunization",
"id": "696f13f9-a246-4c28-98be-cd979b86bfe2",
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1324681000000101",
"display": "Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)"
}
]
}
}
],
"identifier": [
{
"system": "https://tools.ietf.org/html/rfc4122",
"value": "a9e514e2-64fc-495e-9a92-28c786807879"
}
],
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39114911000001105",
"display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
}
]
},
"patient": {
"reference": "Patient/1953684",
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
},
"occurrenceDateTime": "2020-12-23T13:00:08.476+00:00",
"recorded": "2020-12-23",
"primarySource": true,
"manufacturer": {
"display": "DREAMLAND Pharmaceuticals Ltd"
},
"lotNumber": "R04X",
"expirationDate": "2021-04-29",
"site": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "368208006",
"display": "Left upper arm structure (body structure)"
}
]
},
"route": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "78421000",
"display": "Intramuscular route (qualifier value)"
}
]
},
"doseQuantity": {
"value": 1,
"unit": "pre-filled disposable injection",
"system": "http://snomed.info/sct",
"code": "3318611000001103"
},
"performer": [
{
"actor": {
"type": "Practitioner",
"identifier": {
"system": "https://fhir.hl7.org.uk/Id/nmc-number",
"value": "55A6789A"
},
"display": "HOLDING, Rafferty"
}
},
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "AP",
"display": "Administering Provider"
}
]
},
"actor": {
"type": "Organization",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RX809"
}
}
}
],
"reasonCode": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "443684005",
"display": "Disease outbreak (event)"
}
]
}
],
"protocolApplied": [
{
"doseNumberPositiveInt": 1
}
]
}
<Immunization xmlns="http://hl7.org/fhir">
<id value="696f13f9-a246-4c28-98be-cd979b86bfe2" />
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure">
<valueCodeableConcept>
<coding>
<system value="http://snomed.info/sct" />
<code value="1324681000000101" />
<display value="Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)" />
</coding>
</valueCodeableConcept>
</extension>
<identifier>
<system value="https://tools.ietf.org/html/rfc4122" />
<value value="a9e514e2-64fc-495e-9a92-28c786807879" />
</identifier>
<status value="completed" />
<vaccineCode>
<coding>
<system value="http://snomed.info/sct" />
<code value="39114911000001105" />
<display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
</coding>
</vaccineCode>
<patient>
<reference value="Patient/1953684" />
<type value="Patient" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9912003888" />
</identifier>
</patient>
<occurrenceDateTime value="2020-12-23T13:00:08.476+00:00" />
<recorded value="2020-12-23" />
<primarySource value="true" />
<manufacturer>
<display value="DREAMLAND Pharmaceuticals Ltd" />
</manufacturer>
<lotNumber value="R04X" />
<expirationDate value="2021-04-29" />
<site>
<coding>
<system value="http://snomed.info/sct" />
<code value="368208006" />
<display value="Left upper arm structure (body structure)" />
</coding>
</site>
<route>
<coding>
<system value="http://snomed.info/sct" />
<code value="78421000" />
<display value="Intramuscular route (qualifier value)" />
</coding>
</route>
<doseQuantity>
<value value="1" />
<unit value="pre-filled disposable injection" />
<system value="http://snomed.info/sct" />
<code value="3318611000001103" />
</doseQuantity>
<performer>
<actor>
<type value="Practitioner" />
<identifier>
<system value="https://fhir.hl7.org.uk/Id/nmc-number" />
<value value="55A6789A" />
</identifier>
<display value="HOLDING, Rafferty" />
</actor>
</performer>
<performer>
<function>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0443" />
<code value="AP" />
<display value="Administering Provider" />
</coding>
</function>
<actor>
<type value="Organization" />
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="RX809" />
</identifier>
</actor>
</performer>
<reasonCode>
<coding>
<system value="http://snomed.info/sct" />
<code value="443684005" />
<display value="Disease outbreak (event)" />
</coding>
</reasonCode>
<protocolApplied>
<doseNumberPositiveInt value="1" />
</protocolApplied>
</Immunization>
Immunization

vaccination-covid19-2nd-dose

{
"resourceType": "Immunization",
"id": "551ef667-1402-4c92-ba34-a0bb88b998dc",
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1324691000000104",
"display": "Administration of second dose of SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccine"
}
]
}
}
],
"identifier": [
{
"system": "https://tools.ietf.org/html/rfc4122",
"value": "7ec28d82-33bf-4e6d-a8de-91dcbc8d1802"
}
],
"status": "completed",
"primarySource": false,
"reportOrigin": {
"text": "RR8 - LEEDS TEACHING HOSPITALS NHS TRUST"
},
"occurrenceDateTime": "2021-02-23T13:00:08.476+00:00",
"patient": {
"reference": "Patient/1953684",
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
},
"vaccineCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39114911000001105",
"display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
}
]
},
"manufacturer": {
"display": "DREAMLAND Pharmaceuticals Ltd"
},
"lotNumber": "R04X",
"protocolApplied": [
{
"doseNumberPositiveInt": 2
}
]
}
<Immunization xmlns="http://hl7.org/fhir">
<id value="551ef667-1402-4c92-ba34-a0bb88b998dc" />
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure">
<valueCodeableConcept>
<coding>
<system value="http://snomed.info/sct" />
<code value="1324691000000104" />
<display value="Administration of second dose of SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccine" />
</coding>
</valueCodeableConcept>
</extension>
<identifier>
<system value="https://tools.ietf.org/html/rfc4122" />
<value value="7ec28d82-33bf-4e6d-a8de-91dcbc8d1802" />
</identifier>
<status value="completed" />
<vaccineCode>
<coding>
<system value="http://snomed.info/sct" />
<code value="39114911000001105" />
<display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
</coding>
</vaccineCode>
<patient>
<reference value="Patient/1953684" />
<type value="Patient" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9912003888" />
</identifier>
</patient>
<occurrenceDateTime value="2021-02-23T13:00:08.476+00:00" />
<primarySource value="false" />
<reportOrigin>
<text value="RR8 - LEEDS TEACHING HOSPITALS NHS TRUST" />
</reportOrigin>
<manufacturer>
<display value="DREAMLAND Pharmaceuticals Ltd" />
</manufacturer>
<lotNumber value="R04X" />
<protocolApplied>
<doseNumberPositiveInt value="2" />
</protocolApplied>
</Immunization>
Immunization

vaccination-covid19-not-given

{
"resourceType": "Immunization",
"id": "251d4f32-e9ae-41f2-bb63-54e692195cc2",
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1324681000000101",
"display": "Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)"
}
]
}
}
],
"identifier": [
{
"use": "secondary",
"system": "https://fhir.leedsth.nhs.uk/Id/vaccination",
"value": "1001324761000000"
}
],
"status": "not-done",
"statusReason": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1324721000000108",
"display": "SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccination dose declined"
}
]
},
"vaccineCode": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
"code": "NA",
"display": "not applicable"
}
]
},
"patient": {
"reference": "urn:uuid:edea022a-2d81-11eb-adc1-0242ac120002",
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
},
"occurrenceDateTime": "2020-12-21T09:15:08.326+00:00",
"recorded": "2020-12-21",
"primarySource": false,
"reportOrigin": {
"text": "RR8 - LEEDS TEACHING HOSPITALS NHS TRUST"
},
"performer": [
{
"actor": {
"type": "Organization",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "C4B2A"
},
"display": "ELLAND ROAD STADIUM - COVID VACCINATION CENTRE"
}
}
]
}
<Immunization xmlns="http://hl7.org/fhir">
<id value="251d4f32-e9ae-41f2-bb63-54e692195cc2" />
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure">
<valueCodeableConcept>
<coding>
<system value="http://snomed.info/sct" />
<code value="1324681000000101" />
<display value="Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)" />
</coding>
</valueCodeableConcept>
</extension>
<identifier>
<use value="secondary" />
<system value="https://fhir.leedsth.nhs.uk/Id/vaccination" />
<value value="1001324761000000" />
</identifier>
<status value="not-done" />
<statusReason>
<coding>
<system value="http://snomed.info/sct" />
<code value="1324721000000108" />
<display value="SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccination dose declined" />
</coding>
</statusReason>
<vaccineCode>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v3-NullFlavor" />
<code value="NA" />
<display value="not applicable" />
</coding>
</vaccineCode>
<patient>
<reference value="urn:uuid:edea022a-2d81-11eb-adc1-0242ac120002" />
<type value="Patient" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9912003888" />
</identifier>
</patient>
<occurrenceDateTime value="2020-12-21T09:15:08.326+00:00" />
<recorded value="2020-12-21" />
<primarySource value="false" />
<reportOrigin>
<text value="RR8 - LEEDS TEACHING HOSPITALS NHS TRUST" />
</reportOrigin>
<performer>
<actor>
<type value="Organization" />
<identifier>
<system value="https://fhir.nhs.uk/Id/ods-organization-code" />
<value value="C4B2A" />
</identifier>
<display value="ELLAND ROAD STADIUM - COVID VACCINATION CENTRE" />
</actor>
</performer>
</Immunization>
Immunization

vaccination-covid19-international

{
"resourceType": "Immunization",
"id": "bd2ec326-7570-46bd-98a0-02c4b924c79d",
"extension": [
{
"url": "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1324681000000101",
"display": "Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)"
}
]
}
}
],
"identifier": [
{
"system": "https://tools.ietf.org/html/rfc4122",
"value": "bd2ec326-7570-46bd-98a0-02c4b924c79d"
}
],
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39114911000001105",
"display": "COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)"
}
]
},
"patient": {
"reference": "Patient/1953684",
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
},
"occurrenceDateTime": "2020-12-23T13:00:08.476+00:00",
"recorded": "2020-12-23",
"primarySource": true,
"location": {
"identifier": {
"system": "urn:iso:std:iso:3166",
"value": "FR"
},
"display": "France"
},
"manufacturer": {
"display": "DREAMLAND Pharmaceuticals Ltd"
},
"lotNumber": "4XR0",
"expirationDate": "2021-04-29",
"site": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "368208006",
"display": "Left upper arm structure (body structure)"
}
]
},
"route": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "78421000",
"display": "Intramuscular route (qualifier value)"
}
]
},
"doseQuantity": {
"value": 1,
"unit": "pre-filled disposable injection",
"system": "http://snomed.info/sct",
"code": "3318611000001103"
},
"reasonCode": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "443684005",
"display": "Disease outbreak (event)"
}
]
}
],
"protocolApplied": [
{
"doseNumberPositiveInt": 1
}
]
}
<Immunization xmlns="http://hl7.org/fhir">
<id value="bd2ec326-7570-46bd-98a0-02c4b924c79d" />
<extension url="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-VaccinationProcedure">
<valueCodeableConcept>
<coding>
<system value="http://snomed.info/sct" />
<code value="1324681000000101" />
<display value="Administration of first dose of severe acute respiratory syndrome coronavirus 2 vaccine (procedure)" />
</coding>
</valueCodeableConcept>
</extension>
<identifier>
<system value="https://tools.ietf.org/html/rfc4122" />
<value value="bd2ec326-7570-46bd-98a0-02c4b924c79d" />
</identifier>
<status value="completed" />
<vaccineCode>
<coding>
<system value="http://snomed.info/sct" />
<code value="39114911000001105" />
<display value="COVID-19 Vaccine Vaxzevria (ChAdOx1 S [recombinant]) not less than 2.5x100,000,000 infectious units/0.5ml dose suspension for injection multidose vials (AstraZeneca UK Ltd)" />
</coding>
</vaccineCode>
<patient>
<reference value="Patient/1953684" />
<type value="Patient" />
<identifier>
<system value="https://fhir.nhs.uk/Id/nhs-number" />
<value value="9912003888" />
</identifier>
</patient>
<occurrenceDateTime value="2020-12-23T13:00:08.476+00:00" />
<recorded value="2020-12-23" />
<primarySource value="true" />
<location>
<identifier>
<system value="urn:iso:std:iso:3166" />
<value value="FR" />
</identifier>
<display value="France" />
</location>
<manufacturer>
<display value="DREAMLAND Pharmaceuticals Ltd" />
</manufacturer>
<lotNumber value="4XR0" />
<expirationDate value="2021-04-29" />
<site>
<coding>
<system value="http://snomed.info/sct" />
<code value="368208006" />
<display value="Left upper arm structure (body structure)" />
</coding>
</site>
<route>
<coding>
<system value="http://snomed.info/sct" />
<code value="78421000" />
<display value="Intramuscular route (qualifier value)" />
</coding>
</route>
<doseQuantity>
<value value="1" />
<unit value="pre-filled disposable injection" />
<system value="http://snomed.info/sct" />
<code value="3318611000001103" />
</doseQuantity>
<reasonCode>
<coding>
<system value="http://snomed.info/sct" />
<code value="443684005" />
<display value="Disease outbreak (event)" />
</coding>
</reasonCode>
<protocolApplied>
<doseNumberPositiveInt value="1" />
</protocolApplied>
</Immunization>
Immunization
back to top