Rethink POST Appointment API - Create

Outcomes:

POST Appointment to schedule or modify an appointment

	Field	Data Type	Max Length	Description	Required	Expected Values	Errors

	Field	Data Type	Max Length	Description	Required	Expected Values	Errors
1	appointmentTypeId	number	1	Type of appointment. Send ID associated to the Appointment Type. Refer Appointment Type Appendix.	Yes	1	Appointment Type does not match system set values.
2	date	string	10	Date of Service	Yes	2020-12-12	Must be date format
3	scheduledStartTime	string	5	Scheduled Start Time of the appointment. Times should be sent in UTC	Yes	16:00	Must be time format
4	scheduledEndTime	string	5	Scheduled End Time of the appointment. Times should be sent in UTC.	Yes	17:00	Must be time format
5	staffId	number	20	Staff ID should be same as the ID returned by Rethink when Staff was created	Yes	1234	Submitted StaffID does match any IDs associated with this Company Account
6	payCodeId	number	10	Pay Code ID should match the Id Pay Codes configured in Staff Profile > Pay Code. IDs for Paycodes will be provided by Rethink during implementation Pay Code ID transmitted should also be configured in the Staff Member Profile.	Yes	12345	Invalid format Submitted value does match any IDs associated with a Paycode
7	tagId	number		Tag Id should match the Id of the Tag configured in the Company Account > Scheduling. Tag Id is required for non-billable appointments Error will be returned if Appointment Type is Billable and Tag sent is Non-Billable. Error will be returned if Appointment Type is Non-Billable. and Tag sent is Billable.	Situational	123	Invalid Tag Id Invalid Tag Id for Billable Appointment Invalid Tag Id for Non-Billable Appointment
8	clientId	number	20	Should be same as the Client ID returned by rethink when client was created	Yes	12345	Submitted ClientID does match any IDs associated with this Company Account
9	locationCodeId	number	2	Place of Service to denote the location where the appointment was performed i.e. 03-School See Place of Service Data Dictionary to see expected values	Yes	1	Place of Service ID does not match expected Place of Service values:
10	locationId	number	100	Location should EXACTLY MATCH be one of the following number values: ID associated with value of Client Home (See Appendix Location) ID associated with Staff Home (See Appendix Location) ID of the Location values configured in Company Account > Locations. Location IDs will be provided by Rethink during implementation.	No	1	Value does not match ID for Locations
11	scheduledLocationAddress	string	500	Address associated with the scheduled location of the appointment IF location is sent as 1 (Client Home), scheduled location address can be blank. The address present in the Client Profile will be auto populated as scheduled location address. IF location is sent as 2 (Staff Home), scheduled location address can be blank. The address present in the Staff Profile will be auto populated. IF back-end ID of a location is sent, address associated with the location in Company Account will be auto-populated. Any address passed in this field will over-ride the auto-population logic for addresses.	No	123 Avenue, NY, NY, 07202	Exceeds max length
12	authorizationBillingCodeId	number	10	If a new service is added to the Authorization, this field can be blank. Rethink will assign an Authorization Billing Code ID and return the Authorization Billing Code ID. Any further updates to the Authorization Service will require the Authorization Billing Code ID.	Situational	11134	Invalid format Invalid Authorization Billing Code ID.
13	funderBillingCodeId	number	10	If appointment is created for a Billing Code that has Does NOT require Authorization setting checked on Funder THEN the Funder Billing Code needs to be sent. The Funder Billing Code ID is the ID of the CPT code attached to the Funder. Funder Billing Code ID associated to the intended Service should be passed. The Funder Billling Code IDs are the IDs for CPT codes configured in the Company Account > Funders > Service Lines > Billing Code. The Billing Code IDs will be provided by Rethink during implementation.	Situational	11134	Billing Code does not match values under Company Account Current Values: [Show Company Values]
14	scheduledLocation
15	latitude	number	11	Scheduled location latitude returned for EVV Appointments	No	25.555903	Value provided cannot exceed 11 numbers.
16	longitude	number	11	Scheduled location longitude returned for EVV Appointments	No	-80.394343	Value provided cannot exceed 11 numbers.