Salesforce Docs Portal

PatientImmunization

Represents information about a patient’s immunizations. This object is available in API version 51.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Additional Information for PatientImmunization in Other Objects

In addition to creating a record using these fields, you can add more details to your PatientImmunization record by creating records in certain other objects, and referencing your PatientImmunization record as the parent record. Here’s the list of objects you can associate to PatientImmunization in this way, the type of information they add, and the field they use to reference PatientImmunization.

Object Type of Information Reference Field
Identifier Associates an identifier value to the patient immunization. ParentRecordId
Patient Health Reaction Adds information about a patient’s adverse reaction to an immunization, if any. ParentId
Patient Immunization Protocol Adds information about this protocols followed by a provider during the immunization. This object enables the support of one-to-many values between immunization and protocols applied. PatientImmunizationId

Fields

CareObservationId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The observation that determined the need for the immunization.
  • Referenced Objects:
    • CareObservation

ClinicalEncounterId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The clinical encounter that the immunization was a part of.
  • Referenced Objects:
    • ClinicalEncounter

CurrentDose

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The current dose the patient is on in the total number of doses recommended for immunization.

DiagnosticSummaryId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The diagnostic summary that determined the need for the immunization.
  • Referenced Objects:
    • DiagnosticSummary

Dose

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The amount of vaccine that was administered.

DoseUnitId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The unit of the amount of vaccine that was administered.
  • Referenced Object: UnitOfMeasure

ExpirationDate

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the immunization is expected to expire.

FacilityId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The healthcare facility where the immunization was performed.
  • Referenced Objects:
    • HealthcareFacility

HealthConditionId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The health condition that determined the need for the immunization.
  • Referenced Objects:
    • HealthCondition

ImmunizationRecommendation

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The protocol that was followed for the immunzation.

InformationSourceId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents the source that provided information about the immunization.
  • Referenced Objects:
    • CodeSetBundle

IsRecordedByVaccinator

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the immunization record was recorded by the vaccinator.

IsSubpotent

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the vaccination dose was sub-potent.

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The date and time when the record was last referenced.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The date and time when the record was last viewed.

LotNumber

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The lot number of the vaccine.

Manufacturer

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the vaccine’s manufacturer.

ManufacturerAccountId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: References the organization that manufactured the vaccine.
  • Referenced Objects: Account

Name

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The system-generated name of the patient immunization record.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: The owner of the patient immunization record. Available in API version 56.0 and later. This is a polymorphic relationship field.
  • Relationship Name: Owner
  • Relationship Type: Lookup
  • Refers To:
    • Group
    • User

PatientId

  • Type: Master-detail reference
  • Properties: Create, Filter, Group, Sort
  • Description: The patient who was immunized.
  • Referenced Objects:
    • Account

ReasonCodeId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents the reason for the immunization.
  • Referenced Objects:
    • CodeSetBundle

RecommendedDoses

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Total number of doses recommended to achieve immunity.

RecommendingAuthority

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The authority or organization that recommended the vaccination protocol that was followed.

RecordCreationDateTime

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the patient immunization record was created.

RouteId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents the route followed in the vaccine administration.
  • Referenced Objects:
    • CodeSetBundle

SiteId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents the site of the vaccine administration on the patient’s body.
  • Referenced Objects:
    • CodeSetBundle

SourceSystem

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The source system from where the immunization record was brought into Salesforce.

SourceSystemIdentifier

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The identifier of the immunization record in its source system.

SourceSystemModified

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time when the immunization record was last modified in its source system.

Status

  • Type: picklist
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Specifies the status of the vaccination.
  • Possible values:
    • Completed
    • Entered in Error
    • Not Done

StatusReasonCodeId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents the reason for the status of the vaccination.
  • Referenced Objects:
    • CodeSetBundle

SubpotencyReasonCodeId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents the reason for why the vaccination was sub-potent.
  • Referenced Objects:
    • CodeSetBundle

TargetDiseaseCodeId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The system-defined code that represents the disease that was targeted in the immunization.
  • Referenced Objects:
    • CodeSetBundle

VaccinationDate

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time of the vaccination. If you specify a vaccination date, you can’t specifiy a vaccination period.

VaccinationPeriod

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The period of time during which the vaccination happened. If you specify a vaccination period, you can’t specify a vaccination date.

VaccineCodeId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The system-defined code that represents vaccine that was administered in the immunization.
  • Referenced Objects:
    • CodeSetBundle

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

PatientImmunizationChangeEvent (API version 58.0)
Change events are available for the object.
PatientImmunizationFeed
Feed tracking is available for the object.
PatientImmunizationHistory
History is available for tracked fields of the object.
PatientImmunizationOwnerSharingRule (API version 56.0)
Sharing rules are available for the object.
PatientImmunizationShare (API version 56.0)
Sharing is available for the object.