CareScribe Software Integration API (v3.6.4)

Retrieves a list of all specialities.

Creates a doctor record and associates it with an organization.

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

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.

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.

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.

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.

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.

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.

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.

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.

Retrieves route master data for the given hospital_id.

This API:

• Maps the provided hospital_id to the organization
• Reads the stored route CSV data from the organization.

If the organization is not found, or route data is unavailable, the API returns an error.

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.

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.

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.

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.

Deletes the route CSV file associated with the given hospital_id.

This API:

• Finds the organization using hospital_id
• Deletes the route CSV file from Google Cloud Storage
• Returns success message after deletion.

Retrieves frequency master data for the given hospital_id.

This API:

• Maps the provided hospital_id to the organization
• Reads the stored frequency CSV data from the organization.

If the organization is not found, or frequency data is unavailable, the API returns an error.

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.

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.

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.

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.

Deletes the frequency CSV file associated with the given hospital_id.

This API:

• Finds the organization using hospital_id
• Deletes the frequency CSV file from Google Cloud Storage
• Removes the frequency_data reference from the organization
• Saves the organization record

Returns success message after deletion.

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.

Creates or updates a Master Health Checkup (MHC) patient, assigns doctor, and optionally uploads vitals.

Retrieves generated Master Health Checkup (MHC) form data for a patient by calling the OPD chatbot upstream service.

Use this GET endpoint after creating or updating an MHC patient via POST /patient/softwareintegrationmhc. The API resolves the patient (by internal patient_id or hospital_patient_id), locates the active MHC record, and returns the generated form payload for the requested form_name.

Response form_name uses internal keys (eye_checkup, dental_checkup, gynaec_checkup, history_physical_examination, ent_checkup). The matching question_text field echoes the requested label.

Creates or updates a patient and inpatient record. Generates a secure session URL for clinician access.

• Provide EITHER doctor.practitioner_id OR nurse.caregiver_id - If both are provided → request will be rejected - Empty caregiver_id or practitioner_id is treated as NOT provided

Upload a patient document file and patient details using multipart/form-data.

This endpoint saves patient, diagnosis, medication, and vitals data. The patient's outpatient data is sent to the client's system using the URL specified in the organization.api_url field. The data transmission includes both the initial and final payloads as part of the client response.

Dermatology specialty: For dermatology users, the payload sent to the client follows this response format: a wrapped object with top-level status (e.g. "complete") and data. The data object contains SessionId, hospitalId, patientId, OpId, IpId, PractitionerId (nullable), type (e.g. "opd"), response, additional_response, medication_templates, vitals, assessment, dermatology_notes (specialty-specific object), and status (e.g. "initial payload" or "end payload").

IPD bundle forms: For IPD client API URL callbacks (for example an organization's configured ipd_api_url), the payload is a wrapped object with top-level status (e.g. "complete") and data. The data object includes SessionId, hospitalId, patientId, OpId, IpId, PractitionerId, type: "ipd", formName, process, structured_data, and inner status ("initial payload" or "end payload"). Supported bundle structures include IPD_CAUTI_BUNDLE, IPD_CLABSI_BUNDLE, and IPD_VASCULAR_BUNDLE.