CareScribe Software Integration API (v3.6.10)

API endpoints used with the WebSocket integration flow.

Complete Integration Guide: WebSocket Integration Documentation

Inpatient audio: IPD WebSocket Integration Guide

Interactive sample: IPD WebSocket and REST API Tester

Dynamic IPD Forms API

Complete form catalogue, exact body fields, chart categories and response envelopes: IPD forms reference. Read operations, generation and writes have different responses. TODOs use separate software routes. The hospital_id is required in the JSON body; no duplicate query field is required.

Authorizations:
X-API-Key
Request Body schema: application/json
hospital_id
required
string

Required HMS hospital identifier.

hospital_inpatient_id
required
string

Required HMS admission identifier, not internal inpatient_id.

form_name
required
string

Case-sensitive operation. Known names: raw_doctor_notes, raw_nurse_notes, doctor_notes, nurse_notes, initial_assessment, progress_notes, surgery_notes, nurse_care_plan, discharge_summary, case_sheet, get_drug_chart, drug_chart, blood_glucose_monitoring_chart, get_blood_glucose_monitoring_chart, get_all_ipd_notes_grouped_by_date, ipd_notes_grouped_by_date, IPD_VITALS, IPD_INTAKE_OUTTAKE, IPD_CAUTI_BUNDLE, cauti_bundle, cautiBundle, IPD_CLABSI_BUNDLE, clabsi_bundle, clabsiBundle, IPD_VASCULAR_BUNDLE, IPD_BLOOD_GLUCOSE_MONITORING, IPD_VENTI_FORM, IPD_BLOOD_TRANSFUSION, IPD_NUTRITION_FORM, IPD_ICU_FORM, IPD_GENERAL_OBSERVATIONS, IPD_ASSESSMENT_DETAILS, IPD_PRESCRIPTION_ADMINISTRATIONS, update_ipd_data, ingest_chart_data. Any IPD_* category string up to 80 characters is routed; not every accepted key has stored data.

practitioner_id
string

External doctor ID. Either this or caregiver_id is required; doctor notes and surgery require this one.

caregiver_id
string

External nurse ID. Nurse notes and nurse care plan require this one.

categories
string

One exact category for grouped reads; omit for all defaults. Arrays are not supported by this wrapper.

category
string

Forwarded on grouped reads; no separate filter is declared upstream. Ignored on drug/glucose reads.

start_date
string

DD/MM/YYYY. Forwarded from body only for IPD_VITALS and IPD_INTAKE_OUTTAKE.

end_date
string

DD/MM/YYYY. Same restriction as start_date.

interaction_id
string

Required for update_ipd_data; retain the returned ID for chart ingestion. Optional for document generation; discharge_summary resolves latest regardless.

force_regenerate
boolean
stored_signal
boolean
data
any

Required for update_ipd_data: edited note text or JSON object, serialized and sent for clinical extraction.

structured_data
object

For ingest_chart_data: one supported category with actual returned records and edits.

doctor_id
string

Optional internal actor ID for update_ipd_data; not practitioner_id.

nurse_id
string

Optional internal actor ID for update_ipd_data; not caregiver_id.

org_id
string

Normally omit; server resolves it. Mismatch returns 403 on update_ipd_data.

property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "hospital_id": "string",
  • "hospital_inpatient_id": "string",
  • "form_name": "string",
  • "practitioner_id": "string",
  • "caregiver_id": "string",
  • "categories": "string",
  • "category": "string",
  • "start_date": "string",
  • "end_date": "string",
  • "interaction_id": "string",
  • "force_regenerate": true,
  • "stored_signal": true,
  • "data": null,
  • "structured_data": { },
  • "doctor_id": "string",
  • "nurse_id": "string",
  • "org_id": "string"
}

Response samples

Content type
application/json
Example
{
  • "patient_id": "string",
  • "inpatient_id": "string",
  • "structured_data": {
    }
}

Get Inpatient List by Hospital ID

Returns a list of active inpatients for the given hospital_id. hospital_id is first mapped to an organization_id, and then all inpatients under that organization are fetched along with: - Patient details - Assigned doctors - Assigned nurses - Bed details - Primary doctor info

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string
Example: hospital_id=9
header Parameters
x-api-key
required
string
Example: your-api-key-here

Responses

Response samples

Content type
application/json
{
  • "hospital_id": "9",
  • "data": [
    ]
}

