Vaccines
Source Object: Vaccines
Overview: The "Vaccines" source object contains data related to administered vaccines, including important details for tracking patient vaccinations and vaccine administration.
Key Data Fields:
- Administer Date: Date when the vaccine was administered.
- Administer Route: Route of vaccine administration.
- Administer Site: Site on the patient where the vaccine was administered.
- Amount: Quantity or dosage of the vaccine administered.
- Description: Brief description of the vaccine.
- Expiration Date: Date of vaccine expiration.
- Genus Name: Name of the vaccine genus.
- Lot Number: Identifier for the vaccine lot.
- Refused Reason: Reason for refusing the vaccine.
- Status: Status of the administered vaccine (e.g., administered, refused).
- Units: Units of measurement for the vaccine dosage.
- Vaccinator: Healthcare provider administering the vaccine.
- Vaccine Type: Type or category of the vaccine.
- Administer Note: Notes or instructions related to vaccine administration.
- Administer Route Description: Detailed description of the vaccine administration route.
- CVX: Code indicating the vaccine type.
- Declined Reason Text: Textual explanation for declining the vaccine.
- NDC: National Drug Code for the vaccine.
- Ordered Date: Date when the vaccine was ordered.
- Partially Administered: Indication if the vaccine was partially administered.
- Prescribed Date: Date when the vaccine was prescribed.
- Refused Date: Date when the vaccine was refused.
- Refused Note: Notes related to refusing the vaccine.
This data is crucial for maintaining patient vaccination records, tracking administered vaccines, and ensuring accurate healthcare management.
Mapping Table
Data Field | Example Value | Source Data Field Description | Source Field Data Type | Source Data Field Cardinality | Mapped FHIR++ Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapping Context |
---|---|---|---|---|---|---|---|---|---|---|
administerdate | - | Date when this vaccine was administered (if administered). Can be in YYYY, MM/YYYY, or MM/DD/YYYY format | String | 0..1 | Immunization | occurrenceDateTime | - | - | - | Top Level |
administerroute | - | Route by which this vaccine was administered | String | 0..1 | Immunization | route.coding[1].display | - | - | - | Top Level |
administersite | - | Site where the vaccine was administered | String | 0..1 | Immunization | site.coding[1].display | - | - | - | Top Level |
amount | - | Quantity of the vaccine that was administered | Integer | 0..1 | Immunization | doseQuantity.value | - | - | - | Top Level |
description | - | Vaccine description | String | 0..1 | Immunization | vaccineCode.text | - | - | - | Top Level |
entereddate | - | Date when the vaccine information was entered into the chart | String | 0..1 | Immunization | recorded | - | - | - | Top Level |
expirationdate | - | Date to administer vaccine by | String | 0..1 | Immunization | expirationDate | - | - | - | Top Level |
genusname | - | "The name of the vaccine that appears in the UI of the chart | String | 0..1 | Immunization | vaccineCode.coding[1].display | - | - | - | Top Level |
lotnumber | - | The lot number of the vaccine that was administered. This is an identifier assigned to a batch of medications by the manufacturer. | String | 0..1 | Immunization | lotNumber | - | - | - | Top Level |
refusedreason | - | Reason for refusal, if available | String | 0..1 | Immunization | statusReason.coding[*].display | system: "http://xcaliber-fhir/structureDefinition/refused-reason" | - | - | Top Level |
status | - | Status of this vaccine | String | 0..1 | Immunization | status | - | - | - | Top Level |
units | - | Units corresponding to the above quantity | String | 0..1 | Immunization | doseQuantity.unit | - | - | - | Top Level |
vaccinator | - | Individual who has administered the vaccine | String | 0..1 | Immunization | performer[1].actor.reference | - | - | - | Top Level |
vaccineid | - | athena ID for this vaccine (prefix of H for historical, C for clinical) | String | 0..1 | Immunization | id | - | - | - | Top Level |
vaccinetype | - | Type of vaccine (either CLINICAL - ordered/administered by the practice, or HISTORICAL - from patient's previous medical history or alternative source) | String | 0..1 | Immunization | primarySource | - | - | - | Top Level |
administernote | - | Note associated with administering the vaccine, if available | String | 0..1 | Immunization | note[1].text | - | - | - | Top Level |
administerroutedescription | - | Description of the route by which this vaccine was administered | String | 0..1 | Immunization | route.extension[*].valueString | - | - | route/administer-route-description | Top Level |
approvedby | - | The username of the user who approved this vaccine order, if clinica | String | 0..1 | Immunization | performer[*].actor.display | function.extension[].valueString="APPROVEDBY" and function.extension[].url="http://xcaliber-fhir/structureDefinition/approved-by" | - | approved-by | Top Level |
approveddate | - | Date when this vaccine order was approved, if clinical | String | 0..1 | Immunization | extension[*].valueString | - | - | approved-date | Top Level |
cvx | - | Vaccine Administered Code | String | 0..1 | Immunization | vaccineCode.coding[*].code | system="http://hl7.org/fhir/sid/cvx" | CVX | - | Top Level |
declinedreasontext | - | The user-facing description of the reason the order was not given. | String | 0..1 | Immunization | statusReason.text | - | - | - | Top Level |
deleteddate | - | Date when this vaccine was deleted (if deleted) | String | 0..1 | Immunization | extension[*].valueString | - | - | deleted-date | Top Level |
enteredby | - | The username of the user who entered the historic vaccine information into the chart | String | 0..1 | Immunization | performer[*].actor.display | function.extension[].valueString="ENTEREDBY" and function.extension[].url="http://xcaliber-fhir/structureDefinition/ordered-by" | - | entered-by | Top Level |
mvx | - | Manufacturer code | String | 0..1 | Immunization | manufacturer.identifier.value | - | MVX | - | Top Level |
ndc | - | The National Drug Code for the administered vaccine. | String | 0..1 | Immunization | vaccineCode.coding[*].code | system="http://hl7.org/fhir/sid/ndc" | NDC | - | Top Level |
orderedby | - | The username of the user who ordered the vaccine | String | 0..1 | Immunization | performer[*].actor.display | function.coding[*].code=OP & actor.type=Practitioner | - | - | Top Level |
ordereddate | - | Date the vaccine was ordered | String | 0..1 | Immunization | extension[*].valueString | - | - | ordered-date | Top Level |
partiallyadministered | - | Whether this vaccine was partially administered or not | Valueset | 0..1 | Immunization | extension[*].valueString | - | - | partially-administered | Top Level |
prescribeddate | - | Date when this vaccine was prescribed (if prescribed) | String | 0..1 | Immunization | extension[*].valueString | - | - | prescribed-date | Top Level |
refuseddate | - | Date when this vaccine was refused (if refused) | String | 0..1 | Immunization | statusReason.extension[*].valueDateTime | - | - | refused-date | Top Level |
refusednote | - | Note associated with refusal, if available | String | 0..1 | Immunization | statusReason.extension[*].valueString | - | - | refused-note | Top Level |
submitdate | - | Date when this vaccine order was submitted, if clinical | String | 0..1 | Immunization | extension[*].valueString | - | - | submit-date | Top Level |
visgivendate | - | Date when the Vaccine Information Statement was given to the patient | String | 0..1 | Immunization | extension[*].valueString | - | - | vis-given-date | Top Level |
clinicalorderclass | - | The various Clinical Order Classes associated with this Vaccine | Object | 0..* | Immunization | - | - | - | - | Top Level |
clinicalorderclasses.clinicalorderclassid | - | The clinical order class id | Integer | 0..1 | Immunization | extension[*].valueInteger | - | - | clinical-order-class-id | Top Level |
clinicalorderclasses.name | - | The name for this clinical order class | String | 0..1 | Immunization | extension[*].valueString | - | - | clinical-order-class-name | Top Level |
contraindicationreason | - | List of codes indicating why the order was contraindicated (for vaccines only). If this field is not present, the order does not contain a contraindication reason | Object | 0..* | Immunization | - | - | - | - | Top Level |
contraindicationreason.code | - | The code indicating why the order was contraindicated. | String | 0..1 | Immunization | statusReason.coding[*].code | status=not-done | - | - | Top Level |
contraindicationreason.codeset | - | The codeset that the code belongs to. | String | 0..1 | Immunization | statusReason.coding[*].system | - | - | - | Top Level |
contraindicationreason.description | - | The plaintext description of the contraindication reason. | String | 0..1 | Immunization | statusReason.coding[*].display | - | - | - | Top Level |
declinedreason | - | List of codes indicating why the order was not given. If this field is not present, the order was not declined. If the array is empty, no reason has been chosen. | Object | 0..* | Immunization | - | - | - | - | Top Level |
declinedreason.code | - | The code indicating why the order was not given. | String | 0..1 | Immunization | statusReason.coding[*].code | status=not-done | - | - | Top Level |
declinedreason.codeset | - | The codeset that the code belongs to. | String | 0..1 | Immunization | statusReason.coding[*].system | - | - | - | Top Level |
declinedreason.description | - | The plaintext description of the reason the order was not given. | String | 0..1 | Immunization | statusReason.coding[*].display | - | - | - | Top Level |
vaccineinformationstatements | - | The Vaccine Information Statements (VIS) that were given to the patient, grouped by Clinical Order Class | Object | 0..* | Immunization | education[*] | - | - | - | Top Level |
vaccineinformationstatements.clinicalorderclassid | - | The clinical order class id | Integer | 0..1 | Immunization | education[*].id | - | - | - | Top Level |
vaccineinformationstatements.dateonvis | - | The VIS date associated with this vaccine and clinical order class id | String | 0..1 | Immunization | education[*].presentationDate | - | - | - | Top Level |
PATIENTFACINGCALL | - | When 'true' is passed we will collect relevant data and store in our database. | Boolean | 0..1 | Immunization | extensions[*].valueBoolean | - | - | patient-facing-call | Top Level |
THIRDPARTYUSERNAME | - | User name of the patient in the third party application. | String | 0..1 | Immunization | extensions[*].valueString | - | - | third-party-user-name | Top Level |