Integration APIs

Documentation about the APIs used by integration apps that are made available through the app marketplace.

DocsInk REST API

Base URLs:

Authentication

  • HTTP Authentication, scheme: bearer

Appointments

Create appointment

POST http://api.docsink.com/api/appointments HTTP/1.1
Host: api.docsink.com
Content-Type: application/json
Accept: application/json

POST /appointments

Allows you to create appointments

Body parameter

{
"appointment_date": "2020-02-24T13:51:07Z",
"patient_id": 0,
"appointment_type_id": 0
}

Parameters

Name

In

Type

Required

Description

body

body

AppointmentRequest

false

none

Example responses

200 Response

{
"data": {
"appointment_date": "string",
"appointment_date_utc": "string",
"appointment_timezone": "string",
"created_at": "string",
"created_by": 0,
"created_by_first_name": "string",
"created_by_last_name": "string",
"initial_sms_sent": null,
"location": {},
"patient": {
"uuid": 0,
"user_uuid": "string",
"firstname": "string",
"lastname": "string",
"address": {},
"email": "string",
"phone_no": "string",
"dob": "string",
"admit_date": "string",
"gender": "string",
"med_rec_no": "string",
"census": true,
"provider": 0,
"location": 0,
"flags": [
"string"
]
},
"type": {
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
},
"updated_at": "string",
"user": [
"string"
],
"uuid": 0
}
}

Responses

Status

Meaning

Description

Schema

200

โ€‹OKโ€‹

none

โ€‹AppointmentResponseโ€‹

500

โ€‹Internal Server Errorโ€‹

none

โ€‹Exceptionโ€‹

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Get appointment

Code samples

GET http://api.docsink.com/api/appointments/{uuid} HTTP/1.1
Host: api.docsink.com
Accept: application/json

GET /appointments/{uuid}

Get appointment

Parameters

Name

In

Type

Required

Description

uuid

path

string

true

Appointment id

Example responses

200 Response

{
"data": {
"appointment_date": "string",
"appointment_date_utc": "string",
"appointment_timezone": "string",
"created_at": "string",
"created_by": 0,
"created_by_first_name": "string",
"created_by_last_name": "string",
"initial_sms_sent": null,
"location": {},
"patient": {
"uuid": 0,
"user_uuid": "string",
"firstname": "string",
"lastname": "string",
"address": {},
"email": "string",
"phone_no": "string",
"dob": "string",
"admit_date": "string",
"gender": "string",
"med_rec_no": "string",
"census": true,
"provider": 0,
"location": 0,
"flags": [
"string"
]
},
"type": {
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
},
"updated_at": "string",
"user": [
"string"
],
"uuid": 0
}
}

Responses

Status

Meaning

Description

Schema

200

โ€‹OKโ€‹

none

โ€‹AppointmentResponseโ€‹

500

โ€‹Internal Server Errorโ€‹

none

โ€‹Exceptionโ€‹

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Update Appointment

Code samples

PUT http://api.docsink.com/api/appointments/{uuid} HTTP/1.1
Host: api.docsink.com
Content-Type: application/json
Accept: application/json

PUT /appointments/{uuid}

Update appointment information

Body parameter

{
"appointment_date": "2020-02-24T13:51:07Z",
"patient_id": 0,
"appointment_type_id": 0
}

Parameters

Name

In

Type

Required

Description

appointmentid

path

string

true

Appointment UUID

body

body

โ€‹AppointmentRequestโ€‹

true

none

Example responses

200 Response

{
"data": {
"appointment_date": "string",
"appointment_date_utc": "string",
"appointment_timezone": "string",
"created_at": "string",
"created_by": 0,
"created_by_first_name": "string",
"created_by_last_name": "string",
"initial_sms_sent": null,
"location": {},
"patient": {
"uuid": 0,
"user_uuid": "string",
"firstname": "string",
"lastname": "string",
"address": {},
"email": "string",
"phone_no": "string",
"dob": "string",
"admit_date": "string",
"gender": "string",
"med_rec_no": "string",
"census": true,
"provider": 0,
"location": 0,
"flags": [
"string"
]
},
"type": {
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
},
"updated_at": "string",
"user": [
"string"
],
"uuid": 0
}
}

Responses

Status

Meaning

Description

Schema

200

โ€‹OKโ€‹

none

โ€‹AppointmentResponseโ€‹

500

โ€‹Internal Server Errorโ€‹

none

โ€‹Exceptionโ€‹

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Get appointment types

Code samples

GET http://api.docsink.com/api/appointments/types HTTP/1.1
Host: api.docsink.com
Accept: application/json

GET /appointments/types

Get all appointment types

Example responses

200 Response

