CareLink Open API Reference Welcome and Overview Patients Schedule Find Close By Patients Scheduling Wizard Patient Tags Providers Configuration API Development and Testing Sandbox

Welcome and Overview

Welcome to the CareLink Mobile Practice Manager Application Program Interface (API). This document lists the actions that are available for use by the client, and the format of the API Call that the application expects.  Our Open API is based on JSON requests and responses.

API Base End Point

https://{{yourdomain}}.mymobilepracticemanager.com/carelink/apiv2

API Security

For all calls you will need to pass in your API key as a post variable. If enabled your API Key can be found under Configuration Settings->View Site Setting.  When the API is set up for your account you will also be issues Basic Auth credentials. 

For more information on using Basic Auth you can reference here:

https://en.wikipedia.org/wiki/Basic_access_authentication

All API Calls are sent using a POST. All API Calls must be sent over SSL.

---

API Usage and Example

The following curl example illustrates capturing a single patient detail.

Sample Output

{ "recordcount": "1", "result": [ { "patientid": "2633", "patientfirstname": "Tyler", "patientlastname": "Adams", "patientmiddlename": null, "patientemail": "info@mymobilepracticemanager.com", "patientenablesms": "1", "patientpractitioner": "11", "patientvisitfrequency": "14", "patientbirthday": "1/3/1950", "patientlat": "33.28159", "patientlong": "-111.88420", "patientaddress": "2473 W Spruce Dr", "patientaddress2": null, "patientcity": "Chandler", "patientstate": "AZ", "patientzip": "85248", "patientfacilityid": "1", "facilityname": "Test Facility", "patientsex": "Male", "patienthomephone": "111-111-1111", "patientworkphone": null, "patientcellphone": "602-565-6909", "patientemrid": null, "patientnote": "Patient contacted office to schedule a new patient visit Patient does not want to be seen on Fridays", "patientschedulenote": "Call POA before Visit", "patientcreatedate": "2018-07-14", "patientlastupdate": "2022-09-13" } ] }

---

Patients

The Patients API has these available methods.

Method	End Point	Variables
List Patients	/patients/	apikey, lastupdate (“mm/dd/yyyy hh:mm:ss”)
Patient Details	/patients/{{patientid}}	apikey, patientid
Create Patient	/patients/add	apikey, patientfirstname, patientlastname, patientbirthday ("mm/dd/yy"), patientsex (“Male”, “Female”, “Unknown”), patientmiddlename, patientaddress, patientaddress2, patientcity, patientstate, patientzip, patientemail, patienthomephone, patientcellphone, patientenablesms, patientworkphone, patientemrid, patientpractitioner, patientnote, patientschedulenote, patientvisitfrequency, patientinsurance
Edit Patient	/patients/{{patientid}}/edit	apikey, patientid, patientmiddlename, patientaddress, patientaddress2, patientcity, patientstate, patientzip, patientemail, patienthomephone, patientcellphone, patientenablesms, patientworkphone, patientemrid, patientpractitioner, patientnote, patientschedulenote, patientvisitfrequency, patientinsurance
Delete Patent	/patients/{{patientid}}/delete	apikey, patientid

Bold variables are required.

---

List Patients

The List Patients endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Patient Details

The Patient Details endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Create Patient

The Create Patient endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Edit Patient

The Edit Patient endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Delete Patent

The Delete Patent endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Schedule

The Schedule API has these available methods.

Method	End Point	Variables
List Schedule	/schedule/	apikey, practitionerid, startdate
Schedule Details	/schedule/{{scheduleid}}	apikey, scheduleid
Create Schedule	/schedule/add	apikey, schedulepatientid, schedulepractitionerid, scheduledate, scheduletime, scheduleduration, scheduleconfirmed, schedulenote
Edit Schedule	/schedule/{{scheduleid}}/edit	apikey, scheduleid, schedulepatientid, schedulepractitionerid, scheduledate, scheduletime, scheduleduration, scheduleconfirmed
Delete Schedule	/schedule /{{schedule}}/delete	apikey, scheduleid
Optimize Schedule	/schedule/{{practitionerid}}/optimize	apikey, startdate ("mm/dd/yy")

Bold variables are required.

---

List Schedule

The List Schedule endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Schedule Details

The Schedule Details endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Create Schedule

The Create Schedule endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Edit Schedule

The Edit Schedule endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Delete Schedule

The Delete Schedule endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Optimize Schedule

The Optimize Schedule endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Find Close By Patients

The Find Close By Patients API has these available methods.

Method	End Point	Variables
Find Close By Schedule	/closeby	apikey, practitionerid, startdate, miles, excludescheduled
Find Close By Patient	/closeby/patientid	apikey, miles

Bold variables are required.

---

Find Close By Schedule

The Find Close By Schedule endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Find Close By Patient

The Find Close By Patient endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Scheduling Wizard

The Scheduling Wizard API has these available methods.

Method	End Point	Variables
Run Wizard	/wizard/{{patientid}}	apikey, patientid, providerlist, appointmenttype, scheduleduration, maxdistance, maxdistancenearest, startdate, enddate, showavailabletimes, overrideconstraints

Bold variables are required.

---

Run Wizard

The Run Wizard endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Patient Tags

The Patient Tags API has these available methods.

Method	End Point	Variables
List Tags	/patients/tags	apikey, patientid
Add Tag to Patient	/patients/tags/add	apikey, patientid, tagid
Remove Tag from Patient	/patients/tags/delete	apikey, patientid, tagid

Bold variables are required.

---

List Tags

The List Tags endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Add Tag to Patient

The Add Tag to Patient endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Remove Tag from Patient

The Remove Tag from Patient endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Providers

The Providers API has these available methods.

Method	End Point	Variables
List Providers	/providers/	apikey
List Non Working Days	/providers/nonworkdays/	apikey
Add Non Working Day	/providers/nonworkdays/add	apikey, practitionerid, nonworkingdaydate
Delete Non Working Day	/providers/nonworkdays/{{id}}/delete	apikey, id
List Break Times	/providers/breaktimes	apikey
Add Break Time	/providers/breaktimes/add	apikey, practitionerid, breaktimedate, breaktimestartime, breaktimeduration, breaktimenote
Delete Break Time	/providers/breaktimes/{{id}}/delete	apikey, id

Bold variables are required.

---

List Providers

The List Providers endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

List Non Working Days

The List Non Working Days endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Add Non Working Day

The Add Non Working Day endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Delete Non Working Day

The Delete Non Working Day endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

List Break Times

The List Break Times endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Add Break Time

The Add Break Time endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Delete Break Time

The Delete Break Time endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

Configuration

The Configuration API has these available methods.

Method	End Point	Variables
List Appointment Types	/appointmenttypes/	apikey
List Companies	/companies/	apikey

Bold variables are required.

---

List Appointment Types

The List Appointment Types endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

List Companies

The List Companies endpoint accepts a JSON encoded body and must include the apikey.  

Sample Input

Sample Output

---

API Development and Testing Sandbox

Please use the following links for testing:

Endpoint = https://schedule.mymobilepracticemanager.com/carelink/apiv2/

apikey = nJXSVCU7lsIyGud4eqhJ

Basic Auth username and password: please contact support@mymobilepracticemanager.com

Please use the following logon to view your results in the application GUI.

https://schedule.mymobilepracticemanager.com/carelink/admin/

username: testadmin
password: testadmin123!