Combined with
Command 'link' could not render: Object reference not set to an instance of an object.
Immunization | | | Immunization | There are no (further) constraints on this element Data type Immunization |
extension | | 0.. | | There are no (further) constraints on this element Element idSliced: Unordered, Open, by url(Value) |
parentPresent | | 0.. | | There are no (further) constraints on this element Element idImmunization.extension:parentPresent |
vaccinationProcedure | S | 0.. | Binding | There are no (further) constraints on this element Element idImmunization.extension:vaccinationProcedure Definition Where status=completed this is Mandatory
This relates to the vaccine that was administered (procedure) and is a SNOMED CT from {{link:https://fhir.hl7.org.uk/ValueSet/UKCore-VaccinationProcedure}}
In addition to the codes in the following codes are recommended.
<table>
<thead>
<th data-no-sort >
Vaccination Procedure
</th>
<th data-no-sort >
UK SNOMED self
</th>
</thead>
<tr>
<td>
Administration of first dose of SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccine
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=1324681000000101" target="_blank">1324681000000101</a>
</td>
</tr>
<tr>
<td>
Administration of second dose of SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccine
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=1324691000000104" target="_blank">1324691000000104</a>
</td>
</tr>
</table>
<br>
"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)"
}
]
}
}
],
Binding https://fhir.nhs.uk/ValueSet/NHSDigital-VaccinationProcedure
(unbound) (required) |
identifier | S | 1.. | | There are no (further) constraints on this element Element idDefinition identifier.system
A URI for the system that has allocated the vaccination identifier.
Note, this must be unique within a given Supplier system or instance of Supplier system
e.g.
Example of a “single instance for all customers” Supplier system
https://supplierABC/identifiers/vacc
Example of “per customer instance” Supplier system
https://supplierABC/ODSCode/NKO41/identifiers/vacc
identifier.value
A unique identifier for the vaccination record, that is consistent between any subsequent update or delete records.
Ideally this would be a GUID / UUID
Value in combination with UNIQUE_ID_URI must be globally unique
In other words, a combination of identifier.value and identifier.system act as composite primary key to allow lookup of any Adverse Reactions records from the corresponding Adverse Reaction data file.
UUID example:
e045626e-4dc5-4df3-bc35-da25263f901e
Example of a “single instance for all customers” Supplier system
ACME-vacc123456
Example of “per customer instance” Supplier system
ACME-CUSTOMER1-vacc123456
ACME-CUSTOMER2-vacc123456
|
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idImmunization.identifier.value |
status | S | | | There are no (further) constraints on this element Element idDefinition For a vaccination that has been administered, the status will be completed . This status does not indicate a vaccination course has been completed.
When the vaccination has not been administered, the status will be not-done and a statusReason should be supplied.
|
statusReason | | | Binding | There are no (further) constraints on this element Element idImmunization.statusReason Binding NHSDigitalReasonImmunizationNotAdministered (required) |
coding | | 1.. | | There are no (further) constraints on this element Element idImmunization.statusReason.coding |
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.statusReason.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idImmunization.statusReason.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idImmunization.statusReason.coding.display |
vaccineCode | | | Binding | There are no (further) constraints on this element Element idDefinition Where status is completed this is Mandatory. This indicates vaccine product administered. This should be a SNOMED CT code from {{link:https://fhir.hl7.org.uk/ValueSet/UKCore-VaccineCode}}
AMPP codes should not be used.
<table>
<thead>
<th data-no-sort width="20%">
Vaccine Reference Set
</th>
<th data-no-sort width="25%">
UK SNOMED Members Of
</th>
<th data-no-sort width="25%">
UK SNOMED Descendents Of
</th>
</thead>
<tr>
<td>
Meningococcal ACWY vaccines
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=999000811000001105" target="_blank">999000811000001105</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
Influenza vaccines prescribable within general practice
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=12465201000001105" target="_blank">12465201000001105</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
Meningococcal B vaccines
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=999000831000001104" target="_blank">999000831000001104</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
Pneumococcal vaccines
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=999000841000001106" target="_blank">999000841000001106</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
Seasonal Flu vaccines
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=999000821000001101" target="_blank">999000821000001101</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
COVID-19 vaccines
</td>
<td>
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=39330711000001103" target="_blank">39330711000001103</a>
</td>
</tr>
</table>
<br>
"vaccineCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39114911000001105",
"display": "COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose solution for injection multidose vials (AstraZeneca)"
}
]
},
<br>
For EU/international purposes, a vaccination type code can be also be included. The SNOMED CT concept should be from Vaccines (GPS) - IPS and EU SNOMED CT Vaccine List (COVID-19)
"vaccineCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39114911000001105",
"display": "COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose solution for injection multidose vials (AstraZeneca)"
},
{
"system": "http://snomed.info/sct",
"code": "1119305005",
"display": "SARS-CoV-2 antigen vaccine"
}
]
},
Binding NHSDigitalVaccineCode (extensible) |
coding | S | 1.. | | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding |
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.display |
patient | S I | | Reference(NHSDigitalPatientMinimal) | There are no (further) constraints on this element Element idDefinition A traced NHS Number SHOULD be provided and when applicable a resource reference to the Patient resource.
"patient": {
"reference": "urn:uuid:edea022a-2d81-11eb-adc1-0242ac120002",
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
},
Data type Reference(NHSDigitalPatientMinimal) Constraints- patient-reference: subject - An identifier reference or resource reference must be provided
(reference.exists() or (identifier.exists())) - patient-nhs: Supplied NHS Number is outside the English and Welsh NHS Number range or length of the number is wrong.
identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists() and identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').value.matches('^([456789]{1}[0-9]{9})$'))
|
identifier | | 1.. | | There are no (further) constraints on this element Element idImmunization.patient.identifier |
system | | 1.. | Fixed Value | There are no (further) constraints on this element Element idImmunization.patient.identifier.system Fixed value https://fhir.nhs.uk/Id/nhs-number |
value | | 1.. | | There are no (further) constraints on this element Element idImmunization.patient.identifier.value |
occurrence[x] | S | | | There are no (further) constraints on this element Element idImmunization.occurrence[x] Definition The date and time on which the vaccination intervention was carried out or was meant to be administered.
|
occurrenceDateTime | | | dateTime | There are no (further) constraints on this element Data type dateTime |
recorded | S | | | There are no (further) constraints on this element Element idDefinition The date that the vaccination administered (procedure) or not administered (situation) was recorded in the source system.
|
primarySource | S | 1.. | | There are no (further) constraints on this element Element idImmunization.primarySource Definition Set as TRUE when the content of the record is based on information from the person performing the vaccine or who has clinical responsibility for the vaccination, and the system can be considered a primary source of the vaccination event.
Set as FALSE when the information has NOT come directly from people performing the vaccine (e.g. a patient or patient’s carer), and the system should not be treated as a primary source for this record.
This is used to help identify and eliminate duplicate records held centrally.
|
reportOrigin | S | | | There are no (further) constraints on this element Element idImmunization.reportOrigin Definition Where primarySource=false ,
- The ODS code should be set to the location of the primary source of the data where the report of the vaccination event is held
Where primarySource=false and the vaccination event has been stored in local Primary Care System.
- The ODS code should be set to the ODS code of the organisation where the event has been stored e.g. GP practice or PCN.
Note this field will be used to determine whether or not to send the vaccination event to the patient’s registered GP
"reportOrigin": {
"text": "RR8 - LEEDS TEACHING HOSPITALS NHS TRUST"
},
|
location | S | | | There are no (further) constraints on this element Element idDefinition Country where the vaccination took place. This should follow Using ISO 3166 Country Codes with FHIR or a SNOMED Country Code.
"location": {
"identifier": {
"system": "urn:iso:std:iso:3166",
"value": "FR"
},
"display": "France"
},
|
manufacturer | S | | | There are no (further) constraints on this element Element idImmunization.manufacturer Definition Manufacturer of vaccine product. Only the display is expected to be populated.
"manufacturer": {
"display": "DREAMLAND Pharmaceuticals Ltd"
},
|
display | | 1.. | | There are no (further) constraints on this element Element idImmunization.manufacturer.display |
lotNumber | S | | | There are no (further) constraints on this element Element idDefinition Where status=completed this is Mandatory.
This should be captured at source ideally via use of automated scanning technology (GS1 GTIN / NTIN standard).
"lotNumber": "R04X",
|
expirationDate | S | | | There are no (further) constraints on this element Element idImmunization.expirationDate Definition Shorter date of either:
- Manufacturer expiry date of the vaccine
- Coronavirus point of care sites will only put in the defrost expiry date
|
site | S | | Binding | There are no (further) constraints on this element Element idDefinition Body site vaccine was administered into. A SNOMED Concept ID value from UK published reference set “Vaccine body site of administration simple reference set” (1127941000000100) should be used {{link:https://fhir.hl7.org.uk/ValueSet/UKCore-BodySite}}
"site": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "368208006",
"display": "Left upper arm structure (body structure)"
}
]
},
Binding https://fhir.hl7.org.uk/ValueSet/UKCore-BodySite (extensible) |
coding | | 1.. | | There are no (further) constraints on this element Element id |
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.site.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idImmunization.site.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idImmunization.site.coding.display |
route | S | | | There are no (further) constraints on this element Element idDefinition A SNOMED concept ID value from either of the following should be used:
UK “ePrescribing route of administration simple reference set (foundation metadata concept)” (999000051000001100) [UKCore-MedicationDosageRoute](https://simplifier.net/resolve?target=simplifier&scope=uk.nhsdigital.r4&canonical=https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationDosageRoute}
Or:
UK published reference set “Vaccine route of administration simple reference set” (115231000001104)
"route": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "78421000",
"display": "Intramuscular route (qualifier value)"
}
]
},
|
doseQuantity | S | | | There are no (further) constraints on this element Element idImmunization.doseQuantity Definition A dm+d (SNOMED) Concept ID value representing the Unit of measure used.
For COVID-19 a reference set has been published here: https://dd4c.digital.nhs.uk/dd4c/publishedmetadatas/intid/980?size=10
"doseQuantity": {
"value": 1,
"unit": "pre-filled disposable injection",
"system": "http://snomed.info/sct",
"code": "3318611000001100"
},
|
performer | S | | | There are no (further) constraints on this element Element idDefinition The organisation ODS code of the location where the vaccination event took place with corresponding system of https://fhir.nhs.uk/Id/ods-organization-code . For roving teams on home visits or care home visits use the site code of the responsible site e.g. GP practice or dedicated vaccination site. It is strongly recommend the name of the Organisation is present in the display field.
Vaccination professional should be recorded using professional codes, see NHSDigital-Practitioner for details.
"performer": [
{
"actor": {
"type": "Practitioner",
"identifier": {
"system": "https://fhir.hl7.org.uk/Id/nmc-number",
"value": "5566789"
},
"display": "HOLDING, Rafferty"
}
},
{
"actor": {
"type": "Organization",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "C4B2A"
},
"display": "ELLAND ROAD STADIUM - COVID VACCINATION CENTRE"
}
}
],
|
actor | S I | | NHSDigitalReference(NHSDigitalOrganization | NHSDigitalPractitionerRole | NHSDigitalPractitioner) | There are no (further) constraints on this element Element idImmunization.performer.actor Data type NHSDigitalReference(NHSDigitalOrganization | NHSDigitalPractitionerRole | NHSDigitalPractitioner) Constraints- usercode-reference: An identifier reference or resource reference must be provided
(reference.exists() or identifier.exists()) - usercode-nmc: NMC must be of the format NNANNNNA
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').value.matches('^[0-9]{2}[A-Z]{1}[0-9]{4}[A-Z]{1}$')) - usercode-gmp: GMP must be of the format GNNNNNNN and not be a spurious code (starts with G6 or G7)
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').value.matches('^[G]{1}[01234589]{1}[0-9]{6}$')) - usercode-gmc: GMC must be of the format CNNNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').value.matches('^[C]{1}[0-9]{7}$')) - usercode-gphc: GPHC must be of the format NNNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').value.matches('^[0-9]{7}$')) - usercode-hcpc: HCPC must be of the format AANNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').value.matches('^[A-Z]{2}[0-9]{6}$')) - usercode-din: DIN format must be NNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').value.matches('^[0-9]{6}$')) - role-sds-role-profile: SDS Role Profile Id must be 12 digits
identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').exists() and identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').value.matches('^[0-9]{12}$'))
|
type | | 1.. | | There are no (further) constraints on this element Element idImmunization.performer.actor.type |
identifier | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.performer.actor.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idImmunization.performer.actor.identifier.value |
reasonCode | S | | Binding | There are no (further) constraints on this element Element idDefinition A SNOMED Concept Id. For COVID19 and Flu see https://digital.nhs.uk/developer/api-catalogue/vaccination
Binding NHSDigitalImmunizationExplanationReason (extensible) |
coding | S | 1.. | | There are no (further) constraints on this element Element idImmunization.reasonCode.coding |
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.reasonCode.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idImmunization.reasonCode.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idImmunization.reasonCode.coding.display |
protocolApplied | S | | | There are no (further) constraints on this element Element idImmunization.protocolApplied |
targetDisease | S | | Binding | There are no (further) constraints on this element Element idImmunization.protocolApplied.targetDisease Binding (Work in progress) The vaccine preventable disease the dose is being administered for.
http://hl7.eu/fhir/ig/dgc/ValueSet/covid-19-diseases (required) |
Immunization | | | Immunization | There are no (further) constraints on this element Data type Immunization |
extension | | 0.. | | There are no (further) constraints on this element Element idSliced: Unordered, Open, by url(Value) |
parentPresent | | 0.. | | There are no (further) constraints on this element Element idImmunization.extension:parentPresent |
vaccinationProcedure | S | 0.. | Binding | There are no (further) constraints on this element Element idImmunization.extension:vaccinationProcedure Definition Where status=completed this is Mandatory
This relates to the vaccine that was administered (procedure) and is a SNOMED CT from {{link:https://fhir.hl7.org.uk/ValueSet/UKCore-VaccinationProcedure}}
In addition to the codes in the following codes are recommended.
<table>
<thead>
<th data-no-sort >
Vaccination Procedure
</th>
<th data-no-sort >
UK SNOMED self
</th>
</thead>
<tr>
<td>
Administration of first dose of SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccine
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=1324681000000101" target="_blank">1324681000000101</a>
</td>
</tr>
<tr>
<td>
Administration of second dose of SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccine
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=1324691000000104" target="_blank">1324691000000104</a>
</td>
</tr>
</table>
<br>
"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)"
}
]
}
}
],
Binding https://fhir.nhs.uk/ValueSet/NHSDigital-VaccinationProcedure
(unbound) (required) |
identifier | S | 1.. | | There are no (further) constraints on this element Element idDefinition identifier.system
A URI for the system that has allocated the vaccination identifier.
Note, this must be unique within a given Supplier system or instance of Supplier system
e.g.
Example of a “single instance for all customers” Supplier system
https://supplierABC/identifiers/vacc
Example of “per customer instance” Supplier system
https://supplierABC/ODSCode/NKO41/identifiers/vacc
identifier.value
A unique identifier for the vaccination record, that is consistent between any subsequent update or delete records.
Ideally this would be a GUID / UUID
Value in combination with UNIQUE_ID_URI must be globally unique
In other words, a combination of identifier.value and identifier.system act as composite primary key to allow lookup of any Adverse Reactions records from the corresponding Adverse Reaction data file.
UUID example:
e045626e-4dc5-4df3-bc35-da25263f901e
Example of a “single instance for all customers” Supplier system
ACME-vacc123456
Example of “per customer instance” Supplier system
ACME-CUSTOMER1-vacc123456
ACME-CUSTOMER2-vacc123456
|
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idImmunization.identifier.value |
status | S | | | There are no (further) constraints on this element Element idDefinition For a vaccination that has been administered, the status will be completed . This status does not indicate a vaccination course has been completed.
When the vaccination has not been administered, the status will be not-done and a statusReason should be supplied.
|
statusReason | | | Binding | There are no (further) constraints on this element Element idImmunization.statusReason Binding NHSDigitalReasonImmunizationNotAdministered (required) |
coding | | 1.. | | There are no (further) constraints on this element Element idImmunization.statusReason.coding |
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.statusReason.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idImmunization.statusReason.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idImmunization.statusReason.coding.display |
vaccineCode | | | Binding | There are no (further) constraints on this element Element idDefinition Where status is completed this is Mandatory. This indicates vaccine product administered. This should be a SNOMED CT code from {{link:https://fhir.hl7.org.uk/ValueSet/UKCore-VaccineCode}}
AMPP codes should not be used.
<table>
<thead>
<th data-no-sort width="20%">
Vaccine Reference Set
</th>
<th data-no-sort width="25%">
UK SNOMED Members Of
</th>
<th data-no-sort width="25%">
UK SNOMED Descendents Of
</th>
</thead>
<tr>
<td>
Meningococcal ACWY vaccines
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=999000811000001105" target="_blank">999000811000001105</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
Influenza vaccines prescribable within general practice
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=12465201000001105" target="_blank">12465201000001105</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
Meningococcal B vaccines
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=999000831000001104" target="_blank">999000831000001104</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
Pneumococcal vaccines
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=999000841000001106" target="_blank">999000841000001106</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
Seasonal Flu vaccines
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=999000821000001101" target="_blank">999000821000001101</a>
</td>
<td>
</td>
</tr>
<tr>
<td>
COVID-19 vaccines
</td>
<td>
</td>
<td>
<a href="https://termbrowser.nhs.uk/?perspective=full&conceptId1=39330711000001103" target="_blank">39330711000001103</a>
</td>
</tr>
</table>
<br>
"vaccineCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39114911000001105",
"display": "COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose solution for injection multidose vials (AstraZeneca)"
}
]
},
<br>
For EU/international purposes, a vaccination type code can be also be included. The SNOMED CT concept should be from Vaccines (GPS) - IPS and EU SNOMED CT Vaccine List (COVID-19)
"vaccineCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39114911000001105",
"display": "COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose solution for injection multidose vials (AstraZeneca)"
},
{
"system": "http://snomed.info/sct",
"code": "1119305005",
"display": "SARS-CoV-2 antigen vaccine"
}
]
},
Binding NHSDigitalVaccineCode (extensible) |
coding | S | 1.. | | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding |
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idImmunization.vaccineCode.coding.display |
patient | S I | | Reference(NHSDigitalPatientMinimal) | There are no (further) constraints on this element Element idDefinition A traced NHS Number SHOULD be provided and when applicable a resource reference to the Patient resource.
"patient": {
"reference": "urn:uuid:edea022a-2d81-11eb-adc1-0242ac120002",
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
},
Data type Reference(NHSDigitalPatientMinimal) Constraints- patient-reference: subject - An identifier reference or resource reference must be provided
(reference.exists() or (identifier.exists())) - patient-nhs: Supplied NHS Number is outside the English and Welsh NHS Number range or length of the number is wrong.
identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').exists() and identifier.where(system='https://fhir.nhs.uk/Id/nhs-number').value.matches('^([456789]{1}[0-9]{9})$'))
|
identifier | | 1.. | | There are no (further) constraints on this element Element idImmunization.patient.identifier |
system | | 1.. | Fixed Value | There are no (further) constraints on this element Element idImmunization.patient.identifier.system Fixed value https://fhir.nhs.uk/Id/nhs-number |
value | | 1.. | | There are no (further) constraints on this element Element idImmunization.patient.identifier.value |
occurrence[x] | S | | | There are no (further) constraints on this element Element idImmunization.occurrence[x] Definition The date and time on which the vaccination intervention was carried out or was meant to be administered.
|
occurrenceDateTime | | | dateTime | There are no (further) constraints on this element Data type dateTime |
recorded | S | | | There are no (further) constraints on this element Element idDefinition The date that the vaccination administered (procedure) or not administered (situation) was recorded in the source system.
|
primarySource | S | 1.. | | There are no (further) constraints on this element Element idImmunization.primarySource Definition Set as TRUE when the content of the record is based on information from the person performing the vaccine or who has clinical responsibility for the vaccination, and the system can be considered a primary source of the vaccination event.
Set as FALSE when the information has NOT come directly from people performing the vaccine (e.g. a patient or patient’s carer), and the system should not be treated as a primary source for this record.
This is used to help identify and eliminate duplicate records held centrally.
|
reportOrigin | S | | | There are no (further) constraints on this element Element idImmunization.reportOrigin Definition Where primarySource=false ,
- The ODS code should be set to the location of the primary source of the data where the report of the vaccination event is held
Where primarySource=false and the vaccination event has been stored in local Primary Care System.
- The ODS code should be set to the ODS code of the organisation where the event has been stored e.g. GP practice or PCN.
Note this field will be used to determine whether or not to send the vaccination event to the patient’s registered GP
"reportOrigin": {
"text": "RR8 - LEEDS TEACHING HOSPITALS NHS TRUST"
},
|
location | S | | | There are no (further) constraints on this element Element idDefinition Country where the vaccination took place. This should follow Using ISO 3166 Country Codes with FHIR or a SNOMED Country Code.
"location": {
"identifier": {
"system": "urn:iso:std:iso:3166",
"value": "FR"
},
"display": "France"
},
|
manufacturer | S | | | There are no (further) constraints on this element Element idImmunization.manufacturer Definition Manufacturer of vaccine product. Only the display is expected to be populated.
"manufacturer": {
"display": "DREAMLAND Pharmaceuticals Ltd"
},
|
display | | 1.. | | There are no (further) constraints on this element Element idImmunization.manufacturer.display |
lotNumber | S | | | There are no (further) constraints on this element Element idDefinition Where status=completed this is Mandatory.
This should be captured at source ideally via use of automated scanning technology (GS1 GTIN / NTIN standard).
"lotNumber": "R04X",
|
expirationDate | S | | | There are no (further) constraints on this element Element idImmunization.expirationDate Definition Shorter date of either:
- Manufacturer expiry date of the vaccine
- Coronavirus point of care sites will only put in the defrost expiry date
|
site | S | | Binding | There are no (further) constraints on this element Element idDefinition Body site vaccine was administered into. A SNOMED Concept ID value from UK published reference set “Vaccine body site of administration simple reference set” (1127941000000100) should be used {{link:https://fhir.hl7.org.uk/ValueSet/UKCore-BodySite}}
"site": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "368208006",
"display": "Left upper arm structure (body structure)"
}
]
},
Binding https://fhir.hl7.org.uk/ValueSet/UKCore-BodySite (extensible) |
coding | | 1.. | | There are no (further) constraints on this element Element id |
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.site.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idImmunization.site.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idImmunization.site.coding.display |
route | S | | | There are no (further) constraints on this element Element idDefinition A SNOMED concept ID value from either of the following should be used:
UK “ePrescribing route of administration simple reference set (foundation metadata concept)” (999000051000001100) [UKCore-MedicationDosageRoute](https://simplifier.net/resolve?target=simplifier&scope=uk.nhsdigital.r4&canonical=https://fhir.hl7.org.uk/ValueSet/UKCore-MedicationDosageRoute}
Or:
UK published reference set “Vaccine route of administration simple reference set” (115231000001104)
"route": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "78421000",
"display": "Intramuscular route (qualifier value)"
}
]
},
|
doseQuantity | S | | | There are no (further) constraints on this element Element idImmunization.doseQuantity Definition A dm+d (SNOMED) Concept ID value representing the Unit of measure used.
For COVID-19 a reference set has been published here: https://dd4c.digital.nhs.uk/dd4c/publishedmetadatas/intid/980?size=10
"doseQuantity": {
"value": 1,
"unit": "pre-filled disposable injection",
"system": "http://snomed.info/sct",
"code": "3318611000001100"
},
|
performer | S | | | There are no (further) constraints on this element Element idDefinition The organisation ODS code of the location where the vaccination event took place with corresponding system of https://fhir.nhs.uk/Id/ods-organization-code . For roving teams on home visits or care home visits use the site code of the responsible site e.g. GP practice or dedicated vaccination site. It is strongly recommend the name of the Organisation is present in the display field.
Vaccination professional should be recorded using professional codes, see NHSDigital-Practitioner for details.
"performer": [
{
"actor": {
"type": "Practitioner",
"identifier": {
"system": "https://fhir.hl7.org.uk/Id/nmc-number",
"value": "5566789"
},
"display": "HOLDING, Rafferty"
}
},
{
"actor": {
"type": "Organization",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "C4B2A"
},
"display": "ELLAND ROAD STADIUM - COVID VACCINATION CENTRE"
}
}
],
|
actor | S I | | NHSDigitalReference(NHSDigitalOrganization | NHSDigitalPractitionerRole | NHSDigitalPractitioner) | There are no (further) constraints on this element Element idImmunization.performer.actor Data type NHSDigitalReference(NHSDigitalOrganization | NHSDigitalPractitionerRole | NHSDigitalPractitioner) Constraints- usercode-reference: An identifier reference or resource reference must be provided
(reference.exists() or identifier.exists()) - usercode-nmc: NMC must be of the format NNANNNNA
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').value.matches('^[0-9]{2}[A-Z]{1}[0-9]{4}[A-Z]{1}$')) - usercode-gmp: GMP must be of the format GNNNNNNN and not be a spurious code (starts with G6 or G7)
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').value.matches('^[G]{1}[01234589]{1}[0-9]{6}$')) - usercode-gmc: GMC must be of the format CNNNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').value.matches('^[C]{1}[0-9]{7}$')) - usercode-gphc: GPHC must be of the format NNNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').value.matches('^[0-9]{7}$')) - usercode-hcpc: HCPC must be of the format AANNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').value.matches('^[A-Z]{2}[0-9]{6}$')) - usercode-din: DIN format must be NNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').value.matches('^[0-9]{6}$')) - role-sds-role-profile: SDS Role Profile Id must be 12 digits
identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').exists() and identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').value.matches('^[0-9]{12}$'))
|
type | | 1.. | | There are no (further) constraints on this element Element idImmunization.performer.actor.type |
identifier | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.performer.actor.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idImmunization.performer.actor.identifier.value |
reasonCode | S | | Binding | There are no (further) constraints on this element Element idDefinition A SNOMED Concept Id. For COVID19 and Flu see https://digital.nhs.uk/developer/api-catalogue/vaccination
Binding NHSDigitalImmunizationExplanationReason (extensible) |
coding | S | 1.. | | There are no (further) constraints on this element Element idImmunization.reasonCode.coding |
system | | 1.. | | There are no (further) constraints on this element Element idImmunization.reasonCode.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idImmunization.reasonCode.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idImmunization.reasonCode.coding.display |
protocolApplied | S | | | There are no (further) constraints on this element Element idImmunization.protocolApplied |
targetDisease | S | | Binding | There are no (further) constraints on this element Element idImmunization.protocolApplied.targetDisease Binding (Work in progress) The vaccine preventable disease the dose is being administered for.
http://hl7.eu/fhir/ig/dgc/ValueSet/covid-19-diseases (required) |
You dot not have a license to run FQL queries.
Command 'pagelink' could not render: Page not found.
|
Command 'pagelink' could not render: Page not found.
|
Command 'pagelink' could not render: Page not found.
|
Command 'pagelink' could not render: Page not found.
|
Command 'pagelink' could not render: Page not found.
|
This conformance profile is based on the NHS Digital - Daily Clinical Vacination Specification COVID 19 and is intended for internal use only.
Must Support, Optional and Not Supported
Elements marked with a S MUST be supported by both producing and receiving systems. They should be populated if the data exists or the profile has made them mandatory.
The following elements SHOULD NOT are not expected to be supported by consuming or receiving systems.
isSubpotent
subpotentReason
education
programEligibility
fundingSource
Elements that are neither marked as Must Support
or listed as unsupported are optional.
extension(vaccinationProcedure)
Where status=completed
this is Mandatory
This relates to the vaccine that was administered (procedure) and is a SNOMED CT from
Command 'link' could not render: Object reference not set to an instance of an object.
In addition to the codes in the following codes are recommended.
Vaccination Procedure
|
UK SNOMED self
|
Administration of first dose of SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccine
|
1324681000000101
|
Administration of second dose of SARS-CoV-2 (severe acute respiratory syndrome coronavirus 2) vaccine
|
1324691000000104
|
"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
identifier.system
A URI for the system that has allocated the vaccination identifier.
Note, this must be unique within a given Supplier system or instance of Supplier system
e.g.
Example of a “single instance for all customers” Supplier system
https://supplierABC/identifiers/vacc
Example of “per customer instance” Supplier system
https://supplierABC/ODSCode/NKO41/identifiers/vacc
identifier.value
A unique identifier for the vaccination record, that is consistent between any subsequent update or delete records.
Ideally this would be a GUID / UUID
Value in combination with UNIQUE_ID_URI must be globally unique
In other words, a combination of identifier.value
and identifier.system
act as composite primary key to allow lookup of any Adverse Reactions records from the corresponding Adverse Reaction data file.
UUID example:
e045626e-4dc5-4df3-bc35-da25263f901e
Example of a “single instance for all customers” Supplier system
ACME-vacc123456
Example of “per customer instance” Supplier system
ACME-CUSTOMER1-vacc123456
ACME-CUSTOMER2-vacc123456
status
For a vaccination that has been administered, the status will be completed
. This status does not indicate a vaccination course has been completed.
When the vaccination has not been administered, the status will be not-done
and a statusReason should be supplied.
vaccineCode
Where status is completed
this is Mandatory. This indicates vaccine product administered. This should be a SNOMED CT code from
Command 'link' could not render: Object reference not set to an instance of an object.
AMPP codes should not be used.
"vaccineCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39114911000001105",
"display": "COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose solution for injection multidose vials (AstraZeneca)"
}
]
},
For EU/international purposes, a vaccination type code can be also be included. The SNOMED CT concept should be from Vaccines (GPS) - IPS and EU SNOMED CT Vaccine List (COVID-19)
"vaccineCode": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "39114911000001105",
"display": "COVID-19 Vaccine AstraZeneca (ChAdOx1 S [recombinant]) 5x10,000,000,000 viral particles/0.5ml dose solution for injection multidose vials (AstraZeneca)"
},
{
"system": "http://snomed.info/sct",
"code": "1119305005",
"display": "SARS-CoV-2 antigen vaccine"
}
]
},
patient
A traced NHS Number SHOULD be provided and when applicable a resource reference to the Patient resource.
"patient": {
"reference": "urn:uuid:edea022a-2d81-11eb-adc1-0242ac120002",
"type": "Patient",
"identifier": {
"system": "https://fhir.nhs.uk/Id/nhs-number",
"value": "9912003888"
}
},
occurrenceDateTime
The date and time on which the vaccination intervention was carried out or was meant to be administered.
recorded
The date that the vaccination administered (procedure) or not administered (situation) was recorded in the source system.
primarySource
Set as TRUE when the content of the record is based on information from the person performing the vaccine or who has clinical responsibility for the vaccination, and the system can be considered a primary source of the vaccination event.
Set as FALSE when the information has NOT come directly from people performing the vaccine (e.g. a patient or patient’s carer), and the system should not be treated as a primary source for this record.
This is used to help identify and eliminate duplicate records held centrally.
reportOrigin
Where primarySource=false
,
- The ODS code should be set to the location of the primary source of the data where the report of the vaccination event is held
Where primarySource=false
and the vaccination event has been stored in local Primary Care System.
- The ODS code should be set to the ODS code of the organisation where the event has been stored e.g. GP practice or PCN.
Note this field will be used to determine whether or not to send the vaccination event to the patient’s registered GP
"reportOrigin": {
"text": "RR8 - LEEDS TEACHING HOSPITALS NHS TRUST"
},
location
Country where the vaccination took place. This should follow Using ISO 3166 Country Codes with FHIR or a SNOMED Country Code.
"location": {
"identifier": {
"system": "urn:iso:std:iso:3166",
"value": "FR"
},
"display": "France"
},
manufacturer
Manufacturer of vaccine product. Only the display
is expected to be populated.
"manufacturer": {
"display": "DREAMLAND Pharmaceuticals Ltd"
},
lotNumber (Batch Number)
Where status=completed
this is Mandatory.
This should be captured at source ideally via use of automated scanning technology (GS1 GTIN / NTIN standard).
expirationDate
Shorter date of either:
- Manufacturer expiry date of the vaccine
- Coronavirus point of care sites will only put in the defrost expiry date
site
Body site vaccine was administered into. A SNOMED Concept ID value from UK published reference set “Vaccine body site of administration simple reference set” (1127941000000100) should be used
Command 'link' could not render: Object reference not set to an instance of an object.
"site": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "368208006",
"display": "Left upper arm structure (body structure)"
}
]
},
route
A SNOMED concept ID value from either of the following should be used:
UK “ePrescribing route of administration simple reference set (foundation metadata concept)” (999000051000001100)
Command 'link' could not render: Object reference not set to an instance of an object.
Or:
UK published reference set “Vaccine route of administration simple reference set” (115231000001104)
"route": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "78421000",
"display": "Intramuscular route (qualifier value)"
}
]
},
doseQuantity
A dm+d (SNOMED) Concept ID value representing the Unit of measure used.
For COVID-19 a reference set has been published here: https://dd4c.digital.nhs.uk/dd4c/publishedmetadatas/intid/980?size=10
"doseQuantity": {
"value": 1,
"unit": "pre-filled disposable injection",
"system": "http://snomed.info/sct",
"code": "3318611000001100"
},
The organisation ODS code of the location where the vaccination event took place with corresponding system of https://fhir.nhs.uk/Id/ods-organization-code
. For roving teams on home visits or care home visits use the site code of the responsible site e.g. GP practice or dedicated vaccination site. It is strongly recommend the name of the Organisation is present in the display field.
Vaccination professional should be recorded using professional codes, see NHSDigital-Practitioner for details.
"performer": [
{
"actor": {
"type": "Practitioner",
"identifier": {
"system": "https://fhir.hl7.org.uk/Id/nmc-number",
"value": "5566789"
},
"display": "HOLDING, Rafferty"
}
},
{
"actor": {
"type": "Organization",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "C4B2A"
},
"display": "ELLAND ROAD STADIUM - COVID VACCINATION CENTRE"
}
}
],
reasonCode
A SNOMED Concept Id. For COVID19 and Flu see https://digital.nhs.uk/developer/api-catalogue/vaccination
protocolApplied
doseNumberPositiveInt
Nominal position in a series of vaccines,
N.B. This field will not always be reliable, therefore for Covid vaccinations, the vaccination procedure code or situation code should be used as that includes the dose number
"protocolApplied": [
{
"doseNumberPositiveInt": 1
}
]
It is recommended for international/EU interoperability targetDisease
is populated. The SNOMED CT concept should be from EU COVID-19 Diseases or Vaccine Target Diseases (GPS) - IPS
"protocolApplied": [
{
"targetDisease": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "840539006",
"display": "COVID-19"
}
]
}
],
"doseNumberPositiveInt": 1
}
]
SNOMED CT codes relating to COVID-19 Vaccination
A complete list of SNOMED CT Codes relating to this profile can be found here SNOMED CT codes relating to COVID-19 Vaccination
Search Parameters
The following search parameters and search parameter combinations SHALL be supported:
- patient:identifier + procedure-code:below
Name |
Type |
Description |
Conformance |
Path |
date
|
date
|
Vaccination (non-)Administration Date
|
SHOULD
|
Immunization.date
|
patient:identifier
|
token
|
The patient for the vaccination record
|
SHALL
|
Immunization.patient
(Patient)
|
procedure-code
|
token
|
The target disease and dose number the dose is being administered against
|
MAY
|
Immunization.extension:vaccinationProcedure
|
status
|
token
|
Immunization event status
|
MAY
|
Immunization.status
|
Additional parameters can be on Immunization - Search Parameters
Mandatory Search Parameters
patient:identifier
SHALL support searching using the patient:identifier
search parameter:
GET [baseUrl]/Immunization?patient:identifier={system|}[code]
Example:
GET [baseUrl]/Immunization?patient:identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210
GET [baseUrl]/Immunization?patient:identifier=9876543210
Return all Immunization resources for Patients with a NHS Number of 9876543210
Optional Search Parameters
date + patient:identifier
SHOULD support searching using the combination of the patient:identifier
and date
search parameters
- including support for these date comparators: gt,lt,ge,le-
- including optional support for composite AND search on date (e.g.date=[date]&date=[date]]&...)
GET [baseUrl]/Immunization?patient.identifier={system|}[code]&date=[date]
Example
GET [baseUrl]/Immunization?patient:identifier=9876543210&date=ge2010-01-01&date=le2011-12-31
Return all Immunization resources that have a date greater than or equal to 1st Jan 2010, a date less than or equal to 31st Dec 2011 and Patient with an identifier of 9876543210.
procedure-code + patient:identifier
SHOULD support searching using the combination of the patient:identifier
and procedure-code
search parameters
- including optional support for composite OR search on procedure-code (e.g. procedure-code={system|}[code],{system|}[code],...)
GET [baseUrl]/Immunization?patient:identifier={system|}[code]&procedure-code={system|}[code]
Example:
GET [baseUrl]/Immunization?patient:identifier=9876543210&procedure-code=http://snomed.info/sct|1324681000000101,1324691000000104
Return all Immunization resources with a procedure-code of SNOMED CT 1324681000000101 or 1324691000000104 and Patient with a identifier of 9876543210.
status + patient:identifier
SHOULD support searching using the combination of the patient:identifier
and status
search parameters
GET [baseUrl]/Immunization?patient:identifier={system|}[code]&status=[code]
Example:
To filter on status ( in-progress | on-hold | completed | entered-in-error | stopped )
GET [baseUrl]/Immunization?patient:identifier=9876543210&status=on-hold
Return all Immunization resources with a status of on-hold and Patient with a identifier of 9876543210.