The FHIR profiles used for the Vaccinations List
Heading Description
The details of a women’s vaccinations.
Vaccinations Details Structure
Maternity Data Standards Mapping to FHIR profiles
Mapping Overview
| Data Standard Element | FHIR Profile | FHIR target |
| Date and Time of vaccinations | Encounter | period.start |
| ODS/ORD Site Code | Location | identifier |
| Performing Professional | Practitioner | identifier and name |
| SDS Job Role Name | PractitionerRole | code |
| Reported Date | Immunization | date |
| Primary Source | Immunization | primarySource |
| Report Origin | Immunization | reportOrigin |
| Vaccination Procedure | Immunization | extension.vaccinationProcedure |
| Vaccination Situation (Not Given Outcome) | Immunization | explanation.reasonNotGiven |
| Not Given flag | Immunization | notGiven |
| Dose sequence | Immunization | vaccinationProtocol.doseSequence |
| Vaccine Product | Immunization | vaccineCode.coding.code |
| Vaccine Manufacturer | Immunization | manufacturer |
| Batch Number | Immunization | lotNumber |
| Site of Vaccination | Immunization | site |
| Route of Vaccination | Immunization | route |
| Dose Amount | Immunization | doseQuantity |
| Indication | Immunization | reason |
Mapping for Vaccination Details List
| > | Level 1 | List Resource | > | Level 2 | CareConnect-List-1 Profile | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| - id | 0..1 | Optional | Id | Logical id of this artifact |
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-List-1' |
| - identifier | 0..* | Required | Identifier | Business identifier An identifier for this vaccination details list |
| - - system | 1..1 | Required | Uri | The namespace for the identifier value The system from which the identifier came from |
| - - value | 1..1 | Mandatory | String | The value that is unique Business identifier An identifier for this vaccination details list |
| - - - display | 0..1 | Required | String | Text alternative for the resource The organization that allocated the identifier |
| - status | 1..1 | Mandatory | Code | current : retired : entered-in-error Binding (required): The current state of the list ListStatus The status of the list MUST contain the value 'current' |
| - mode | 1..1 | Mandatory | Code | working : snapshot : changes Binding (required): The processing mode that applies to this list ListMode The mode of the list MUST contain the value 'snapshot' |
| - title | 0..1 | Mandatory | String | Descriptive name for the list This MUST contain the value 'Admission details' Mapping to Maternity data item = 'PSRB Heading Immunisation details' |
| - code | 0..1 | Mandatory | CodeableConcept | What the purpose of this list is Binding (preferred): What the purpose of a list is CareConnect-ListCode-1 The PRSB heading for this list. Note: for Maternity the value stated below is used which is not from the preferred value set |
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system The SNOMED CT concept for the PRSB heading type |
| - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system This MUST contain the value 'http://snomed.info/sct' |
| - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system This MUST contain the value '1102181000000102' |
| - - - display | 0..1 | Mandatory | String | Representation defined by the system This MUST contain the value 'Immunisations' Mapping to Maternity data item = 'PSRB Heading Immunisation details' |
| - subject | 0..1 | Mandatory | Reference | If all resources have the same subject Constraint (ref-1): SHALL have a contained resource if a local reference is provided This is a reference to the Patient who is the subject of the list. |
| Mandatory | CareConnect-Patient-1 | This is the subject of the vaccination details List. This MUST use the CareConnect patient profile. Seepatient resource reference for information on how to populate the resource. |
||
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL A reference to the patient resource included in the Patient demographics list within the FHIR Bundle. Note the Patient demographics list is mandatory in the FHIR bundle |
| - date | 0..1 | Mandatory | dateTime | When the list was prepared This MUST contain a system date to indicate when the list was created or updated |
| - note | 0..* | Optional | Annotation | Comments about the list |
| Required | String | Who authored the comment on the list. | ||
| - - time | 0..1 | Required | dateTime | When the annotation was made |
| - - text | 1..1 | Required | String | The annotation - text content |
| - entry | 0..* | Mandatory | BackboneElement | Entries in the list The entries MUST be as per the diagram for this PRSB headings list with the immunization resource being the focal resource. Multiple Encounters with associated resources MAY be present |
| - - date | 0..1 | Required | dateTime | When item added to list The SHOULD contain a system time of when the item was added to the list. |
| - - item | 1..1 | Required | Reference | Actual entry Constraint (ref-1): SHALL have a contained resource if a local reference is provided A reference to an immunization resource included in the list This MUST use the CareConnect Encounter profile. See Immunization resource for information on how to populate the resource. |
| - - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL The reference to the included Immunization resource. |
Patient Reference
The vaccination details list has a mandated subject reference to the Patient resource. This means that any exchange of the vaccination details heading data must also include the Patient demographics List.
Mapping for Vaccinations
| > | Level 1 | Immunization Resource | > | Level 2 | CareConnect-Immunization-1 Profile | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Digital Maternity Implementation |
|---|---|---|---|---|
| - id | 0..1 | Optional | Id | Logical id of this artifact |
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Immunization-1' |
| - - profile | 1..1 | Mandatory | Uri | Profiles this resource claims to conform to The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Immunization-1' |
| - identifier | 0..* | Required | Identifier | Business identifier |
| - - system | 1..1 | Mandatory | Uri | The namespace for the identifier value |
| - - value | 1..1 | Mandatory | String | The value that is unique |
| - - assigner | 0..1 | Required | Reference | Organization that issued id (may be just text) Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| - - - display | 0..1 | Required | String | Text alternative for the resource |
| - status | 1..1 | Mandatory | Code | Completed Binding (required): A set of codes indicating the current status of an Immunization Immunization Status Codes The status of the list MUST contain the value 'Completed' |
| - notGiven | 1..1 | Mandatory | Boolean | Flag for whether immunization was given true = not given false = given |
| - vaccineCode | 1..1 | Optional | CodeableConcept | Vaccine product administered Binding (extensible): The code for vaccine product administered CareConnect-VaccineCode-1 |
| - - coding | 0..* | Optional | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Optional | Uri | Identity of the terminology system |
| - - - code | 0..1 | Optional | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Optional | String | Representation defined by the system |
| - - text | 0..1 | Optional | String | Plain text representation of the concept |
| - patient | 1..1 | Mandatory | Reference | Who the sensitivity is for Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Mandatory | CareConnect-Patient-1 | A reference to the Patient resource. | ||
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL This MUST use the CareConnect Patient profile.See patient resource reference for information on how to populate the resource. |
| - encounter | 0..1 | Mandatory | Reference | Encounter administered as part of Constraint (ref-1): SHALL have a contained resource if a local reference is provided This is a reference to the vaccination encounter. |
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL A reference to the encounter resource included in the vaccination list within the FHIR Bundle. |
| - date | 0..1 | Mandatory | dateTime | Vaccination administration date The date/time on which the immunisation intervention was carried out or was meant to be administered |
| - primarySource | 1..1 | Mandatory | Boolean | Indicates context the data was recorded in Default Value: true false if reported |
| - reportOrigin | 0..1 | Required | CodeableConcept | Indicates the source of a secondarily reported record Binding (example): The source of the data for a record which is not from a primary source. Immunization Origin Codes |
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system |
| - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system |
| - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system |
| - - - display | 0..1 | Mandatory | String | Representation defined by the system |
| - location | 0..1 | Mandatory | Reference | Where vaccination occurred Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL |
| - manufacturer | 0..1 | Required | Reference | Vaccine manufacturer Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Required | CareConnect-Organization-1 | A reference to the Organization resource. | ||
| - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URL This MUST use the CareConnect Patient profileSee organization resource reference for information on how to populate the resource. |
| - lotNumber | 0..1 | Optional | String | Vaccine lot number The batch number of the vaccine product |
| - site | 0..1 | Optional | CodeableConcept | Body site vaccine was administered Binding (examle): The site at which the vaccine was administered Codes for Immunization Site of Administration The immunization site does not use the preferred value set but uses SNOMED CT concepts instead Mapping to Maternity data item = 'site'. |
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
| - - coding (snomedCT) | 0..1 | Optional | Coding | Code defined by a terminology system A SNOMED CT concept from 91723000 |
| - - - system | 1..1 | Mandatory | Uri | Identity of the terminology system The element MUST contain the value 'http://snomed.info/sct' |
| - - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system A SNOMED CT code from 91723000 |
| - - - display | 1..1 | Mandatory | String | Representation defined by the system The display associated with the SNOMED CT concept. This SHOULD be the preferred term |
| - - text | 0..1 | Optional | String | Plain text representation of the concept This element SHOULD only be populated when the Immunisation cannot be coded or when stating one of the following statements: ‘No known site’ Or ‘Information not available’. |
| - route | 0..1 | Optional | CodeableConcept | How vaccine entered body Binding (example): The route by which the vaccine was administered Immunization Route Codes Note the example valueSet is not used for Maternity and the following should be used instead Coded text - SNOMED CT (<284009009 |Route of administration value (qualifier value)) |
| - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system Slicing: Discriminator: system, Ordering: false, Rules: Open |
| - - coding (snomedCT) | 0..1 | Optional | Coding | Code defined by a terminology system Binding (example): A code from the SNOMED Clinical Terminology UK coding system that describes the e-Prescribing route of administration. CareConnect-MedicationDosageRoute-1 Note the example valueSet is not used for Maternity and the following should be used instead Coded text - SNOMED CT (<284009009 |Route of administration value (qualifier value)) |
| - - - system | 1..1 | Mandatory | Uri | Identity of the terminology system The element MUST contain the value 'http://snomed.info/sct' |
| - - - code | 1..1 | Mandatory | Code | Symbol in syntax defined by the system Coded text - SNOMED CT (<284009009 |Route of administration value (qualifier value)) |
| - - - display | 1..1 | Mandatory | String | Representation defined by the system This SHOULD be the preferred term for the SNOMED concept |
| - - text | 0..1 | Optional | String | Plain text representation of the concept This element SHOULD only be populated when the Immunisation cannot be coded or when stating one of the following statements: 'No known route' Or 'Information not available'. |
| - doseQuantity | 0..1 | Optional | Quantity (SimpleQuantity ) | Amount of vaccine administered Constraint (qty-3): If a code for the unit is present, the system SHALL also be present Constraint (sqty-1): The comparator is not used on a SimpleQuantity Amount of vaccine administered |
| - - value | 0..1 | Required | Decimal | Numerical value (with implicit precision) |
| - - unit | 0..1 | Required | String | Unit representation |
| - - system | 0..1 | Required | Uri | System that defines coded unit form |
| - - code | 0..1 | Required | Code | Coded form of the unit |
| - practitioner | 0..* | Mandatory | BackboneElement | Who performed event |
| - - role | 0..1 | Mandatory | CodeableConcept | What type of performance was done Binding (extensible): The role a practitioner plays in the immunization event Immunization Role Codes |
| - - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system |
| - - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Mandatory | String | Representation defined by the system |
| - - - text | 0..1 | Optional | String | Plain text representation of the concept |
| - - actor | 1..1 | Mandatory | Reference | Individual who was performing Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Required | CareConnect-Practitioner-1 | The responsible clinician for the immunization. | ||
| - - - reference | 0..1 | Mandatory | String | Literal reference, Relative, internal or absolute URLThis MUST use the CareConnect Practitioner profile. See Practitioner resource for information on how to populate the resource. |
| - note | 0..* | Optional | Annotation | Vaccination notes |
| - explanation | 0..1 | Optional | BackboneElement | Administration/non-administration reasons The clinical indication or reason for administering or recording an historical vaccination. |
| - - reason | 0..* | Optional | CodeableConcept | Why immunization occurred Binding (example): The reason why a vaccine was administered CareConnect-ImmunizationExplanationReason-2 |
| - - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system This MUST contain the value 'http://snomed.info/sct' |
| - - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Mandatory | String | Representation defined by the system |
| - - reasonNotGiven | 0..1 | Required | CodeableConcept | Why immunization did not occur Binding (example): The reason why a vaccine was not administered Immunization Reasons for Not Immunizing Codes Where a vaccine is not administered a PROCEDURE WITH EXPLICIT CONTEXT (SNOMED CT). Codes TBA |
| - - - coding | 0..* | Mandatory | Coding | Code defined by a terminology system |
| - - - - system | 0..1 | Mandatory | Uri | Identity of the terminology system |
| - - - - code | 0..1 | Mandatory | Code | Symbol in syntax defined by the system |
| - - - - display | 0..1 | Mandatory | String | Representation defined by the system |
| - - - text | 0..1 | Optional | String | Plain text representation of the concept |
| - vaccinationProtocol | 0..* | Mandatory | BackboneElement | What protocol was followed |
| - - doseSequence | 1..1 | Required | positiveInt | Dose number within series Nominal position in a series of vaccines |
Mapping for Vaccination Encounter
| > | Level 1 | Encounter Resource | > | Level 2 | CareConnect-Encounter-1 | > | Level 3 | None |
| View Used FHIR Elements | View All FHIR Elements |
| Name | Card. | Conformance | Type | Description, Constraints and mapping for Implementation |
|---|---|---|---|---|
| Encounter | | An interaction during which services are provided to the patient Constraint (dom-2): If the resource is contained in another resource, it SHALL NOT contain nested Resources Constraint (dom-1): If the resource is contained in another resource, it SHALL NOT contain any narrative Constraint (dom-4): If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated Constraint (dom-3): If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource |
||
| - id | 0..1 | Optional | Id | Logical id of this artifact |
| - meta | 0..1 | Mandatory | Meta | Metadata about the resource The value attribute of the profile element MUST contain the value 'https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Encounter-1' |
| - identifier | 0..* | Required | Identifier | Identifier(s) by which this encounter is known An identifier for this Encounter |
| - - system | 1..1 | Required | Uri | The namespace for the identifier value The system from which the identifier came from |
| - - value | 1..1 | Required | String | The value that is unique An identifier for this Vaccination encounter |
| - status | 1..1 | Mandatory | Code | planned : arrived : triaged : in-progress : onleave : finished : cancelled + Binding (required): Current state of the encounter EncounterStatus The status of the Encounter MUST contain the value 'finished' |
| - - - start | 0..1 | Required | dateTime | Starting time with inclusive boundary |
| - - - end | 0..1 | Required | dateTime | End time with inclusive boundary, if not ongoing |
| - location | 0..1 | Required | BackboneElement | List of locations where the patient has been |
| - - location | 1..1 | Mandatory | Reference | Location the encounter takes place Constraint (ref-1): SHALL have a contained resource if a local reference is provided |
| Mandatory | CareConnect-Location-1 | A reference to the Location resource. | ||
| - - - reference | 1..1 | Mandatory | String | Literal reference, Relative, internal or absolute URLThis MUST use the CareConnect Location profile.See location resource reference for information on how to populate the resource. |
Mapping for Vaccination Practitioner
The vaccination details has reference(s) to the Practitioner resource. This means that any exchange of the vaccination details heading data must also include the Practitioner Details
Mapping for Vaccination Practitioner Role
The vaccination details has reference(s) to the Practitioner Role resource. This means that any exchange of the vaccination details heading data must also include the Practitioner Role Details
Mapping for Vaccination Location
The vaccination details has reference(s) to the Location resource. This means that any exchange of the vaccination details heading data must also include the Location Details
