Immunisation
Represents Immunisations recorded on source systems.
| Database Field Name | Field Description | Sensitive Field | Identifiable Field | Field Type | Field Length | Optionality |
|---|---|---|---|---|---|---|
| batch | The batch/lot number for the administered vaccination | Yes | No | String | min an1 max an32 | O |
| ctv3_code | The recorded immunisation procedure code. See codable concept | Yes | No | See codable concept | See codable concept | See codable concept |
| deletion_flag | Flag specifying that the source record entry has been deleted and receiving systems should logically delete the corresponding record | Yes | No | Boolean | min an4 max an5 | O |
| effective_date | When the immunisation was administered | Yes | No | Timestamp | min an4 max an23 | O |
| encounter_id | The encounter within which the source record entry was made or pertains to | Yes | No | String | an36 | O |
| expiry_date | Expiry date of immunisation administered | Yes | No | Timestamp | min an4 max an23 | O |
| id | Persistent record identifier for resource | Yes | No | String | an36 | M |
| manufacturer | The manufacturer of the immunisation product administered | Yes | No | String | min an1 max an128 | O |
| other_code | The recorded immunisation procedure code. See codable concept | Yes | No | See codable concept | See codable concept | See codable concept |
| other_code_system | The recorded immunisation procedure code. See codable concept | Yes | No | See codable concept | See codable concept | See codable concept |
| other_display | The recorded immunisation procedure code. See codable concept | Yes | No | See codable concept | See codable concept | See codable concept |
| other_expession | The recorded immunisation procedure code. See codable concept | Yes | No | See codable concept | See codable concept | See codable concept |
| parent_present | Whether a parent was present at the point the vaccine was administered | Yes | No | Boolean | min an4 max an5 | O |
| patient_id_deid | NHS number DE-IDENTIFIED | Yes | No | String | an200 | O |
| practitioner_id | The clinician attributed as the vaccinator | Yes | No | String | an36 | M |
| quantity | The quantity of immunisation administered | Yes | No | Decimal | min an1 max an10 | O |
| readv2_code | The recorded immunisation procedure code. See codable concept | Yes | No | See codable concept | See codable concept | See codable concept |
| reason | The reason for immunisation e.g. travel, special risk group etc. | Yes | No | String | min n6 max n18 | O |
| recorded_date | The source system audit trail timestamp of when the source record was created, amended or deleted | Yes | No | Timestamp | min an4 max an23 | M |
| registration_id | The unique supplier generated persistent technical key for the registration | Yes | No | String | an36 | M |
| route | The route by which the immunisation entered body | Yes | No | String | min n6 max n18 | O |
| rubric | The recorded immunisation procedure code. See codable concept | Yes | No | See codable concept | See codable concept | See codable concept |
| site | The body site the immunisation was administered to | Yes | No | String | min n6 max n18 | O |
| snomed_concept_id | The recorded immunisation procedure code. See codable concept | Yes | No | See codable concept | See codable concept | See codable concept |
| snomed_description_id | The recorded immunisation procedure code. See codable concept | Yes | No | See codable concept | See codable concept | See codable concept |
| snomed_expression | The recorded immunisation procedure code. See codable concept | Yes | No | See codable concept | See codable concept | See codable concept |
| substance_ctv3_code | The immunisation product/substance. See codable concept | Yes | No | See codable concept | See codable concept | O |
| substance_other_code | The immunisation product/substance. See codable concept | Yes | No | See codable concept | See codable concept | O |
| substance_other_code_system | The immunisation product/substance. See codable concept | Yes | No | See codable concept | See codable concept | O |
| substance_other_display | The immunisation product/substance. See codable concept | Yes | No | See codable concept | See codable concept | O |
| substance_other_expession | The immunisation product/substance. See codable concept | Yes | No | See codable concept | See codable concept | O |
| substance_readv2_code | The immunisation product/substance. See codable concept | Yes | No | See codable concept | See codable concept | O |
| substance_rubric | The immunisation product/substance. See codable concept | Yes | No | See codable concept | See codable concept | O |
| substance_snomed_concept_id | The immunisation product/substance. See codable concept | Yes | No | See codable concept | See codable concept | O |
| substance_snomed_description_id | The immunisation product/substance. See codable concept | Yes | No | See codable concept | See codable concept | O |
| substance_snomed_expression | The immunisation product/substance. See codable concept | Yes | No | See codable concept | See codable concept | O |
| substance_user_selected | The immunisation product/substance. See codable concept | Yes | No | See codable concept | See codable concept | O |
| template_id | Links the resource to a template header | Yes | No | String | an36 | O |
| uom | The unit of measure associated with the administered quantity | Yes | No | String | min an1 max an32 | O |
| uom_dmd | The SNOMED CT DM+D Unit of measure associated with the quantity of immunisation administered | Yes | No | String | min n6 max n18 | O |
| user_selected | The recorded immunisation procedure code. See codable concept | Yes | No | See codable concept | See codable concept | See codable concept |