Skip to main content

Appointment

Appointment API

GET /patients/{id}/appointments​

Returns all appointments for a patient

URI Parameters​

  • id: Patient's ID

Response:​

Code 200
{
     "appointments": [
            {
                "id": "d2a4d4d0-7cb0-4203-b5f5-ebb8285e0d06",
                "date": "2023-08-23T17:45:00",
                "status": "active",
                "modality": "in-person",
                "payments": {
                       "link":"https://paymentsservice.osana.com",
                        "status:"paid"
                },
                "health_insurances":{
                         "carrier": "OSDE",
                         "plan": "410",
                         "credential_number": "123465/8",
                        "active": "true"
               },
                "practitioner": {
                        "id": "ba204889-d9f1-4ecf-bca9-b9f7240d04e5",
                        "name": "LEONE ANA INES"
                },
                "cancelable": true,
                "location": {
                    "id": "c91a5f2d-0499-4fa9-86d2-8cd5b37ac072",
                    "description": "SANATORIO GÜEMES"
                },
                "healht_care_service": [
                    {
                        "id": "e2c6370f-eeed-4170-bb55-12936fafbcde",
                        "description": "General Check-up"
                    }
                ]
         }
}

POST /patients/{id}/appointments​

Creates an appointment.

URI Parameters​

  • id: Patient's ID
Body
Body:
{
           "health_care_service_id": "e2c6370f-eeed-4170-bb55-12936fafbcde",
           "practitioner_id": "6f94a98c-420e-44c1-89b9-f619dc75c382",
           "health_insurance_id": "45e00934-8516-4c34-a478-eb27a37678a0",
           "date": "2023-08-23T17:45:00"
}

Response:​

Code 201
 {}

PUT /patients/{id}/appointments/{appointment_id}​

Cancels an appointment. This endpoint is optional.

URI Parameters​

  • id: Patient's ID
  • appointment_id: Appointment's ID
Body
{
    "status": "canceled"
}

Response:​

Code 200
 {}