Get All IPD Notes Grouped By Date

Fetches IPD notes grouped by date for a given patient and inpatient record. Query Parameters: - patient_id - inpatient_id - hospital_id - categories This API supports the following categories: - IPD_PERIPHERAL_CHART (I/O Chart / Vascular Checklist) - IPD_INTAKE_OUTTAKE (Intake Output Chart) - IPD_VITALS (TPR Chart) Important: - Categories must be passed exactly as listed above. - If an incorrect category is provided, the API will return an empty response.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string
Example: hospital_id=9

Unique hospital identifier.

patient_id
string
Example: patient_id=GEN9-202509-00435

Unique patient ID.

inpatient_id
required
string
Example: inpatient_id=IN-GEN9-202509-00034

Unique inpatient ID.

categories
string
Example: categories=IPD_VITALS

Category of IPD notes. Must be one of: IPD_PERIPHERAL_CHART, IPD_INTAKE_OUTTAKE, IPD_VITALS.

Responses

Response samples

Content type
application/json
{
  • "patient_id": "GEN9-202509-00435",
  • "inpatient_id": "IN-GEN9-202509-00034",
  • "structured_data": {
    }
}

Get Drug Chart

Fetches the drug chart details for a given IPD patient using patient and inpatient IDs. Required Query Parameters: - hospital_id - inpatient_id Optional: - patient_id Note: - This API retrieves medication/drug administration data associated with the inpatient stay.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string
Example: hospital_id=9

Unique hospital identifier.

inpatient_id
required
string
Example: inpatient_id=IN-GEN9-202601-00013

Unique inpatient ID.

patient_id
string
Example: patient_id=GEN9-202601-00106

Unique patient ID.

Responses

Response samples

Content type
application/json
{ }

Toggle Inpatient Setup

Enables or disables the inpatient setup configuration for a hospital. The hospital is identified using the hospital_id query parameter.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string
Example: hospital_id=9

Hospital ID for which inpatient setup needs to be toggled

Request Body schema: application/json
inpatientSetup
required
boolean

Responses

Request samples

Content type
application/json
{
  • "inpatientSetup": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Inpatient setup has been turned ON",
  • "inpatientSetup": true
}

Get All Floors

Retrieves all floors for a given hospital. The hospital_id is used to identify the organization.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string
Example: hospital_id=9

Hospital ID to validate the organization

Responses

Response samples

Content type
application/json
{
  • "message": "Floors fetched successfully.",
  • "data": [
    ]
}

Create Floor

Creates a new floor for a given hospital. The hospital_id is used to identify the organization. Floor name must be unique within the organization.

Authorizations:
X-API-Key
Request Body schema: application/json
floor_name
required
string
hospital_id
required
string

Responses

Request samples

Content type
application/json
{
  • "floor_name": "First Floor",
  • "hospital_id": "9"
}

Response samples

Content type
application/json
{
  • "message": "Floor created successfully.",
  • "data": {
    }
}

Create Nurse

Creates a new nurse for the specified hospital_id. The hospital_id is mapped to an organization and the nurse is created under that organization. Email is optional—if not provided, a unique email is auto-generated based on the nurse name and organization.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string
Example: hospital_id=9
header Parameters
x-api-key
required
string
Example: your-api-key-here
Request Body schema: application/json
firstname
required
string
lastname
required
string
email
string <email>
phone
string
floor_id
required
integer
caregiver_id
required
string
nurse_category
string
Enum: "Ward Nurse" "ICU Nurse" "ER Nurse"

Optional nurse category. A blank value is stored as null.

Responses

Request samples

Content type
application/json
{
  • "firstname": "Sarah",
  • "lastname": "John",
  • "email": "",
  • "phone": "994056789",
  • "floor_id": 2,
  • "caregiver_id": "LI7897",
  • "nurse_category": "Ward Nurse"
}

Response samples

Content type
application/json
{
  • "message": "Nurse created successfully",
  • "data": {
    }
}

Create Inpatient

Creates a new inpatient record for a given hospital. Validates hospital, practitioner, floor, and organization details. Generates unique patient_id and inpatient_id automatically.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string
Example: hospital_id=9

Hospital ID to validate the organization

