Enrollments

Enroll multiple patients into a care program.

Resource

1/services/data/vXX.X/connect/health/care-programs/enrollments

Available version

46.0

Authentication

Use OAuth to connect to Salesforce and get an access token. Pass the access token in your requests. For more information, see Connect to Chatter REST API Using OAuth.

HTTP methods

POST

Request body

Root XML tag

<careProgramEnrollmentData>

JSON example

1{
2  "programId": "programId1",
3  "sourceSystem": "source-system-name",
4  "patientData": [
5    {
6      "patientId": "patient1",
7      "careProgramProductData": [
8        {
9          "providerId": "provider1",
10          "productId": "product1"
11        },
12        {
13          "providerId": "provider1",
14          "productId": "product2"
15        }
16      ]
17    },
18    {
19      "patientId": "patient2",
20      "careProgramProductData": [
21        {
22          "providerId": "provider3",
23          "productId": "product4"
24        }
25      ]
26    }
27  ]
28}

Properties

Name	Type	Description	Required	Available Version
`patientData`	Patient Input[]	List of all objects that contain patients data. You can have up to 200 items in this list.	Yes	46.0
`programId`	String	ID of the care program as configured in the care system field mappings.	Yes	46.0
`sourceSystem`	String	Name of the source system as configured in the care system field mappings.	Yes	46.0

Response body

Program Enrollment Result

Prerequisites

Ensure that you have configured the following care system field mapping configured in Setup | Care System Field Mappings:

Name	Role	Target Object
`Care_Program`	Not Applicable	`CareProgram`
`Patient`	Patient	`Account`
`Product`	Not Applicable	`Product2`
`Provider`	Service Provider	`Account`

Ensure that you have configured appropriate external ID field and source system for each of these mappings.

Note

For more information, see CareSystemFieldMapping.

Salesforce Health Cloud Developer Guide

Enrollments

See Also