Salesforce Docs Portal

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

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.
PatientImmunizationProtocolChangeEvent (API version 61.0)
Change events are available for the object.