---
schema_version: "1"
id: f19eb3221d22f00802022ae934c3dc75b754b05113f2329184ebc467bef9cbba
title: FHIR Reference Input
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/health_cloud_object_reference/connect_requests_fhir_reference.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.health_cloud_object_reference.meta/health_cloud_object_reference/connect_requests_fhir_reference.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: d72cc8a14dd5d08330fd9495d60b87e0813a8375b990b4e981bd1fc0972f52a9
description: The input representation for the Reference FHIR object.
---
# FHIR Reference Input

The input representation for the Reference FHIR object.

## Root XML tag

<FhirReferenceInput>

## JSON example

{
   "reference": {
      "referenceResource": "practitioner",
      "referenceId": "ABCId",
      "relationship": "Oncologist"
   }
}

## Properties

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d578345e52">Name</th>
              <th class="featureTableHeader vertical-align-top " id="d578345e54">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d578345e56">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d578345e58">Required or Optional</th>
              <th class="featureTableHeader vertical-align-top " id="d578345e60">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d578345e52" data-title="Name"><samp class="codeph nolang">referenceId</samp></td>
              <td class="entry" headers="d578345e54" data-title="Type">String</td>
              <td class="entry" headers="d578345e56" data-title="Description">The ID of the medication or practitioner (healthcare provider) record or the managing
                organization (account) record in the source system.</td>
              <td class="entry" headers="d578345e58" data-title="Required or Optional">Required<p class="p">Note: Optional if <samp class="codeph nolang">salesforceId</samp> is
                  specified.</p>
              </td>
              <td class="entry" headers="d578345e60" data-title="Available Version">53.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d578345e52" data-title="Name"><samp class="codeph nolang">referenceResource</samp></td>
              <td class="entry" headers="d578345e54" data-title="Type">String</td>
              <td class="entry" headers="d578345e56" data-title="Description">The FHIR resource referred to. For example, organization or practitioner.</td>
              <td class="entry" headers="d578345e58" data-title="Required or Optional">Required</td>
              <td class="entry" headers="d578345e60" data-title="Available Version">53.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d578345e52" data-title="Name"><samp class="codeph nolang">relationship</samp></td>
              <td class="entry" headers="d578345e54" data-title="Type">String</td>
              <td class="entry" headers="d578345e56" data-title="Description">The relationship between the patient and the healthcare provider or the managing
                organization, stored using the Reciprocal Roles records.</td>
              <td class="entry" headers="d578345e58" data-title="Required or Optional">Optional</td>
              <td class="entry" headers="d578345e60" data-title="Available Version">53.0</td>
            </tr>

            <tr>
              <td class="entry" headers="d578345e52" data-title="Name"><samp class="codeph nolang">salesforceId</samp></td>

              <td class="entry" headers="d578345e54" data-title="Type">String</td>

              <td class="entry" headers="d578345e56" data-title="Description">The Salesforce ID of the record that’s created in Salesforce.</td>

              <td class="entry" headers="d578345e58" data-title="Required or Optional">Required<p class="p">Note: Optional if <samp class="codeph nolang">referenceId</samp> is specified.</p>
              </td>

              <td class="entry" headers="d578345e60" data-title="Available Version">54.0</td>

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