api-docs v5.116.0

API Docs

Table of contents

Appointment

Appointment - Find

Back to top

Get list of appointments

GET /appointments

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/appointments" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
appointments[] object[]

array of appointment
appointments.id string
appointments.createdAt number

timestamp
appointments.createdBy string

account uid
appointments.organization string

owner organization
appointments.target string

target id. facility id for facility appointments
appointments.startAt number

timestamp
appointments.endAt number

timestamp
appointments.reason string
appointments.services object[]
appointments.services.id string

auto-generated id
appointments.services.service string
appointments.services.metadata object
appointments.arrivedAt number

timestamp. if !null, subject has shown up
appointments.arrivedBy string

user uid who marked the arrival
appointments.cancelledAt number

timestamp. if !null, cancelled
appointments.cancelledBy string

account uid
appointments.meta object

meta can hold the patient id, encounter type (new/follow-up), etc...

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Appointment - Get

Back to top

Get specific an appointment

GET /appointments/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Examples

Example usage:

curl "https://yourdomain.com/appointments/<appointment-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
organization string

owner organization
target string

target id. facility id for facility appointments
startAt number

timestamp
endAt number

timestamp
reason string
services object[]
services.id string

auto-generated id
services.service string
services.metadata object
arrivedAt number

timestamp. if !null, subject has shown up
arrivedBy string

user uid who marked the arrival
cancelledAt number

timestamp. if !null, cancelled
cancelledBy string

account uid
meta object

meta can hold the patient id, encounter type (new/follow-up), etc...

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Appointment - Patch

Back to top

Update an appointment

PATCH /appointments/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
cancel boolean optional

directive
arrive boolean optional

directive

Examples

Example usage:

curl "https://yourdomain.com/appointments/<appointment-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "cancel": true
  }'

Parameters examples

json - Request-Example

{
  "cancel": true
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
organization string

owner organization
target string

target id. facility id for facility appointments
startAt number

timestamp
endAt number

timestamp
reason string
services object[]
services.id string

auto-generated id
services.service string
services.metadata object
arrivedAt number

timestamp. if !null, subject has shown up
arrivedBy string

user uid who marked the arrival
cancelledAt number

timestamp. if !null, cancelled
cancelledBy string

account uid
meta object

meta can hold the patient id, encounter type (new/follow-up), etc...

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Appointment - Post

Back to top

Create an appointment

POST /appointments

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
organization string optional
target string

target id
startAt number

timestamp
endAt number

timestamp
reason string
meta object optional

meta can hold the patient id, encounter type (new/follow-up), etc...
createdAt number optional

timestamp

Default value: currentTime
services object[] optional
services.id string

auto-generated id
services.service string
services.metadata object

Examples

Example usage:

curl "https://yourdomain.com/appointments" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "target": "target-id",
    "startAt": 1234567890,
    "endAt": 1234567890,
    "reason": "some reason"
  }'

Parameters examples

json - Request-Example

{
  "target": "target-id",
  "startAt": 1234567890,
  "endAt": 1234567890,
  "reason": "some reason"
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
organization string

owner organization
target string

target id. facility id for facility appointments
startAt number

timestamp
endAt number

timestamp
reason string
services object[]
services.id string

auto-generated id
services.service string
services.metadata object
arrivedAt number

timestamp. if !null, subject has shown up
arrivedBy string

user uid who marked the arrival
cancelledAt number

timestamp. if !null, cancelled
cancelledBy string

account uid
meta object

meta can hold the patient id, encounter type (new/follow-up), etc...

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""