encounters

Create an encounter

Creates a new, empty encounter (visit) on a patient's chart from an encounter type. Use GET /encounter-types to discover the available types. The encounter starts at server time with no documentation; forms are attached separately via POST /patients/{id}/forms.

The new encounter behaves exactly like one created in-app: forms and documents configured on the encounter type are seeded onto it, and billing artifacts are generated asynchronously for billable types. Requests are not idempotent: retrying a successful call creates a second encounter.

post/encounters

Request

Base URL: https://api.ritten.io/v1
URL: https://api.ritten.io/v1/encounters
Auth: none declared

Request body

patientIdstring uuid required

ID of the patient to create the encounter for.

encounterTypeIdstring uuid required

ID of the encounter type to create the encounter from. Use GET /encounter-types to discover types.

Attendance status of an encounter. Defaults to Attended when omitted at creation.

Example request

{
  "patientId": "d3f2c9a1-8b47-4e0f-a2c9-53f7f0c1b2aa",
  "encounterTypeId": "0b6a1f6e-2f9a-4c56-9d1c-6a3f6f9d2e11",
  "attendanceType": "Attended"
}

Response

Encounter created successfully.

idstring uuid

patientIdstring uuid

encounterTypeIdstring uuid

ID of the encounter type the encounter was created from.

namestring

Display name of the encounter type.

status'Empty' | 'Incomplete' | 'Complete'

Documentation status of the encounter. New encounters always start Empty.

startTimestring date-time

Start time of the encounter (server time at creation).

Attendance status of an encounter. Defaults to Attended when omitted at creation.

createdAtstring date-time

Example response

{
  "name": "Individual Therapy",
  "startTime": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.