Care Services Review Resources

Use these resources to create or update care services review requests, or get information about the status of existing requests.

Available resources:

Resource	Description
`/services/data/vXX.X/connect/health/care-services`	Create care services review requests.
`/services/data/vXX.X/connect/health/care-services`	Update existing care services review requests.
`/services/data/vXX.X/connect/health/care-services/{ids}`	Get details of existing care services review requests. Replace `{ids}` with a semicolon-separated list of IDs.

Care Services Review Requests (GET)

Get details of existing care services review requests.

Resource

/services/data/vXX.X/connect/health/care-services/{ids}

Replace {ids} with a semicolon-separated list of IDs. The items in this list can be Salesforce ID, or a SourceSystemIdentifier. Use idName query parameter to specify the type of {ids} provided in the URI.

URI Example to retrieve care requests using Salesforce IDs:

1/connect/health/care-services/0Uk7859783498540;0Uk6712899900;0Um4367564378788?idName=Id&sectionNames=Subscriber;CareRequest

Ensure that semicolon character is not a part of any id, if using SourceSystemIdentifier to retrieve care requests.

Important

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 Connect REST API Using OAuth.

HTTP methods

GET

Query parameters

Parameter Name	Type	Description	Required	Available Version
`idName`	String	Indicates the type of identifiers used in the path parameter `ids`. The valid values are: `id`: Salesforce object ID. `SourceSystemIdentifier`: ID of the external system.	Yes	46.0
`sectionNames`	String	Semicolon separated list of section names for which data is requested. For example, `Subscriber, Patient, CareDiagnoses, CareRequestItems, CareRequestDrugs, TransportLocations, CareRequest`, or `CareRequestCase`.	No	46.0

Response body for GET

Care Authorization Request Get Result

Care Services Review Requests (POST)

Create 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.
You can create or update up to 25 care services requests.

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

POST

Request body for POST

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

JSON Schema

1{
2  "careRequestsList": [
3    {
4      "careRequestCase": {
5        "caseOrigin": "Web"
6      },
7      "careRequest": {
8        "recordType": "Admission",
9        "authorizationRefIdentifier": "1234",
10        "name": "Headache",
11        "member": "001RM000005XHdbYAG",
12        "memberPrimaryPlan": "0SqRM00000000Fp0AI",
13        "caseSubStatus": "active",
14        "servicingFacility": {
15          "npi": "742963",
16          "servicingFacilityId": "0klRM0000004CBnYAM"
17        },
18        "requestingPractitioner": {
19          "npi": "11111",
20          "healthCareProviderId": "0cmRM0000000tldYAA"
21        }
22      },
23      "careRequestItems": [
24        {
25          "authApprovalIdentifier": "123",
26          "authorizationRefIdentifier": "123",
27          "name": "CRI Connect-1.0",
28          "procedureCodeSet": "0hxxG0000008hKxxAI",
29          "requestType": "Order",
30          "priority": "Stat",
31          "healthcareProcedureCode": "0XSxx000000SXxxA2",
32          "reasonCode": "0hsRM00000003ytYAA",
33          "servicingFacility": {
34            "npi": "742963",
35            "servicingFacilityId": "0klRM0000004CBnYAM"
36          },
37          "servicingProvider": {
38            "npi": "11111",
39            "healthCareProviderId": "0cmRM0000000tldYAA"
40          },
41          "clinicalServiceRequestId": "0jyRM0000004CAGYA2"
42        }
43      ],
44      "careDiagnoses": [
45        {
46          "name": "CD Connect 1.0",
47          "presentOnAdmission": "Yes",
48          "diagnosisCodeSet": "0hsSG0000008hKjYAI",
49          "healthcareDiagnosisCode": "0XNSG0000000PjB4AU",
50          "healthConditionId": "0j4RM0000004Mk9YAE"
51        }
52      ],
53      "careRequestDrugs": [
54        {
55          "name": "CRD Connect 1.0",
56          "status": "Active",
57          "statusReason": "Insufficient Information",
58          "requestType": "Filler Order",
59          "drugAdministrationSetting": "Inpatient",
60          "priority": "Routine",
61          "medicationRefObjectId": "0kmRM0000004CSeYAM",
62          "authApprovalIdentifier": "123",
63          "authorizationRefIdentifier": "123",
64          "servicingFacility": {
65            "npi": "742963",
66            "servicingFacilityId": "0klRM0000004CBnYAM"
67          },
68          "servicingProvider": {
69            "npi": "11111",
70            "healthCareProviderId": "0cmRM0000000tldYAA"
71          }
72        }
73      ],
74      "assessmentLinks": [
75          {
76            "id": "0U3SG00000068Cb0AI"     
77          },
78      "patient": {
79        "memberId": "001RM000005XHdbYAG",
80        "lastName": "Green",
81        "firstName": "Charles",
82        "birthDate": "2001-10-26T21:32:52"
83      }
84    }
85  ]
86}

Root XML tag: <careRequestsList>

Response body for POST

Care Authorization Request Result

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

Care Requests Update List Input

Response body for PATCH

Care Authorization Request Result

See Also