{
"data": [
{
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"prev": "string"
},
"meta": null
}

Responses

Status

Meaning

Description

Schema

200

โ€‹OKโ€‹

none

โ€‹GetAppointmentTypesResponseโ€‹

500

โ€‹Internal Server Errorโ€‹

none

โ€‹Exceptionโ€‹

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Create appointment types

Code samples

POST http://api.docsink.com/api/appointments/types HTTP/1.1
Host: api.docsink.com
Content-Type: application/json
Accept: application/json

POST /appointments/types

create appointment types

Body parameter

{
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
}

Parameters

Name

In

Type

Required

Description

body

body

โ€‹AppointmentTypeโ€‹

true

none

Example responses

200 Response

{
"data": {
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
}
}

Responses

Status

Meaning

Description

Schema

200

โ€‹OKโ€‹

none

โ€‹AppointmentTypeResponseโ€‹

500

โ€‹Internal Server Errorโ€‹

none

โ€‹Exceptionโ€‹

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Update appointment types

Code samples

PUT http://api.docsink.com/api/appointments/types HTTP/1.1
Host: api.docsink.com
Content-Type: application/json
Accept: application/json

PUT /appointments/types

update appointment types

Body parameter

{
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
}

Parameters

Name

In

Type

Required

Description

body

body

โ€‹AppointmentTypeโ€‹

true

none

Example responses

200 Response

{
"data": {
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
}
}

Responses

Status

Meaning

Description

Schema

200

โ€‹OKโ€‹

none

โ€‹AppointmentTypeResponseโ€‹

500

โ€‹Internal Server Errorโ€‹

none

โ€‹Exceptionโ€‹

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Patients

Create patient

Code samples

POST http://api.docsink.com/api/patients HTTP/1.1
Host: api.docsink.com
Content-Type: application/json
Accept: application/json

POST /patients

Create a new DocsInk patient

Body parameter

{
"uuid": 0,
"user_uuid": "string",
"firstname": "string",
"lastname": "string",
"address": {},
"email": "string",
"phone_no": "string",
"dob": "string",
"admit_date": "string",
"gender": "string",
"med_rec_no": "string",
"census": true,
"provider": 0,
"location": 0,
"flags": [
"string"
],
"fname": "string",
"lname": "string"
}

Parameters

Name

In

Type

Required

Description

body

body

โ€‹PatientRequestโ€‹

true

none

Example responses

500 Response

{
"exception": "string",
"file": "string",
"line": 0,
"message": "string"
}

Responses

Status

Meaning

Description

Schema

200

โ€‹OKโ€‹

none

None

500

โ€‹Internal Server Errorโ€‹

none

โ€‹Exceptionโ€‹

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Update Patient

Code samples

PUT http://api.docsink.com/api/patients/{uuid} HTTP/1.1
Host: api.docsink.com
Content-Type: application/json
Accept: application/json

PUT /patients/{uuid}

Update patient information

Body parameter

false

Parameters

Name

In

Type

Required

Description

uuid

path

string

true

Patient UUID

Example responses

200 Response

{
"data": {
"uuid": 0,
"user_uuid": "string",
"firstname": "string",
"lastname": "string",
"address": {},
"email": "string",
"phone_no": "string",
"dob": "string",
"admit_date": "string",
"gender": "string",
"med_rec_no": "string",
"census": true,
"provider": 0,
"location": 0,
"flags": [
"string"
]
}
}

Responses

Status

Meaning

Description

Schema

200

โ€‹OKโ€‹

none

โ€‹PatientResponseโ€‹

500

โ€‹Internal Server Errorโ€‹

none

โ€‹Exceptionโ€‹

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Get patient by MRN

Code samples

GET http://api.docsink.com/api/patients/mrn/{mrn} HTTP/1.1
Host: api.docsink.com
Accept: application/json

GET /patients/mrn/{mrn}

Get patient using external system MRN

Parameters

Name

In

Type

Required

Description

mrn

path

string

true

Patient MRN

Example responses

200 Response

{
"data": {
"uuid": 0,
"user_uuid": "string",
"firstname": "string",
"lastname": "string",
"address": {},
"email": "string",
"phone_no": "string",
"dob": "string",
"admit_date": "string",
"gender": "string",
"med_rec_no": "string",
"census": true,
"provider": 0,
"location": 0,
"flags": [
"string"
]
}
}

Responses

Status

Meaning

Description

Schema

200

โ€‹OKโ€‹

none

โ€‹PatientResponseโ€‹

500

โ€‹Internal Server Errorโ€‹

none

โ€‹Exceptionโ€‹

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Schemas

Appointment

{
"appointment_date": "string",
"appointment_date_utc": "string",
"appointment_timezone": "string",
"created_at": "string",
"created_by": 0,
"created_by_first_name": "string",
"created_by_last_name": "string",
"initial_sms_sent": null,
"location": {},
"patient": {
"uuid": 0,
"user_uuid": "string",
"firstname": "string",
"lastname": "string",
"address": {},
"email": "string",
"phone_no": "string",
"dob": "string",
"admit_date": "string",
"gender": "string",
"med_rec_no": "string",
"census": true,
"provider": 0,
"location": 0,
"flags": [
"string"
]
},
"type": {
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
},
"updated_at": "string",
"user": [
"string"
],
"uuid": 0
}

Patient appointment

Properties

Name

Type

Required

Restrictions

Description

appointment_date

string

false

none

none

appointment_date_utc

string

false

none

none

appointment_timezone

string

false

none

none

created_at

string

false

none

none

created_by

integer

false

none

none

created_by_first_name

string

false

none

none

created_by_last_name

string

false

none

none

initial_sms_sent

bool

false

none

none

location

object

false

none

none

patient

โ€‹Patientโ€‹

false

none

Patient

type

โ€‹AppointmentTypeโ€‹

false

none

none

updated_at

string

false

none

none

user

[string]

false

none

none

uuid

integer

false

none

none

AppointmentRequest

{
"appointment_date": "2020-02-24T13:51:07Z",
"patient_id": 0,
"appointment_type_id": 0
}

Properties

Name

Type

Required

Restrictions

Description

appointment_date

string(date-time)

false

none

none

patient_id

integer

false

none

none

appointment_type_id

integer

false

none

none

AppointmentResponse

{
"data": {
"appointment_date": "string",
"appointment_date_utc": "string",
"appointment_timezone": "string",
"created_at": "string",
"created_by": 0,
"created_by_first_name": "string",
"created_by_last_name": "string",
"initial_sms_sent": null,
"location": {},
"patient": {
"uuid": 0,
"user_uuid": "string",
"firstname": "string",
"lastname": "string",
"address": {},
"email": "string",
"phone_no": "string",
"dob": "string",
"admit_date": "string",
"gender": "string",
"med_rec_no": "string",
"census": true,
"provider": 0,
"location": 0,
"flags": [
"string"
]
},
"type": {
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
},
"updated_at": "string",
"user": [
"string"
],
"uuid": 0
}
}

Appointment response

Properties

Name

Type

Required

Restrictions

Description

data

โ€‹Appointmentโ€‹

false

none

Patient appointment

AppointmentType

{
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
}

Properties

Name

Type

Required

Restrictions

Description

active

integer

false

none

none

description

string

false

none

none

is_global

integer

false

none

none

name

string

false

none

none

uuid

integer

false

none

none

AppointmentTypeResponse

{
"data": {
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
}
}

Properties

Name

Type

Required

Restrictions

Description

data

โ€‹AppointmentTypeโ€‹

false

none

none

Exception

{
"exception": "string",
"file": "string",
"line": 0,
"message": "string"
}

Properties

Name

Type

Required

Restrictions

Description

exception

string

false

none

none

file

string

false

none

none

line

integer

false

none

none

message

string

false

none

none

{
"first": "string",
"last": "string",
"next": "string",
"prev": "string"
}

Name

Type

Required

Restrictions

Description

first

string

false

none

none

last

string

false

none

none

next

string

false

none

none

prev

string

false

none

none

Meta

null

Properties

None

Patient

{
"uuid": 0,
"user_uuid": "string",
"firstname": "string",
"lastname": "string",
"address": {},
"email": "string",
"phone_no": "string",
"dob": "string",
"admit_date": "string",
"gender": "string",
"med_rec_no": "string",
"census": true,
"provider": 0,
"location": 0,
"flags": [
"string"
]
}

Patient

Properties

Name

Type

Required

Restrictions

Description

uuid

integer

false

none

none

user_uuid

string

false

none

none

firstname

string

false

none

none

lastname

string

false

none

none

address

object

false

none

none

email

string

false

none

none

phone_no

string

false

none

none

dob

string

false

none

none

admit_date

string

false

none

none

gender

string

false

none

none

med_rec_no

string

false

none

none

census

boolean

false

none

none

provider

integer

false

none

none

location

integer

false

none

none

flags

[string]

false

none

none

PatientRequest

{
"uuid": 0,
"user_uuid": "string",
"firstname": "string",
"lastname": "string",
"address": {},
"email": "string",
"phone_no": "string",
"dob": "string",
"admit_date": "string",
"gender": "string",
"med_rec_no": "string",
"census": true,
"provider": 0,
"location": 0,
"flags": [
"string"
],
"fname": "string",
"lname": "string"
}

Properties

allOf

Name

Type

Required

Restrictions

Description

anonymous

โ€‹Patientโ€‹

false

none

Patient

and

Name

Type

Required

Restrictions

Description

anonymous

object

false

none

none

ยป fname

string

false

none

none

ยป lname

string

false

none

none

PatientResponse

{
"data": {
"uuid": 0,
"user_uuid": "string",
"firstname": "string",
"lastname": "string",
"address": {},
"email": "string",
"phone_no": "string",
"dob": "string",
"admit_date": "string",
"gender": "string",
"med_rec_no": "string",
"census": true,
"provider": 0,
"location": 0,
"flags": [
"string"
]
}
}

Properties

Name

Type

Required

Restrictions

Description

data

โ€‹Patientโ€‹

false

none

Patient

GetAppointmentTypesResponse

{
"data": [
{
"active": 0,
"description": "string",
"is_global": 0,
"name": "string",
"uuid": 0
}
],
"links": {
"first": "string",
"last": "string",
"next": "string",
"prev": "string"
},
"meta": null
}

Properties

Name

Type

Required

Restrictions

Description

data

[AppointmentType]

false

none

none

links

โ€‹Linksโ€‹

false

none

none

meta

โ€‹Metaโ€‹

false

none

none