Request Body schema: application/json
first_name
string
last_name
string
hospital_inpatient_id
required
string
practitioner_id
required
string
patient_category
required
string
floor_id
required
integer
speciality_id
integer
hospital_patient_id
string
date_of_birth
string <date>
phone_number
string
age
integer
gender
string
address1
string
email
string <email>
marital_status
string
aadhar_number
string
Referred_by_doctor
string
in_date
string <date>
bed_id
integer
ward
string
timeZone
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "Ravi",
  • "last_name": "Kumar",
  • "hospital_inpatient_id": "IN-GEN9-202601-00025",
  • "practitioner_id": "0123",
  • "patient_category": "Inpatient",
  • "floor_id": 29,
  • "speciality_id": 5,
  • "hospital_patient_id": "HSP123",
  • "date_of_birth": "1995-06-15",
  • "phone_number": "9876543210",
  • "age": 30,
  • "gender": "Male",
  • "address1": "Chennai",
  • "email": "ravi@gmail.com",
  • "marital_status": "Single",
  • "aadhar_number": "123412341234",
  • "Referred_by_doctor": "Dr. Suresh",
  • "in_date": "2026-01-05",
  • "bed_id": 12,
  • "ward": "Ward-A",
  • "timeZone": "Asia/Kolkata"
}

Response samples

Content type
application/json
{
  • "message": "Inpatient created successfully.",
  • "patient": { },
  • "inpatient": { }
}

Assign an inpatient using caregiver_id (nurse) and practitioner_id (doctor)

This API assigns nurses (via caregiver_id) and doctors (via practitioner_id)
to an inpatient.
It accepts single or multiple IDs for both caregivers and practitioners.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

Hospital ID

Request Body schema: application/json
inpatient_id
required
string
caregiver_id
string

Caregiver ID (nurse) - can be a single string or array of strings

practitioner_id
string

Practitioner ID (doctor) - can be a single string or array of strings

Responses

Request samples

Content type
application/json
{
  • "inpatient_id": "IN-GEN9-202508-00004",
  • "caregiver_id": "carescribe-nurse001",
  • "practitioner_id": "123"
}

Response samples

Content type
application/json
{
  • "message": "Inpatient assignment processed",
  • "data": {
    }
}

Get Doctor Todo List

Fetch generated doctor tasks for review. The service may fall back to database interaction records on failure. Complete task categories, fallback behavior and edit procedure: TODO workflow.

Authorizations:
X-API-Key
query Parameters
hospital_inpatient_id
required
string
Example: hospital_inpatient_id=IN-GEN9-202601-00008

Hospital inpatient identifier

hospital_id
required
string
Example: hospital_id=9

Hospital ID

Responses

Response samples

Content type
application/json
{
  • "patient_id": "string",
  • "inpatient_id": "string",
  • "todo_data": [
    ]
}

Approve Doctor Todo

See complete TODO workflow. Approve the interaction; send {} to use stored tasks or the returned todo_data structure with edits. Upstream network/server failure may return a fallback HTTP 200 without a persisted write. Always read back.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string
Example: hospital_id=9

Hospital ID

hospital_inpatient_id
required
string
Example: hospital_inpatient_id=IN-GEN9-202601-00008

Hospital inpatient identifier

interaction_id
required
string
Example: interaction_id=102463

Interaction ID to approve

Request Body schema: application/json

Todo data to be approved

patient_id
string
inpatient_id
string
Array of objects (IpdContract_TaskRecord)
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "patient_id": "string",
  • "inpatient_id": "string",
  • "todo_data": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Doctor approved for this interaction_id=102474 and patient_id=GEN9-202601-00048."
}

Get Nurse Todo List

Fetch approved nurse tasks with todo_data and merged_todo. An upstream outage can return a fallback empty todo_data list. Complete task categories, fallback behavior and edit procedure: TODO workflow.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string
Example: hospital_id=9

Hospital ID

hospital_inpatient_id
required
string
Example: hospital_inpatient_id=IN-GEN9-202601-00008

Hospital inpatient identifier

Responses

Response samples

Content type
application/json
{
  • "patient_id": "string",
  • "inpatient_id": "string",
  • "todo_data": [
    ],
  • "merged_todo": {
    }
}

Update Nurse Todo Status

See complete TODO workflow. Persist execution changes to a returned task record. Preserve all categories and IDs. Upstream network/server failure may return a fallback HTTP 200 without a persisted write. Always read back.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string
Example: hospital_id=9

Hospital ID

hospital_inpatient_id
required
string
Example: hospital_inpatient_id=IN-GEN9-202601-00008

Hospital inpatient identifier

