1 Intake
- 1.1 Create intake
- 1.2 Update intake
2 Visit
- 2.1 Create a visit from the intake
- 2.2 Schedule a visit
  - 2.2.1 To schedule a visit, you need to get available slots
  - 2.2.2 Create an appointment from the slot
- 2.3 Get Visits

Intake

Intake represents the initial registration information collected from a patient during their visit to a healthcare facility.

Create intake

Create an intake with the provided configuration.

const createIntakeResponse = await VSeeClinicKit.createIntake({
    reason_for_visit?: string;
    member_id?: string;
    room_code?: string;
    location?: string;
    attachments?: string[];
});

Parameter	Type	Description

Parameter	Type	Description
`attachments`	`string[]`	Array of attachment IDs
`location`	`string`
`member_id`	`string`
`reason_for_visit`	`string`	Reason for visit
`room_code`	`string`

Update intake

Update the current intake with the provided parameters.

await VSeeClinicKit.updateIntake({
    id: string;
    key: value;
});

Parameter	Type	Description

Parameter	Type	Description
`id`	`string`	Intake ID to change
`key:value`		Key:Value pair to change

Visit

Visit refers to an appointment or session of patient care at a healthcare facility, storing relevant details such as appointment time, healthcare provider, and associated intake information.

Create a visit from the intake

Create a visit with a given intake.

const createVisitResponse = await VSeeClinicKit.createWalkinVisit({
  intake_id: intakeId,
  room_code: 'thuatelehealth', //This is the room code of the clinic
});

Parameter	Type	Description

Parameter	Type	Description
`intake_id`	`string`	The intake id from create intake request
`room_code`	`string`	Room code to create visit

Schedule a visit

To schedule a visit, you need to get available slots

Parameter	Type	Description

Parameter	Type	Description
`room_code`	`string`	Room code is required
`start`	`number\|timestamp`	Limit slots from the specific time
`end`	`number\|timestamp`	Limit slots to the specific time
`duration`	`number`	Slot duration (in seconds)
`intake_id`	`string`	Intake ID to get list slots based on location/specialies
`consultation_id`	`string`	The visit option ID, if you don’t pass the duration param, system will get it automatically from `consultation_id`

Create an appointment from the slot

Parameter	Type	Description

Parameter	Type	Description
`room_code`	`string`	Room code is required
`start`	`number\|timestamp`	Appointment start time
`end`	`number\|timestamp`	Appointment end time
`provider_id`	`number`	Provider ID
`intake_id`	`string`	Intake ID to get list slots based on location/specialies

Get Visits

Retrieves the list of Visits.

Parameter	Type	Description

Parameter	Type	Description
`provider_id`	`string`	A closure that is called when the retrieval of the upcoming Visits is successful. It takes an array of Visit objects as a parameter, representing the list of upcoming Visits.
`member_id`	`string`	A closure that is called when an error occurs during the retrieval of the upcoming Visits. It takes an Error as a parameter, indicating the cause of the failure.
`start_date`	`number\|timestamp`
`end_date`	`number\|timestamp`

VSee Developers

[React Native] Intake & Visit API