Client APIs

Owned by Sara Fetherson
Last updated: Oct 26, 2023
3 min read

GET client

A get method is needed to get client demographics by a client ID(s). The API client will send the client ID as a parameter to the API and the demographics returned will be the data mapped in the below table

POST to add a new client or modify a client

A post method is needed to insert or update client information into Rethink. The input to the method will be a client object based on the below mapping table

Client (Patient)

Field

Data Type

Max Length

Description

Req

Expected Values

Error Messages

Field

Data Type

Max Length

Description

Req

Expected Values

Error Messages

1

clientId

integer

100

Rethink Client ID.  This will be null in case a new client is being created. If the client is being updated, the client ID will be sent to Rethink

No

12345

Client Id does not exist under this Organization.

Invalid Format - Must be a number.

 

2

firstName

string

100

Client's First Name

Yes

Eric

Exceeds Max Length

3

middleName

string

100

Client's Middle Name

No

 T

Exceeds Max Length

4

lastName

string

100

Client's Last Name

Yes

Morales

Exceeds Max Length

5

dateOfBirth

string

10

Client's Date of Birth

Yes

1997-12-10

Invalid Format - Must be Date Format

Exceeds Max Length

6

genderID

integer

3

ID associated with gender of the Client. See Appendix Client Gender.

Yes

1

Invalid Format - Must be a number

Invalid Gender ID . Valid range of values is 1-3.

Exceeds Max Length

7

addressStreet

string

100

Client's Street Address

No

12345 21 Street

Exceeds Max Length

8

city

string

100

Client's City

No

New York City

Exceeds Max Length

9

stateId

integer

52

ID associated with the with the State. See Appendix for State.

No

1

Exceeds Max Length

Invalid Format - Must be a number

Invalid State ID . Valid range of values is 1-52.

10

zipCode

string

9

5 or 9 digit Zip Code
No dashes allowed

No

07745

Invalid Format - Dashes are not supported

Exceeds Max Length

 

11

clientExternalId

string

20

Unique Client Identifier number on the External system

No

234RTY7699

 

Exceeds Max Length

12

uniqueClientIdentifierNumber

string

20

Unique Client Identifier number;
Applicable if using Parent Verification Form Report

No

12345

 

Exceeds Max Length

13

clientOrder

integer

99999

Number to divide clients in a group that are managed by a therapist or supervisor.

No

12345

Invalid Format - Must be a number

Exceeds Max Length

14

reasonForReferral

string

200 chars

Free text field to note a reason for referral

No

Social skill issues

Exceeds Max Length

15

noticeOfPrivacyPracticeDate

string

10

Date to denote the notice of privacy practice date

No

2016-12-20

Invalid Format - Must be Date Format

Exceeds Max Length

16

locationId

integer

100

Location ID associated to the intended location should be passed. The Location IDs are the IDs for the Location configured in Company Account > Locations > Location. The Location IDs will be  provided by Rethink during implementation.

Yes

2801

Invalid Location Id. Location Id does not exist under this account.

Exceeds Max Length

Invalid Format - Must be a number.

17

statusId

integer

100

Status ID connected to the Client Status should be passed. The Status IDs are the IDs for statuses configured in the Company Account > Client Settings > Client Statuses. The Status IDs will be provided by Rethink during implementation.

Yes

3

Invalid Status Id. Status Id does not exist under this account.

Exceeds Max Length

Invalid Format - Must be a number.

18

serviceIntensityId

integer

2

Intensity of Services provided. Send ID of the intended intensity. See Appendix 1.0. Service Intensity.

Yes

1

Invalid Service Intensity Id. Valid range of values is 1-2.

Exceeds Max Length

Invalid Format - Must be a number.

19

notes

string

500

Text field to add specific notes for client

No

NO BCBA on Case

Exceeds Max Length

20

stateAbbreviation

string

2

Client’s state abbreviated

No

NY

Exceeds Max Length

21

dateCreated

string

 

 

No

2012-04-23T18:25:43

 

22

dateLastModified

string

 

 

No

2012-04-23T18:25:43

 

23

dateDeleted

string

 

 

No

2012-04-23T18:25:43

 

24

clientNotes

List <ClientNotes>

 

 

No

 

 

25

clientFunders

List <ClientFunders>

 

 

No

 

 

26

clientAuthorizations

List <ClientAuthorization>

 

 

No

 

 

27

clientAvailability

List<ClientAvailability>

 

 

No

 

 

28

errorMessage

String

10,000

ErrorMessage is used to return any API errors to the client

No

 

 

 
Other Notes:

  1. A unique API Key will need to be provided for each account 

  2. API can be tested in Postman

  3. API responds with the Rethink Client ID 

  4. A swagger document will be provided after the design phase is complete

  5. Lookups will be provided to customer before creating the client. 

  6. Errors will be returned if the API is used with an incorrect lookup value (Error handling scenarios in the specs)

  7. Capacity to be defined at the performance testing (throughput) and communicated to customer (# max number of requests per minute and # of concurrent requests)