Request Body schema: application/json

Todo update payload with interaction_id, gcs_uri, and todos array

required
string or integer or (any or null)
gcs_uri
string
required
Array of objects (ToDoList)
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "interaction_id": "string",
  • "gcs_uri": "string",
  • "todos": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "todo_data": [
    ]
}

Get all specialities

Retrieves a list of all specialities.

Authorizations:
X-API-Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new doctor

Creates a doctor record and associates it with an organization.

Authorizations:
X-API-Key
Request Body schema: application/json

Doctor creation payload

first_name
required
string
last_name
required
string
speciality_id
required
integer
salutation
string
hospital_id
required
integer
license_no
string
phone_number
string
email
string
practitioner_id
required
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Doe",
  • "speciality_id": 5,
  • "salutation": "Dr.",
  • "hospital_id": 101,
  • "license_no": "ABC12345",
  • "phone_number": "+91-9876543210",
  • "email": "johndoe@example.com",
  • "practitioner_id": "PRAC-001"
}

Response samples

Content type
application/json
{
  • "message": "Doctor created successfully",
  • "doctor": {
    }
}

Integrate patient software data

Accepts patient, doctor, hospital, and vitals data for integration.

Authorizations:
X-API-Key
Request Body schema: application/json
hospital_id
required
string
required
object
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "hospital_id": "HOS789",
  • "doctor": {
    },
  • "patient": {
    },
  • "vitals": {
    }
}

Response samples

Content type
application/json
{}

Upload medication master data (JSON) and store as CSV

Uploads medication master data for a hospital in JSON format and stores it as a CSV file.

Requirements:

  • hospital_id and a non-empty medications array are required.
  • Each medication must contain BRAND NAME and GENERIC NAME.
  • BRAND ID is optional, but if provided in any item, it must be present in all items.

Optional Fields:

  • UOM CODE
  • UOM DESCRIPTION (if provided, UOM CODE is required).
  • ACTIVE FROM (DD/MM/YYYY)
  • ACTIVE TO (DD/MM/YYYY)
  • MEDICATION TYPE

Validation:

  • Duplicate BRAND ID values in the request are marked invalid.
  • Duplicate BRAND NAME and GENERIC NAME combinations are marked invalid.

The API stores the valid data as a CSV file and returns the processed file URL along with any invalid rows.

Authorizations:
X-API-Key
Request Body schema: application/json
hospital_id
required
string

Hospital/organization identifier.

required
Array of objects non-empty

Array of medication objects.

Supported fields (case-sensitive as shown in examples):

  • BRAND NAME (required)
  • GENERIC NAME (required)
  • BRAND ID (conditionally required if present in any item)
  • UOM CODE (optional)
  • UOM DESCRIPTION (optional; if provided, UOM CODE is required)
  • ACTIVE FROM (optional; DD/MM/YYYY)
  • ACTIVE TO (optional; DD/MM/YYYY)
  • MEDICATION TYPE (optional)

Responses

Request samples

Content type
application/json
{
  • "hospital_id": "9",
  • "medications": [
    ]
}

Response samples

Content type
application/json
{}

Update medication data (merge into existing CSV)

Updates the medication master data for a hospital by merging the given JSON medications with the existing stored CSV.

  • hospital_id and non-empty medications are required.
  • Each item must contain BRAND NAME and GENERIC NAME.
  • BRAND ID is optional, but if used in any item, it must be present in all items.
  • UOM CODE and UOM DESCRIPTION are optional (if UOM DESCRIPTION is provided, UOM CODE is required).
  • ACTIVE FROM, ACTIVE TO, and MEDICATION TYPE are optional; dates use DD/MM/YYYY.
  • If an existing CSV is present, BRAND ID presence must match incoming data.
  • The body may use medications, rows, data, or items; hospital_id may be supplied in query or body.
  • Final merged data is stored back as a CSV file.
Authorizations:
X-API-Key
Request Body schema: application/json
hospital_id
required
string

Hospital/organization identifier.

required
Array of objects non-empty

Array of medication objects to merge into existing data.

Responses

Request samples

Content type
application/json
{
  • "hospital_id": "9",
  • "medications": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Medication data updated successfully (merged, duplicates removed)",
  • "url": "gs://bucket/csv_uploads/organization_20260916120000.csv",
  • "invalid": [ ]
}

Upload medication CSV

