Salesforce Health Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Health Cloud Developer Guide
Health Cloud Data Model
Health Cloud Associated Objects
Health Cloud Fields on Standard Objects
Working With Electronic Health Records
Emergency Response Management
Apex Reference
Health Cloud Business APIs
REST Reference
Resources
Assessment Responses
Book Slot Chain
Care Services Review and Response
Care Services Review Resources
Care Services Review Requests (GET)
Care Services Review Requests (POST)
Care Services Review Requests (PATCH)
Contact Encounter
Care Program Enrollments
Digital Verification (POST)
Guest Referral
Identity Verification
Benefit Verification
Intelligent Document Management
Medication Statements
Omniscript
Patients
Providers
Referral Management
Unified Health Scoring
Visits
Work Type Lead Time
Quotas and Allocations
Request Bodies
Response Bodies
Intelligent Appointment Management Operations
Health Cloud Tooling API Objects
Health Cloud Standard Invocable Actions
Metadata Types
API End-of-Life Policy
PDF

Care Services Review Requests (PATCH)

Update care services review requests or update existing requests.
  • You must have Person Accounts enabled to use these APIs.
  • After enabling person accounts, enable name suffixes.
    1. Navigate to Setup | Customize | User Interface.
    2. In Name Settings, select Enable Name Suffixes for Person Names and save.
  • For PATCH, if the request body contains IDs for CareRequestitem, CareRequestDrug, or CareDiagnosis, then the corresponding records are updated, else the new child records are created.
Resource
/services/data/vXX.X/connect/health/care-services
Available version
46.0
Authentication
Use OAuth to connect to Salesforce and get an access token. Pass the access token in your requests.
HTTP methods
PATCH
Request body for PATCH
Root XML tag
<careRequestsList>
JSON Schema
{
  "careRequestsList": [
    {
      "careRequestCase": {
        "caseOrigin": "Web"
      },
      "careRequest": {
        "recordType": "Admission",
        "authorizationRefIdentifier": "1234",
        "name": "Headache",
        "member": "001RM000005XHdbYAG",
        "memberPrimaryPlan": "0SqRM00000000Fp0AI",
        "caseSubStatus": "active",
        "servicingFacility": {
          "npi": "742963",
          "servicingFacilityId": "0klRM0000004CBnYAM"
        },
        "requestingPractitioner": {
          "npi": "11111",
          "healthCareProviderId": "0cmRM0000000tldYAA"
        }
      },
      "careRequestItems": [
        {
          "authApprovalIdentifier": "123",
          "authorizationRefIdentifier": "123",
          "name": "CRI Connect-1.0",
          "requestType": "Order",
          "priority": "Stat",
          "reasonCode": "0hsRM00000003ytYAA",
          "servicingFacility": {
            "npi": "742963",
            "servicingFacilityId": "0klRM0000004CBnYAM"
          },
          "servicingProvider": {
            "npi": "11111",
            "healthCareProviderId": "0cmRM0000000tldYAA"
          },
          "clinicalServiceRequestId": "0jyRM0000004CAGYA2"
        }
      ],
      "careDiagnoses": [
        {
          "name": "CD Connect 1.0",
          "presentOnAdmission": "Yes",
          "healthConditionId": "0j4RM0000004Mk9YAE"
        }
      ],
      "careRequestDrugs": [
        {
          "name": "CRD Connect 1.0",
          "status": "Active",
          "statusReason": "Insufficient Information",
          "requestType": "Filler Order",
          "drugAdministrationSetting": "Inpatient",
          "priority": "Routine",
          "medicationRefObjectId": "0kmRM0000004CSeYAM",
          "authApprovalIdentifier": "123",
          "authorizationRefIdentifier": "123",
          "servicingFacility": {
            "npi": "742963",
            "servicingFacilityId": "0klRM0000004CBnYAM"
          },
          "servicingProvider": {
            "npi": "11111",
            "healthCareProviderId": "0cmRM0000000tldYAA"
          }
        }
      ],
      "patient": {
        "memberId": "001RM000005XHdbYAG",
        "lastName": "Green",
        "firstName": "Charles",
        "birthDate": "2001-10-26T21:32:52"
      }
    }
  ]
}
Properties
Name Type Description Required Available Version
careRequestsList Care Authorization Request Input[] List of Care Requests to be created or updated. (Up to 25 items.) Yes 46.0
Response body for PATCH
Care Authorization Request Result