--- schema_version: "1" id: 0a23a88e52597962f0865f60348b9a9e97c4654565d0f9fab0ae51034953fa28 title: PatientImmunizationProtocol collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/life_sciences_dev_guide/hc_r4_api_objects_patientimmunizationprotocol.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/hc_r4_api_objects_patientimmunizationprotocol.htm source_site: developer.salesforce.com content_type: documentation content_hash: cbb97412208a25dec8023004aaf289420d73f03ab0ae9fd562b474129b2f83ec description: 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. --- # 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](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PatientImmunizationProtocolHistory](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PatientImmunizationProtocolOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") (API version 57.0) Sharing rules are available for the object. [PatientImmunizationProtocolShare](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") (API version 57.0) Sharing is available for the object. [PatientImmunizationProtocolChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.life_sciences_dev_guide.meta/life_sciences_dev_guide/sforce_api_associated_objects_change_event.htm "A StandardObjectNameChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 61.0) Change events are available for the object.