Cancel Encounter - Documentation

  curl -X POST "https://api.wizlo.example.com/encounters/12345/cancel" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d ''

{
  "id": 1,
  "gfeId": "ES00000001",
  "clinicId": "550e8400-e29b-41d4-a716-446655440000",
  "providerId": "770e8400-e29b-41d4-a716-446655440002",
  "reviewType": "synchronous",
  "serviceQueue": "internal_staff",
  "patientId": "990e8400-e29b-41d4-a716-446655440004",
  "additionalNotes": "Patient reported improvement",
  "reviewerId": "990e8400-e29b-41d4-a716-446655440004",
  "isActive": false,
  "status": "cancelled",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-02T15:30:00.000Z",
  "createdBy": "770e8400-e29b-41d4-a716-446655440002",
  "updatedBy": "api-client-uuid-here",
  "zoomMeetingUrl": "https://zoom.us/j/123456789?pwd=xxx",
  "zoomMeeting": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "meetingId": "123456789",
    "topic": "Dr. Smith - John Doe Consultation",
    "startUrl": "https://zoom.us/s/123456789?zak=xxx",
    "joinUrl": "https://zoom.us/j/123456789?pwd=xxx",
    "password": "abc123",
    "startTime": "2024-01-15T14:00:00.000Z",
    "duration": 30,
    "timezone": "America/Los_Angeles",
    "status": "cancelled",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-02T15:30:00.000Z"
  },
  "latestReview": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "encounterId": 1,
    "note": "Patient consultation completed successfully",
    "medical_decision_type": "injectables",
    "medical_decision_note": "All treatments approved",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "createdBy": "770e8400-e29b-41d4-a716-446655440002"
  },
  "latestTreatments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "encounterId": 1,
      "treatmentId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "indicated",
      "status_note": "Patient meets criteria",
      "icd": "E11.9",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "createdBy": "770e8400-e29b-41d4-a716-446655440002"
    }
  ],
  "documents": [],
  "clientNotes": [],
  "encounterAppointment": null,
  "latestVitals": null,
  "order": null
}

POST

encounters

{id}

cancel

  curl -X POST "https://api.wizlo.example.com/encounters/12345/cancel" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d ''

{
  "id": 1,
  "gfeId": "ES00000001",
  "clinicId": "550e8400-e29b-41d4-a716-446655440000",
  "providerId": "770e8400-e29b-41d4-a716-446655440002",
  "reviewType": "synchronous",
  "serviceQueue": "internal_staff",
  "patientId": "990e8400-e29b-41d4-a716-446655440004",
  "additionalNotes": "Patient reported improvement",
  "reviewerId": "990e8400-e29b-41d4-a716-446655440004",
  "isActive": false,
  "status": "cancelled",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-02T15:30:00.000Z",
  "createdBy": "770e8400-e29b-41d4-a716-446655440002",
  "updatedBy": "api-client-uuid-here",
  "zoomMeetingUrl": "https://zoom.us/j/123456789?pwd=xxx",
  "zoomMeeting": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "meetingId": "123456789",
    "topic": "Dr. Smith - John Doe Consultation",
    "startUrl": "https://zoom.us/s/123456789?zak=xxx",
    "joinUrl": "https://zoom.us/j/123456789?pwd=xxx",
    "password": "abc123",
    "startTime": "2024-01-15T14:00:00.000Z",
    "duration": 30,
    "timezone": "America/Los_Angeles",
    "status": "cancelled",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-02T15:30:00.000Z"
  },
  "latestReview": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "encounterId": 1,
    "note": "Patient consultation completed successfully",
    "medical_decision_type": "injectables",
    "medical_decision_note": "All treatments approved",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "createdBy": "770e8400-e29b-41d4-a716-446655440002"
  },
  "latestTreatments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "encounterId": 1,
      "treatmentId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "indicated",
      "status_note": "Patient meets criteria",
      "icd": "E11.9",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "createdBy": "770e8400-e29b-41d4-a716-446655440002"
    }
  ],
  "documents": [],
  "clientNotes": [],
  "encounterAppointment": null,
  "latestVitals": null,
  "order": null
}

Overview

This endpoint can be used to cancel an encounter. Behavior:

Validation: Checks if the encounter exists and is in a cancellable state.
Cancellable Statuses: An encounter can only be cancelled if its current status is awaiting, in_review, processing, or missing_id.
State Update: Updates the encounter status to cancelled.
Restrictions: If the encounter is already completed, cancelled, or rejected, the request will fail.

Headers

This endpoint uses Machine-to-Machine (M2M) authentication.

Authorization

string

required

Standard Bearer token (e.g., Bearer <your_access_token>). See the M2M Authentication guide for details on generating this token.

Content-Type

string

required

Must be set to application/json.

Path Parameters

number

required

The unique numeric ID of the encounter to cancel.

Response Parameters

The response returns the updated Encounter object.

number

The unique identifier of the encounter.

gfeId

string

The unique Good Faith Exam (GFE) identifier (e.g., ES00000001).

status

string

The new status of the encounter (e.g., cancelled).

isActive

boolean

Indicates if the encounter record is currently active.

clinicId

string

UUID of the clinic.

patientId

string

UUID of the patient.

reviewerId

string

UUID of the assigned reviewer.

providerId

string

UUID of the provider (optional).

reviewType

string

The type of review (e.g., synchronous).

serviceQueue

string

The queue this encounter belongs to (e.g., internal_staff).

