Immunization-BNet-Preg-Vaccinations

FHIR Resource information

FHIR Resource	🌍Immunization-BNet-Preg-Vaccinations. Based on 🌍 Immunization
Description	Mother Immunization Update
Release status	LIVE
Cardinality	Cardinality TBC
Writing to Spine permitted	YES - for Spine Client Type (ClientTBD) For receiving vaccination records from middleware client.
Spine filters	MAT-VACCINATIONS

Key FHIR Resource elements used

* id - External identifier for immunization resource

Summary	External identifier for immunization resource
Mandatory	Yes
Expected type	🌍string
Write allowed	No
Data Dictionary item	None

* occurenceDateTime - The datetime at which immunization took place, formatted as an ISO timestamp string in UTC with the use of 'Z' or an appropriate offset

Summary	The datetime at which immunization took place, formatted as an ISO timestamp string in UTC with the use of 'Z' or an appropriate offset
Mandatory	Yes
Expected type	🌍dateTime
Write allowed	Yes
Data Dictionary item	VacOccurrence - Vaccine Occurrence - The datetime at which immunization took place, formatted as an ISO timestamp string - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (VaccinationsWoman) Pregnancy Vaccinations

* patient.reference - This is a reference to the logical ID of the patient in the format Patient/[logicalID]

Summary	This is a reference to the logical ID of the patient in the format Patient/[logicalID]
Mandatory	Yes
Value type	🌍Reference(Patient)
Write allowed	Yes
Data Dictionary item	None

* performer.actor.reference - Only the first performer in the performer array is used. Supported references are a UUID or a local reference

Summary	Only the first performer in the performer array is used. Supported references are a UUID or a local reference
Mandatory	Yes
Value type	🌍Reference(Practitioner)
Write allowed	Yes
Data Dictionary item	Performer - Who performed event - Topic: (VaccinationsWoman) Pregnancy Vaccinations

primarySource - A Boolean to indicate the context the data was recorded in

Summary	A Boolean to indicate the context the data was recorded in
Mandatory	No
Expected type	🌍Boolean
Write allowed	Yes
Data Dictionary item	PrimarySource - True if this immunization is being recorded at the point of immunization, false otherwise - Topic: (VaccinationsWoman) Pregnancy Vaccinations

protocolApplied.targetDisease - SNOMED code for disease

Summary	SNOMED code for disease
Mandatory	No
Expected type	🌍CodeableConcept
Write allowed	Yes
Data Dictionary item	DiseaseCode - SNOMED code for disease - Topic: (VaccinationsWoman) Pregnancy Vaccinations
Value set used	🌍ValueSet-BNet-Preg-DiseaseCode

* protocolApplied.doseNumberString - String used when dose number is not applicable or unknown

Summary	String used when dose number is not applicable or unknown
Mandatory	Yes
Expected type	🌍positiveInt
Write allowed	Yes
Data Dictionary item	DoseNumber - Dose number within series, e.g. 1 - Topic: (VaccinationsWoman) Pregnancy Vaccinations

* protocolApplied.doseNumberPositiveInt - Dose number within series, e.g. 1

Summary	Dose number within series, e.g. 1
Mandatory	Yes
Expected type	🌍positiveInt
Write allowed	Yes
Data Dictionary item	DoseNumber - Dose number within series, e.g. 1 - Topic: (VaccinationsWoman) Pregnancy Vaccinations

site - Code describing where on patient the vaccine was administered

Summary	Code describing where on patient the vaccine was administered
Mandatory	No
Expected type	🌍CodeableConcept
Write allowed	Yes
Data Dictionary item	RouteCode - The path by which the vaccine product is taken into the body. Code system: http://terminology.hl7.org/CodeSystem/v3-ActSite - Topic: (VaccinationsWoman) Pregnancy Vaccinations
Value set used	🌍ValueSet-BNet-Preg-VaccinationSite

* status - Immunization status.

