Skip to main content

Health Care Service

Health Care Service API.

This API enables us to allow query available health care services for a patient's health insurance.

GET /health-care-services/search​

Returns available health care services for a patient's health insurance.

URI Parameters​

  • patient_id: Patient's identifier.
  • health_insurance_id: Patient's health insurance id.
Example:
 GET /health-care-services/search?patient_id=f6262835-fbd8-423a-8746-46069edbaf18&health_insurance_id=45e00934-8516-4c34-a478-eb27a37678a0

Response:​

Code 200
 {
  "health_care_services": [
    {
      "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
    },
    {
      "id": "7398f8d2-2447-4529-98fb-f9df40510405",
      "offered_in": "Clinic ABC",
      "practitioner_id": "4dd18d44-9f15-41ab-9505-a4f0f3ad7c1b",
      "active": true,
      "name": "Blood Test",
      "comment": "Complete blood count",
      "extra_details": "Fasting required for 12 hours prior to the test.",
      "appointment_required": false,
      "availability_exceptions": null,
      "created_at": "2023-07-18T09:15:00Z",
      "updated_at": "2023-07-18T09:15:00Z",
      "deleted_at": null,
      "patient_instruction": "Drink plenty of water before the test.",
      "integration_id": "HCSC-002",
      "min_age": 16,
      "max_age": 65,
      "sex_id": 2
    },
    {
      "id": "32fee6c4-cb8c-4633-8aef-22b883c05679",
      "offered_in": "Medical Center 123",
      practitioner_id": "6e289de9-b42a-420b-be20-fb42cfc76a72",
      "active": false,
      "name": "Vaccination",
      "comment": "COVID-19 vaccine",
      "extra_details": "Two doses required for complete vaccination.",
      "appointment_required": true,
      "availability_exceptions": "Limited vaccine supply on Mondays",
      "created_at": "2023-07-17T18:45:00Z",
      "updated_at": "2023-07-17T18:45:00Z",
      "deleted_at": null,
      "patient_instruction": "Bring your vaccination card for the second dose.",
      "integration_id": "HCSC-003",
      "min_age": 12,
      "max_age": 80,
      "sex_id": null
    }
  ]
}