Uploads a medication master CSV for a hospital and replaces the existing stored file (if any). The API validates the CSV, stores only valid rows, and returns the processed file URL.

Supported CSV headers (normalized case-insensitively and kept in this order):

  • BRAND NAME, GENERIC NAME
  • BRAND ID, BRAND NAME, GENERIC NAME
  • BRAND NAME, GENERIC NAME, UOM CODE, UOM DESCRIPTION
  • BRAND ID, BRAND NAME, GENERIC NAME, UOM CODE, UOM DESCRIPTION
  • Any format above may continue with optional ACTIVE FROM, ACTIVE TO, and MEDICATION TYPE columns in that order.

Validation rules:

  • BRAND NAME and GENERIC NAME are required.
  • BRAND ID is required only if the header contains BRAND ID.
  • UOM CODE and UOM DESCRIPTION are optional.
  • If UOM DESCRIPTION is provided, UOM CODE must also be provided.
  • ACTIVE FROM and ACTIVE TO, when present, must use DD/MM/YYYY.
  • Duplicate BRAND ID values are rejected.
  • Duplicate BRAND NAME + GENERIC NAME combinations are rejected.
  • Empty values or values containing only , or . are rejected.

Invalid rows are returned in the invalid field of the response.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

Hospital/organization identifier.

Request Body schema: multipart/form-data
csvFile
required
string <binary>

Medication CSV file to upload.

Responses

Response samples

Content type
application/json
{}

Update medication CSV data

Uploads a medication CSV for the given hospital_id and merges it with the existing medication CSV stored in Google Cloud Storage (GCS).

CSV headers (normalized case-insensitively and kept in this order):

  1. BRAND NAME, GENERIC NAME
  2. BRAND ID, BRAND NAME, GENERIC NAME
  3. BRAND NAME, GENERIC NAME, UOM CODE, UOM DESCRIPTION
  4. BRAND ID, BRAND NAME, GENERIC NAME, UOM CODE, UOM DESCRIPTION
  5. Any format above may continue with optional ACTIVE FROM, ACTIVE TO, and MEDICATION TYPE columns in that order.

Validation rules (applies to both existing CSV and uploaded CSV):

  • BRAND NAME and GENERIC NAME are required in every row.
  • Empty values or values containing only , or . are rejected.
  • Duplicate BRAND ID values (when BRAND ID exists) are rejected.
  • Duplicate BRAND NAME + GENERIC NAME combinations are rejected.
  • If UOM DESCRIPTION is provided, UOM CODE is required.
  • ACTIVE FROM and ACTIVE TO, when present, must use DD/MM/YYYY.
  • If an existing medication CSV is present, BRAND ID presence must match; otherwise the API returns 400 with Header mismatch between existing and new CSV.

Merge behavior:

  • If the uploaded header includes BRAND ID, the merge key is BRAND ID.
  • Otherwise, the merge key is BRAND NAME + GENERIC NAME.
  • Uploaded rows overwrite matching existing rows.
Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

Hospital identifier for the organization.

Request Body schema: multipart/form-data
csvFile
required
string <binary>

Medication CSV file to upload (must end with .csv).

Responses

Response samples

Content type
application/json
{}

Upload an investigation CSV file

Uploads and replaces the organization's investigation CSV. Required headers are Service ID and Standard Lab Test Name. Optional headers are Alias Name, Service Type, Hospital ID, ACTIVE FROM, and ACTIVE TO. Headers are matched case-insensitively. Dates, when supplied, must use DD/MM/YYYY. Invalid rows are returned while valid rows are stored; an empty Alias Name is populated from Standard Lab Test Name.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

The ID of the hospital associated with the organization.

Request Body schema: multipart/form-data
csvFile
required
string <binary>

CSV with required columns Service ID and Standard Lab Test Name, and optional Alias Name, Service Type, Hospital ID, ACTIVE FROM, and ACTIVE TO.

Responses

Response samples

Content type
application/json
{}

Update an investigation CSV file

Merges the uploaded CSV with stored investigation data using the case-insensitive Service ID and Service Type pair as the key. The same Service ID may therefore be stored in multiple rows when Service Type differs, while duplicate Service ID and Service Type pairs are rejected. Required headers are Service ID and Standard Lab Test Name; optional headers are Alias Name, Service Type, Hospital ID, ACTIVE FROM, and ACTIVE TO. Dates must use DD/MM/YYYY.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

The ID of the hospital associated with the organization.