Summary	Immunization status.
Description	This element describes the status of the immunization. Completed is defined as the event has now concluded. Entered in error is defined as the electronic record should have never existed, though it is possible that real world decisions were based on it.
Mandatory	Yes
Expected type	🌍code
Write allowed	Yes
Data Dictionary item	Status - Status of vaccination attempt
Value set used	🌍ValueSet-BNet-Preg-VacStatus

statusReason - Reason for why vaccine was not completed. Where the vaccination was administered, this value will bet set to NULL

Summary	Reason for why vaccine was not completed. Where the vaccination was administered, this value will bet set to NULL
Mandatory	No
Expected type	🌍CodeableConcept
Write allowed	Yes
Data Dictionary item	StatusReason - Reason for why vaccine was not completed - Topic: (VaccinationsWoman) Pregnancy Vaccinations
Value set used	🌍ValueSet-BNet-Preg-VacStatusReasonSNOMED

* vaccineCode - Vaccine product administered

Summary	Vaccine product administered
Mandatory	Yes
Expected type	🌍CodeableConcept
Write allowed	Yes
Data Dictionary item	VaccineCode - Vaccine Code - DataSet: (PREGSUMUK) UK PREGSUM Maternity Data set - Topic: (VaccinationsWoman) Pregnancy Vaccinations
Value set used	🌍ValueSet-BNet-Preg-VaccinationCode

recorded - When the immunization was first captured in the subject's record

Summary	When the immunization was first captured in the subject's record
Mandatory	No
Expected type	🌍dateTime
Write allowed	Yes
Data Dictionary item	Recorded - Date and time for vaccination record - Topic: (VaccinationsWoman) Pregnancy Vaccinations

extension.Booster - This element signifies whether the dose is a booster.

Summary	This element signifies whether the dose is a booster.
Description	A Booelean to signify whether the dose number identified in 'protocolApplied.doseNumberPositiveInt' was a booster. This field is only applicable when protocolApplied.targetDisease='840539006(COVID)'. If this element is posted as true with any other value for protocolApplied.targetDisease, it will be ignored. The extension URL is https://clevermed.com/fhir/StructureDefinition/booster.
Mandatory	No
Expected type	🌍Boolean
Write allowed	Yes
Data Dictionary item	Booster - Booster identifier for vaccine dose - Topic: (VaccinationsWoman) Pregnancy Vaccinations

CONFIDENTIAL/COMMERCIAL IN CONFIDENCE

Confidentiality/document control

This document contains information that is confidential to System C Healthcare Ltd (System C) and is intended for our customers to use in connection with our products and services. It must not be used for any other purpose nor disclosed to any other party, either whole or in part, without the prior written consent of System C except as follows. A customer may permit those of its employees, advisors and agents having a need to know the contents of this platform to have access to such of the contents as are strictly necessary, but that customer shall ensure that such employees, advisors and agents are bound to it by an obligation, in similar term, to keep it confidential. A customer's acceptance of these obligations shall be indicated by that customer's use of any of the information contained in this document.

System C acknowledges that a customer may be bound by the Freedom of Information Act 2000 (FOIA). In such cases, System C considers that the contents of this document are confidential and exempt from disclosure pursuant to section 41 of the FOIA. A customer should consult System C before making any disclosure of information relating to System C under the FOIA. System C's business information, methodologies, solutions, as well as reference to System C clients and their projects, are always considered by System C to be exempt from disclosure by virtue of section 41 and 43 of the FOIA, whether indicated or not. 

Product Information: any descriptions of future functionality reflect current product direction, are for informational purposes only, and do not constitute a commitment to provide specific functionality. Timing and availability remain at System C’s discretion and are subject to change and applicable regulatory approvals.

Warning: Paper or PDF copies of this document are not version controlled and will automatically be considered obsolete and superseded at the time of printing or conversion.

Confidentiality/document control statement version number 2.0, QMSUID-0059