additionalNotes

string

Any notes added during creation.

createdAt

string

ISO 8601 timestamp of creation.

updatedAt

string

ISO 8601 timestamp of the last update (cancellation time).

createdBy

string

UUID of the user who created the encounter.

updatedBy

string

UUID of the user (or API Client) who performed the cancellation.

zoomMeetingUrl

string

Direct URL to join the Zoom meeting (if applicable).

zoomMeeting

object

Full details of the associated Zoom meeting.

Show Properties

meetingId

string

Zoom Meeting ID.

joinUrl

string

Participant join URL.

startUrl

string

Host start URL.

status

string

Meeting status.

startTime

string

Scheduled start time.

duration

number

Duration in minutes.

timezone

string

Timezone of the meeting.

latestReview

object

Details of the latest review performed on this encounter.

Show Properties

string

Review ID.

note

string

Reviewer notes.

medical_decision_type

string

Type of medical decision.

medical_decision_note

string

Notes on the decision.

createdAt

string

Creation timestamp.

updatedAt

string

Last update timestamp.

createdBy

string

User UUID who created the review.

latestTreatments

array

List of treatments associated with this encounter.

Show Item Properties

string

Treatment record ID.

treatmentId

string

Product/Treatment ID.

status

string

Status (e.g., indicated, not_indicated).

status_note

string

Status note.

icd

string

ICD code.

additional_note

string

Additional notes.

createdAt

string

Creation timestamp.

documents

array

Documents linked to this encounter.

Show Item Properties

string

Encounter Document ID.

documentId

string

Document UUID.

document

object

Show Properties

fileUrl

string

URL to access the file.

contentType

string

MIME type.

fileName

string

Name of the file.

sizeBytes

number

Size in bytes.

clientNotes

array

Notes visible to the client/patient.

Show Item Properties

string

Note ID.

note

string

Note content.

createdAt

string

Creation timestamp.

createdBy

string

User UUID.

encounterAppointment

object

Details of the appointment linked to this encounter.

Show Properties

string

EncounterAppointment ID.

appointmentId

string

Appointment ID.

isActive

boolean

Active status.

appointment

object

Show Properties

string

Appointment ID.

startAt

string

Start time.

endAt

string

End time.

status

string

Appointment status.

reason

string

Appointment reason.

notes

string

Appointment notes.

latestVitals

object

Most recent vital signs recorded for the patient.

Show Properties

weight

string

Patient weight.

height

string

Patient height.

bmi

string

Calculated BMI.

bpSystolic

string

Systolic Blood Pressure.

bpDiastolic

string

Diastolic Blood Pressure.

lastUpdated

string

Date recorded.

order

object

Associated order details.

Status Codes

Status	Description
`200`	OK. Encounter cancelled successfully.
`400`	Bad Request. Encounter cannot be cancelled (e.g., already completed, cancelled, rejected, or invalid state).
`401`	Unauthorized. Authentication required - Missing or invalid JWT token.
`403`	Forbidden. Insufficient permissions or encounter belongs to a different tenant.
`404`	Not Found. Encounter with specified ID not found.

  curl -X POST "https://api.wizlo.example.com/encounters/12345/cancel" \
  -H "Authorization: Bearer <your_access_token>" \
  -H "Content-Type: application/json" \
  -d ''

{
  "id": 1,
  "gfeId": "ES00000001",
  "clinicId": "550e8400-e29b-41d4-a716-446655440000",
  "providerId": "770e8400-e29b-41d4-a716-446655440002",
  "reviewType": "synchronous",
  "serviceQueue": "internal_staff",
  "patientId": "990e8400-e29b-41d4-a716-446655440004",
  "additionalNotes": "Patient reported improvement",
  "reviewerId": "990e8400-e29b-41d4-a716-446655440004",
  "isActive": false,
  "status": "cancelled",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-02T15:30:00.000Z",
  "createdBy": "770e8400-e29b-41d4-a716-446655440002",
  "updatedBy": "api-client-uuid-here",
  "zoomMeetingUrl": "https://zoom.us/j/123456789?pwd=xxx",
  "zoomMeeting": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "meetingId": "123456789",
    "topic": "Dr. Smith - John Doe Consultation",
    "startUrl": "https://zoom.us/s/123456789?zak=xxx",
    "joinUrl": "https://zoom.us/j/123456789?pwd=xxx",
    "password": "abc123",
    "startTime": "2024-01-15T14:00:00.000Z",
    "duration": 30,
    "timezone": "America/Los_Angeles",
    "status": "cancelled",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-02T15:30:00.000Z"
  },
  "latestReview": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "encounterId": 1,
    "note": "Patient consultation completed successfully",
    "medical_decision_type": "injectables",
    "medical_decision_note": "All treatments approved",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "createdBy": "770e8400-e29b-41d4-a716-446655440002"
  },
  "latestTreatments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "encounterId": 1,
      "treatmentId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "indicated",
      "status_note": "Patient meets criteria",
      "icd": "E11.9",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "createdBy": "770e8400-e29b-41d4-a716-446655440002"
    }
  ],
  "documents": [],
  "clientNotes": [],
  "encounterAppointment": null,
  "latestVitals": null,
  "order": null
}

Get Encounter Status List All Clinics

⌘I

APIs

Authentication

​Overview

​Headers

​Path Parameters

​Response Parameters

​Status Codes

Overview

Headers

Path Parameters

Response Parameters

Status Codes