Request Body schema: multipart/form-data
csvFile
required
string <binary>

Investigation CSV to merge. Service ID and Standard Lab Test Name are required; Alias Name, Service Type, Hospital ID, ACTIVE FROM, and ACTIVE TO are optional.

Responses

Response samples

Content type
application/json
{}

Upload investigation data as JSON

Replaces stored investigation data using either a direct JSON array or { data: [...] }. Service ID and Standard Lab Test Name are required. Alias Name, Service Type, Hospital ID, ACTIVE FROM, and ACTIVE TO are optional. Field names are normalized case-insensitively and dates must use DD/MM/YYYY.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

The ID of the hospital associated with the organization.

Request Body schema: application/json

Investigation rows wrapped in data; the controller also accepts a direct array.

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{}

Update investigation data as JSON

Merges a direct JSON array or { data: [...] } into stored investigation data using the case-insensitive Service ID and Service Type pair as the key. The same Service ID may be used for different Service Types. Service ID and Standard Lab Test Name are required; all other supported columns are optional. Dates must use DD/MM/YYYY.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

The ID of the hospital associated with the organization.

Request Body schema: application/json

Array of investigation objects to merge with existing data

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{}

Upload Route CSV

Uploads a Route master CSV for the specified hospital_id (query parameter). The CSV requires ROUTE CODE and ROUTE DESCRIPTION. ACTIVE FROM and ACTIVE TO are optional and must use DD/MM/YYYY. Header matching is case-insensitive; unknown or duplicate headers are rejected. Use the uploadRouteCsv API only for the initial upload of Route master data. If this API is called again for appending data, the existing Route list will be completely deleted and replaced with the newly uploaded CSV data. For any modifications, additions, or updates to the existing Route list, please use the updateRouteCsvs API.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

Hospital ID used to resolve organization

Request Body schema: multipart/form-data
csvFile
required
string <binary>

CSV file containing route data (ROUTE CODE, ROUTE DESCRIPTION)

Responses

Response samples

Content type
application/json
{}

Update (merge) Route CSV

Uploads a Route CSV file for the specified hospital_id and merges it with the existing Route data (if available) stored for the organization. Requirements: - ROUTE CODE and ROUTE DESCRIPTION are required headers. - ACTIVE FROM and ACTIVE TO are optional headers using DD/MM/YYYY. - Header matching is case-insensitive; unknown or duplicate headers are rejected. Validation: - If duplicate ROUTE CODE values are found in the uploaded CSV, those rows will be reported in the invalid field of the response.

Merge Behavior: - ROUTE CODE is used as the unique key. - If a ROUTE CODE already exists in the stored Route data, the uploaded value overwrites the existing one.

  • New ROUTE CODE entries are added to the dataset. The final merged dataset is stored as a CSV file and linked to the organization.
Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

Hospital ID used to resolve organization

Request Body schema: multipart/form-data
csvFile
required
string <binary>

CSV file containing route data (ROUTE CODE, ROUTE DESCRIPTION)

Responses

Response samples

Content type
application/json
{}

Upload route data

Uploads Route master data from a direct array or an object containing routes, rows, data, or items, then stores it as CSV. ROUTE CODE and ROUTE DESCRIPTION are required; ACTIVE FROM and ACTIVE TO are optional dates in DD/MM/YYYY format. This API should be used only for the initial upload of Route data. If this API is called again, the existing Route list will be completely deleted and replaced with the newly uploaded data. For any modifications or additions to the existing Route list, please use the updateRouteJson API.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

The ID of the hospital/organization

Request Body schema: application/json
Array of objects

Array of route objects

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{}

Update Route Data using JSON

Merges a direct JSON array, or an object containing routes, rows, data, or items, into stored route data using ROUTE CODE as the key. ACTIVE FROM and ACTIVE TO are optional dates in DD/MM/YYYY format.

The uploaded Route json will be merged with the existing route data (if available) stored for the organization and saved as a CSV file.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

Hospital ID used to identify the organization

Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{}

Upload Frequency CSV

Uploads a Frequency master CSV for the given hospital_id (query param) and stores it for the organization. The CSV requires FREQUENCY CODE and FREQUENCY DESCRIPTION. ACTIVE FROM and ACTIVE TO are optional and must use DD/MM/YYYY. Header matching is case-insensitive; unknown or duplicate headers are rejected.

