Create appointment

Adds an appointment. VersionConflictError is returned when the placer_appointment_id is already in use.

Authorization

BearerAuth

AuthorizationBearer <token>

Send your Taiga API key as a Bearer token. Create and manage keys in the Taiga developer portal.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

An object representing a appointment.

patient_id*pre-encounterPatientId

The Taiga-defined patient identifier.

start_timestamp*string

Formatdate-time

status?|

Defaults to PENDING. If status is NOT_READY, work_queue must be set. If status is READY or CHECKED_IN, work_queue must be null. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN.

not_ready_reason?|

The reason the appointment is NOT_READY. Must only be set when status is NOT_READY; it is cleared otherwise. It is not recommended to change this value manually via API.

ready_source?|

The method that set the appointment status to READY. It is not recommended to change this value manually via API. Must only be set when the status is READY or CHECKED_IN, it is cleared otherwise.

service_duration*integer

The requested length of time allotted for the appointment. The units are in minutes.

services*array<>

placer_appointment_id?|

ID for the appointment/order for the event.

attending_doctor?|

Attending physician information. The attending physician will be stored as the Current MD for the patient.

estimated_copay_cents?integer|null

estimated_patient_responsibility_cents?integer|null

patient_deposit_cents?integer|null

appointment_details?string|null

checked_in_timestamp?|

The timestamp when the patient checked in for their appointment. If status is CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set, status must be CHECKED_IN.

Formatdate-time

notes?string|null

location_resource_id?|

Contains the coded identification of the location being scheduled. Components: <Identifier (ST)>^<Text (ST)>

automated_eligibility_check_complete?|

True if the automated eligibility check has been completed. It is not recommended to change this value manually via API. This refers explicitly to the automated eligibility check that occurs a specific number of days before the appointment.

work_queue?|

The work queue that the appointment belongs to. It is not recommended to change this value manually via API. If status is NOT_READY, work_queue must be set. If status is READY, work_queue must be null.

Response Body

`application/json`

curl -X POST "https://example.com/appointments/v1" \  -H "Content-Type: application/json" \  -d '{    "patient_id": "string",    "start_timestamp": "2019-08-24T14:15:22Z",    "service_duration": 0,    "services": [      {}    ]  }'

{  "id": "string",  "organization_id": "string",  "deactivated": true,  "version": 0,  "updated_at": "2019-08-24T14:15:22Z",  "updating_user_id": "string",  "patient_id": "string",  "start_timestamp": "2019-08-24T14:15:22Z",  "status": "PENDING",  "not_ready_reason": "INACTIVE_PRIMARY",  "ready_source": "MANUAL",  "service_duration": 0,  "services": [    {      "universal_service_identifier": "MD_Visit",      "start_timestamp": "2019-08-24T14:15:22Z"    }  ],  "placer_appointment_id": "string",  "attending_doctor": {    "name": {      "family": "string",      "given": [        "string"      ],      "use": "USUAL",      "period": {        "start": "2019-08-24",        "end": "2019-08-24"      },      "suffix": "string"    },    "type": "PRIMARY",    "npi": "string",    "telecoms": [      {        "value": "string",        "use": "HOME",        "period": {          "start": "2019-08-24",          "end": "2019-08-24"        }      }    ],    "addresses": [      {        "use": "HOME",        "line": [          "string"        ],        "city": "string",        "state": "string",        "postal_code": "string",        "country": "string",        "county": "string",        "period": {          "start": "2019-08-24",          "end": "2019-08-24"        }      }    ],    "period": {      "start": "2019-08-24",      "end": "2019-08-24"    },    "canonical_id": "string",    "fax": "string",    "other_fax_numbers": [      "string"    ],    "emails": [      "string"    ],    "service_facilities": [      {        "service_facility_id": "string"      }    ]  },  "estimated_copay_cents": 0,  "estimated_patient_responsibility_cents": 0,  "patient_deposit_cents": 0,  "appointment_details": "string",  "checked_in_timestamp": "2019-08-24T14:15:22Z",  "notes": "string",  "location_resource_id": "string",  "automated_eligibility_check_complete": true,  "work_queue": "EMERGENT_ISSUE"}

Authorization

Request Body

Response Body

200application/json

404application/json

409application/json

`application/json`

`application/json`

`application/json`