Skip to main content

Create a manual pre-appointment

When an appointment doesn't come through the HIS integration, a reception user can register it by hand. This guide covers the manual create → confirm path.

Prerequisites​

  • Credentials enabled for creating manual pre-appointments (and for updating them, which is what confirming requires).
  • An access token — see Obtaining tokens.

Step 1 — Create the pre-appointment​

Unlike HIS inbound, the manual create has no external_appointment_id (there's no external system to dedupe against) and it requires at least one charge.

curl -X POST https://sandbox.osigu.com/pre-attendance-api/v1/checkin/appointments \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "payer_tax_identification_number": "800123456",
    "beneficiary_card_number": "0123456789",
    "beneficiary_name": "Juan Carlos Perez Gomez",
    "beneficiary_document_type": "CC",
    "beneficiary_document_number": "1234567890",
    "doctor_name": "Dr. Maria Sanchez",
    "specialty_name": "Cardiology",
    "agreement_code": "AGR2024001",
    "appointment_date": "2026-07-15T14:30:00-05:00",
    "charges": [
      { "provider_product_code": "PROC001", "provider_product_name": "Electrocardiogram (ECG)", "quantity": 1 }
    ]
  }'

On success you get 201 Created with a Location header pointing at the new appointment and the appointment (including its id) in the body. The pre-appointment starts in PENDING.

Step 2 — (Optional) upload required documents​

If the charges have required supports configured, the appointment now has PENDING placeholders. Complete them — see Upload a document. Remember that missing documents will not block the next step.

Step 3 — Confirm the check-in​

curl -X POST https://sandbox.osigu.com/pre-attendance-api/v1/checkin/appointments/$ID/confirm \
  -H "Authorization: Bearer $ACCESS_TOKEN"

This transitions PENDING → CONFIRMED. It succeeds regardless of missing or AI-rejected documents; it only returns 409 if the appointment isn't in PENDING (e.g. already confirmed).

Editing and deleting​

  • Update an existing pre-appointment with PUT /v1/checkin/appointments/{id}.
  • Delete a PENDING manual pre-appointment with DELETE /v1/checkin/appointments/{id} — a soft-delete.

Next steps​