xCaliber healthCare Data Mesh

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 FieldExample ValueSource Data Field DescriptionSource Field Data TypeSource Data Field CardinalityMapped FHIR++ ResourceMapped FHIR Data FieldAugmented MappingAssociated Coding SystemAssociated FHIR Data Field ExtensionMapping Context
administerdate-Date when this vaccine was administered (if administered). Can be in YYYY, MM/YYYY, or MM/DD/YYYY formatString0..1ImmunizationoccurrenceDateTime---Top Level
administerroute-Route by which this vaccine was administeredString0..1Immunizationroute.coding[1].display---Top Level
administersite-Site where the vaccine was administeredString0..1Immunizationsite.coding[1].display---Top Level
amount-Quantity of the vaccine that was administeredInteger0..1ImmunizationdoseQuantity.value---Top Level
description-Vaccine descriptionString0..1ImmunizationvaccineCode.text---Top Level
entereddate-Date when the vaccine information was entered into the chartString0..1Immunizationrecorded---Top Level
expirationdate-Date to administer vaccine byString0..1ImmunizationexpirationDate---Top Level
genusname-"The name of the vaccine that appears in the UI of the chartString0..1ImmunizationvaccineCode.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.String0..1ImmunizationlotNumber---Top Level
refusedreason-Reason for refusal, if availableString0..1ImmunizationstatusReason.coding[*].displaysystem: "http://xcaliber-fhir/structureDefinition/refused-reason"--Top Level
status-Status of this vaccineString0..1Immunizationstatus---Top Level
units-Units corresponding to the above quantityString0..1ImmunizationdoseQuantity.unit---Top Level
vaccinator-Individual who has administered the vaccineString0..1Immunizationperformer[1].actor.reference---Top Level
vaccineid-athena ID for this vaccine (prefix of H for historical, C for clinical)String0..1Immunizationid---Top Level
vaccinetype-Type of vaccine (either CLINICAL - ordered/administered by the practice, or HISTORICAL - from patient's previous medical history or alternative source)String0..1ImmunizationprimarySource---Top Level
administernote-Note associated with administering the vaccine, if availableString0..1Immunizationnote[1].text---Top Level
administerroutedescription-Description of the route by which this vaccine was administeredString0..1Immunizationroute.extension[*].valueString--route/administer-route-descriptionTop Level
approvedby-The username of the user who approved this vaccine order, if clinicaString0..1Immunizationperformer[*].actor.displayfunction.extension[].valueString="APPROVEDBY" and function.extension[].url="http://xcaliber-fhir/structureDefinition/approved-by"-approved-byTop Level
approveddate-Date when this vaccine order was approved, if clinicalString0..1Immunizationextension[*].valueString--approved-dateTop Level
cvx-Vaccine Administered CodeString0..1ImmunizationvaccineCode.coding[*].codesystem="http://hl7.org/fhir/sid/cvx"CVX-Top Level
declinedreasontext-The user-facing description of the reason the order was not given.String0..1ImmunizationstatusReason.text---Top Level
deleteddate-Date when this vaccine was deleted (if deleted)String0..1Immunizationextension[*].valueString--deleted-dateTop Level
enteredby-The username of the user who entered the historic vaccine information into the chartString0..1Immunizationperformer[*].actor.displayfunction.extension[].valueString="ENTEREDBY" and function.extension[].url="http://xcaliber-fhir/structureDefinition/ordered-by"-entered-byTop Level
mvx-Manufacturer codeString0..1Immunizationmanufacturer.identifier.value-MVX-Top Level
ndc-The National Drug Code for the administered vaccine.String0..1ImmunizationvaccineCode.coding[*].codesystem="http://hl7.org/fhir/sid/ndc"NDC-Top Level
orderedby-The username of the user who ordered the vaccineString0..1Immunizationperformer[*].actor.displayfunction.coding[*].code=OP & actor.type=Practitioner--Top Level
ordereddate-Date the vaccine was orderedString0..1Immunizationextension[*].valueString--ordered-dateTop Level
partiallyadministered-Whether this vaccine was partially administered or notValueset0..1Immunizationextension[*].valueString--partially-administeredTop Level
prescribeddate-Date when this vaccine was prescribed (if prescribed)String0..1Immunizationextension[*].valueString--prescribed-dateTop Level
refuseddate-Date when this vaccine was refused (if refused)String0..1ImmunizationstatusReason.extension[*].valueDateTime--refused-dateTop Level
refusednote-Note associated with refusal, if availableString0..1ImmunizationstatusReason.extension[*].valueString--refused-noteTop Level
submitdate-Date when this vaccine order was submitted, if clinicalString0..1Immunizationextension[*].valueString--submit-dateTop Level
visgivendate-Date when the Vaccine Information Statement was given to the patientString0..1Immunizationextension[*].valueString--vis-given-dateTop Level
clinicalorderclass-The various Clinical Order Classes associated with this VaccineObject0..*Immunization----Top Level
clinicalorderclasses.clinicalorderclassid-The clinical order class idInteger0..1Immunizationextension[*].valueInteger--clinical-order-class-idTop Level
clinicalorderclasses.name-The name for this clinical order classString0..1Immunizationextension[*].valueString--clinical-order-class-nameTop 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 reasonObject0..*Immunization----Top Level
contraindicationreason.code-The code indicating why the order was contraindicated.String0..1ImmunizationstatusReason.coding[*].codestatus=not-done--Top Level
contraindicationreason.codeset-The codeset that the code belongs to.String0..1ImmunizationstatusReason.coding[*].system---Top Level
contraindicationreason.description-The plaintext description of the contraindication reason.String0..1ImmunizationstatusReason.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.Object0..*Immunization----Top Level
declinedreason.code-The code indicating why the order was not given.String0..1ImmunizationstatusReason.coding[*].codestatus=not-done--Top Level
declinedreason.codeset-The codeset that the code belongs to.String0..1ImmunizationstatusReason.coding[*].system---Top Level
declinedreason.description-The plaintext description of the reason the order was not given.String0..1ImmunizationstatusReason.coding[*].display---Top Level
vaccineinformationstatements-The Vaccine Information Statements (VIS) that were given to the patient, grouped by Clinical Order ClassObject0..*Immunizationeducation[*]---Top Level
vaccineinformationstatements.clinicalorderclassid-The clinical order class idInteger0..1Immunizationeducation[*].id---Top Level
vaccineinformationstatements.dateonvis-The VIS date associated with this vaccine and clinical order class idString0..1Immunizationeducation[*].presentationDate---Top Level
PATIENTFACINGCALL-When 'true' is passed we will collect relevant data and store in our database.Boolean0..1Immunizationextensions[*].valueBoolean--patient-facing-callTop Level
THIRDPARTYUSERNAME-User name of the patient in the third party application.String0..1Immunizationextensions[*].valueString--third-party-user-nameTop Level