{"openapi":"3.1.0","info":{"title":"Ekline Claims API","version":"1.0.1","description":"HL7 FHIR R4 and JSON API for hospital information systems (HMIS). One patient file = one Patient, Encounter, Coverage, Claim and ClaimResponse with the same id. Authenticate with a hospital API key: Authorization: Bearer ek_live_... Limits: 300 calls a minute per key. Every call is logged and metered.","contact":{"name":"Ekline Health","url":"https://eklinehealth.com"}},"servers":[{"url":"https://staging.eklinehealth.com"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"Hospital API key from Admin > API and integrations"}},"responses":{"Unauthorised":{"description":"Missing, wrong or revoked key"}},"schemas":{"Case":{"type":"object","properties":{"id":{"type":["string","number","null"]},"patient_name":{"type":["string","number","null"]},"uhid":{"type":["string","number","null"]},"ipd_no":{"type":["string","number","null"]},"payer_name":{"type":["string","number","null"]},"payer_group":{"type":["string","number","null"]},"policy_no":{"type":["string","number","null"]},"claim_id":{"type":["string","number","null"]},"preauth_no":{"type":["string","number","null"]},"doa":{"type":["string","number","null"]},"dod":{"type":["string","number","null"]},"diagnosis":{"type":["string","number","null"]},"stage":{"type":["string","number","null"]},"audit_status":{"type":["string","number","null"]},"verdict":{"type":["string","number","null"]},"initial_al":{"type":["string","number","null"]},"final_al":{"type":["string","number","null"]},"bill_amount":{"type":["string","number","null"]},"settled_amount":{"type":["string","number","null"]},"deductions":{"type":["string","number","null"]},"tds":{"type":["string","number","null"]},"payment_received":{"type":["string","number","null"]},"payment_date":{"type":["string","number","null"]},"utr":{"type":["string","number","null"]},"submitted_on":{"type":["string","number","null"]},"created_at":{"type":["string","number","null"]},"updated_at":{"type":["string","number","null"]}}},"CaseUpdate":{"type":"object","properties":{"stage":{"type":["string","number","null"]},"claim_id":{"type":["string","number","null"]},"preauth_no":{"type":["string","number","null"]},"payer_name":{"type":["string","number","null"]},"policy_no":{"type":["string","number","null"]},"doa":{"type":["string","number","null"]},"dod":{"type":["string","number","null"]},"initial_al":{"type":["string","number","null"]},"final_al":{"type":["string","number","null"]},"bill_amount":{"type":["string","number","null"]},"settled_amount":{"type":["string","number","null"]},"deductions":{"type":["string","number","null"]},"tds":{"type":["string","number","null"]},"payment_received":{"type":["string","number","null"]},"payment_date":{"type":["string","number","null"]},"utr":{"type":["string","number","null"]}}}}},"paths":{"/fhir/R4/metadata":{"get":{"tags":["FHIR R4"],"summary":"CapabilityStatement (no key needed)","security":[],"responses":{"200":{"description":"CapabilityStatement"}}}},"/fhir/R4/Patient":{"get":{"tags":["FHIR R4"],"summary":"Search Patient","description":"Patients of this hospital (one per patient file).","parameters":[{"name":"identifier","in":"query","schema":{"type":"string"},"description":"UHID, IPD, claim or policy number"},{"name":"name","in":"query","schema":{"type":"string"},"description":"Part of the name"},{"name":"_count","in":"query","schema":{"type":"string"},"description":"Page size, 1 to 200 (default 50)"},{"name":"_offset","in":"query","schema":{"type":"string"},"description":"Skip this many results"},{"name":"_lastUpdated","in":"query","schema":{"type":"string"},"description":"e.g. ge2026-11-01"}],"responses":{"200":{"description":"searchset Bundle","content":{"application/fhir+json":{}}},"401":{"$ref":"#/components/responses/Unauthorised"}}}},"/fhir/R4/Patient/{id}":{"get":{"tags":["FHIR R4"],"summary":"Read Patient","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Patient","content":{"application/fhir+json":{}}},"404":{"description":"OperationOutcome: not found"}}}},"/fhir/R4/Encounter":{"get":{"tags":["FHIR R4"],"summary":"Search Encounter","description":"Admissions: dates, diagnosis, discharge mode.","parameters":[{"name":"patient","in":"query","schema":{"type":"string"},"description":"Patient/{id}"},{"name":"identifier","in":"query","schema":{"type":"string"},"description":"IPD number"},{"name":"date","in":"query","schema":{"type":"string"},"description":"Admission date, e.g. ge2026-11-01"},{"name":"_count","in":"query","schema":{"type":"string"},"description":"Page size, 1 to 200 (default 50)"},{"name":"_offset","in":"query","schema":{"type":"string"},"description":"Skip this many results"},{"name":"_lastUpdated","in":"query","schema":{"type":"string"},"description":"e.g. ge2026-11-01"}],"responses":{"200":{"description":"searchset Bundle","content":{"application/fhir+json":{}}},"401":{"$ref":"#/components/responses/Unauthorised"}}}},"/fhir/R4/Encounter/{id}":{"get":{"tags":["FHIR R4"],"summary":"Read Encounter","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Encounter","content":{"application/fhir+json":{}}},"404":{"description":"OperationOutcome: not found"}}}},"/fhir/R4/Coverage":{"get":{"tags":["FHIR R4"],"summary":"Search Coverage","description":"Insurer, TPA or scheme and policy number.","parameters":[{"name":"patient","in":"query","schema":{"type":"string"},"description":"Patient/{id}"}],"responses":{"200":{"description":"searchset Bundle","content":{"application/fhir+json":{}}},"401":{"$ref":"#/components/responses/Unauthorised"}}}},"/fhir/R4/Coverage/{id}":{"get":{"tags":["FHIR R4"],"summary":"Read Coverage","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Coverage","content":{"application/fhir+json":{}}},"404":{"description":"OperationOutcome: not found"}}}},"/fhir/R4/Claim":{"get":{"tags":["FHIR R4"],"summary":"Search Claim","description":"Claims with stage and audit verdict (extensions).","parameters":[{"name":"patient","in":"query","schema":{"type":"string"},"description":"Patient/{id}"},{"name":"identifier","in":"query","schema":{"type":"string"},"description":"Claim or pre-auth number"},{"name":"_count","in":"query","schema":{"type":"string"},"description":"Page size, 1 to 200 (default 50)"},{"name":"_offset","in":"query","schema":{"type":"string"},"description":"Skip this many results"},{"name":"_lastUpdated","in":"query","schema":{"type":"string"},"description":"e.g. ge2026-11-01"}],"responses":{"200":{"description":"searchset Bundle","content":{"application/fhir+json":{}}},"401":{"$ref":"#/components/responses/Unauthorised"}}}},"/fhir/R4/Claim/{id}":{"get":{"tags":["FHIR R4"],"summary":"Read Claim","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Claim","content":{"application/fhir+json":{}}},"404":{"description":"OperationOutcome: not found"}}}},"/fhir/R4/ClaimResponse":{"get":{"tags":["FHIR R4"],"summary":"Search ClaimResponse","description":"Approved, settled and paid amounts, once the payer has answered.","parameters":[{"name":"request","in":"query","schema":{"type":"string"},"description":"Claim/{id}"},{"name":"patient","in":"query","schema":{"type":"string"},"description":"Patient/{id}"}],"responses":{"200":{"description":"searchset Bundle","content":{"application/fhir+json":{}}},"401":{"$ref":"#/components/responses/Unauthorised"}}}},"/fhir/R4/ClaimResponse/{id}":{"get":{"tags":["FHIR R4"],"summary":"Read ClaimResponse","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"ClaimResponse","content":{"application/fhir+json":{}}},"404":{"description":"OperationOutcome: not found"}}}},"/fhir/R4/DocumentReference":{"get":{"tags":["FHIR R4"],"summary":"Search DocumentReference","description":"Scanned PDFs of a patient file.","parameters":[{"name":"patient","in":"query","schema":{"type":"string"},"description":"Patient/{id}"}],"responses":{"200":{"description":"searchset Bundle","content":{"application/fhir+json":{}}},"401":{"$ref":"#/components/responses/Unauthorised"}}},"post":{"tags":["FHIR R4"],"summary":"Send a discharge file from the HMIS (needs a read and write key)","description":"Creates a patient file and starts its audit, as an upload does. content[0].attachment: contentType application/pdf, data = base64 PDF, title = file name. Put a contained Patient with identifier (UHID) and name[0].text; context.related[0].identifier.value = IPD number; description = tracker stage (optional).","requestBody":{"required":true,"content":{"application/fhir+json":{"example":{"resourceType":"DocumentReference","status":"current","contained":[{"resourceType":"Patient","id":"p","identifier":[{"value":"JRH/24/0123"}],"name":[{"text":"Ramesh Kumar"}]}],"subject":{"reference":"#p"},"context":{"related":[{"identifier":{"value":"IPD-5521"}}]},"content":[{"attachment":{"contentType":"application/pdf","title":"discharge-file.pdf","data":"JVBERi0xLjQK..."}}]}}}},"responses":{"201":{"description":"DocumentReference created; Location header has its address"},"400":{"description":"OperationOutcome: not a PDF or missing fields"},"403":{"description":"Key is read-only"}}}},"/fhir/R4/DocumentReference/{id}":{"get":{"tags":["FHIR R4"],"summary":"Read DocumentReference","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"DocumentReference","content":{"application/fhir+json":{}}},"404":{"description":"OperationOutcome: not found"}}}},"/fhir/R4/Binary/{id}":{"get":{"tags":["FHIR R4"],"summary":"Download the PDF","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"PDF","content":{"application/pdf":{}}}}}},"/api/v1/cases":{"get":{"tags":["JSON v1"],"summary":"Patient files changed since a time","parameters":[{"name":"updated_since","in":"query","schema":{"type":"string"},"description":"2026-11-01 or 2026-11-01T10:00:00"},{"name":"limit","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"List","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Case"}}}}}}}}}},"/api/v1/cases/{id}":{"get":{"tags":["JSON v1"],"summary":"One patient file with its latest audit findings","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Case"}}},"patch":{"tags":["JSON v1"],"summary":"Update stage, claim and payment details (read and write key)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseUpdate"},"example":{"stage":"Payment received","payment_received":84500,"payment_date":"2026-11-20","utr":"SBIN1234567890"}}}},"responses":{"200":{"description":"Updated case"},"400":{"description":"Field not valid"}}}},"/api/v1/usage":{"get":{"tags":["JSON v1"],"summary":"This month's calls and charges for this hospital","responses":{"200":{"description":"Usage"}}}}}}