EhrImmunization__c

Represents information about the administration of vaccines to patients.

Supported Calls

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

This packaged object has a standard object counterpart in the Clinical Data Model. We recommend using the standard object because it’s more closely aligned with FHIR v4.0.

Fields

Account__c

Type: reference
Properties: Create, Filter, Group, Sort
Description: The person account that represents the patient in Lightning Platform

DateAdministered__c

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date when a vaccine was administered or was to be administered.

DoseQuantity__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The quantity of vaccine product that was administered.

DoseQuantityUnits__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The unit of measurement in the quantity of vaccine product that was administered.

DoseQuantityValue__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The quantity of vaccine product that was administered.

ExpirationDate__c

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date when a vaccine batch expires.

IsRestricted__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Indicates whether or not this field has restricted visibility based on sharing rules.

IsVisibleOnPatientCard__c

Type: boolean
Properties: Defaulted on create, Filter, Group
Description: Indicates whether or not this field appears on the patient card.

LastActivityDate

Type: date
Properties: Filter, Group, Nillable, Sort
Description: Whichever of the following is the most recent:
- Due date of the most recent event logged against the record.
- Due date of the most recently closed task associated with the record.

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The time stamp that indicates when the current user last viewed a related record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.

LocationCity__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The city where the vaccine was administered.

LocationCountry__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The country where the vaccine was administered.

LocationId__c

Type: string
Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
Description: An external identifier for the service delivery location where the vaccine was administered.

LocationLline1__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The first line of the address where the vaccine was administered.

LocationLline2__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The second line of the address where the vaccine was administered.

LocationName__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The name of the location where the vaccine was administered.

LocationPostalCode__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The postal code in the address where the vaccine was administered.

LocationStartDate__c

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The first date when the vaccination location is valid.

LocationState__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The state where the vaccine was administered.

LocationTelecom__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A contact detail for the location where the vaccine was administered.

LocationText__c

Type: textarea
Properties: Create, Nillable, Update
Description: The complete address of the location where the vaccine was administered.

LocationType__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: A type of location where the vaccine was administered.

LocationUse__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Details such as home or office related to the location where the vaccine was administered.

LotNumber__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The lot number of the vaccine product that was administered.

Name

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookupSort
Description: The name of the vaccine product that was administered. Limit: 255 characters.

Patient__c

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The patient who received or was to receive the vaccine. Lookup to EhrPatient__c.

Performer__c

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The clinician who administered the vaccine. Lookup to EhrPractitioner__c.

PerformerName255__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The clinician who administered the vaccine. Limit: 255 characters.

PerformerName__c

Type: textarea
Properties: Create, Nillable, Update
Description: The long text description of the name of the clinician who administered the vaccine.

ReasonCode__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the reason why a vaccination was administered.

ReasonLabel__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The human-readable label that represents the reason why a vaccination was administered.

ReasonSystem__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system that defines the reason why a vaccination was administered.

RefusalLabel__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The human-readable label that indicates that the vaccine wasn’t administered.

RefusalReasonCode__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the reason why a vaccine wasn’t administrated.

RefusalReasonLabel__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The human-readable label that represents the reason why a vaccine wasn’t administrated.

RefusalReasonSystem__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system that defines the reason why a vaccine wasn’t administrated.

RefusedIndicator__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Whether the vaccine was refused (true) or not (false). The default checkbox value is deselected.

Requestor__c

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The clinician who ordered the vaccine. Lookup to EhrPractitioner__c.

RequestorName255__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The clinician who ordered the vaccine. Limit: 255 characters.

RequestorName__c

Type: textarea
Properties: Create, Nillable, Update
Description: The long text description of the name of the clinician who ordered the vaccine.

RouteCode__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the path through which the vaccine is taken into the body.

RouteLabel__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The human-readable label that represents the path through which the vaccine is taken into the body.

RouteSystem__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system that defines the path through which the vaccine is taken into the body.

SelfReported__c

Type: boolean
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: Whether the vaccine is self-reported (true) or not (false). The default checkbox value is deselected.

SiteCode__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the body site where the vaccine was administered.

SiteLabel__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The human-readable label that represents the body site where the vaccine was administered.

SiteSystem__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system that defines the body site where the vaccine was administered.

SourceSystem__c

Type: string
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: A name that identifies the system that created the record and owns update rights to it.

SourceSystemId__c

Type: string
Properties: Create, Filter, Group, idLookup, NillableSort, Update
Description: The ID of an external record. This field can’t be encrypted.

SourceSystemModified__c

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The most recent date when the integration system wrote the record from the source record.

VaccineTypeCode__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system-defined code that represents the type of vaccine that was administered or was to be administered.

VaccineTypeLabel__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The human-readable label that represents the type of vaccine that was administered or was to be administered.

VaccineTypeSystem__c

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The system that defines the type of vaccine that was administered or was to be administered.

Usage

This resource excludes the administration of nonvaccine agents, even those that have or claim to have immunological effects.