---
schema_version: "1"
id: 208f5c58c7add6e0dd83ebd0569c6aacd3537fe12d62ba70b883aa9dd1652cfe
title: Health | Generate FHIR Payload
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/ai/264-0-0/agent_ref_hc_generate_fhir_payload.md
canonical_url: https://help.salesforce.com/s/articleView?id=ai.agent_ref_hc_generate_fhir_payload.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: f7448a0d8a4d1bc51a76ef57244e0d9cf62261922e96e2b37db2f92aa7e42ed5
description: Generates the FHIR input payload required to register a patient in the Electronic Health Record (EHR) system.
products:
  - Agentforce
  - Cross Cloud
release: "264"
---
# Health | Generate FHIR Payload

Generates the FHIR input payload required to register a patient in the Electronic Health Record (EHR) system.

### Required Editions

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small edition"><colgroup><col></colgroup><tbody><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Available in: Lightning Experience</td></tr><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Available in: <strong>Enterprise</strong>, <strong>Performance</strong>, <strong>Unlimited</strong>, and <strong>Developer</strong> Editions with the Agentforce for Health add-on or included in Agentforce 1 Health Edition. Requires each user to have the Agentforce for Health add-on to access the action.</td></tr></tbody></table>

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small permission">
      <colgroup>
        <col style="width:50%">
        <col style="width:50%">
      </colgroup>
      <thead class="slds-text-title_caps ">
        <tr class="">
          <th scope="col" class="slds-cell-wrap" style="text-align:center;vertical-align:top;" id="d193862e85">User Permissions Needed</th>
          <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d193862e88">&nbsp;</th>
        </tr>
      </thead>
      <tbody>
        <tr class="">
          <td data-label="User Permissions Needed" class="slds-cell-wrap" style="vertical-align:top;" headers="d193862e85 ">To use this action:</td>

          <td data-label="" class="slds-cell-wrap" style="vertical-align:top;" headers="d193862e88 ">
            <p>Use Contact Center AI Assistive Agent</p>
            <p>AND</p>
            <p>Contact Center Agent for Health Cloud
              permission set </p>
            <p>AND</p>
            <p>Prompt Template User </p>
            <p style="margin-bottom:0;">AND</p>
            <p style="margin-bottom:0;">Data Cloud User</p>
          </td>

        </tr>
        <tr class="">
          <td class="slds-cell-wrap" colspan="2" style="vertical-align:top;" headers="d193862e85 d193862e88 ">See <a href="https://help.salesforce.com/s/articleView?id=ai.agent_actions_common_perms.htm&amp;type=5&amp;language=en_US" target="_blank">Common User Access for Standard Agent Actions</a>.</td>

        </tr>
      </tbody>
    </table>

![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-ai-generative_ai-264-0-0-production-enus/f8ef6498-d7b2-44e3-9b34-ffd5a850aae9/images/icon_note.png)

Note The agent uses public FHIR APIs to retrieve patient data in real time, including demographic data, clinical information such as prescriptions, lab results, health conditions, procedures, referrals, and care plans, and administrative data such as visit encounters and coverage from any certified EMR such as Epic, Oracle Cerner, and AthenaHealth. Data retrieval has been tested in the publicly available sandbox environments of these EMRs.

The agent leverages a pre-packaged [MuleSoft API](https://anypoint.mulesoft.com/exchange/org.mule.examples/generic-fhir-client-api/minor/1.2/console/method/%233963/) to interact with these FHIR endpoints. To enable the integration, provide the EMR-specific FHIR base URLs and credentials outlined on the [MuleSoft setup](https://www.mulesoft.com/exchange/org.mule.examples/generic-system-app/minor/1.3/pages/hb1-pmy/Setup/) page.

![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-ai-generative_ai-264-0-0-production-enus/f8ef6498-d7b2-44e3-9b34-ffd5a850aae9/images/icon_note.png)

Note The user interface of this product is available only in English and may not be fully supported in other languages.

## Action Details

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small "><colgroup><col style="width:50%"> <col style="width:50%"></colgroup><tbody><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">API Name</td><td class="slds-cell-wrap" style="vertical-align:top;">GenerateFhirPayload</td></tr><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Reference Action Type</td><td class="slds-cell-wrap" style="vertical-align:top;">Prompt Template</td></tr><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Reference Action</td><td class="slds-cell-wrap" style="vertical-align:top;">Generate FHIR Payload (GenerateFhirPayload)</td></tr><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Does this action run one or more prompt templates?</td><td class="slds-cell-wrap" style="vertical-align:top;">Yes</td></tr><tr class=""><td class="slds-cell-wrap" style="vertical-align:top;">Required Setup</td><td class="slds-cell-wrap" style="vertical-align:top;"><a href="https://help.salesforce.com/s/articleView?id=ind.hc_admin_cs_agentforce_for_contact_center.htm&amp;type=5&amp;language=en_US" target="_blank">Set Up Agentforce for Provider Contact Center</a></td></tr></tbody></table>

## Generate FHIR Payload and Prompt Templates

This action uses the Generate FHIR Payload prompt template to generate the request payload in JSON format to process the user's request.