Salesforce Health Cloud Developer Guide

Health Cloud Developer Guide
PDF

EhrImmunization​__c to PatientImmunization

Fields in EhrImmunization​__c map to PatientImmunization in the Clinical data model.

Mapping

Field Details Clinical Data Model Field Notes
Account​__c
Description
The person account that represents the patient in Lightning Platform
 Patient​Immunization​.PatientId N/A
Date​Administered​__c
Description
The date when a vaccine was administered or was to be administered.
 Patient​Immunization​.Vaccination​Date Date in DateTime format.
Patient​Immunization​.Vaccination​Period Date as a string.
Dose​Quantity​__c
Description
The quantity of vaccine product that was administered.
 Patient​Immunization​.​Dose Dose​Quantity​__c and Dose​Quantity​Value​__c are duplicare fields in Ehr​Immunization​__c
Dose​Quantity​Units​__c
Description
The unit of measurement in the quantity of vaccine product that was administered.
 Patient​Immunization​.​Dose​UnitId N/A
Dose​Quantity​Value​__c
Description
The quantity of vaccine product that was administered.
 Patient​Immunization​.​Dose Dose​Quantity​__c and Dose​Quantity​Value​__c are duplicare fields in Ehr​Immunization​__c
Expiration​Date​__c
Description
The date when a vaccine batch expires.
 Patient​Immunization​.Expiration​Date N/A
IsRestricted​__c
Description
Indicates whether or not this field has restricted visibility based on sharing rules.
 Not supported N/A
IsVisible​OnPatient​Card​__c
Description
Indicates whether or not this field appears on the patient card.
 Not supported N/A
Location​City​__c
Description
The city where the vaccine was administered.
 Patient​Immunization​.FacilityId Location for an immunization is specified in the Clinical data model as a reference to a HealthcareFacility record.
Location​Country​__c
Description
The country where the vaccine was administered.
LocationId​__c
Description
An external identifier for the service delivery location where the vaccine was administered.
Location​Lline1​__c
Description
The first line of the address where the vaccine was administered.
Location​Lline2​__c
Description
The second line of the address where the vaccine was administered.
Location​Name​__c
Description
The name of the location where the vaccine was administered.
Location​Postal​Code​__c
Description
The postal code in the address where the vaccine was administered.
Location​StartDate​__c
Description
The first date when the vaccination location is valid.
Location​State​__c
Description
The state where the vaccine was administered.
Location​Telecom​__c
Description
A contact detail for the location where the vaccine was administered.
Location​Text​__c
Description
The complete address of the location where the vaccine was administered.
Location​Type​__c
Description
A type of location where the vaccine was administered.
Location​Use​__c
Description
Details such as home or office related to the location where the vaccine was administered.
Lot​Number​__c
Description
The lot number of the vaccine product that was administered.
 Patient​Immunization​.Lot​Number N/A
Name
Description
The name of the vaccine product that was administered. Limit: 255 characters.
 Identifier The identifier information for an immunization is represented as Identifier records that reference the Patient​Immunization record using their Identifier​.Parent​RecordId field​.
Patient​__c
Description
The patient who received or was to receive the vaccine. Lookup to EhrPatient​__c.
 Patient​Immunization​.PatientId N/A
Performer​__c
Description
The clinician who administered the vaccine. Lookup to EhrPractitioner​__c.
 ​Care​Performer The performer information for an immunization is represented as ​Care​Performer records that reference the Patient​Immunization record using their ​Care​Performer​.Parent​RecordId field​.
Performer​Name255​__c
Description
The clinician who administered the vaccine. Limit: 255 characters.
Performer​Name​__c
Description
The long text description of the name of the clinician who administered the vaccine.
Reason​Code​__c
Description
The system-defined code that represents the reason why a vaccination was administered.
 Patient​Immunization​.Reason​CodeId This code value is specified as a reference to a code set bundle record.
Reason​Label​__c
Description
The human-readable label that represents the reason why a vaccination was administered.
Reason​System​__c
Description
The system that defines the reason why a vaccination was administered.
Refusal​Label​__c
Description
The human-readable label that indicates that the vaccine wasn’t administered.
 Not supported N/A
Refusal​Reason​Code​__c
Description
The system-defined code that represents the reason why a vaccine wasn’t administrated.
 Patient​Immunization​.Status​Reason​​CodeId Refusal reason is a subset of status reason, since refused is a status.
Refusal​Reason​Label​__c
Description
The human-readable label that represents the reason why a vaccine wasn’t administrated.
Refusal​Reason​System​__c
Description
The system that defines the reason why a vaccine wasn’t administrated.
Refused​Indicator​__c
Description
Whether the vaccine was refused (true) or not (false). The default checkbox value is deselected.
 Not supported The clinical data model has no dedicated field to indicate whether a vaccine was refused or not. But the status field can be used to indicate if a vaccine was refused, among the other possible statuses.
Requestor​__c
Description
The clinician who ordered the vaccine. Lookup to EhrPractitioner​__c.
 Care​Performer Use the Care​Performer object to connect the immunization record with the person who requested the immunnization. Specify Requestor as the role type in the Care​Performer record.
Requestor​Name255​__c
Description
The clinician who ordered the vaccine. Limit: 255 characters.
Requestor​Name​__c
Description
The long text description of the name of the clinician who ordered the vaccine.
Route​Code​__c
Description
The system-defined code that represents the path through which the vaccine is taken into the body.
 Patient​Immunization​.RouteId This code value is specified as a reference to a code set bundle record.
Route​Label​__c
Description
The human-readable label that represents the path through which the vaccine is taken into the body.
Route​System​__c
Description
The system that defines the path through which the vaccine is taken into the body.
Self​Reported​__c
Description
Whether the vaccine is self-reported (true) or not (false). The default checkbox value is deselected.
 Not supported N/A
Site​Code​__c
Description
The system-defined code that represents the body site where the vaccine was administered.
 Patient​Immunization​.SiteId This code value is specified as a reference to a code set bundle record.
Site​Label​__c
Description
The human-readable label that represents the body site where the vaccine was administered.
Site​System​__c
Description
The system that defines the body site where the vaccine was administered.
Source​System​__c
The external system of record.
 Patient​Immunization​.Source​System N/A
Source​SystemId​__c
The ID of the record in the source system.
 Patient​Immunization​.Source​System​Identifier N/A
Source​System​Modified​__c
The date and time when the record was last modified in the source system.
 Patient​Immunization​.Source​System​Modified N/A
Vaccine​Type​Code​__c
Description
The system-defined code that represents the type of vaccine that was administered or was to be administered.
 Patient​Immunization​.Vaccine​CodeId This code value is specified as a reference to a code set bundle record.
Vaccine​Type​Label​__c
Description
The human-readable label that represents the type of vaccine that was administered or was to be administered.
Vaccine​Type​System​__c
Description
The system that defines the type of vaccine that was administered or was to be administered.