Validation:

  • If FREQUENCY CODE is empty, the row is reported in invalid.
  • If FREQUENCY DESCRIPTION is empty, the row is reported in invalid.
  • This API should be used only for the initial upload of Frequency data.
  • If this API is called again, the existing Frequency list will completely deleted and replaced with the newly uploaded data. For any modifications or additions to the existing Frequency list, please use the updateFrequencyCsvs API.
Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

Hospital ID used to resolve organization

Request Body schema: multipart/form-data
csvFile
required
string <binary>

CSV file with headers FREQUENCY CODE and FREQUENCY DESCRIPTION

Responses

Response samples

Content type
application/json
{}

Upload frequency data

This API uploads or updates Frequency master data for a hospital using JSON input and stores it as a CSV file.

For the initial setup, this API can be used to upload the complete Frequency master list for the organization. If this API is called again, the existing Frequency list will be completely deleted and replaced with the newly uploaded data.

For any modifications or incremental updates to the existing Frequency list, please use the updateFrequencyJson API.

Requirements:

  • The body may be a direct array or an object containing frequencies, rows, data, or items.
  • Each object must contain the fields "FREQUENCY CODE" and "FREQUENCY DESCRIPTION".
  • Each FREQUENCY CODE must be unique within the request payload.

Validation:

  • Missing/empty required values and invalid dates are reported in invalid.
  • If duplicate FREQUENCY CODE values are found within the request payload, those items will be reported in the invalid field. A 400 is returned when no valid rows remain.

Behavior:

  • FREQUENCY CODE is treated as the unique identifier for frequency records.
  • During updates, if a FREQUENCY CODE already exists in the stored frequency data, the uploaded value overwrites the existing one.
  • New FREQUENCY CODE entries will be added to the dataset.

The final dataset is stored as a CSV file and linked to the organization.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

The ID of the hospital/organization

Request Body schema: application/json
Array of objects

Array of frequency objects

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{}

Update (merge) Frequency data using JSON

This API updates frequency master data for a hospital using JSON input.

The provided Frequency list will be merged with the existing frequency data (if available) stored for the organization and saved as a CSV file.

Requirements:

  • The body may be a direct array or an object containing frequencies, rows, data, or items.
  • Each object must contain: "FREQUENCY CODE" and "FREQUENCY DESCRIPTION".
  • Each FREQUENCY CODE must be unique within the request payload.

Validation:

  • Missing/empty required values and invalid dates are reported in invalid.
  • If duplicate FREQUENCY CODE values are found within the request payload, the duplicates will be reported in invalid. A 400 is returned when no valid rows remain.

Merge Behavior:

  • FREQUENCY CODE is used as the unique key.
  • If a FREQUENCY CODE already exists in the stored frequency data, the uploaded value overwrites it.
  • New FREQUENCY CODE entries are added to the dataset.

The final merged dataset is stored as a CSV file and linked to the organization.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

Hospital ID used to resolve organization

Request Body schema: application/json
Array of objects

Array of frequency objects. Can be sent directly as an array or wrapped as an object with a data property.

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{}

Update (merge) Frequency CSV

This API updates frequency data for a hospital.

The uploaded Frequency CSV will be merged with the existing frequency data (if available) stored for the organization and saved as a CSV file.

Requirements:

  • FREQUENCY CODE and FREQUENCY DESCRIPTION are required headers.
  • ACTIVE FROM and ACTIVE TO are optional headers using DD/MM/YYYY.
  • Header matching is case-insensitive; unknown or duplicate headers are rejected.

Validation:

  • If duplicate FREQUENCY CODE values are found in the uploaded CSV, those rows will be reported in the invalid field of the response.
  • If FREQUENCY CODE is empty, the row will be reported in invalid.
  • If FREQUENCY DESCRIPTION is empty, the row will be reported in invalid.

Merge Behavior:

  • FREQUENCY CODE is used as the unique key.
  • If a FREQUENCY CODE already exists in the stored frequency data, the uploaded value overwrites the existing one.
  • New FREQUENCY CODE entries will be added to the dataset.

The final merged dataset will be stored as a CSV file and linked to the organization.

Authorizations:
X-API-Key
query Parameters
hospital_id
required
string

Hospital ID used to resolve organization

Request Body schema: multipart/form-data
csvFile
required
string <binary>

CSV file containing frequency data (FREQUENCY CODE, FREQUENCY DESCRIPTION)

Responses

Response samples

Content type
application/json
{}