WebHooks

Below is the detailed list of webhooks to be implemented by the Service Provider, in order to ensure data synchronization between the platforms. We expect to be notified when any of these entities get created, modified or deleted.

Appointments

Appointment

{
    "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"
        }
    ]
}

Practitioners

Practitioner

{
    "id": "8a7c3e1f-449b-4aa7-b2e3-6d987d0b52f1",
    "name": "Dr. John Smith",
    "specialty": "Cardiology",
    "email": "john.smith@example.com",
    "phone": "+1 123-456-7890",
    "working_hours": "Mon-Fri: 9 AM - 5 PM",
    "location": "Building A, 3rd Floor, Room 301",
    "is_available": true
}

Locations

Location

{
  "id": "f6262835-fbd8-423a-8746-46069edbaf18",
  "name": "Sanatorio Güemes",
  "address": {
        "street": "Alfonso XIII",
        "number": "1234",
        "floor": "5",
        "apartment": "12",
        "city": "Guaymallén",
        "state": "Mendoza",
        "country": "Argentina",
        "zip_code": "5533"
      }
}

Health Care Services

Health Care Service

 {
      "id": "e2c6370f-eeed-4170-bb55-12936fafbcde",
      "offered_in": "Hospital XYZ",
      "practitioner_id": "6f94a98c-420e-44c1-89b9-f619dc75c382",
      "active": true,
      "name": "General Check-up",
      "comment": "Routine health check-up",
      "extra_details": "Fasting required before the check-up",
      "appointment_required": true,
      "availability_exceptions": "Not available on weekends",
      "created_at": "2023-07-18T12:00:00Z",
      "updated_at": "2023-07-18T14:30:00Z",
      "deleted_at": null,
      "patient_instruction": "Please bring any medical records for review.",
      "integration_id": "HCSC-001",
      "min_age": 18,
      "max_age": null,
      "sex_id": null
    },

Health Insurance Carriers

Health Insurance Carrier

{
  "id": "8a7c3e1f-449b-4aa7-b2e3-6d987d0b52f1",
  "carrier": "OSDE",
   "active": "true"
}

Patients

Patient

{
  "id": "f6262835-fbd8-423a-8746-46069edbaf18",
  "name": "Jose",
  "last_name": "Perez",
  "gender": "Male",
  "birth_date": "1985/11/30",
  "identifier_type": "DNI",
  "identifier": 31465466,
  "medical_record_id": "2201125-12",
  "phone": "+5495552512",
  "email": "jose.perez@gmail.com",
  "address": {
        "street": "Alfonso XIII",
        "number": "1234",
        "floor": "5",
        "apartment": "12",
        "city": "Guaymallén",
        "state": "Mendoza",
        "country": "Argentina",
        "zip_code": "5533"
      }
}

Patient Health Insurances

Patient Health Insurance

{
    "id":"45e00934-8516-4c34-a478-eb27a37678a0",
  "patient_id": "45e00934-8516-4c34-a478-eb27a37678a0",
  "carrier": "OSDE",
  "plan": "410",
  "credential_number": "123465/8",
  "active": "true"
}

Patient Family Groups

Patient Family Group

{
    "id":"45e00934-8516-4c34-a478-eb27a37678a0",
  "patient_id": "45e00934-8516-4c34-a478-eb27a37678a0",
  "carrier": "OSDE",
  "plan": "410",
  "credential_number": "123465/8",
  "active": "true"
}

Orders

Order

{
    "id":"65717250-53a4-4e67-a15a-a38b0c05f4c4",
    "practicioner_id": "8a7c3e1f-449b-4aa7-b2e3-6d987d0b52f1",  
    "patients_health_insurances": "45e00934-8516-4c34-a478-eb27a37678a0",
    "health_care_service_id": "e2c6370f-eeed-4170-bb55-12936fafbcde",
    "date": "2022-11-07",
    "pdf": "https://www.osana.com/order/62a5f527-86f5-4a41-811a-76fdaeed9a7f.pdf",
}

Prescriptions

Prescriptions

{
  "id":"65717250-53a4-4e67-a15a-a38b0c05f4c4",
  "pdf_url": "https://www.osana.com/prescription3.pdf",
  "medications": ["Lisinopril", "Metoprolol"],
  "diagnosis": "Hypertension",
  "practicioner_id": "8a7c3e1f-449b-4aa7-b2e3-6d987d0b52f1",
  "prescription_date": "2023-08-10",
  "expiration_date": "2023-08-20"
}

Tickets

Tickets

{
  "uid": "8b82d37a-8613-46f0-b6d4-b61c31ad6643",
  "createdAt": "2024-01-15T12:00:00Z",
  "updatedAt": "2024-09-01T08:30:00Z",
  "status": "completed",
  "ticket_type_id": "9685c4b5-f25d-4adf-b821-2996f0e05ebe",
  "observations": "Procedure approved.",
  "fields": [
    {
      "id":"66ea3050-dcbb-4747-af0d-622d5fdd6904",
      "dataType": "string",
      "value": "John",
      "tooltip": "First name"
    },
      {
      "id":"1be40ef2-8ab2-4569-b012-4ea0fdd2f45c",
      "dataType": "file",
      "value": "binary file",
      "tooltip": ""
    }
  ]
}