Salesforce Health Cloud Developer Guide

Health Cloud Developer Guide
Health Cloud Data Model
Advanced Therapy Management
Benefits Verification
Care Management
Care Program Management
Claims
Clinical Data Model
ActivityTiming
AllergyIntolerance
AuthorNote
CareObservation
CarePerformer
CareRegisteredDevice
DiagnosticSummary
ClinicalAlert
ClinicalDetectedIssue
ClinicalDetectedIssueDetail
ClinicalEncounter
ClinicalServiceRequest
CodeSet
CodeSetBundle
HealthcareFacility
HealthCondition
Identifier
Medication
MedicationDispense
MedicationRequest
MedicationStatement
PatientHealthReaction
PatientImmunization
PatientImmunizationProtocol
PatientMedicalProcedure
PatientMedicationDosage
PersonLanguage
PersonName
Code Sets for Diagnosis and Procedure
Crisis Support Center Management
Electronic Health Records
Electronic Signatures
Engagement Interaction
Health Assessments
Health Insurance
Home Health
Integrated Care Management
Intelligent Appointment Management
Intelligent Document Automation
Intelligent Sales
Medication Management
Provider Network Management
Provider Relationship Management
Remote Monitoring and Device Registration
Social Determinants
Timeline in Health Cloud
Unified Health Scoring
Utilization Management
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Creating and Importing Documents
Intelligent Appointment Management
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
Health Cloud Custom Metadata Types
Health Cloud Empower Components for Experience Cloud Sites
API End-of-Life Policy
PDF

Newer Version Available

This content describes an older version of this product. View Latest

PatientImmunizationProtocol

Represents the protocol followed by a provider for a patient’s immunization and its related details. The protocol defines the set of recommendations that are followed while a vaccine is administered. This object is a child of the PatientImmunization object. This object is available in API version 56.0 and later.

Supported Calls

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

Fields

Field Details
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.
ImmunizationRecommendation
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the protocol that was followed for the immunization.
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.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The system-generated name of the PatientImmuizationProtocol record.
OwnerId
Type
Polymorphic lookup
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The owner of the record.
Relationship Name
Owner
Refers To
  • Group
  • User
PatientImmunizationId
Type
Master-detail reference
Properties
Create, Filter, Group, Sort
Description
The parent PatientImmunization record that the applied protocol is a part of.
Relationship Name
PatientImmunization
Refers To
PatientImmunization
RecommendedDoses
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
RecommendingAuthority
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Total number of doses recommended to achieve immunity.
TargetDisease1CodeId
Type
Lookup
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system-defined code that represents a disease that was targeted in the immunization
Relationship Name
TargetDisease1Code
Refers To
CodeSetBundle
TargetDisease2CodeId
Type
Lookup
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system-defined code that represents a disease that was targeted in the immunization
Relationship Name
TargetDisease2Code
Refers To
CodeSetBundle
TargetDisease3CodeId
Type
Lookup
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system-defined code that represents a disease that was targeted in the immunization
This field is a relationship field.
Relationship Name
TargetDisease3Code
Refers To
CodeSetBundle
TargetDisease4CodeId
Type
Lookup
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system-defined code that represents a disease that was targeted in the immunization
This field is a relationship field.
Relationship Name
TargetDisease4Code
Refers To
CodeSetBundle
TargetDisease5CodeId
Type
Lookup
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system-defined code that represents a disease that was targeted in the immunization
This field is a relationship field.
Relationship Name
TargetDisease5Code
Refers To
CodeSetBundle
TargetDisease6CodeId
Type
Lookup
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The system-defined code that represents a disease that was targeted in the immunization
This field is a relationship field.
Relationship Name
TargetDisease6Code
Refers To
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.

PatientImmunizationProtocolFeed
Feed tracking is available for the object.
PatientImmunizationProtocolHistory
History is available for tracked fields of the object.
PatientImmunizationProtocolOwnerSharingRule (API version 57.0)
Sharing rules are available for the object.
PatientImmunizationProtocolShare (API version 57.0)
Sharing is available for the object.