Visit API

post /visits/add_walkin

Create a walk-in visit

Base URL https://api.vseepreview.com/api_v3 · operationId createWalkinVisit

Authentication: User Token — Requires a user access token from login or SSO.

Create a new walk-in visit for a patient

Parameters

NameInTypeRequiredEnumDefaultDescription
X-ApiTokenheaderstringyesAPI token (e.g. your_api_token)
X-AccountCodeheaderstringyesAccount code (e.g. vclinic)
provider_idquerystringnoThe ID of the provider (optional) (e.g. 826)
intake_idquerystringyesThe ID of the intake (e.g. 57a0705e-1c4c-4f24-b51d-3c71ac1f0144)
visit_data_idquerystringyesThe ID of a scheduled appointment
visit_idquerystringnoThe ID of a scheduled appointment (optional)
user_codequerystringnoPatient's code ID (optional)
room_codequerystringyesCurrent room's code (e.g. ceproom1)

Responses

200 — Walk-in visit created successfully

Walk-in visit created — Successfully created walk-in visit

{
  "data": {
    "id": "1525",
    "member_id": "508",
    "provider_id": "509",
    "account_code": null,
    "code": "56e8c580f55c44a2868b66f0ac1f0144",
    "start": "1458095488",
    "end": "1458096388",
    "type": "1",
    "status": "10",
    "room_id": null,
    "intake": {
      "provider": "509",
      "reason_for_visit": "Test intake functionalities 1",
      "type": "1",
      "visit_id": "1525",
      "id": "56e8c536-566c-44b6-bbca-66f0ac1f0144"
    },
    "provider": {
      "id": "509",
      "first_name": "Ligeng",
      "last_name": "Doctor"
    },
    "member": {
      "id": "508",
      "first_name": "Ligeng",
      "last_name": "01"
    }
  }
}

400 — Bad request - missing required parameters

{
  "error": "Unauthorized",
  "message": "Invalid or missing API token"
}

401 — Unauthorized

{
  "error": "Unauthorized",
  "message": "Invalid or missing API token"
}

Machine-readable: OpenAPI JSON (operationId: createWalkinVisit)