Newer Version Available

This content describes an older version of this product. View Latest

Public Sector Solutions APIs

Use the Public Sector Solutions Business APIs to create care plan templates and care plans. Also, define or merge party relationship groups of individuals or trusts to manage shared processes, such as cases and benefits.

Special Access Rules

To use care plans, users need the Care Plans Access and Benefit Management Access permission sets.

To create party relationship groups, users need the Group Membership permission set. To merge party relationship groups, users must clone the Group Membership permission set, and enable the Merge and Split Groups system permission in the cloned permission set.

Available Resources

Resource Description
/connect/careplan/care-plans Use the POST request to create care plan records.
/connect/careplan/care-plans/${carePlanId} Use the PATCH request to update a care plan record.
/connect/careplan/care-plans/${carePlanId} Use the GET request to retrieve the care plan details.
/connect/careplan/careplan-templates/​${carePlanTemplateId}/actions/${actionType} Use the POST request to create care plan template records.
/connect/careplan/careplan-templates/​${carePlanTemplateId} Use the GET request to retrieve the care plan template details.
/connect/careplan/definitions/${definitionId} Use the GET request to retrieve details about a specified definition record that is related to goal definition and the benefits of a care plan.
/connect/group/group-definitions Use the POST request to define a party relationship group of individuals or trusts to deliver support services or to manage shared processes, such as cases and benefits.
/connect/group/group-fields Use the GET request to get the details from two party relationship groups.
/connect/group/accounts/${accountId}/related-records Use the GET request to get the related records of a party relationship group.
/connect/group/group-definitions/actions/merge Use the POST request to combine the details of two party relationship groups.