IPD WebSocket Integration Guide

Direct audio integration for inpatient admissions, doctor and nurse documentation, and supporting IPD APIs.

Click here : IPD WebSocket and REST API Tester

Start here

Use the same hospital, clinician and admission setup as the IPD integration. WebSocket replaces the recording step: your application streams the audio, then retrieves forms and tasks through REST.

Already integrated with IPD? Keep your existing setup and admission mapping. Start at 6. Record audio, then 7. Retrieve results. Add the TODO workflow only if your application reviews or completes care tasks.

New integration: follow this order

  1. Hospital setup → floors → wards and beds, if used.
  2. Register doctors/nurses → identify or create the admission.
  3. Record audio → retrieve the required output.
  4. When needed: review/approve/complete tasks → handover and discharge.

Setup is reused across recordings. The payload and response panels below contain the full contracts; open only the operations you need. Replace ${...} tokens with actual returned IDs or configured values.

IDs and authentication used in every step

REST base URL

https://carescribe-app-api-8to2squd.wl.gateway.dev

Use the provisioned API key on REST calls. Include hospital_id in the query string where shown. For JSON requests, include both headers:

X-API-Key: YOUR_API_KEY
Content-Type: application/json

Binary audio WebSocket

wss://app.carescribe.health/wsaudio

// Browser authentication follows the existing OPD socket integration.
const socket = new WebSocket(
  "wss://app.carescribe.health/wsaudio",
  [apiKey]
);

The browser passes the API key as a WebSocket subprotocol. Do not place the key inside the patient initialization message. Use the credentials and hospital ID provisioned for the same integration environment.

FieldMeaningUsed by
hospital_idProvisioned hospital identifier.Socket initialization and REST APIs.
hospital_patient_idYour HMS patient identifier; stable across admissions.Socket initialization / patient mapping.
hospital_inpatient_idYour HMS admission identifier; stable within one admission.Socket initialization, dynamic forms and task APIs.
practitioner_idYour registered doctor identifier.Doctor recordings and doctor form requests.
caregiver_idYour registered nurse identifier.Nurse recordings and nurse form requests.
patient_idCareScribe patient identifier.Returned by CareScribe; required by certain downstream APIs.
inpatient_idCareScribe admission identifier.Grouped notes, drug chart and assignment APIs.
interaction_idCareScribe identifier for one recording / interaction.Returned after audio submission; used for tracking and task updates.

Do not interchange hospital_inpatient_id and inpatient_id. Store both in your integration mapping.

1. Enable IPD for the hospital

Once per hospital. Use your existing hospital_id and API key. If the hospital is already enabled for IPD, continue to the floor step.

POST /software/inpatientsetup?hospital_id=${HOSPITAL_ID}

{"inpatientSetup": true}

Both query hospital_id and the JSON boolean inpatientSetup are required. HTTP 200 returns {success, message, inpatientSetup}. Missing/invalid input: 400; unknown hospital: 404; server failure: 500.

New hospital onboarding is the same as in the IPD integration guide. Existing OPD partners reuse their configured hospital and credentials.

2. Create or select a floor

Once per hospital. First read the existing floors. Reuse a returned floor_id; create a floor only if the required one is missing. You will use this ID for nurses, beds and explicit admission setup.

GET /software/getallfloor?hospital_id=${HOSPITAL_ID}

Success: HTTP 200 with {message, data: [Floor]}. No floors returns HTTP 404, not an empty success list.

Create, rename or delete a floor — payloads and responses

Create

POST /software/createfloor
Content-Type: application/json
X-API-Key: ${API_KEY}

{
  "hospital_id": "${HOSPITAL_ID}",
  "floor_name": "${ACTUAL_FLOOR_NAME}"
}

Both body fields are required strings. HTTP 201 returns {message, data: Floor}; retain data.floor_id. A duplicate floor name in the hospital returns 409.

Rename

PUT /software/updatefloor?hospital_id=${HOSPITAL_ID}

{
  "floor_id": "${RETURNED_FLOOR_ID}",
  "floor_name": "${NEW_FLOOR_NAME}"
}

floor_id must represent a positive integer; send the ID returned for this hospital. floor_name is optional in the handler; omit it only if no rename is intended. HTTP 200: {message, data: Floor}; a duplicate name returns 409.

Delete

DELETE /software/deletefloor?hospital_id=${HOSPITAL_ID}&floor_id=${RETURNED_FLOOR_ID}

No body. HTTP 200: {message}. Deletion removes a floor; it is not a bed transfer or discharge action. The handler does not move existing assignments; dependent database records can prevent deletion.

Floor response fields

FieldType / meaning
floor_idinteger; generated CareScribe floor ID
floor_namestring; configured name
organization_idinteger; internal organization ID
created_at, updated_atserialized timestamps
update_logsJSON audit metadata; preserve unfamiliar keys

Common errors: 400 missing/invalid input, 404 hospital/floor not found, 409 duplicate name on create/rename, 500 unexpected/database failure. Errors use message and may include error.

Optional: change the floor label
PATCH /software/floor-variable?hospital_id=${HOSPITAL_ID}

{"floor_variable": "${AREA_LABEL}"}

Required nonempty label, for example your hospital's chosen term for a floor. HTTP 200: {message, data: <saved label>}. This changes the label; it does not create floors or alter the hierarchy. Missing input: 400; unknown hospital: 404; failure: 500.

3. Set up wards and beds, if needed

Once per hospital, only when CareScribe will track beds. Ward names and bed types are hospital-wide lists. Each bed belongs to a floor and stores a ward name. They are not additional numeric ward/type IDs to invent.

GET /software/bedtypes-wards?hospital_id=${HOSPITAL_ID}
GET /software/get/bedslist?hospital_id=${HOSPITAL_ID}

The first response is {bedtypes: string[], wards: string[]}. The second is {message, beds: Bed[]}, including each bed's floor object. Reuse the returned bed_id, bed_no, ward and floor_id. An empty bed list is beds: [].

Ward management — add, rename and remove
POST /software/ward/add?hospital_id=${HOSPITAL_ID}
{"ward": "${ACTUAL_WARD_NAME}"}

PUT /software/ward/update?hospital_id=${HOSPITAL_ID}
{"old_ward": "${EXISTING_WARD_NAME}", "new_ward": "${NEW_WARD_NAME}"}

DELETE /software/ward/delete?hospital_id=${HOSPITAL_ID}
{"ward": "${EXISTING_WARD_NAME}"}

All shown body fields are required strings; DELETE also has a JSON body. Responses are HTTP 200 with {message, data: {wards: string[], unchanged?: boolean}}. Rename additionally returns data.organization_id and data.hospital_id. Repeating add/delete can return unchanged: true; renaming to an existing name merges the list entries. These operations change the hospital's ward list; they do not rename or move existing bed/admission records. Missing input: 400; unknown hospital or rename source: 404; failure: 500.

Create a bed — complete payload and defaults
POST /software/create/bed

{
  "hospital_id": "${HOSPITAL_ID}",
  "floor": "${RETURNED_FLOOR_ID}",
  "ward": "${ACTUAL_WARD_NAME}",
  "bed_type": "${CONFIGURED_BED_TYPE}",
  "bed_no": "${ACTUAL_BED_NUMBER}",
  "is_occupied": false,
  "status": "available",
  "need_maintenance": false
}

The five strings hospital_id, floor, ward, bed_type and bed_no are required. floor accepts the returned floor ID or an exact floor name; numeric strings are interpreted as IDs. The three boolean/status fields shown are optional with the displayed defaults.

Other optional create fields: patient_id and inpatient_id (internal CareScribe IDs, default null), admitted_at and last_cleaned_at (timestamps or null). For an empty new bed, omit patient/admission fields. Do not use bed creation as the ordinary admission workflow. HTTP 201: {message, bed: Bed}; save bed.bed_id.

Update a bed — payload and limitations
POST /software/update/bed?bed_id=${RETURNED_BED_ID}

{
  "hospital_id": "${HOSPITAL_ID}",
  "floor": "${RETURNED_FLOOR_ID}",
  "bed_no": "${RETURNED_BED_NUMBER}",
  "ward": "${RETURNED_WARD_NAME}",
  "bed_type": "${RETURNED_BED_TYPE}"
}

Required by validation: query bed_id, body hospital_id and floor. Also retain the current bed_no, ward and bed_type because duplicate checking uses them. Optional changes: is_occupied, status, need_maintenance, last_cleaned_at. HTTP 200: {message, bed: Bed}.

This update does not accept patient_id, inpatient_id, admitted_at, room_no or active changes. No bed-delete software route is exposed here. Setting is_occupied alone does not link an admission; use the admission assignment operation below and read beds back.

Bed errors: 400 missing fields or duplicate bed number on the same floor/ward; 404 hospital, floor or bed not found; 500 unexpected/database failure. Bed-type lookup currently can return 500 for an unknown hospital; do not treat that as an empty configuration.

Bed response — every model field
FieldsType / meaning
bed_id, organization_idstrings; generated bed UUID and internal organization ID
bed_no, ward, bed_typestrings; bed number and configured names
floor_idinteger; parent floor
floorlist endpoint association: {floor_id: integer, floor_name: string}, or null
active, is_occupied, need_maintenancebooleans; activity, occupancy and maintenance state
statusstring; defaults to available; occupied is used during assignment
room_nostring or null; returned metadata, not writable through these two bed routes
patient_id, inpatient_idinternal CareScribe ID strings or null
admitted_at, last_cleaned_atserialized timestamps or null
created_at, updated_atserialized timestamps
update_logsJSON audit metadata
Optional bulk setup: import floors, ward names and bed types from CSV
POST /software/upload-csv/partitionsetup?hospital_id=${HOSPITAL_ID}
X-API-Key: ${API_KEY}
Content-Type: multipart/form-data; boundary=...

File field: csvFile
Filename: your-setup.csv
CSV headers: Floor Name,Bed Type,Ward

Supply an actual .csv file, not a JSON body. At least one of the exact headers must be present. Each nonempty value contributes to that hospital's floors, bed types or wards; existing values are skipped. This imports configuration lists, not bed instances; create individual beds separately.

HTTP 200: {message, data}, with integer counts floorsCreated, floorsSkipped, bedTypesAdded, bedTypesSkipped, wardsAdded, wardsSkipped, totalFloors, totalBedTypes, totalWards. Optional top-level invalidRows, duplicateRows, skippedRows contain {row, reason, data}. Review these even on 200. Missing hospital/file: 400; unknown hospital: 404; CSV/parser/server errors: 500.

4. Register the recording clinicians

Once per clinician. Reuse the doctor's registered practitioner_id or the nurse's registered caregiver_id. Provision only the roles your integration uses. A nurse requires the floor ID from step 2.

New doctor — required payload and returned ID

Select a configured speciality from GET /software/speciality/list, then send:

POST /software/doctor/create

{
  "hospital_id": "${HOSPITAL_ID}",
  "practitioner_id": "${HMS_DOCTOR_ID}",
  "first_name": "${DOCTOR_FIRST_NAME}",
  "last_name": "${DOCTOR_LAST_NAME}",
  "speciality_id": "${RETURNED_SPECIALITY_ID}"
}

All shown fields are required. Optional fields: salutation, license_no, phone_number, email, doctor_active_from and doctor_active_to. Dates use YYYY-MM-DD; retain the configured activation range. HTTP 201 returns {message, doctor}; doctor.doctor_id is the internal CareScribe ID. Continue using your practitioner_id in recording and form requests. Validation/duplicate doctor errors return 400; unexpected failures return 500.

New nurse — required payload and provisioning response
POST /software/nurse/create?hospital_id=${HOSPITAL_ID}

{
  "firstname": "${NURSE_FIRST_NAME}",
  "lastname": "${NURSE_LAST_NAME}",
  "floor_id": "${RETURNED_FLOOR_ID}",
  "caregiver_id": "${HMS_NURSE_ID}"
}

All shown body fields and query hospital_id are required. Optional fields: email, phone and nurse_category; configured categories can include Ward Nurse, ICU Nurse and ER Nurse.

Check the response before recording. Direct creation returns HTTP 201 with {message, member_request: false, created: true, user_id, nurse_id, username}. Where member approval is enabled, HTTP 202 returns {message, member_request: true, created: false, request_id}; wait until the nurse is approved and available. A 202 response does not mean the recording clinician exists yet.

Missing/invalid fields or duplicate caregiver/email: 400; member quota reached: 403; unknown hospital: 404; duplicate pending request: 409; failure: 500. Use your caregiver_id in subsequent requests; nurse_id is internal.

5. Identify the patient and admission

For each admission. Keep one HMS hospital_patient_id for the patient and one hospital_inpatient_id for this admission. Reuse them for every recording in that admission.

Existing admission: continue with the same IDs. New admission using direct recording: the WebSocket handler can create missing patient/admission records from the initialization message. Include accurate demographics. Floor/bed allocation is a separate step when you need it.

You do not need to call every admission endpoint. Use the following panels only for explicit preregistration, clinician assignment or bed allocation.

Optional: create an admission before recording

Create an admission before recording

POST /software/createinpatient?hospital_id=YOUR_HOSPITAL_ID

{
  "hospital_patient_id": "HMS-PAT-001",
  "hospital_inpatient_id": "HMS-IP-2026-001",
  "practitioner_id": "DOC-001",
  "patient_category": "Inpatient",
  "floor_id": "${RETURNED_FLOOR_ID}",
  "first_name": "Demo",
  "last_name": "Patient",
  "date_of_birth": "1980-01-15",
  "age": 46,
  "gender": "Male",
  "ward": "Ward-A",
  "timeZone": "Asia/Kolkata"
}

The required inputs are query hospital_id and body hospital_inpatient_id, practitioner_id, patient_category and floor_id. Supply accurate patient demographics and the HMS patient identifier shown. An existing patient is looked up by hospital_patient_id; the current new-patient branch stores its generated patient ID as hospital_patient_id, so verify the returned patient mapping before subsequent recordings. Optional bed_id plus ward links a bed; a 201 response alone does not prove the bed was matched. Read the bed list back. Avoid repeating creation after a timeout without checking for the admission first.

Use a valid hospital floor and practitioner. Store the returned patient and inpatient identifiers. Continue with the same HMS identifiers in the socket initialization.

Optional: assign doctors or nurses to the admission

Assign doctors or nurses to the admission

POST /software/inpatient/assign-by-caregiver-practitioner?hospital_id=YOUR_HOSPITAL_ID

{
  "inpatient_id": "CARESCRIBE_INPATIENT_ID",
  "practitioner_id": "DOC-001",
  "caregiver_id": "NURSE-001"
}

This assignment request can include either or both clinician identifiers. Each field also supports an array for multiple assignments.

Assign the primary doctor, floor and bed — or transfer an admission
PUT /software/inpatient/assign-primary-doctor?hospital_id=${HOSPITAL_ID}

{
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "patient_id": "${HMS_PATIENT_ID}",
  "practitioner_id": "${REGISTERED_DOCTOR_ID}",
  "floor_id": "${RETURNED_FLOOR_ID}",
  "bed_no": "${RETURNED_BED_NUMBER}",
  "ward": "${RETURNED_WARD_NAME}"
}

The first four body fields are required. Here patient_id means the HMS patient ID, matched to hospital_patient_id. Optional fields: bed_no, ward, in_date (timestamp), attender_mobile_no, attender_name, attender_relation, insurance_type and the admission insurance-detail fields. Retain the intended admission date when updating an existing admission; omitted in_date is replaced with the current time and the admission is set active.

Omit bed_no to preserve the current bed. Including it releases the existing linked bed first; a nonempty value attempts to assign an active bed by bed number in this hospital. A null/empty value clears the bed link. The current selection does not distinguish matching bed numbers by floor/ward and does not reject an occupied target, so check the returned bed list for an unambiguous available bed before transfer. Read both the admission and beds after the call; a missing target bed can still produce a successful admission response.

HTTP 201 if an admission is created, otherwise 200: {message, patient_created: boolean, inpatient_created: boolean, inpatient: object}. The returned admission contains its stored fields and associated Patient, primaryDoctor, Beds and floor data. Missing patient/admission records can be created by this operation; a newly created patient initially has placeholder demographics. Supply accurate demographics through your patient workflow before recording. Missing inputs: 400; unknown hospital/doctor: 404; conflicting admission ID: 409; unhandled errors: 500.

6. Record and process audio

  1. Open the authenticated /wsaudio socket.
  2. Send one JSON initialization message with the admission and clinician identifiers.
  3. Wait for the exact acknowledgement status: "init-received".
  4. Stream binary WebM/Opus audio chunks. The example uses one-second chunks.
  5. Stop the recorder, send its final audio chunk, then send {"type":"stop"}.
  6. Keep the socket open for the creation acknowledgement and status: "processed". Store the returned identifiers.

Doctor initialization

{
  "hospital_id": "YOUR_HOSPITAL_ID",
  "hospital_patient_id": "HMS-PAT-001",
  "hospital_inpatient_id": "HMS-IP-2026-001",
  "patient_category": "Inpatient",
  "practitioner_id": "DOC-001",
  "first_name": "Demo",
  "last_name": "Patient",
  "date_of_birth": "1980-01-15",
  "age": 46,
  "gender": "Male",
  "ward": "Ward-A",
  "interaction_detail_type": "Audio url"
}

Nurse initialization

Use the same hospital, patient and admission identifiers. Replace practitioner_id with caregiver_id; identify one recording clinician per session.

{
  "hospital_id": "YOUR_HOSPITAL_ID",
  "hospital_patient_id": "HMS-PAT-001",
  "hospital_inpatient_id": "HMS-IP-2026-001",
  "patient_category": "Inpatient",
  "caregiver_id": "NURSE-001",
  "nurse_category": "Ward Nurse",
  "first_name": "Demo",
  "last_name": "Patient",
  "date_of_birth": "1980-01-15",
  "age": 46,
  "gender": "Male",
  "ward": "Ward-A",
  "interaction_detail_type": "Audio url"
}
For a new recording, omit interaction_id. Let CareScribe create and return it. Start a new socket session for the next recording, keeping the admission identifiers unchanged.

Message milestones

These examples show the fields to handle; server responses may contain additional fields.

{
  "status": "init-received",
  "file": "${RETURNED_AUDIO_OBJECT_PATH}"
}

After audio is submitted, capture the identifiers from the creation acknowledgement:

{
  "status": true,
  "message": "Interaction and InteractionDetail created successfully",
  "result": {
    "patient_id": "CARESCRIBE_PATIENT_ID",
    "inpatient_id": "CARESCRIBE_INPATIENT_ID",
    "interaction_id": "CARESCRIBE_INTERACTION_ID"
  }
}

Creation acknowledgement is not processing completion. Wait for:

{
  "status": "processed",
  "allData": {
    "interaction_id": "CARESCRIBE_INTERACTION_ID",
    "patient_id": "CARESCRIBE_PATIENT_ID",
    "processedText": "..."
  }
}

processedText may be a JSON string. Parse it when valid JSON; otherwise retain the returned value. Output structure depends on the processed content and form. Use the IPD form API to request a specific document.

WebSocket message fields and what to do next

The following fields come from the direct /wsaudio handler and its creation/result delivery functions. Do not treat the three message types as interchangeable. A successful creation acknowledgement means the recording was submitted; wait for processing before retrieving its clinical output.

Message / fieldValue or typeMeaning and client handling
Initialization: statusstring, exactly init-receivedStart sending binary audio after this message.
Initialization: filestringGenerated audio object path. It is not a downloadable URL, a clinical form or a task gcs_uri.
Initialization echostatus: init-received -data, initPayload: objectThe current binary handler may also echo initialization fields. This is not the exact readiness acknowledgement; do not start the recorder twice.
Creation: status, messageboolean true, stringInteraction creation succeeded. Store result identifiers; keep the socket open.
Creation: result.patient_idreturned identifierInternal CareScribe patient ID. Preserve its returned representation; it differs from hospital_patient_id.
Creation: result.inpatient_idreturned identifier or nullResolved CareScribe admission ID. Retain the original HMS hospital_inpatient_id separately for forms and TODO calls.
Creation: result.interaction_idreturned identifierRecording/interaction ID for tracking. For task edits, use the interaction_id on the selected returned task record.
Creation: result.doctor_id, result.nurse_idreturned identifiers or nullInternal recording actor IDs. They do not replace the HMS practitioner_id/caregiver_id in form requests.
Creation: result.interaction_status, result.token_numberstored database valuesInteraction metadata; neither is a processing-completion signal. Retain unknown/null values.
Creation: result.Patientobject {patient_id, patient_category}Patient context; patient_id repeats the internal patient ID. Expected category for this flow is Inpatient.
Creation: result.interaction_detail_typestringSubmitted detail type, default Audio url.
Creation: result.audio_urlstring or nullStored recording location. Do not assume it is public or use it as a TODO record location.
Creation: result.patient_status, result.mhc_idstored values or nullAdditional patient/interaction metadata, unrelated to TODO completion.
Creation: audiointeractionservice-built JSON or nullAdditional interaction/detail representation. Not the final form response; no fixed nested field contract is asserted here.
Creation: opdbooleanCurrent implementation derives this flag from the presence of a doctor. It does not prove that the admission was routed as OPD.
Completion: statusstring, exactly processedThe processed-result service delivered the result; the server then closes this socket.
Completion: allDataupstream result objectPassed through by the result-delivery service. Do not require every illustrated field to be present. Retain the creation identifiers as the reliable recording context.
Completion: allData.processedTextJSON string or service-provided valueParse a string only if it is valid JSON. Clinical content depends on the processing route/template. It is not a universal envelope for all charts or TODOs.
Failure: status, messageboolean false, stringCreation/upload/processing submission failed. Stop the recorder and surface the message. Current messages include Upload failed, Error processing interaction and Failed to upload interaction. Transport failures may close the socket without this envelope.

From the processed recording to forms and TODO data

  1. Keep hospital_id, hospital_patient_id, hospital_inpatient_id and the recording clinician's HMS ID from initialization. Save the returned internal patient, admission and interaction IDs separately.
  2. After status: "processed", use the form catalogue below to choose what the HMS displays. Each operation includes a complete request body and a link to its response fields in this page.
  3. For generated tasks, call GET /software/doctortodo with the HMS hospital/admission query parameters. The TODO section below shows the response, review/approval payload and nurse execution update using actual returned records.
  4. Read GET /software/nurse/todo after doctor approval. Update the selected original record and read it back. Socket processing does not itself approve tasks, mark them complete or discharge the admission.

The field dictionary in this page covers every form envelope and nested clinical/task model. Template-dependent values are explicitly described as open content instead of showing fabricated clinical results.

Browser JavaScript example

Call startIpdRecording from your recording UI using one of the initialization objects above. This is an integration example, not an executable recorder on this page. Microphone access requires HTTPS or localhost and user permission.

async function startIpdRecording({
  apiKey, init, onCreated, onProcessed, onError
}) {
  const mimeType = "audio/webm;codecs=opus";
  if (!window.MediaRecorder || !MediaRecorder.isTypeSupported(mimeType)) {
    throw new Error("This browser does not support WebM/Opus recording.");
  }

  const stream = await navigator.mediaDevices.getUserMedia({ audio: true });
  let socket;
  let recorder;
  let stopping = false;
  let completed = false;
  let failed = false;
  const releaseMicrophone = () => stream.getTracks().forEach(t => t.stop());

  function fail(error) {
    if (failed || completed) return;
    failed = true;
    if (recorder?.state === "recording") recorder.stop();
    releaseMicrophone();
    if (socket && socket.readyState < WebSocket.CLOSING) socket.close();
    onError(error);
  }

  try {
    socket = new WebSocket("wss://app.carescribe.health/wsaudio", [apiKey]);
    recorder = new MediaRecorder(stream, {
      mimeType,
      audioBitsPerSecond: 32000
    });
  } catch (error) {
    releaseMicrophone();
    socket?.close();
    throw error;
  }

  recorder.ondataavailable = ({ data }) => {
    // Send every chunk exactly once, including the final chunk.
    if (!failed && data.size && socket.readyState === WebSocket.OPEN) {
      socket.send(data);
    }
  };
  recorder.onstop = () => {
    // MediaRecorder emits final dataavailable BEFORE stop.
    // Sending Blobs directly preserves ordering without async conversion.
    if (!failed && socket.readyState === WebSocket.OPEN) {
      socket.send(JSON.stringify({ type: "stop" }));
    }
    releaseMicrophone();
  };
  recorder.onerror = () => fail(new Error("Audio recording failed."));
  socket.onopen = () => socket.send(JSON.stringify(init));
  socket.onerror = () => fail(new Error("WebSocket connection failed."));
  socket.onclose = () => {
    if (!completed) fail(new Error("Socket closed before processing completed."));
  };
  socket.onmessage = ({ data }) => {
    if (failed) return;
    let message;
    try { message = JSON.parse(data); } catch { return; }

    if (message.status === "init-received") {
      if (!stopping && recorder.state === "inactive") recorder.start(1000);
    } else if (message.status === true && message.result) {
      onCreated(message.result); // Persist patient_id, inpatient_id, interaction_id.
    } else if (message.status === "processed") {
      completed = true;
      const result = message.allData || {};
      let parsed = result.processedText;
      if (typeof parsed === "string") {
        try { parsed = JSON.parse(parsed); } catch { /* Preserve plain text. */ }
      }
      releaseMicrophone();
      socket.close();
      onProcessed(result, parsed);
    } else if (message.status === false || message.status === "error") {
      fail(new Error(message.message || "IPD audio processing failed."));
    }
  };

  return {
    stop() {
      if (stopping || failed || completed) return;
      stopping = true;
      if (recorder.state === "recording") recorder.stop();
      else fail(new Error("Recording has not started yet."));
    }
  };
}

Partners already using the Base64 variant can use wss://app.carescribe.health/wsaudiobase64 with the same IPD initialization and their existing Base64 audio message format. Do not send Base64 JSON to the binary endpoint.

7. Retrieve the output your application needs

After status: "processed", keep the HMS hospital/admission IDs from initialization and the CareScribe IDs from the creation acknowledgement. Select an operation below and send its JSON body over REST. The socket completion message does not contain every admission chart or approve any TODO task.

POST /software/ipd/forms

One endpoint routes the operations below. Choose the exact, case-sensitive form_name. Retrieving an existing chart, generating a document and editing a chart are different operations. TODOs use the four task endpoints, not a form_name.

Verified 29 September 2026: request routing checked against the application handler; chart/TODO envelopes and nested models checked against deployed IPD source. Existing supplied responses are used only as shape evidence. No new patient data was fetched. Download the full JSON field definitions or request catalogue.

Authentication, identifiers and the complete common body

Base URL: https://carescribe-app-api-8to2squd.wl.gateway.dev. Headers: X-API-Key: YOUR_API_KEY and Content-Type: application/json. The key must belong to the hospital. All three common fields are required in the JSON body, plus at least one non-empty clinician ID. A hospital_id query parameter alone does not replace the body field.

Body fieldTypeRequired / meaning
hospital_idstringRequired: your configured HMS hospital ID.
hospital_inpatient_idstringRequired: your HMS admission ID. Must resolve to a patient in this hospital.
form_namestringRequired: exact operation listed below.
practitioner_idstringHMS doctor identifier; required for doctor_notes, raw_doctor_notes and surgery_notes.
caregiver_idstringHMS nurse identifier; required for nurse_notes, raw_nurse_notes and nurse_care_plan.

Other forms accept either clinician ID. Use the relevant one for the intended workflow. The server resolves patient_id and inpatient_id; do not invent internal IDs. role is legacy and ignored. Internal doctor_id/nurse_id can remain in responses; practitioner_id/caregiver_id are added when a matching external ID can be resolved and are not guaranteed on every nested object.

Every request below is a complete JSON body. Replace ${...} tokens with registered identifiers or the actual clinical content; tokens are not fictional working accounts. Send no patient demographics or unrelated template fields for chart reads.

Available operations

form_name (aliases)OperationResponse
raw_doctor_notesRead latest stored noteStoredNoteResponse
raw_nurse_notesRead latest stored noteStoredNoteResponse
doctor_notesRetrieve and assemble progress notesResponse_doctor_notes
nurse_notesRetrieve and assemble nurse notesResponse_nurse_notes
initial_assessmentGenerate documentGeneratedDocumentResponse
progress_notesGenerate documentGeneratedDocumentResponse
surgery_notesGenerate documentGeneratedDocumentResponse
nurse_care_planGenerate care planGeneratedDocumentResponse
discharge_summaryGenerate discharge documentGeneratedDocumentResponse
case_sheetAssemble case sheetResponse_case_sheet
get_drug_chart — drug_chartRead medication chartResponse_get_drug_chart
blood_glucose_monitoring_chart — get_blood_glucose_monitoring_chartRead glucose chartGlucoseResponse
get_all_ipd_notes_grouped_by_date — ipd_notes_grouped_by_dateRead grouped chartsGroupedResponse
IPD_VITALSRead chart categoryResponse_IPD_VITALS
IPD_INTAKE_OUTTAKERead chart categoryResponse_IPD_INTAKE_OUTTAKE
IPD_CAUTI_BUNDLE — cauti_bundle, cautiBundleRead chart categoryResponse_cauti_bundle
IPD_CLABSI_BUNDLE — clabsi_bundle, clabsiBundleRead chart categoryResponse_CLABSI_Bundle
IPD_VASCULAR_BUNDLERead chart categoryResponse_Vascular_Bundle
IPD_BLOOD_GLUCOSE_MONITORINGRead chart categoryGlucoseResponse
IPD_VENTI_FORMRead chart categoryVentilationResponse
IPD_BLOOD_TRANSFUSIONRead chart categoryBloodTransfusionResponse
IPD_NUTRITION_FORMRead chart categoryNutritionResponse
IPD_ICU_FORMRead chart categoryIcuResponse
IPD_GENERAL_OBSERVATIONSRead chart categoryResponse_IPD_GENERAL_OBSERVATIONS
IPD_ASSESSMENT_DETAILSRead chart categoryResponse_IPD_ASSESSMENT_DETAILS
IPD_PRESCRIPTION_ADMINISTRATIONSRead chart categoryResponse_IPD_PRESCRIPTION_ADMINISTRATIONS
update_ipd_dataWrite: extract chart data from edited notesWriteResponse
ingest_chart_dataWrite: persist returned chart structureIngestResponse

Category and date rules

The router accepts any IPD_* string up to 80 characters; that acceptance is not proof that the upstream stores that category. The table lists the current upstream default chart categories. raw_info can be requested with form_name=get_all_ipd_notes_grouped_by_date and categories=raw_info. IPD_PERIPHERAL_CHART is a legacy reference; use IPD_VASCULAR_BUNDLE for current vascular data. Unsupported/empty categories may produce an empty result, not an unknown-form error.

Use DD/MM/YYYY dates for start_date/end_date on IPD_VITALS and IPD_INTAKE_OUTTAKE. Body dates are forwarded only for these exact shortcut names. Do not send empty dates. category is forwarded on grouped reads but the current upstream declares categories, not a separate category filter. Drug and glucose routes remove both filters. A categories array is not supported by this wrapper.

Optional generation fields

For initial_assessment, progress_notes, surgery_notes and nurse_care_plan only: interaction_id (string/number, optional), force_regenerate and stored_signal (optional flags), specialty_name, patient_type, gender, user_country, time_zone, preferred_language, opd_question, question_text (optional strings), diagnosisComorbid and audio_transcribe (booleans). Configured master-data URLs are normally resolved by the server. The handler also accepts med_url, assess_url, freq_url, route_url, icd_url and icd_code overrides, but they are not required for standard integration. Do not assume these fields filter read operations. The discharge handler resolves its own latest interaction and question text.

raw_doctor_notes — request and response

raw_doctor_notes

Read latest stored note. Latest stored doctor_notes detail for this admission, ordered by update time. This is not the full note history. The practitioner identifier is required, but the stored-note query is admission-wide rather than filtered to that practitioner. answer can be a JSON value, text, or null if attachment content is unavailable. No stored note returns 404 with resultData: [].

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "practitioner_id": "${PRACTITIONER_ID}",
  "form_name": "raw_doctor_notes"
}

Response fields: StoredNoteResponse.

raw_nurse_notes — request and response

raw_nurse_notes

Read latest stored note. Same stored-note envelope as raw_doctor_notes, selecting nurse_notes. The caregiver identifier is required; the stored-note query is admission-wide. 404 when no matching stored note exists.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "raw_nurse_notes"
}

Response fields: StoredNoteResponse.

doctor_notes — request and response

doctor_notes

Retrieve and assemble progress notes. notes is an object keyed by interaction ID, not an array. Values contain created_at, updated_at, interaction_type, answer and clinician IDs; read_error may be present. A no-table response may return status: "table not exists" and notes: {}. The service can assemble notes; do not treat this as a side-effect-free generation trigger.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "practitioner_id": "${PRACTITIONER_ID}",
  "form_name": "doctor_notes"
}

Response fields: Response_doctor_notes.

nurse_notes — request and response

nurse_notes

Retrieve and assemble nurse notes. notes is an array of handover-delimited sets. Each set contains a notes map keyed by interaction ID plus generated care/pain sections, and may contain section_error or braden_scale. Also returns handover_interactions and pain_graph. On a no-table response notes can instead be {}.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "nurse_notes"
}

Response fields: Response_nurse_notes.

Nested clinical field definition: NurseNotes. Clinical record models describe content; the response envelope above describes how to reach it.

initial_assessment — request and response

initial_assessment

Generate document. Use practitioner_id for the doctor assessment or caregiver_id for the nurse workflow. Identity and template configuration determine the generated form. Patient and admission IDs are resolved internally. See the clinical models for field-level content; the data envelope is not a fixed template.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "practitioner_id": "${PRACTITIONER_ID}",
  "form_name": "initial_assessment"
}

Response fields: GeneratedDocumentResponse.

Nested clinical field definition: DoctorInitialAssessment. Clinical record models describe content; the response envelope above describes how to reach it.

progress_notes — request and response

progress_notes

Generate document. Calls document generation, distinct from doctor_notes retrieval. Optional interaction_id selects a recording; omitted/zero falls back to the latest matching interaction. Response data is the upstream generation result.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "practitioner_id": "${PRACTITIONER_ID}",
  "form_name": "progress_notes"
}

Response fields: GeneratedDocumentResponse.

Nested clinical field definition: InitialAssessment. Clinical record models describe content; the response envelope above describes how to reach it.

surgery_notes — request and response

surgery_notes

Generate document. practitioner_id is mandatory. Response data contains the generated surgery document; the supplied surgery response below records a known shape, not a universal set of required fields.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "practitioner_id": "${PRACTITIONER_ID}",
  "form_name": "surgery_notes"
}

Response fields: GeneratedDocumentResponse.

nurse_care_plan — request and response

nurse_care_plan

Generate care plan. caregiver_id is mandatory. Care-plan rows include diagnosis, goal, interventions and evaluation. This generates a plan; it is not the upstream read-all-care-plans API.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "nurse_care_plan"
}

Response fields: GeneratedDocumentResponse.

Nested clinical field definition: NurseCarePlanSchema. Clinical record models describe content; the response envelope above describes how to reach it.

discharge_summary — request and response

discharge_summary

Generate discharge document. Either clinician ID is accepted. The current handler always resolves the latest interaction ordered by updated_at; a supplied interaction_id does not select an older interaction. A missing interaction returns 404. Invalid upstream document content returns 502. Generating this document does not discharge the admission.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "practitioner_id": "${PRACTITIONER_ID}",
  "form_name": "discharge_summary"
}

Response fields: GeneratedDocumentResponse.

case_sheet — request and response

case_sheet

Assemble case sheet. Either clinician ID is accepted. force_regenerate is optional. Sections aggregate assessments, notes, charts and care plans; the service may generate missing notes/plans while assembling the case sheet. Empty objects/arrays represent unavailable sections. Nested chart objects use the dedicated response definitions. Content inside assessment.response depends on the configured template.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "practitioner_id": "${PRACTITIONER_ID}",
  "form_name": "case_sheet",
  "force_regenerate": false
}

Response fields: Response_case_sheet.

get_drug_chart — request and response

get_drug_chart

Read medication chart. Read merged_schema.prescription_data and merged_schema.total_records. Includes medications, administration records, allergies and reconciliation. Category/category filters are stripped by the proxy for this endpoint. Counts describe the full response, not an example subset.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "practitioner_id": "${PRACTITIONER_ID}",
  "form_name": "get_drug_chart"
}

Response fields: Response_get_drug_chart.

Nested clinical field definition: DrugChartRoot. Clinical record models describe content; the response envelope above describes how to reach it.

blood_glucose_monitoring_chart — request and response

blood_glucose_monitoring_chart

Read glucose chart. The array mixes dated day records and a final creatinine_level/consent_for_insulin record. Do not assume every item has date or entries. Each day has entries, total and remarks. Medication and measurement rows can be separate. Category filters are ignored.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "blood_glucose_monitoring_chart"
}

Response fields: GlucoseResponse.

get_all_ipd_notes_grouped_by_date — request and response

get_all_ipd_notes_grouped_by_date

Read grouped charts. Omit categories to retrieve the upstream default category set. To select one category, send its exact name in categories. The wrapper converts categories to a string; arrays/comma-separated multiple categories are not a documented multi-select contract. Body start_date/end_date are not forwarded on this generic branch. Use the exact IPD_VITALS/IPD_INTAKE_OUTTAKE shortcut for body date filters.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "get_all_ipd_notes_grouped_by_date"
}

Response fields: GroupedResponse.

IPD_VITALS — request and response

IPD_VITALS

Read chart category. Vitals grouped into date records. Values may include units as text. start_date/end_date filter the chart.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_VITALS",
  "start_date": "29/09/2026",
  "end_date": "29/09/2026"
}

Response fields: Response_IPD_VITALS.

Nested clinical field definition: VitalSigns. Clinical record models describe content; the response envelope above describes how to reach it.

IPD_INTAKE_OUTTAKE — request and response

IPD_INTAKE_OUTTAKE

Read chart category. Intake/output rows plus optional IPD_INTAKE_OUTTAKE_SUMMARY. Without dates the current service shows the current nursing shift; cumulative balance can include earlier shifts. Date filtering is not simply midnight-to-midnight.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_INTAKE_OUTTAKE",
  "start_date": "29/09/2026",
  "end_date": "29/09/2026"
}

Response fields: Response_IPD_INTAKE_OUTTAKE.

Nested clinical field definition: IntakeOutput. Clinical record models describe content; the response envelope above describes how to reach it.

IPD_CAUTI_BUNDLE — request and response

IPD_CAUTI_BUNDLE

Read chart category. Catheter lifecycle records: insertion, daily maintenance, removal and summary. Preserve interaction identifiers within nested rows.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_CAUTI_BUNDLE"
}

Response fields: Response_cauti_bundle.

Nested clinical field definition: CautiBundle. Clinical record models describe content; the response envelope above describes how to reach it.

IPD_CLABSI_BUNDLE — request and response

IPD_CLABSI_BUNDLE

Read chart category. Central-line lifecycle records, including insertion, maintenance, dressing and removal. Preserve multiple devices/lifecycles.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_CLABSI_BUNDLE"
}

Response fields: Response_CLABSI_Bundle.

Nested clinical field definition: ClabsiBundle. Clinical record models describe content; the response envelope above describes how to reach it.

IPD_VASCULAR_BUNDLE — request and response

IPD_VASCULAR_BUNDLE

Read chart category. Vascular access device records. A record contains vascular_bundle with insertion_checklist_form, daily_maintenance_checklist_form, vad_removal_checklist_form and complication_report_form.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_VASCULAR_BUNDLE"
}

Response fields: Response_Vascular_Bundle.

Nested clinical field definition: VascularAccessDeviceBundle. Clinical record models describe content; the response envelope above describes how to reach it.

IPD_BLOOD_GLUCOSE_MONITORING — request and response

IPD_BLOOD_GLUCOSE_MONITORING

Read chart category. Same grouped glucose retrieval shape as blood_glucose_monitoring_chart.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_BLOOD_GLUCOSE_MONITORING"
}

Response fields: GlucoseResponse.

IPD_VENTI_FORM — request and response

IPD_VENTI_FORM

Read chart category. This category is an OBJECT with venti_insert and venti_maintain arrays, not an array of date groups. Doctor insertion and nurse maintenance records are merged separately.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_VENTI_FORM"
}

Response fields: VentilationResponse.

IPD_BLOOD_TRANSFUSION — request and response

IPD_BLOOD_TRANSFUSION

Read chart category. This category is an OBJECT containing blood_transfusion_reaction_report and blood_transfusion_monitoring_sheet. The latter also contains checklist, fluid_monitoring and post_transfusion_record. It is not an array of date groups. Doctor orders and nurse monitoring/reaction records are combined.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_BLOOD_TRANSFUSION"
}

Response fields: BloodTransfusionResponse.

Nested clinical field definition: NurBloodTrans. Clinical record models describe content; the response envelope above describes how to reach it.

IPD_NUTRITION_FORM — request and response

IPD_NUTRITION_FORM

Read chart category. Nutrition periods and clinical sections; the retrieval serializer enriches nutrition with assessment/scoring data. Preserve unknown fields and distinguish absent data from a zero score.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_NUTRITION_FORM"
}

Response fields: NutritionResponse.

Nested clinical field definition: NutritionNotes. Clinical record models describe content; the response envelope above describes how to reach it.

IPD_ICU_FORM — request and response

IPD_ICU_FORM

Read chart category. Assembled ICU view: front, tpr, intake_outtake, eye_movement and position_ent. FAST HUGS BID lives under front.fasthug; it is not a standalone /ipd/forms name.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_ICU_FORM"
}

Response fields: IcuResponse.

IPD_GENERAL_OBSERVATIONS — request and response

IPD_GENERAL_OBSERVATIONS

Read chart category. Stored general observations. Entries are service-defined; no stable nested response DTO is declared by the upstream API.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_GENERAL_OBSERVATIONS"
}

Response fields: Response_IPD_GENERAL_OBSERVATIONS.

IPD_ASSESSMENT_DETAILS — request and response

IPD_ASSESSMENT_DETAILS

Read chart category. Stored assessment details. The inner content follows the assessment template; it is not one fixed schema.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_ASSESSMENT_DETAILS"
}

Response fields: Response_IPD_ASSESSMENT_DETAILS.

IPD_PRESCRIPTION_ADMINISTRATIONS — request and response

IPD_PRESCRIPTION_ADMINISTRATIONS

Read chart category. Medication administration entries; preserve the record and actor IDs and the stated administration time.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "IPD_PRESCRIPTION_ADMINISTRATIONS"
}

Response fields: Response_IPD_PRESCRIPTION_ADMINISTRATIONS.

Nested clinical field definition: PrescriptionAdministration. Clinical record models describe content; the response envelope above describes how to reach it.

update_ipd_data — request and response

update_ipd_data

Write: extract chart data from edited notes. Requires interaction_id and non-null data. data is notes text or an object serialized to JSON by the wrapper. The upstream extracts chart information; this is not a generic JSON patch operation. Optional doctor_id/nurse_id are internal IDs and are not inferred from the external clinician IDs on this branch. Omit org_id; the server derives it. If supplied, it must match the hospital.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "update_ipd_data",
  "interaction_id": "${INTERACTION_ID}",
  "data": "${EDITED_NOTE_TEXT}"
}

Response fields: WriteResponse.

ingest_chart_data — request and response

ingest_chart_data

Write: persist returned chart structure. Send interaction_id and structured_data containing ONE supported chart category with the returned record structure and your edits. The upstream handles only its first recognized category, so do not combine unrelated charts in one update. Preserve nested interaction IDs. Supported write categories are listed below; the current ingestion handler does not support nutrition writes.

{
  "hospital_id": "${HOSPITAL_ID}",
  "hospital_inpatient_id": "${HMS_ADMISSION_ID}",
  "caregiver_id": "${CAREGIVER_ID}",
  "form_name": "ingest_chart_data",
  "interaction_id": "${INTERACTION_ID}",
  "structured_data": {
    "IPD_VITALS": []
  }
}

Response fields: IngestResponse.

Chart edit procedure

  1. Read the exact form and retain its full record, including nested interaction IDs.
  2. Modify only the intended values. Missing values are not equivalent to false or zero.
  3. For ingest_chart_data, replace the empty array in the template with the returned edited records. Supported structured_data write keys: IPD_VITALS, IPD_INTAKE_OUTTAKE, IPD_VASCULAR_BUNDLE, IPD_PRESCRIPTION_ADMINISTRATIONS, IPD_BLOOD_GLUCOSE_MONITORING, IPD_CAUTI_BUNDLE, IPD_CLABSI_BUNDLE, IPD_BLOOD_TRANSFUSION, IPD_ICU_FORM, IPD_VENTI_FORM. Send one category per call.
  4. Read the same form again and verify the persisted values. An acknowledgement is not the updated chart.

Empty data, response types and errors

Do not unwrap every result through data: stored notes use resultData; notes use notes; charts use structured_data; the drug chart uses merged_schema; generated documents use data. Empty collections and null values must be handled explicitly. Clinical extraction can serialize unfilled nested values as null even when the source model names a string/object; false and zero remain real values. Preserve fields your client does not edit.

HTTP statusMeaning
400Missing common or form-specific input; unknown form_name; upstream validation failure. Unknown form errors include allowed, but that array is not an exhaustive catalogue of aliases/categories.
401 / 403API-key/hospital access failure; mismatched org_id on update_ipd_data.
404Hospital/admission/clinician or stored note not found; no interaction for discharge generation.
422Upstream validation error where the delegated proxy preserves it.
500Unhandled form/generation error; doctor/nurse notes failures can be flattened to the generic form error.
502 / 503Delegated service failure or unavailable configuration. Retry reads cautiously; read back state before retrying writes.

Errors may have message, success or status, and optional details/error depending on the handler. There is no one universal error envelope. No pagination, webhooks, idempotency key or ETag contract is declared on /ipd/forms.

Dedicated retrieval endpoints

These GET endpoints use the CareScribe inpatient_id, not the HMS admission identifier:

GET /software/get-all-ipd-notes-grouped-by-date
    ?hospital_id=YOUR_HOSPITAL_ID
    &inpatient_id=CARESCRIBE_INPATIENT_ID
    &patient_id=CARESCRIBE_PATIENT_ID

GET /software/get-drug-chart
    ?hospital_id=YOUR_HOSPITAL_ID
    &inpatient_id=CARESCRIBE_INPATIENT_ID
    &patient_id=CARESCRIBE_PATIENT_ID

Join each path and its query parameters into one URL. patient_id is optional for these two endpoints. Grouped notes return structured_data. To look up admissions, use GET /software/inpatient/list?hospital_id=YOUR_HOSPITAL_ID and match the admission before saving its internal identifiers.

8. Review, approve and complete TODOs (optional)

Use these APIs when the HMS displays, approves or completes care tasks. They are separate from /software/ipd/forms and from the medication chart. Use X-API-Key on every request. Every route requires hospital_id and hospital_inpatient_id in the query; these are HMS identifiers.

StepRoutePayload / response
1. Review tasksGET /software/doctortodoNo body. TaskResponse.
2. Approve interactionPUT /software/doctor/approvetodoAlso requires interaction_id in query. JSON {} approves stored tasks; edited approval body uses patient_id, inpatient_id and todo_data containing the returned interaction records. TaskRecord.
3. Retrieve approved tasksGET /software/nurse/todoNo body. NurseTaskResponse, including merged_todo when supplied.
4. Record executionPUT /software/nurse/updatestatusJSON TaskUpdate; preserve returned interaction_id, gcs_uri and todos.
Complete task edit code, field definitions and response behavior

Request construction using the real returned data

This JavaScript uses a fresh API response rather than invented task IDs. selectRecord and editTodos are your UI's record selection and editing functions. All writes require the user's intended clinical action.

const query = new URLSearchParams({hospital_id, hospital_inpatient_id});
const headers = {"X-API-Key": apiKey, "Content-Type": "application/json"};
const read = await fetch(`${baseUrl}/software/doctortodo?${query}`, {headers});
if (!read.ok) throw new Error(`Read failed: ${read.status}`);
const doctorTasks = await read.json();
const record = selectRecord(doctorTasks.todo_data);
if (!record?.interaction_id || !Array.isArray(record.todos)) throw new Error("No editable task record");
const approvalQuery = new URLSearchParams(query);
approvalQuery.set("interaction_id", String(record.interaction_id));
const approvedRecord = {...record, todos: editTodos(structuredClone(record.todos))};
const approval = await fetch(`${baseUrl}/software/doctor/approvetodo?${approvalQuery}`, {
  method: "PUT", headers,
  body: JSON.stringify({patient_id: doctorTasks.patient_id,
    inpatient_id: doctorTasks.inpatient_id, todo_data: [approvedRecord]})
});
if (!approval.ok) throw new Error(`Approval failed: ${approval.status}`);
const nurseRead = await fetch(`${baseUrl}/software/nurse/todo?${query}`, {headers});
if (!nurseRead.ok) throw new Error(`Nurse read failed: ${nurseRead.status}`);
const nurseTasks = await nurseRead.json();
const nurseRecord = selectRecord(nurseTasks.todo_data);
if (!nurseRecord?.interaction_id || !Array.isArray(nurseRecord.todos)) throw new Error("No nurse task record");
const update = await fetch(`${baseUrl}/software/nurse/updatestatus?${query}`, {
  method: "PUT", headers,
  body: JSON.stringify({...nurseRecord, todos: editTodos(structuredClone(nurseRecord.todos))})
});
if (!update.ok) throw new Error(`Update failed: ${update.status}`);
// Fetch nurse/todo again and verify the specific task, status and identifiers.

All task categories and fields

ToDoList includes investigations, opinions, prescription_tasks, monitoring_orders, nursing_care_orders, procedure_orders and deferred_orders. Deferred orders are conditional/future orders and must not be presented as immediately executable tasks. Each category links to its complete nested model below. Preserve todo_id, todo_version, source and any extra returned fields. merged_todo is an admission-wide flattened view; use the original todo_data record for updates so the correct interaction is retained.

Medication execution lives in frequency_morning/afternoon/evening/night slot arrays with frequency and status, alongside dosage_time and scheduled_date. Do not confuse a slot's completion status with med_status (order continuation/stop state). Task status values can vary by category and historical record; do not invent one shared enum. Investigations use investigation_type/details/status; opinions include reason and clinician/specialty fields. See the source field definitions below.

Success, empty data and service failures

The Node approval wrapper returns HTTP 200 with the upstream acknowledgement (commonly message only), even when the upstream approval returned 201. Nurse status updates return the upstream acknowledgement plus todo_data, which may be [] and is not a replacement for a fresh GET. The Node response filter only checks investigations, opinions and prescription_tasks in todos[0]; records containing only the newer task categories may be omitted from that immediate update response.

Known behavior: upstream server/network failures can produce HTTP 200 fallback success for approval/status writes without proving that the write persisted. A nurse read can fall back to todo_data: []; a doctor read can fall back to database interaction records rather than normal task records. Check record shape and read back the intended change. Do not equate an empty list with confirmed absence of tasks during an outage. Upstream 4xx errors are forwarded by approval/nurse handlers; local validation uses 400/404; unhandled errors use 500. No optimistic-concurrency contract is exposed on these four software routes.

Task-by-ID patching exists on the upstream service, but there is no corresponding software API route in this release. Do not call an invented PUT /software/doctortodo or send its expected_version contract to these endpoints.

9. Handover, discharge and other admission actions

Use these after admission setup when your product needs handover, a speciality dashboard or discharge. Generating a discharge summary, approving it and discharging the patient are separate actions.

Handover, dashboard, discharge approval and bed release — full contracts

These are separate software routes, not additional form_name values. All require X-API-Key. The body/query distinction matters.

GET /software/api/ipd/get_handover_notes

Query fieldRequiredMeaning
hospital_idYesHMS hospital ID.
patient_idYesHMS patient ID for this endpoint, despite its name; resolves hospital_patient_id.
hospital_inpatient_idYesHMS admission ID belonging to that patient.
caregiver_idYesRegistered HMS nurse ID.
typeNoDefaults to all. all returns all handovers; a non-all value requests the latest.

No request body. Response contains status, message, data (handover notes), handovered_nurse, patient_id and inpatient_id (resolved CareScribe IDs), nurse_id and interaction_id. The service retrieves the admission's handover; caregiver_id identifies the requester, not a guaranteed author filter. Organization time zone is applied. Missing inputs: 400; unknown hospital/patient/nurse/admission: 404; upstream failures: delegated status or 502.

POST /software/api/ipd/get_speciality_dashboard

Body fields hospital_id, patient_id and inpatient_id are required. Here patient_id and inpatient_id are CareScribe IDs. interaction_date is optional and defaults to all. The admission must have an assigned nurse. Returns {message, data}; data is the upstream speciality dashboard and is not a fixed clinical form DTO.

{
  "hospital_id": "${HOSPITAL_ID}",
  "patient_id": "${CARESCRIBE_PATIENT_ID}",
  "inpatient_id": "${CARESCRIBE_ADMISSION_ID}",
  "interaction_date": "all"
}

400 for missing fields; 404 for unknown hospital/patient/admission or no assigned nurse; upstream errors retain their HTTP status, with message/error; other failures return 500.

PATCH /software/api/ipd/approve-discharge-summary

Query requires hospital_id and CareScribe inpatient_id. Body uses a JSON boolean approved (defaults to true) and optional out_date (DD-MM-YYYY or an ISO timestamp). This writes approval metadata and out_date; it is a clinical mutation and is separate from document generation.

{
  "approved": true,
  "out_date": "${DISCHARGE_DATE_DD-MM-YYYY}"
}

When approved is true, a missing/unparseable out_date falls back to the server's current time; validate dates in your client before submitting. approved:false clears out_date and approved_at. Do not send strings such as "false": the handler coerces truthiness. Response: message, metadata (additional admission metadata including approved and, when approved, approved_at), inpatient {inpatient_id, patient_id, active, out_date}. This route does not change active or release a bed. 400 for missing hospital_id; 404 for hospital/admission mismatch; 500 for unhandled errors.

Provisioning, admission lookup and recording handover

The WebSocket guide covers admission setup and assignment. Use the software inpatient lookup/integration response to retain both HMS and CareScribe identifiers. Clinician provisioning is a separate setup operation. The IPD tester covers recording, forms and task calls. Completion of a recording does not itself approve tasks or discharge the patient.

Capabilities that are not exposed by /software/ipd/forms

No independent form_name is registered for handover, speciality_dashboard, discharge approval, read-all nurse care plans, care-plan editing, task-by-ID patches or the standalone FAST HUGS dashboard. Use the documented separate software route where one exists. Upstream-only routes are not part of the API-key HMS contract. Configured templates can add clinical fields, so retain unknown response keys.

Discharge the patient and release the linked bed
PATCH /software/inpatient/discharge?hospital_id=${HOSPITAL_ID}&patient_id=${CARESCRIBE_PATIENT_ID}

{"category": "Outpatient"}

Both query fields are required. Here patient_id is the internal CareScribe patient ID. Optional body category defaults to Outpatient. The handler selects the patient's admission by active status first and latest creation time; it does not accept an admission selector. Verify the intended admission before this action.

This sets the selected admission active=false, preserves an existing out_date or sets one, records discharge_datetime, releases linked beds and changes the patient's category. This is separate from generating or approving a discharge summary.

HTTP 200: {message, patient, inpatient, bed_release_count}. patient is the updated patient record; inpatient is {inpatient_id, patient_id, active: false, out_date} or null if none exists; bed_release_count is the number of released beds. Read the admission and bed list back to verify. Missing query: 400; unknown hospital/patient: 404; failure: 500.

Check your integration

  • Unexpected OPD output: check that hospital_inpatient_id is present and corresponds to the intended admission.
  • Wrong recording role: initialize with practitioner_id for a doctor or caregiver_id for a nurse. Avoid including both in a recording message.
  • Missing admission on a REST call: check whether that endpoint expects hospital_inpatient_id or inpatient_id, and verify the hospital mapping.
  • Lost final audio: wait for the recorder's final dataavailable event before sending stop. Do not resend the entire accumulated recording after streaming its chunks.
  • No processed result: keep the socket open after the creation acknowledgement. Surface errors and provide a timeout/recovery action in the partner UI.
  • Interrupted connection: retain any received interaction ID and check the admission's saved output before retrying. A fresh recording submission may create another interaction; do not assume retries are deduplicated.
  • New recording: use a new socket without an old interaction_id. Reuse the patient and admission identifiers only while they refer to the same patient and admission.
Minimum handover: existing WebSocket authentication/audio protocol + IPD initialization fields + hospital enablement + the IPD forms API. Add nurse provisioning for nurse recordings, and share admission lookup, charts and task APIs according to the partner's UI requirements.

Response and clinical field dictionary

Browse all response and nested field definitions

Envelope definitions describe the HTTP result. Clinical models describe nested record fields; retrieval may add metadata, reshape lists and serialize unfilled values as null. Required in a clinical model means required by that source model, not a guarantee that every historical stored response includes the field. No fields are marked required merely because a supplied example included them. Follow links for every nested object. JSON value denotes intentionally untyped service/template content.

AdministrationRecord

FieldType / nested definitionRequiredMeaning
drug_namestringOptional / source-dependent
administered_timestring | nullOptional / source-dependent
administered_bystringOptional / source-dependent
statusstring | nullOptional / source-dependent
notesstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "drug_name": {
      "title": "Drug Name",
      "type": "string"
    },
    "administered_time": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Administered Time"
    },
    "administered_by": {
      "title": "Administered By",
      "type": "string"
    },
    "status": {
      "anyOf": [
        {
          "enum": [
            "given",
            "withheld",
            "refused",
            "not_available",
            "patient_asleep"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Status"
    },
    "notes": {
      "title": "Notes",
      "type": "string"
    }
  },
  "title": "AdministrationRecord",
  "type": "object"
}
AllergyEntry

FieldType / nested definitionRequiredMeaning
substancestringOptional / source-dependent
reactionstringOptional / source-dependent
severitystring | nullOptional / source-dependent
recorded_bystring | nullOptional / source-dependent
sourcestring | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "substance": {
      "title": "Substance",
      "type": "string"
    },
    "reaction": {
      "title": "Reaction",
      "type": "string"
    },
    "severity": {
      "anyOf": [
        {
          "enum": [
            "mild",
            "moderate",
            "severe"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Severity"
    },
    "recorded_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Recorded By"
    },
    "source": {
      "anyOf": [
        {
          "enum": [
            "doctor",
            "nurse",
            "patient",
            "history"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Source"
    }
  },
  "title": "AllergyEntry",
  "type": "object"
}
AllergySection

FieldType / nested definitionRequiredMeaning
has_known_allergiesbooleanOptional / source-dependent
allergiesarray<string>Optional / source-dependent
Exact JSON field definition
{
  "properties": {
    "has_known_allergies": {
      "title": "Has Known Allergies",
      "type": "boolean"
    },
    "allergies": {
      "items": {
        "type": "string"
      },
      "title": "Allergies",
      "type": "array"
    }
  },
  "title": "AllergySection",
  "type": "object"
}
AssessmentTemplate

FieldType / nested definitionRequiredMeaning
template_testsstringYes
Exact JSON field definition
{
  "properties": {
    "template_tests": {
      "title": "Template Tests",
      "type": "string"
    }
  },
  "required": [
    "template_tests"
  ],
  "title": "AssessmentTemplate",
  "type": "object"
}
BTChecklist

FieldType / nested definitionRequiredMeaning
consent_signedboolean | nullOptional / source-dependent
pt_voidedboolean | nullOptional / source-dependent
bowel_emptiedboolean | nullOptional / source-dependent
bt_set_validboolean | nullOptional / source-dependent
cannula_potencyboolean | nullOptional / source-dependent
blood_warmthboolean | nullOptional / source-dependent
blood_clots_checkedboolean | nullOptional / source-dependent
pre_med_givenboolean | nullOptional / source-dependent
ns_flushboolean | nullOptional / source-dependent
post_bt_med_orderboolean | nullOptional / source-dependent
informed_supervisorboolean | nullOptional / source-dependent
informed_doctorboolean | nullOptional / source-dependent
billing_updatedboolean | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "consent_signed": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Consent Signed"
    },
    "pt_voided": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pt Voided"
    },
    "bowel_emptied": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Bowel Emptied"
    },
    "bt_set_valid": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Bt Set Valid"
    },
    "cannula_potency": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cannula Potency"
    },
    "blood_warmth": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Blood Warmth"
    },
    "blood_clots_checked": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Blood Clots Checked"
    },
    "pre_med_given": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pre Med Given"
    },
    "ns_flush": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ns Flush"
    },
    "post_bt_med_order": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Post Bt Med Order"
    },
    "informed_supervisor": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Informed Supervisor"
    },
    "informed_doctor": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Informed Doctor"
    },
    "billing_updated": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Billing Updated"
    }
  },
  "title": "BTChecklist",
  "type": "object"
}
BTClericalCheck

FieldType / nested definitionRequiredMeaning
pt_id_correctboolean | nullOptional / source-dependent
blood_pack_correctboolean | nullOptional / source-dependent
bt_record_correctboolean | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "pt_id_correct": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pt Id Correct"
    },
    "blood_pack_correct": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Blood Pack Correct"
    },
    "bt_record_correct": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Bt Record Correct"
    }
  },
  "title": "BTClericalCheck",
  "type": "object"
}
BTFluidMonitoring

FieldType / nested definitionRequiredMeaning
intervalstringOptional / source-dependent
timestringOptional / source-dependent
tempstringOptional / source-dependent
pulsestringOptional / source-dependent
respstringOptional / source-dependent
bpstringOptional / source-dependent
observationsstringOptional / source-dependent
urine_outputstringOptional / source-dependent
reaction_detectedbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "interval": {
      "title": "Interval",
      "type": "string"
    },
    "time": {
      "title": "Time",
      "type": "string"
    },
    "temp": {
      "title": "Temp",
      "type": "string"
    },
    "pulse": {
      "title": "Pulse",
      "type": "string"
    },
    "resp": {
      "title": "Resp",
      "type": "string"
    },
    "bp": {
      "title": "Bp",
      "type": "string"
    },
    "observations": {
      "title": "Observations",
      "type": "string"
    },
    "urine_output": {
      "title": "Urine Output",
      "type": "string"
    },
    "reaction_detected": {
      "title": "Reaction Detected",
      "type": "boolean"
    }
  },
  "title": "BTFluidMonitoring",
  "type": "object"
}
BTPostTransfusion

FieldType / nested definitionRequiredMeaning
urine_color_qtyboolean | nullOptional / source-dependent
chest_breath_soundsboolean | nullOptional / source-dependent
bag_saved_24hrsboolean | nullOptional / source-dependent
blood_sent_hbboolean | nullOptional / source-dependent
post_bt_med_givenboolean | nullOptional / source-dependent
specifystringOptional / source-dependent
staff_signstringOptional / source-dependent
datestringOptional / source-dependent
timestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "urine_color_qty": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Urine Color Qty"
    },
    "chest_breath_sounds": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Chest Breath Sounds"
    },
    "bag_saved_24hrs": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Bag Saved 24Hrs"
    },
    "blood_sent_hb": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Blood Sent Hb"
    },
    "post_bt_med_given": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Post Bt Med Given"
    },
    "specify": {
      "title": "Specify",
      "type": "string"
    },
    "staff_sign": {
      "title": "Staff Sign",
      "type": "string"
    },
    "date": {
      "title": "Date",
      "type": "string"
    },
    "time": {
      "title": "Time",
      "type": "string"
    }
  },
  "title": "BTPostTransfusion",
  "type": "object"
}
BTPrevBloodProduct

FieldType / nested definitionRequiredMeaning
donor_unit_nostringOptional / source-dependent
product_typestringOptional / source-dependent
datestringOptional / source-dependent
time_unitsstringOptional / source-dependent
volumestringOptional / source-dependent
reactionstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "donor_unit_no": {
      "title": "Donor Unit No",
      "type": "string"
    },
    "product_type": {
      "title": "Product Type",
      "type": "string"
    },
    "date": {
      "title": "Date",
      "type": "string"
    },
    "time_units": {
      "title": "Time Units",
      "type": "string"
    },
    "volume": {
      "title": "Volume",
      "type": "string"
    },
    "reaction": {
      "title": "Reaction",
      "type": "string"
    }
  },
  "title": "BTPrevBloodProduct",
  "type": "object"
}
BTReactionReport

FieldType / nested definitionRequiredMeaning
clinical_diagnosisstringOptional / source-dependent
product_transfusedstringOptional / source-dependent
time_commencedstringOptional / source-dependent
donation_pack_nostringOptional / source-dependent
volume_transfusedstringOptional / source-dependent
clerical_checkBTClericalCheckOptional / source-dependent
temp_24h_priorstringOptional / source-dependent Values: , febrile, afebrile
pre_reaction_vitalsBTReactionVitalsOptional / source-dependent
post_reaction_vitalsBTReactionVitalsOptional / source-dependent
signs_symptomsBTReactionSignsOptional / source-dependent
prev_blood_productsarray<BTPrevBloodProduct>Optional / source-dependent
reviewing_doctorsstringOptional / source-dependent
signaturestringOptional / source-dependent
namestringOptional / source-dependent
sign_datestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "clinical_diagnosis": {
      "title": "Clinical Diagnosis",
      "type": "string"
    },
    "product_transfused": {
      "title": "Product Transfused",
      "type": "string"
    },
    "time_commenced": {
      "title": "Time Commenced",
      "type": "string"
    },
    "donation_pack_no": {
      "title": "Donation Pack No",
      "type": "string"
    },
    "volume_transfused": {
      "title": "Volume Transfused",
      "type": "string"
    },
    "clerical_check": {
      "$ref": "#/$defs/BTClericalCheck"
    },
    "temp_24h_prior": {
      "enum": [
        "",
        "febrile",
        "afebrile"
      ],
      "title": "Temp 24H Prior",
      "type": "string"
    },
    "pre_reaction_vitals": {
      "$ref": "#/$defs/BTReactionVitals"
    },
    "post_reaction_vitals": {
      "$ref": "#/$defs/BTReactionVitals"
    },
    "signs_symptoms": {
      "$ref": "#/$defs/BTReactionSigns"
    },
    "prev_blood_products": {
      "items": {
        "$ref": "#/$defs/BTPrevBloodProduct"
      },
      "title": "Prev Blood Products",
      "type": "array"
    },
    "reviewing_doctors": {
      "title": "Reviewing Doctors",
      "type": "string"
    },
    "signature": {
      "title": "Signature",
      "type": "string"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "sign_date": {
      "title": "Sign Date",
      "type": "string"
    }
  },
  "title": "BTReactionReport",
  "type": "object"
}
BTReactionSigns

FieldType / nested definitionRequiredMeaning
feverbooleanOptional / source-dependent
chillsbooleanOptional / source-dependent
nausea_vomitingbooleanOptional / source-dependent
hives_itchingbooleanOptional / source-dependent
lower_back_painbooleanOptional / source-dependent
chest_painbooleanOptional / source-dependent
anxietybooleanOptional / source-dependent
headachebooleanOptional / source-dependent
skin_pallorbooleanOptional / source-dependent
dark_urinebooleanOptional / source-dependent
dyspnoeabooleanOptional / source-dependent
bleeding_iv_sitebooleanOptional / source-dependent
othersstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "fever": {
      "title": "Fever",
      "type": "boolean"
    },
    "chills": {
      "title": "Chills",
      "type": "boolean"
    },
    "nausea_vomiting": {
      "title": "Nausea Vomiting",
      "type": "boolean"
    },
    "hives_itching": {
      "title": "Hives Itching",
      "type": "boolean"
    },
    "lower_back_pain": {
      "title": "Lower Back Pain",
      "type": "boolean"
    },
    "chest_pain": {
      "title": "Chest Pain",
      "type": "boolean"
    },
    "anxiety": {
      "title": "Anxiety",
      "type": "boolean"
    },
    "headache": {
      "title": "Headache",
      "type": "boolean"
    },
    "skin_pallor": {
      "title": "Skin Pallor",
      "type": "boolean"
    },
    "dark_urine": {
      "title": "Dark Urine",
      "type": "boolean"
    },
    "dyspnoea": {
      "title": "Dyspnoea",
      "type": "boolean"
    },
    "bleeding_iv_site": {
      "title": "Bleeding Iv Site",
      "type": "boolean"
    },
    "others": {
      "title": "Others",
      "type": "string"
    }
  },
  "title": "BTReactionSigns",
  "type": "object"
}
BTReactionVitals

FieldType / nested definitionRequiredMeaning
timestringOptional / source-dependent
tempstringOptional / source-dependent
resp_ratestringOptional / source-dependent
bpstringOptional / source-dependent
pulse_ratestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "time": {
      "title": "Time",
      "type": "string"
    },
    "temp": {
      "title": "Temp",
      "type": "string"
    },
    "resp_rate": {
      "title": "Resp Rate",
      "type": "string"
    },
    "bp": {
      "title": "Bp",
      "type": "string"
    },
    "pulse_rate": {
      "title": "Pulse Rate",
      "type": "string"
    }
  },
  "title": "BTReactionVitals",
  "type": "object"
}
BasicInformation

FieldType / nested definitionRequiredMeaning
how_admittedstringYes
attendant_presentstringYes
mother_tonguestringYes
allergiesstringYes
blood_groupstringOptional / source-dependent
heightstringYes
weightstringYes
vitalsarray<NurseAssessmentVitals>Yes
special_notesstringYes
consultantstringYes
oralstringYes
Exact JSON field definition
{
  "properties": {
    "how_admitted": {
      "title": "How Admitted",
      "type": "string"
    },
    "attendant_present": {
      "title": "Attendant Present",
      "type": "string"
    },
    "mother_tongue": {
      "title": "Mother Tongue",
      "type": "string"
    },
    "allergies": {
      "title": "Allergies",
      "type": "string"
    },
    "blood_group": {
      "title": "Blood Group",
      "type": "string"
    },
    "height": {
      "title": "Height",
      "type": "string"
    },
    "weight": {
      "title": "Weight",
      "type": "string"
    },
    "vitals": {
      "items": {
        "$ref": "#/$defs/NurseAssessmentVitals"
      },
      "title": "Vitals",
      "type": "array"
    },
    "special_notes": {
      "title": "Special Notes",
      "type": "string"
    },
    "consultant": {
      "title": "Consultant",
      "type": "string"
    },
    "oral": {
      "title": "Oral",
      "type": "string"
    }
  },
  "required": [
    "how_admitted",
    "attendant_present",
    "mother_tongue",
    "allergies",
    "height",
    "weight",
    "vitals",
    "special_notes",
    "consultant",
    "oral"
  ],
  "title": "BasicInformation",
  "type": "object"
}
BloodBorne

FieldType / nested definitionRequiredMeaning
hivstring | nullOptional / source-dependent
hcvstring | nullOptional / source-dependent
hbvstring | nullOptional / source-dependent
syphilisstring | nullOptional / source-dependent
htlvstring | nullOptional / source-dependent
malariastring | nullOptional / source-dependent
cmvstring | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "hiv": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Hiv"
    },
    "hcv": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Hcv"
    },
    "hbv": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Hbv"
    },
    "syphilis": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Syphilis"
    },
    "htlv": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Htlv"
    },
    "malaria": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Malaria"
    },
    "cmv": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cmv"
    }
  },
  "title": "BloodBorne",
  "type": "object"
}
BloodTransfusionFields

FieldType / nested definitionRequiredMeaning
blood_transfusion_reaction_reportobjectOptional / source-dependent
blood_transfusion_reaction_report.datestringSource-dependent
blood_transfusion_reaction_report.clinical_diagnosisstringSource-dependent
blood_transfusion_reaction_report.product_transfusedstringSource-dependent
blood_transfusion_reaction_report.time_commencedstringSource-dependent
blood_transfusion_reaction_report.donation_pack_numberstringSource-dependent
blood_transfusion_reaction_report.volume_transfusedstringSource-dependent
blood_transfusion_reaction_report.patient_id_correctJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_reaction_report.blood_pack_correctJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_reaction_report.blood_transfusion_record_correctJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_reaction_report.febrilebooleanSource-dependent
blood_transfusion_reaction_report.afebrilebooleanSource-dependent
blood_transfusion_reaction_report.vital_signsobjectSource-dependent
blood_transfusion_reaction_report.vital_signs.pre_reactionobjectSource-dependent
blood_transfusion_reaction_report.vital_signs.pre_reaction.timestringSource-dependent
blood_transfusion_reaction_report.vital_signs.pre_reaction.temperaturestringSource-dependent
blood_transfusion_reaction_report.vital_signs.pre_reaction.respiratory_ratestringSource-dependent
blood_transfusion_reaction_report.vital_signs.pre_reaction.bpstringSource-dependent
blood_transfusion_reaction_report.vital_signs.pre_reaction.pulse_ratestringSource-dependent
blood_transfusion_reaction_report.vital_signs.post_reactionobjectSource-dependent
blood_transfusion_reaction_report.vital_signs.post_reaction.timestringSource-dependent
blood_transfusion_reaction_report.vital_signs.post_reaction.temperaturestringSource-dependent
blood_transfusion_reaction_report.vital_signs.post_reaction.respiratory_ratestringSource-dependent
blood_transfusion_reaction_report.vital_signs.post_reaction.bpstringSource-dependent
blood_transfusion_reaction_report.vital_signs.post_reaction.pulse_ratestringSource-dependent
blood_transfusion_reaction_report.signs_and_symptomsobjectSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.feverbooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.chillsbooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.nausea_vomitingbooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.hives_itchingbooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.lower_back_painbooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.chest_painbooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.anxietybooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.headachebooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.skin_pallorbooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.dark_urinebooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.dyspnoeabooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.bleeding_from_wound_or_iv_sitebooleanSource-dependent
blood_transfusion_reaction_report.signs_and_symptoms.othersstringSource-dependent
blood_transfusion_reaction_report.previous_blood_productsarray<object>Source-dependent
blood_transfusion_reaction_report.previous_blood_products[].datestringSource-dependent
blood_transfusion_reaction_report.previous_blood_products[].donor_unit_nostringSource-dependent
blood_transfusion_reaction_report.previous_blood_products[].product_typestringSource-dependent
blood_transfusion_reaction_report.previous_blood_products[].reactionstringSource-dependent
blood_transfusion_reaction_report.previous_blood_products[].time_unitsstringSource-dependent
blood_transfusion_reaction_report.previous_blood_products[].volumestringSource-dependent
blood_transfusion_reaction_report.reviewing_doctorsstringSource-dependent
blood_transfusion_reaction_report.signaturestringSource-dependent
blood_transfusion_reaction_report.namestringSource-dependent
blood_transfusion_reaction_report.sign_datestringSource-dependent
blood_transfusion_reaction_report.note_timestringSource-dependent
blood_transfusion_reaction_report.timestampstringSource-dependent
blood_transfusion_reaction_report.interaction_idstringSource-dependent
blood_transfusion_monitoring_sheetobjectOptional / source-dependent
blood_transfusion_monitoring_sheet.location_of_blood_transfusionstringSource-dependent
blood_transfusion_monitoring_sheet.blood_groupstringSource-dependent
blood_transfusion_monitoring_sheet.diagnosisstringSource-dependent
blood_transfusion_monitoring_sheet.indicationstringSource-dependent
blood_transfusion_monitoring_sheet.number_of_unitsstringSource-dependent
blood_transfusion_monitoring_sheet.type_of_componentstringSource-dependent
blood_transfusion_monitoring_sheet.pack_nostringSource-dependent
blood_transfusion_monitoring_sheet.blood_group_of_productsstringSource-dependent
blood_transfusion_monitoring_sheet.date_of_cross_matchstringSource-dependent
blood_transfusion_monitoring_sheet.expiry_datestringSource-dependent
blood_transfusion_monitoring_sheet.checked_by_doctor_namestringSource-dependent
blood_transfusion_monitoring_sheet.checked_by_signaturestringSource-dependent
blood_transfusion_monitoring_sheet.checked_by_datestringSource-dependent
blood_transfusion_monitoring_sheet.checked_by_timestringSource-dependent
blood_transfusion_monitoring_sheet.time_out_before_transfusionobjectSource-dependent
blood_transfusion_monitoring_sheet.time_out_before_transfusion.correct_patientJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.time_out_before_transfusion.correct_blood_groupJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.time_out_before_transfusion.correct_componentJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.pre_medicationarray<JSON value>Source-dependent
blood_transfusion_monitoring_sheet.post_medicationarray<JSON value>Source-dependent
blood_transfusion_monitoring_sheet.doctor_namestringSource-dependent
blood_transfusion_monitoring_sheet.doctor_signaturestringSource-dependent
blood_transfusion_monitoring_sheet.bt_nurses_recordobjectSource-dependent
blood_transfusion_monitoring_sheet.bt_nurses_record.consent_for_transfusionJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.bt_nurses_record.assigned_nurse_signaturestringSource-dependent
blood_transfusion_monitoring_sheet.bt_nurses_record.cross_checked_bystringSource-dependent
blood_transfusion_monitoring_sheet.note_timestringSource-dependent
blood_transfusion_monitoring_sheet.timestampstringSource-dependent
blood_transfusion_monitoring_sheet.interaction_idstringSource-dependent
blood_transfusion_monitoring_sheet.fluid_volume_infusedstringSource-dependent
blood_transfusion_monitoring_sheet.checklistobjectSource-dependent
blood_transfusion_monitoring_sheet.checklist.bt_consent_signedJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.patient_voidedJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.bowel_emptiedJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.validity_of_blood_transfusion_set_checkedJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.cannula_potency_checkedJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.blood_warmth_checkedJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.check_blood_clots_any_visible_particleJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.pre_medication_givenJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.ns_100ml_50ml_transfusedJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.post_bt_medication_orderJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.informed_nursing_supervisorJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.information_to_doctor_concernedJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.checklist.updating_billing_sheetJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.fluid_monitoringarray<object>Source-dependent
blood_transfusion_monitoring_sheet.fluid_monitoring[].labelstringSource-dependent
blood_transfusion_monitoring_sheet.fluid_monitoring[].timestringSource-dependent
blood_transfusion_monitoring_sheet.fluid_monitoring[].temperaturestringSource-dependent
blood_transfusion_monitoring_sheet.fluid_monitoring[].pulsestringSource-dependent
blood_transfusion_monitoring_sheet.fluid_monitoring[].respirationstringSource-dependent
blood_transfusion_monitoring_sheet.fluid_monitoring[].bpstringSource-dependent
blood_transfusion_monitoring_sheet.fluid_monitoring[].observationsstringSource-dependent
blood_transfusion_monitoring_sheet.fluid_monitoring[].urine_outputstringSource-dependent
blood_transfusion_monitoring_sheet.fluid_monitoring[].reaction_detectedJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.post_transfusion_recordobjectSource-dependent
blood_transfusion_monitoring_sheet.post_transfusion_record.observe_urine_color_and_quantityJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.post_transfusion_record.assess_chest_and_breath_soundsJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.post_transfusion_record.save_transfusion_bag_for_24hrsJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.post_transfusion_record.send_blood_for_reevaluation_of_hb_percentJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.post_transfusion_record.post_bt_medication_givenJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
blood_transfusion_monitoring_sheet.post_transfusion_record.specifystringSource-dependent
note_timestringOptional / source-dependent
timestampstringOptional / source-dependent
interaction_idstringOptional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "blood_transfusion_reaction_report": {
      "type": "object",
      "properties": {
        "date": {
          "type": "string"
        },
        "clinical_diagnosis": {
          "type": "string"
        },
        "product_transfused": {
          "type": "string"
        },
        "time_commenced": {
          "type": "string"
        },
        "donation_pack_number": {
          "type": "string"
        },
        "volume_transfused": {
          "type": "string"
        },
        "patient_id_correct": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "blood_pack_correct": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "blood_transfusion_record_correct": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "febrile": {
          "type": "boolean"
        },
        "afebrile": {
          "type": "boolean"
        },
        "vital_signs": {
          "type": "object",
          "properties": {
            "pre_reaction": {
              "type": "object",
              "properties": {
                "time": {
                  "type": "string"
                },
                "temperature": {
                  "type": "string"
                },
                "respiratory_rate": {
                  "type": "string"
                },
                "bp": {
                  "type": "string"
                },
                "pulse_rate": {
                  "type": "string"
                }
              },
              "additionalProperties": true
            },
            "post_reaction": {
              "type": "object",
              "properties": {
                "time": {
                  "type": "string"
                },
                "temperature": {
                  "type": "string"
                },
                "respiratory_rate": {
                  "type": "string"
                },
                "bp": {
                  "type": "string"
                },
                "pulse_rate": {
                  "type": "string"
                }
              },
              "additionalProperties": true
            }
          },
          "additionalProperties": true
        },
        "signs_and_symptoms": {
          "type": "object",
          "properties": {
            "fever": {
              "type": "boolean"
            },
            "chills": {
              "type": "boolean"
            },
            "nausea_vomiting": {
              "type": "boolean"
            },
            "hives_itching": {
              "type": "boolean"
            },
            "lower_back_pain": {
              "type": "boolean"
            },
            "chest_pain": {
              "type": "boolean"
            },
            "anxiety": {
              "type": "boolean"
            },
            "headache": {
              "type": "boolean"
            },
            "skin_pallor": {
              "type": "boolean"
            },
            "dark_urine": {
              "type": "boolean"
            },
            "dyspnoea": {
              "type": "boolean"
            },
            "bleeding_from_wound_or_iv_site": {
              "type": "boolean"
            },
            "others": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "previous_blood_products": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "donor_unit_no": {
                "type": "string"
              },
              "product_type": {
                "type": "string"
              },
              "reaction": {
                "type": "string"
              },
              "time_units": {
                "type": "string"
              },
              "volume": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "reviewing_doctors": {
          "type": "string"
        },
        "signature": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "sign_date": {
          "type": "string"
        },
        "note_time": {
          "type": "string"
        },
        "timestamp": {
          "type": "string"
        },
        "interaction_id": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "blood_transfusion_monitoring_sheet": {
      "type": "object",
      "properties": {
        "location_of_blood_transfusion": {
          "type": "string"
        },
        "blood_group": {
          "type": "string"
        },
        "diagnosis": {
          "type": "string"
        },
        "indication": {
          "type": "string"
        },
        "number_of_units": {
          "type": "string"
        },
        "type_of_component": {
          "type": "string"
        },
        "pack_no": {
          "type": "string"
        },
        "blood_group_of_products": {
          "type": "string"
        },
        "date_of_cross_match": {
          "type": "string"
        },
        "expiry_date": {
          "type": "string"
        },
        "checked_by_doctor_name": {
          "type": "string"
        },
        "checked_by_signature": {
          "type": "string"
        },
        "checked_by_date": {
          "type": "string"
        },
        "checked_by_time": {
          "type": "string"
        },
        "time_out_before_transfusion": {
          "type": "object",
          "properties": {
            "correct_patient": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "correct_blood_group": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "correct_component": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            }
          },
          "additionalProperties": true
        },
        "pre_medication": {
          "type": "array",
          "items": {
            "description": "Service-defined JSON value; preserve its returned type and fields."
          }
        },
        "post_medication": {
          "type": "array",
          "items": {
            "description": "Service-defined JSON value; preserve its returned type and fields."
          }
        },
        "doctor_name": {
          "type": "string"
        },
        "doctor_signature": {
          "type": "string"
        },
        "bt_nurses_record": {
          "type": "object",
          "properties": {
            "consent_for_transfusion": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "assigned_nurse_signature": {
              "type": "string"
            },
            "cross_checked_by": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "note_time": {
          "type": "string"
        },
        "timestamp": {
          "type": "string"
        },
        "interaction_id": {
          "type": "string"
        },
        "fluid_volume_infused": {
          "type": "string"
        },
        "checklist": {
          "type": "object",
          "properties": {
            "bt_consent_signed": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "patient_voided": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "bowel_emptied": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "validity_of_blood_transfusion_set_checked": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "cannula_potency_checked": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "blood_warmth_checked": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "check_blood_clots_any_visible_particle": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "pre_medication_given": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "ns_100ml_50ml_transfused": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "post_bt_medication_order": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "informed_nursing_supervisor": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "information_to_doctor_concerned": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "updating_billing_sheet": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            }
          },
          "additionalProperties": true
        },
        "fluid_monitoring": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "label": {
                "type": "string"
              },
              "time": {
                "type": "string"
              },
              "temperature": {
                "type": "string"
              },
              "pulse": {
                "type": "string"
              },
              "respiration": {
                "type": "string"
              },
              "bp": {
                "type": "string"
              },
              "observations": {
                "type": "string"
              },
              "urine_output": {
                "type": "string"
              },
              "reaction_detected": {
                "description": "Service-defined JSON value; preserve its returned type and fields."
              }
            },
            "additionalProperties": true
          }
        },
        "post_transfusion_record": {
          "type": "object",
          "properties": {
            "observe_urine_color_and_quantity": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "assess_chest_and_breath_sounds": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "save_transfusion_bag_for_24hrs": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "send_blood_for_reevaluation_of_hb_percent": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "post_bt_medication_given": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "specify": {
              "type": "string"
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "note_time": {
      "type": "string"
    },
    "timestamp": {
      "type": "string"
    },
    "interaction_id": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
BloodTransfusionResponse

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
structured_dataobjectYes
structured_data.IPD_BLOOD_TRANSFUSIONBloodTransfusionFieldsSource-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_BLOOD_TRANSFUSION": {
          "$ref": "#/$defs/BloodTransfusionFields"
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "inpatient_id",
    "structured_data"
  ]
}
BradenScale

FieldType / nested definitionRequiredMeaning
sensory_perceptioninteger | nullOptional / source-dependent
moistureinteger | nullOptional / source-dependent
activityinteger | nullOptional / source-dependent
mobilityinteger | nullOptional / source-dependent
nutritioninteger | nullOptional / source-dependent
friction_and_shearinteger | nullOptional / source-dependent
total_scoreinteger | nullOptional / source-dependent
risk_levelstring | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "sensory_perception": {
      "anyOf": [
        {
          "maximum": 4,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sensory Perception"
    },
    "moisture": {
      "anyOf": [
        {
          "maximum": 4,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Moisture"
    },
    "activity": {
      "anyOf": [
        {
          "maximum": 4,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Activity"
    },
    "mobility": {
      "anyOf": [
        {
          "maximum": 4,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Mobility"
    },
    "nutrition": {
      "anyOf": [
        {
          "maximum": 4,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Nutrition"
    },
    "friction_and_shear": {
      "anyOf": [
        {
          "maximum": 3,
          "minimum": 1,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Friction And Shear"
    },
    "total_score": {
      "anyOf": [
        {
          "maximum": 23,
          "minimum": 6,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Total Score"
    },
    "risk_level": {
      "anyOf": [
        {
          "enum": [
            "severe risk",
            "high risk",
            "moderate risk",
            "mild risk",
            "no risk"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Risk Level"
    }
  },
  "title": "BradenScale",
  "type": "object"
}
CautiActionTaken

FieldType / nested definitionRequiredMeaning
actionstringOptional / source-dependent
datestringOptional / source-dependent
signaturestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "action": {
      "title": "Action",
      "type": "string"
    },
    "date": {
      "title": "Date",
      "type": "string"
    },
    "signature": {
      "title": "Signature",
      "type": "string"
    }
  },
  "title": "CautiActionTaken",
  "type": "object"
}
CautiBundle

FieldType / nested definitionRequiredMeaning
insertion_checklist_formCautiInsertionChecklistFormOptional / source-dependent
daily_maintenance_checklist_formCautiDailyMaintenanceChecklistFormOptional / source-dependent
removal_checklist_formCautiRemovalChecklistFormOptional / source-dependent
summary_formCautiSummaryFormOptional / source-dependent
is_form_completedbooleanOptional / source-dependent
form_completed_date_timestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "insertion_checklist_form": {
      "$ref": "#/$defs/CautiInsertionChecklistForm"
    },
    "daily_maintenance_checklist_form": {
      "$ref": "#/$defs/CautiDailyMaintenanceChecklistForm"
    },
    "removal_checklist_form": {
      "$ref": "#/$defs/CautiRemovalChecklistForm"
    },
    "summary_form": {
      "$ref": "#/$defs/CautiSummaryForm"
    },
    "is_form_completed": {
      "title": "Is Form Completed",
      "type": "boolean"
    },
    "form_completed_date_time": {
      "title": "Form Completed Date Time",
      "type": "string"
    }
  },
  "title": "CautiBundle",
  "type": "object"
}
CautiCatheterDetails

FieldType / nested definitionRequiredMeaning
type_of_catheterstringOptional / source-dependent Values: , foley, suprapubic, other
type_optionsCautiCatheterTypeOptionsOptional / source-dependent
sizestringOptional / source-dependent
date_time_of_insertionstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "type_of_catheter": {
      "enum": [
        "",
        "foley",
        "suprapubic",
        "other"
      ],
      "title": "Type Of Catheter",
      "type": "string"
    },
    "type_options": {
      "$ref": "#/$defs/CautiCatheterTypeOptions"
    },
    "size": {
      "title": "Size",
      "type": "string"
    },
    "date_time_of_insertion": {
      "title": "Date Time Of Insertion",
      "type": "string"
    }
  },
  "title": "CautiCatheterDetails",
  "type": "object"
}
CautiCatheterTypeOptions

FieldType / nested definitionRequiredMeaning
foleybooleanOptional / source-dependent
suprapubicbooleanOptional / source-dependent
otherstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "foley": {
      "title": "Foley",
      "type": "boolean"
    },
    "suprapubic": {
      "title": "Suprapubic",
      "type": "boolean"
    },
    "other": {
      "title": "Other",
      "type": "string"
    }
  },
  "title": "CautiCatheterTypeOptions",
  "type": "object"
}
CautiDailyMaintenanceChecklistForm

FieldType / nested definitionRequiredMeaning
date_of_insertionstringOptional / source-dependent
assessmentsarray<CautiDailyMonitoringEntry>Optional / source-dependent
signs_of_infectionCautiSignsOfInfectionOptional / source-dependent
action_takenCautiActionTakenOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "date_of_insertion": {
      "title": "Date Of Insertion",
      "type": "string"
    },
    "assessments": {
      "items": {
        "$ref": "#/$defs/CautiDailyMonitoringEntry"
      },
      "title": "Assessments",
      "type": "array"
    },
    "signs_of_infection": {
      "$ref": "#/$defs/CautiSignsOfInfection"
    },
    "action_taken": {
      "$ref": "#/$defs/CautiActionTaken"
    }
  },
  "title": "CautiDailyMaintenanceChecklistForm",
  "type": "object"
}
CautiDailyMonitoringEntry

FieldType / nested definitionRequiredMeaning
datestringOptional / source-dependent
timestringOptional / source-dependent
catheter_still_indicatedbooleanOptional / source-dependent
hand_hygiene_before_after_carebooleanOptional / source-dependent
catheter_secured_properlybooleanOptional / source-dependent
drainage_bag_below_bladderbooleanOptional / source-dependent
no_kinks_in_tubingbooleanOptional / source-dependent
closed_drainage_system_intactbooleanOptional / source-dependent
perineal_care_performedbooleanOptional / source-dependent
bag_not_touching_floorbooleanOptional / source-dependent
urine_clear_no_infection_signsbooleanOptional / source-dependent
culturebooleanOptional / source-dependent
pain_scorestringOptional / source-dependent
remarksstringOptional / source-dependent
signaturestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "date": {
      "title": "Date",
      "type": "string"
    },
    "time": {
      "title": "Time",
      "type": "string"
    },
    "catheter_still_indicated": {
      "title": "Catheter Still Indicated",
      "type": "boolean"
    },
    "hand_hygiene_before_after_care": {
      "title": "Hand Hygiene Before After Care",
      "type": "boolean"
    },
    "catheter_secured_properly": {
      "title": "Catheter Secured Properly",
      "type": "boolean"
    },
    "drainage_bag_below_bladder": {
      "title": "Drainage Bag Below Bladder",
      "type": "boolean"
    },
    "no_kinks_in_tubing": {
      "title": "No Kinks In Tubing",
      "type": "boolean"
    },
    "closed_drainage_system_intact": {
      "title": "Closed Drainage System Intact",
      "type": "boolean"
    },
    "perineal_care_performed": {
      "title": "Perineal Care Performed",
      "type": "boolean"
    },
    "bag_not_touching_floor": {
      "title": "Bag Not Touching Floor",
      "type": "boolean"
    },
    "urine_clear_no_infection_signs": {
      "title": "Urine Clear No Infection Signs",
      "type": "boolean"
    },
    "culture": {
      "title": "Culture",
      "type": "boolean"
    },
    "pain_score": {
      "title": "Pain Score",
      "type": "string"
    },
    "remarks": {
      "title": "Remarks",
      "type": "string"
    },
    "signature": {
      "title": "Signature",
      "type": "string"
    }
  },
  "title": "CautiDailyMonitoringEntry",
  "type": "object"
}
CautiIndicationForCatheter

FieldType / nested definitionRequiredMeaning
acute_urinary_retentionbooleanOptional / source-dependent
accurate_urine_output_monitoring_critically_illbooleanOptional / source-dependent
perioperative_usebooleanOptional / source-dependent
pressure_ulcer_managementbooleanOptional / source-dependent
otherstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "acute_urinary_retention": {
      "title": "Acute Urinary Retention",
      "type": "boolean"
    },
    "accurate_urine_output_monitoring_critically_ill": {
      "title": "Accurate Urine Output Monitoring Critically Ill",
      "type": "boolean"
    },
    "perioperative_use": {
      "title": "Perioperative Use",
      "type": "boolean"
    },
    "pressure_ulcer_management": {
      "title": "Pressure Ulcer Management",
      "type": "boolean"
    },
    "other": {
      "title": "Other",
      "type": "string"
    }
  },
  "title": "CautiIndicationForCatheter",
  "type": "object"
}
CautiInsertionBundleChecklist

FieldType / nested definitionRequiredMeaning
patient_identity_confirmedbooleanOptional / source-dependent
informed_consent_obtainedbooleanOptional / source-dependent
hand_hygiene_performedbooleanOptional / source-dependent
sterile_gloves_ppe_usedbooleanOptional / source-dependent
perineal_area_cleanedbooleanOptional / source-dependent
aseptic_technique_maintainedbooleanOptional / source-dependent
sterile_catheter_usedbooleanOptional / source-dependent
closed_drainage_system_maintainedbooleanOptional / source-dependent
catheter_secured_properlybooleanOptional / source-dependent
drainage_bag_below_bladder_levelbooleanOptional / source-dependent
no_kinks_obstruction_in_tubingbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "patient_identity_confirmed": {
      "title": "Patient Identity Confirmed",
      "type": "boolean"
    },
    "informed_consent_obtained": {
      "title": "Informed Consent Obtained",
      "type": "boolean"
    },
    "hand_hygiene_performed": {
      "title": "Hand Hygiene Performed",
      "type": "boolean"
    },
    "sterile_gloves_ppe_used": {
      "title": "Sterile Gloves Ppe Used",
      "type": "boolean"
    },
    "perineal_area_cleaned": {
      "title": "Perineal Area Cleaned",
      "type": "boolean"
    },
    "aseptic_technique_maintained": {
      "title": "Aseptic Technique Maintained",
      "type": "boolean"
    },
    "sterile_catheter_used": {
      "title": "Sterile Catheter Used",
      "type": "boolean"
    },
    "closed_drainage_system_maintained": {
      "title": "Closed Drainage System Maintained",
      "type": "boolean"
    },
    "catheter_secured_properly": {
      "title": "Catheter Secured Properly",
      "type": "boolean"
    },
    "drainage_bag_below_bladder_level": {
      "title": "Drainage Bag Below Bladder Level",
      "type": "boolean"
    },
    "no_kinks_obstruction_in_tubing": {
      "title": "No Kinks Obstruction In Tubing",
      "type": "boolean"
    }
  },
  "title": "CautiInsertionBundleChecklist",
  "type": "object"
}
CautiInsertionChecklistForm

FieldType / nested definitionRequiredMeaning
diagnosisstringOptional / source-dependent
catheter_detailsCautiCatheterDetailsOptional / source-dependent
indication_for_catheterCautiIndicationForCatheterOptional / source-dependent
insertion_bundle_checklistCautiInsertionBundleChecklistOptional / source-dependent
post_insertion_careCautiPostInsertionCareOptional / source-dependent
signaturesSignaturesOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "diagnosis": {
      "title": "Diagnosis",
      "type": "string"
    },
    "catheter_details": {
      "$ref": "#/$defs/CautiCatheterDetails"
    },
    "indication_for_catheter": {
      "$ref": "#/$defs/CautiIndicationForCatheter"
    },
    "insertion_bundle_checklist": {
      "$ref": "#/$defs/CautiInsertionBundleChecklist"
    },
    "post_insertion_care": {
      "$ref": "#/$defs/CautiPostInsertionCare"
    },
    "signatures": {
      "$ref": "#/$defs/Signatures"
    }
  },
  "title": "CautiInsertionChecklistForm",
  "type": "object"
}
CautiPostInsertionCare

FieldType / nested definitionRequiredMeaning
urine_flow_confirmedbooleanOptional / source-dependent
patient_comfortablebooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "urine_flow_confirmed": {
      "title": "Urine Flow Confirmed",
      "type": "boolean"
    },
    "patient_comfortable": {
      "title": "Patient Comfortable",
      "type": "boolean"
    }
  },
  "title": "CautiPostInsertionCare",
  "type": "object"
}
CautiPostRemovalObservation

FieldType / nested definitionRequiredMeaning
able_to_voidbooleanOptional / source-dependent
pain_discomfortbooleanOptional / source-dependent
retentionbooleanOptional / source-dependent
othersstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "able_to_void": {
      "title": "Able To Void",
      "type": "boolean"
    },
    "pain_discomfort": {
      "title": "Pain Discomfort",
      "type": "boolean"
    },
    "retention": {
      "title": "Retention",
      "type": "boolean"
    },
    "others": {
      "title": "Others",
      "type": "string"
    }
  },
  "title": "CautiPostRemovalObservation",
  "type": "object"
}
CautiRemovalChecklist

FieldType / nested definitionRequiredMeaning
doctors_order_verifiedbooleanOptional / source-dependent
catheter_no_longer_indicatedbooleanOptional / source-dependent
hand_hygiene_performedbooleanOptional / source-dependent
ppe_usedbooleanOptional / source-dependent
balloon_deflated_completelybooleanOptional / source-dependent
catheter_removed_gentlybooleanOptional / source-dependent
patient_monitored_post_removalbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "doctors_order_verified": {
      "title": "Doctors Order Verified",
      "type": "boolean"
    },
    "catheter_no_longer_indicated": {
      "title": "Catheter No Longer Indicated",
      "type": "boolean"
    },
    "hand_hygiene_performed": {
      "title": "Hand Hygiene Performed",
      "type": "boolean"
    },
    "ppe_used": {
      "title": "Ppe Used",
      "type": "boolean"
    },
    "balloon_deflated_completely": {
      "title": "Balloon Deflated Completely",
      "type": "boolean"
    },
    "catheter_removed_gently": {
      "title": "Catheter Removed Gently",
      "type": "boolean"
    },
    "patient_monitored_post_removal": {
      "title": "Patient Monitored Post Removal",
      "type": "boolean"
    }
  },
  "title": "CautiRemovalChecklist",
  "type": "object"
}
CautiRemovalChecklistForm

FieldType / nested definitionRequiredMeaning
type_of_catheterstringOptional / source-dependent
date_of_removalstringOptional / source-dependent
removal_checklistCautiRemovalChecklistOptional / source-dependent
post_removal_observationCautiPostRemovalObservationOptional / source-dependent
datestringOptional / source-dependent
signaturestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "type_of_catheter": {
      "title": "Type Of Catheter",
      "type": "string"
    },
    "date_of_removal": {
      "title": "Date Of Removal",
      "type": "string"
    },
    "removal_checklist": {
      "$ref": "#/$defs/CautiRemovalChecklist"
    },
    "post_removal_observation": {
      "$ref": "#/$defs/CautiPostRemovalObservation"
    },
    "date": {
      "title": "Date",
      "type": "string"
    },
    "signature": {
      "title": "Signature",
      "type": "string"
    }
  },
  "title": "CautiRemovalChecklistForm",
  "type": "object"
}
CautiSignsOfInfection

FieldType / nested definitionRequiredMeaning
feverbooleanOptional / source-dependent
burning_sensationbooleanOptional / source-dependent
cloudy_urinebooleanOptional / source-dependent
foul_smellbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "fever": {
      "title": "Fever",
      "type": "boolean"
    },
    "burning_sensation": {
      "title": "Burning Sensation",
      "type": "boolean"
    },
    "cloudy_urine": {
      "title": "Cloudy Urine",
      "type": "boolean"
    },
    "foul_smell": {
      "title": "Foul Smell",
      "type": "boolean"
    }
  },
  "title": "CautiSignsOfInfection",
  "type": "object"
}
CautiSummaryForm

FieldType / nested definitionRequiredMeaning
unitstringOptional / source-dependent
monthstringOptional / source-dependent
catheter_datestringOptional / source-dependent
indication_daysstringOptional / source-dependent
insitu_infectionbooleanOptional / source-dependent
remarksstringOptional / source-dependent
total_catheter_daysstringOptional / source-dependent
total_cauti_casesstringOptional / source-dependent
infection_control_nurse_signaturestringOptional / source-dependent
datestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "unit": {
      "title": "Unit",
      "type": "string"
    },
    "month": {
      "title": "Month",
      "type": "string"
    },
    "catheter_date": {
      "title": "Catheter Date",
      "type": "string"
    },
    "indication_days": {
      "title": "Indication Days",
      "type": "string"
    },
    "insitu_infection": {
      "title": "Insitu Infection",
      "type": "boolean"
    },
    "remarks": {
      "title": "Remarks",
      "type": "string"
    },
    "total_catheter_days": {
      "title": "Total Catheter Days",
      "type": "string"
    },
    "total_cauti_cases": {
      "title": "Total Cauti Cases",
      "type": "string"
    },
    "infection_control_nurse_signature": {
      "title": "Infection Control Nurse Signature",
      "type": "string"
    },
    "date": {
      "title": "Date",
      "type": "string"
    }
  },
  "title": "CautiSummaryForm",
  "type": "object"
}
ClabsiBundle

FieldType / nested definitionRequiredMeaning
central_line_insertionClabsiCentralLineInsertion | nullOptional / source-dependent
indication_for_central_lineClabsiIndicationForCentralLine | nullOptional / source-dependent
clabsi_bundle_complianceClabsiBundleCompliance | nullOptional / source-dependent
signaturesClabsiSignatures | nullOptional / source-dependent
daily_maintenancearray<ClabsiDailyMaintenanceEntry>Optional / source-dependent
dressing_change_checklistClabsiDressingChangeChecklist | nullOptional / source-dependent
central_line_removalClabsiCentralLineRemoval | nullOptional / source-dependent
culturebooleanOptional / source-dependent
antibioticsstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "central_line_insertion": {
      "anyOf": [
        {
          "$ref": "#/$defs/ClabsiCentralLineInsertion"
        },
        {
          "type": "null"
        }
      ]
    },
    "indication_for_central_line": {
      "anyOf": [
        {
          "$ref": "#/$defs/ClabsiIndicationForCentralLine"
        },
        {
          "type": "null"
        }
      ]
    },
    "clabsi_bundle_compliance": {
      "anyOf": [
        {
          "$ref": "#/$defs/ClabsiBundleCompliance"
        },
        {
          "type": "null"
        }
      ]
    },
    "signatures": {
      "anyOf": [
        {
          "$ref": "#/$defs/ClabsiSignatures"
        },
        {
          "type": "null"
        }
      ]
    },
    "daily_maintenance": {
      "items": {
        "$ref": "#/$defs/ClabsiDailyMaintenanceEntry"
      },
      "title": "Daily Maintenance",
      "type": "array"
    },
    "dressing_change_checklist": {
      "anyOf": [
        {
          "$ref": "#/$defs/ClabsiDressingChangeChecklist"
        },
        {
          "type": "null"
        }
      ]
    },
    "central_line_removal": {
      "anyOf": [
        {
          "$ref": "#/$defs/ClabsiCentralLineRemoval"
        },
        {
          "type": "null"
        }
      ]
    },
    "culture": {
      "title": "Culture",
      "type": "boolean"
    },
    "antibiotics": {
      "title": "Antibiotics",
      "type": "string"
    }
  },
  "title": "ClabsiBundle",
  "type": "object"
}
ClabsiBundleCompliance

FieldType / nested definitionRequiredMeaning
patient_identity_confirmedbooleanOptional / source-dependent
informed_consent_obtainedbooleanOptional / source-dependent
hand_hygiene_performedbooleanOptional / source-dependent
full_sterile_barrier_precautions_usedbooleanOptional / source-dependent
skin_antisepsis_with_chlorhexidinebooleanOptional / source-dependent
appropriate_site_selectedbooleanOptional / source-dependent
aseptic_technique_maintainedbooleanOptional / source-dependent
ultrasound_guidance_usedbooleanOptional / source-dependent
sterile_dressing_appliedbooleanOptional / source-dependent
line_secured_properlybooleanOptional / source-dependent
line_flushed_and_patentbooleanOptional / source-dependent
all_lumens_cappedbooleanOptional / source-dependent
dressing_clean_dry_intactbooleanOptional / source-dependent
date_time_label_appliedbooleanOptional / source-dependent
chest_xray_donebooleanOptional / source-dependent
procedure_documentedbooleanOptional / source-dependent
review_catheter_necessity_daily_and_remove_promptlybooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "patient_identity_confirmed": {
      "title": "Patient Identity Confirmed",
      "type": "boolean"
    },
    "informed_consent_obtained": {
      "title": "Informed Consent Obtained",
      "type": "boolean"
    },
    "hand_hygiene_performed": {
      "title": "Hand Hygiene Performed",
      "type": "boolean"
    },
    "full_sterile_barrier_precautions_used": {
      "title": "Full Sterile Barrier Precautions Used",
      "type": "boolean"
    },
    "skin_antisepsis_with_chlorhexidine": {
      "title": "Skin Antisepsis With Chlorhexidine",
      "type": "boolean"
    },
    "appropriate_site_selected": {
      "title": "Appropriate Site Selected",
      "type": "boolean"
    },
    "aseptic_technique_maintained": {
      "title": "Aseptic Technique Maintained",
      "type": "boolean"
    },
    "ultrasound_guidance_used": {
      "title": "Ultrasound Guidance Used",
      "type": "boolean"
    },
    "sterile_dressing_applied": {
      "title": "Sterile Dressing Applied",
      "type": "boolean"
    },
    "line_secured_properly": {
      "title": "Line Secured Properly",
      "type": "boolean"
    },
    "line_flushed_and_patent": {
      "title": "Line Flushed And Patent",
      "type": "boolean"
    },
    "all_lumens_capped": {
      "title": "All Lumens Capped",
      "type": "boolean"
    },
    "dressing_clean_dry_intact": {
      "title": "Dressing Clean Dry Intact",
      "type": "boolean"
    },
    "date_time_label_applied": {
      "title": "Date Time Label Applied",
      "type": "boolean"
    },
    "chest_xray_done": {
      "title": "Chest Xray Done",
      "type": "boolean"
    },
    "procedure_documented": {
      "title": "Procedure Documented",
      "type": "boolean"
    },
    "review_catheter_necessity_daily_and_remove_promptly": {
      "title": "Review Catheter Necessity Daily And Remove Promptly",
      "type": "boolean"
    }
  },
  "title": "ClabsiBundleCompliance",
  "type": "object"
}
ClabsiCentralLineInsertion

FieldType / nested definitionRequiredMeaning
line_typeClabsiCentralLineTypeOptional / source-dependent
siteClabsiCentralLineSiteOptional / source-dependent
date_of_insertionstringOptional / source-dependent
time_of_insertionstringOptional / source-dependent
central_line_placed_instringOptional / source-dependent
reasons_for_insertionstringOptional / source-dependent
inserted_by_namestringOptional / source-dependent
no_of_attemptsstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "line_type": {
      "$ref": "#/$defs/ClabsiCentralLineType"
    },
    "site": {
      "$ref": "#/$defs/ClabsiCentralLineSite"
    },
    "date_of_insertion": {
      "title": "Date Of Insertion",
      "type": "string"
    },
    "time_of_insertion": {
      "title": "Time Of Insertion",
      "type": "string"
    },
    "central_line_placed_in": {
      "title": "Central Line Placed In",
      "type": "string"
    },
    "reasons_for_insertion": {
      "title": "Reasons For Insertion",
      "type": "string"
    },
    "inserted_by_name": {
      "title": "Inserted By Name",
      "type": "string"
    },
    "no_of_attempts": {
      "title": "No Of Attempts",
      "type": "string"
    }
  },
  "title": "ClabsiCentralLineInsertion",
  "type": "object"
}
ClabsiCentralLineRemoval

FieldType / nested definitionRequiredMeaning
line_typestringOptional / source-dependent
sitestringOptional / source-dependent
date_of_removalstringOptional / source-dependent
doctors_order_verifiedbooleanOptional / source-dependent
line_no_longer_indicatedbooleanOptional / source-dependent
hand_hygiene_performedbooleanOptional / source-dependent
ppe_usedbooleanOptional / source-dependent
line_removed_using_aseptic_techniquebooleanOptional / source-dependent
catheter_tip_intactbooleanOptional / source-dependent
hemostasis_achievedbooleanOptional / source-dependent
sterile_dressing_appliedbooleanOptional / source-dependent
post_removal_monitoringClabsiPostRemovalMonitoringOptional / source-dependent
othersstringOptional / source-dependent
doctor_nursestringOptional / source-dependent
datestringOptional / source-dependent
signaturestringOptional / source-dependent
reasons_for_removalstringOptional / source-dependent
removed_bystringOptional / source-dependent
signstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "line_type": {
      "title": "Line Type",
      "type": "string"
    },
    "site": {
      "title": "Site",
      "type": "string"
    },
    "date_of_removal": {
      "title": "Date Of Removal",
      "type": "string"
    },
    "doctors_order_verified": {
      "title": "Doctors Order Verified",
      "type": "boolean"
    },
    "line_no_longer_indicated": {
      "title": "Line No Longer Indicated",
      "type": "boolean"
    },
    "hand_hygiene_performed": {
      "title": "Hand Hygiene Performed",
      "type": "boolean"
    },
    "ppe_used": {
      "title": "Ppe Used",
      "type": "boolean"
    },
    "line_removed_using_aseptic_technique": {
      "title": "Line Removed Using Aseptic Technique",
      "type": "boolean"
    },
    "catheter_tip_intact": {
      "title": "Catheter Tip Intact",
      "type": "boolean"
    },
    "hemostasis_achieved": {
      "title": "Hemostasis Achieved",
      "type": "boolean"
    },
    "sterile_dressing_applied": {
      "title": "Sterile Dressing Applied",
      "type": "boolean"
    },
    "post_removal_monitoring": {
      "$ref": "#/$defs/ClabsiPostRemovalMonitoring"
    },
    "others": {
      "title": "Others",
      "type": "string"
    },
    "doctor_nurse": {
      "title": "Doctor Nurse",
      "type": "string"
    },
    "date": {
      "title": "Date",
      "type": "string"
    },
    "signature": {
      "title": "Signature",
      "type": "string"
    },
    "reasons_for_removal": {
      "title": "Reasons For Removal",
      "type": "string"
    },
    "removed_by": {
      "title": "Removed By",
      "type": "string"
    },
    "sign": {
      "title": "Sign",
      "type": "string"
    }
  },
  "title": "ClabsiCentralLineRemoval",
  "type": "object"
}
ClabsiCentralLineSite

FieldType / nested definitionRequiredMeaning
sitestringOptional / source-dependent
internal_jugularbooleanOptional / source-dependent
subclavianbooleanOptional / source-dependent
femoralbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "site": {
      "title": "Site",
      "type": "string"
    },
    "internal_jugular": {
      "title": "Internal Jugular",
      "type": "boolean"
    },
    "subclavian": {
      "title": "Subclavian",
      "type": "boolean"
    },
    "femoral": {
      "title": "Femoral",
      "type": "boolean"
    }
  },
  "title": "ClabsiCentralLineSite",
  "type": "object"
}
ClabsiCentralLineType

FieldType / nested definitionRequiredMeaning
cvcbooleanOptional / source-dependent
dialysis_linebooleanOptional / source-dependent
otherstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "cvc": {
      "title": "Cvc",
      "type": "boolean"
    },
    "dialysis_line": {
      "title": "Dialysis Line",
      "type": "boolean"
    },
    "other": {
      "title": "Other",
      "type": "string"
    }
  },
  "title": "ClabsiCentralLineType",
  "type": "object"
}
ClabsiDailyMaintenanceEntry

FieldType / nested definitionRequiredMeaning
line_typestringOptional / source-dependent
sitestringOptional / source-dependent
line_detail_datestringOptional / source-dependent
datestringOptional / source-dependent
timestringOptional / source-dependent
dayintegerOptional / source-dependent
central_line_still_indicatedbooleanOptional / source-dependent
hand_hygiene_before_handlingbooleanOptional / source-dependent
hub_port_disinfected_before_accessbooleanOptional / source-dependent
dressing_clean_dry_intactbooleanOptional / source-dependent
dressing_change_dailybooleanOptional / source-dependent
no_redness_swelling_at_sitebooleanOptional / source-dependent
no_discharge_pusbooleanOptional / source-dependent
line_secured_properlybooleanOptional / source-dependent
tubing_cap_changed_as_per_policybooleanOptional / source-dependent
feverstringOptional / source-dependent
chillsbooleanOptional / source-dependent
local_site_infectionbooleanOptional / source-dependent
positive_blood_culturebooleanOptional / source-dependent
action_takenstringOptional / source-dependent
nurse_namestringOptional / source-dependent
reviewed_bystringOptional / source-dependent
hand_hygiene_before_accessingbooleanOptional / source-dependent
scrub_the_hubbooleanOptional / source-dependent
rednessbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "line_type": {
      "title": "Line Type",
      "type": "string"
    },
    "site": {
      "title": "Site",
      "type": "string"
    },
    "line_detail_date": {
      "title": "Line Detail Date",
      "type": "string"
    },
    "date": {
      "title": "Date",
      "type": "string"
    },
    "time": {
      "title": "Time",
      "type": "string"
    },
    "day": {
      "title": "Day",
      "type": "integer"
    },
    "central_line_still_indicated": {
      "title": "Central Line Still Indicated",
      "type": "boolean"
    },
    "hand_hygiene_before_handling": {
      "title": "Hand Hygiene Before Handling",
      "type": "boolean"
    },
    "hub_port_disinfected_before_access": {
      "title": "Hub Port Disinfected Before Access",
      "type": "boolean"
    },
    "dressing_clean_dry_intact": {
      "title": "Dressing Clean Dry Intact",
      "type": "boolean"
    },
    "dressing_change_daily": {
      "title": "Dressing Change Daily",
      "type": "boolean"
    },
    "no_redness_swelling_at_site": {
      "title": "No Redness Swelling At Site",
      "type": "boolean"
    },
    "no_discharge_pus": {
      "title": "No Discharge Pus",
      "type": "boolean"
    },
    "line_secured_properly": {
      "title": "Line Secured Properly",
      "type": "boolean"
    },
    "tubing_cap_changed_as_per_policy": {
      "title": "Tubing Cap Changed As Per Policy",
      "type": "boolean"
    },
    "fever": {
      "title": "Fever",
      "type": "string"
    },
    "chills": {
      "title": "Chills",
      "type": "boolean"
    },
    "local_site_infection": {
      "title": "Local Site Infection",
      "type": "boolean"
    },
    "positive_blood_culture": {
      "title": "Positive Blood Culture",
      "type": "boolean"
    },
    "action_taken": {
      "title": "Action Taken",
      "type": "string"
    },
    "nurse_name": {
      "title": "Nurse Name",
      "type": "string"
    },
    "reviewed_by": {
      "title": "Reviewed By",
      "type": "string"
    },
    "hand_hygiene_before_accessing": {
      "title": "Hand Hygiene Before Accessing",
      "type": "boolean"
    },
    "scrub_the_hub": {
      "title": "Scrub The Hub",
      "type": "boolean"
    },
    "redness": {
      "title": "Redness",
      "type": "boolean"
    }
  },
  "title": "ClabsiDailyMaintenanceEntry",
  "type": "object"
}
ClabsiDressingChangeChecklist

FieldType / nested definitionRequiredMeaning
sitestringOptional / source-dependent
datestringOptional / source-dependent
hand_hygiene_performedbooleanOptional / source-dependent
sterile_gloves_usedbooleanOptional / source-dependent
old_dressing_removed_asepticallybooleanOptional / source-dependent
site_inspectedbooleanOptional / source-dependent
skin_cleaned_with_chlorhexidinebooleanOptional / source-dependent
allowed_to_dry_completelybooleanOptional / source-dependent
sterile_dressing_appliedbooleanOptional / source-dependent
date_time_labeledbooleanOptional / source-dependent
remarksstringOptional / source-dependent
nursestringOptional / source-dependent
signaturestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "site": {
      "title": "Site",
      "type": "string"
    },
    "date": {
      "title": "Date",
      "type": "string"
    },
    "hand_hygiene_performed": {
      "title": "Hand Hygiene Performed",
      "type": "boolean"
    },
    "sterile_gloves_used": {
      "title": "Sterile Gloves Used",
      "type": "boolean"
    },
    "old_dressing_removed_aseptically": {
      "title": "Old Dressing Removed Aseptically",
      "type": "boolean"
    },
    "site_inspected": {
      "title": "Site Inspected",
      "type": "boolean"
    },
    "skin_cleaned_with_chlorhexidine": {
      "title": "Skin Cleaned With Chlorhexidine",
      "type": "boolean"
    },
    "allowed_to_dry_completely": {
      "title": "Allowed To Dry Completely",
      "type": "boolean"
    },
    "sterile_dressing_applied": {
      "title": "Sterile Dressing Applied",
      "type": "boolean"
    },
    "date_time_labeled": {
      "title": "Date Time Labeled",
      "type": "boolean"
    },
    "remarks": {
      "title": "Remarks",
      "type": "string"
    },
    "nurse": {
      "title": "Nurse",
      "type": "string"
    },
    "signature": {
      "title": "Signature",
      "type": "string"
    }
  },
  "title": "ClabsiDressingChangeChecklist",
  "type": "object"
}
ClabsiIndicationForCentralLine

FieldType / nested definitionRequiredMeaning
hemodynamic_monitoringbooleanOptional / source-dependent
iv_medicationsbooleanOptional / source-dependent
difficult_peripheral_accessbooleanOptional / source-dependent
dialysisbooleanOptional / source-dependent
otherstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "hemodynamic_monitoring": {
      "title": "Hemodynamic Monitoring",
      "type": "boolean"
    },
    "iv_medications": {
      "title": "Iv Medications",
      "type": "boolean"
    },
    "difficult_peripheral_access": {
      "title": "Difficult Peripheral Access",
      "type": "boolean"
    },
    "dialysis": {
      "title": "Dialysis",
      "type": "boolean"
    },
    "other": {
      "title": "Other",
      "type": "string"
    }
  },
  "title": "ClabsiIndicationForCentralLine",
  "type": "object"
}
ClabsiPostRemovalMonitoring

FieldType / nested definitionRequiredMeaning
bleedingbooleanOptional / source-dependent
painbooleanOptional / source-dependent
air_embolism_signsbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "bleeding": {
      "title": "Bleeding",
      "type": "boolean"
    },
    "pain": {
      "title": "Pain",
      "type": "boolean"
    },
    "air_embolism_signs": {
      "title": "Air Embolism Signs",
      "type": "boolean"
    }
  },
  "title": "ClabsiPostRemovalMonitoring",
  "type": "object"
}
ClabsiSignatures

FieldType / nested definitionRequiredMeaning
inserted_bystringOptional / source-dependent
verified_bystringOptional / source-dependent
assistant_nursestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "inserted_by": {
      "title": "Inserted By",
      "type": "string"
    },
    "verified_by": {
      "title": "Verified By",
      "type": "string"
    },
    "assistant_nurse": {
      "title": "Assistant Nurse",
      "type": "string"
    }
  },
  "title": "ClabsiSignatures",
  "type": "object"
}
ComplicProcedure

FieldType / nested definitionRequiredMeaning
hypotensbooleanOptional / source-dependent
hypoxemiabooleanOptional / source-dependent
bradycardiabooleanOptional / source-dependent
bleedingbooleanOptional / source-dependent
dental_injbooleanOptional / source-dependent
esophageal_intubbooleanOptional / source-dependent
diff_intubbooleanOptional / source-dependent
othersstringOptional / source-dependent
detailsstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "hypotens": {
      "title": "Hypotens",
      "type": "boolean"
    },
    "hypoxemia": {
      "title": "Hypoxemia",
      "type": "boolean"
    },
    "bradycardia": {
      "title": "Bradycardia",
      "type": "boolean"
    },
    "bleeding": {
      "title": "Bleeding",
      "type": "boolean"
    },
    "dental_inj": {
      "title": "Dental Inj",
      "type": "boolean"
    },
    "esophageal_intub": {
      "title": "Esophageal Intub",
      "type": "boolean"
    },
    "diff_intub": {
      "title": "Diff Intub",
      "type": "boolean"
    },
    "others": {
      "title": "Others",
      "type": "string"
    },
    "details": {
      "title": "Details",
      "type": "string"
    }
  },
  "title": "ComplicProcedure",
  "type": "object"
}
ComplicationReportForm

FieldType / nested definitionRequiredMeaning
typestringOptional / source-dependent
sitestringOptional / source-dependent
complication_typeComplicationTypeOptional / source-dependent
signs_symptomsstringOptional / source-dependent
action_takenstringOptional / source-dependent
reported_tostringOptional / source-dependent
nursestringOptional / source-dependent
datestringOptional / source-dependent
signaturestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "type": {
      "title": "Type",
      "type": "string"
    },
    "site": {
      "title": "Site",
      "type": "string"
    },
    "complication_type": {
      "$ref": "#/$defs/ComplicationType"
    },
    "signs_symptoms": {
      "title": "Signs Symptoms",
      "type": "string"
    },
    "action_taken": {
      "title": "Action Taken",
      "type": "string"
    },
    "reported_to": {
      "title": "Reported To",
      "type": "string"
    },
    "nurse": {
      "title": "Nurse",
      "type": "string"
    },
    "date": {
      "title": "Date",
      "type": "string"
    },
    "signature": {
      "title": "Signature",
      "type": "string"
    }
  },
  "title": "ComplicationReportForm",
  "type": "object"
}
ComplicationType

FieldType / nested definitionRequiredMeaning
infectionbooleanOptional / source-dependent
occlusionbooleanOptional / source-dependent
infiltrationbooleanOptional / source-dependent
dislodgementbooleanOptional / source-dependent
otherstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "infection": {
      "title": "Infection",
      "type": "boolean"
    },
    "occlusion": {
      "title": "Occlusion",
      "type": "boolean"
    },
    "infiltration": {
      "title": "Infiltration",
      "type": "boolean"
    },
    "dislodgement": {
      "title": "Dislodgement",
      "type": "boolean"
    },
    "other": {
      "title": "Other",
      "type": "string"
    }
  },
  "title": "ComplicationType",
  "type": "object"
}
ConExtub

FieldType / nested definitionRequiredMeaning
awakebooleanOptional / source-dependent
follow_commbooleanOptional / source-dependent
stablebooleanOptional / source-dependent
on_supbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "awake": {
      "title": "Awake",
      "type": "boolean"
    },
    "follow_comm": {
      "title": "Follow Comm",
      "type": "boolean"
    },
    "stable": {
      "title": "Stable",
      "type": "boolean"
    },
    "on_sup": {
      "title": "On Sup",
      "type": "boolean"
    }
  },
  "title": "ConExtub",
  "type": "object"
}
DailyAssessment

FieldType / nested definitionRequiredMeaning
datestringOptional / source-dependent
timestringOptional / source-dependent
sitestringOptional / source-dependent
vad_still_requiredbooleanOptional / source-dependent
site_clean_drybooleanOptional / source-dependent
redness_swelling_presentbooleanOptional / source-dependent
dressing_intactbooleanOptional / source-dependent
line_patent_flush_workingbooleanOptional / source-dependent
signs_of_infectionbooleanOptional / source-dependent
hub_disinfected_before_usebooleanOptional / source-dependent
pain_scorestringOptional / source-dependent
signaturestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "date": {
      "title": "Date",
      "type": "string"
    },
    "time": {
      "title": "Time",
      "type": "string"
    },
    "site": {
      "title": "Site",
      "type": "string"
    },
    "vad_still_required": {
      "title": "Vad Still Required",
      "type": "boolean"
    },
    "site_clean_dry": {
      "title": "Site Clean Dry",
      "type": "boolean"
    },
    "redness_swelling_present": {
      "title": "Redness Swelling Present",
      "type": "boolean"
    },
    "dressing_intact": {
      "title": "Dressing Intact",
      "type": "boolean"
    },
    "line_patent_flush_working": {
      "title": "Line Patent Flush Working",
      "type": "boolean"
    },
    "signs_of_infection": {
      "title": "Signs Of Infection",
      "type": "boolean"
    },
    "hub_disinfected_before_use": {
      "title": "Hub Disinfected Before Use",
      "type": "boolean"
    },
    "pain_score": {
      "title": "Pain Score",
      "type": "string"
    },
    "signature": {
      "title": "Signature",
      "type": "string"
    }
  },
  "title": "DailyAssessment",
  "type": "object"
}
DailyMaintenanceChecklistForm

FieldType / nested definitionRequiredMeaning
type_of_vadstringOptional / source-dependent
sitestringOptional / source-dependent
assessmentsarray<DailyAssessment>Optional / source-dependent
Exact JSON field definition
{
  "properties": {
    "type_of_vad": {
      "title": "Type Of Vad",
      "type": "string"
    },
    "site": {
      "title": "Site",
      "type": "string"
    },
    "assessments": {
      "items": {
        "$ref": "#/$defs/DailyAssessment"
      },
      "title": "Assessments",
      "type": "array"
    }
  },
  "title": "DailyMaintenanceChecklistForm",
  "type": "object"
}
DeferredOrder

FieldType / nested definitionRequiredMeaning
deferred_orderstringYes
trigger_conditionstringOptional / source-dependent
order_typestringOptional / source-dependent
statusstringOptional / source-dependent
sourceTodoSourceOptional / source-dependentDocument provenance; preserve without editing.
todo_idstringOptional / source-dependentOpaque task identifier; preserve it during edits.
todo_versionintegerOptional / source-dependentVersion returned by the service. Preserve it; the software routes do not expose a conditional-update contract.
Exact JSON field definition
{
  "properties": {
    "deferred_order": {
      "title": "Deferred Order",
      "type": "string"
    },
    "trigger_condition": {
      "title": "Trigger Condition",
      "type": "string"
    },
    "order_type": {
      "title": "Order Type",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "source": {
      "$ref": "#/$defs/TodoSource",
      "description": "Document provenance; preserve without editing."
    },
    "todo_id": {
      "type": "string",
      "description": "Opaque task identifier; preserve it during edits."
    },
    "todo_version": {
      "type": "integer",
      "description": "Version returned by the service. Preserve it; the software routes do not expose a conditional-update contract."
    }
  },
  "required": [
    "deferred_order"
  ],
  "title": "DeferredOrder",
  "type": "object"
}
DeviceDetails

FieldType / nested definitionRequiredMeaning
type_of_vadstringOptional / source-dependent Values: , picc, port
type_optionsVadTypeOptionsOptional / source-dependent
site_selectedstringOptional / source-dependent
date_timestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "type_of_vad": {
      "enum": [
        "",
        "picc",
        "port"
      ],
      "title": "Type Of Vad",
      "type": "string"
    },
    "type_options": {
      "$ref": "#/$defs/VadTypeOptions"
    },
    "site_selected": {
      "title": "Site Selected",
      "type": "string"
    },
    "date_time": {
      "title": "Date Time",
      "type": "string"
    }
  },
  "title": "DeviceDetails",
  "type": "object"
}
Diet

FieldType / nested definitionRequiredMeaning
isSpecialDietbooleanYes
typestringYes
Exact JSON field definition
{
  "properties": {
    "isSpecialDiet": {
      "title": "Isspecialdiet",
      "type": "boolean"
    },
    "type": {
      "title": "Type",
      "type": "string"
    }
  },
  "required": [
    "isSpecialDiet",
    "type"
  ],
  "title": "Diet",
  "type": "object"
}
DietPatternAndAllergies

FieldType / nested definitionRequiredMeaning
diet_typestringOptional / source-dependent Values: , Vegetarian, Non-vegetarian, Eggetarian, Vegan, Other
diet_type_otherstringOptional / source-dependent
has_food_allergiesbooleanOptional / source-dependent
food_allergiesstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "diet_type": {
      "enum": [
        "",
        "Vegetarian",
        "Non-vegetarian",
        "Eggetarian",
        "Vegan",
        "Other"
      ],
      "title": "Diet Type",
      "type": "string"
    },
    "diet_type_other": {
      "title": "Diet Type Other",
      "type": "string"
    },
    "has_food_allergies": {
      "title": "Has Food Allergies",
      "type": "boolean"
    },
    "food_allergies": {
      "title": "Food Allergies",
      "type": "string"
    }
  },
  "title": "DietPatternAndAllergies",
  "type": "object"
}
DocBloodTrans

FieldType / nested definitionRequiredMeaning
diagnosisstring | nullOptional / source-dependent
indicationstringOptional / source-dependent
noustringOptional / source-dependent
comp_typestringOptional / source-dependent
pre_medarray<MedicationData>Optional / source-dependent
post_medarray<MedicationData>Optional / source-dependent
Exact JSON field definition
{
  "properties": {
    "diagnosis": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Diagnosis"
    },
    "indication": {
      "title": "Indication",
      "type": "string"
    },
    "nou": {
      "title": "Nou",
      "type": "string"
    },
    "comp_type": {
      "title": "Comp Type",
      "type": "string"
    },
    "pre_med": {
      "items": {
        "$ref": "#/$defs/MedicationData"
      },
      "title": "Pre Med",
      "type": "array"
    },
    "post_med": {
      "items": {
        "$ref": "#/$defs/MedicationData"
      },
      "title": "Post Med",
      "type": "array"
    }
  },
  "title": "DocBloodTrans",
  "type": "object"
}
DoctorBloodGlucoseMonitoring

FieldType / nested definitionRequiredMeaning
blood_sugarstring | nullOptional / source-dependent
medicationstring | nullOptional / source-dependent
creatinine_levelstring | nullOptional / source-dependent
consent_for_insulinboolean | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "blood_sugar": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Blood Sugar"
    },
    "medication": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Medication"
    },
    "creatinine_level": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Creatinine Level"
    },
    "consent_for_insulin": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Consent For Insulin"
    }
  },
  "title": "DoctorBloodGlucoseMonitoring",
  "type": "object"
}
DoctorInitialAssessment

FieldType / nested definitionRequiredMeaning
chief_complaintsstringYes
history_of_present_illnessstringYes
past_history_and_durationstringYes
family_historystringYes
personal_historystringYes
menstrual_historystringYes
obstetrical_historystringYes
allergiesstringYes
blood_groupstringOptional / source-dependent
previous_medicationstringYes
present_medicationstringYes
previous_investigationsstringYes
examination_findingsstringYes
provisional_diagnosisstringYes
plan_of_carestringYes
surgery_procedure_plannedstringYes
pre_operative_instructionsstringYes
recommendationsstringYes
assessmentarray<AssessmentTemplate>Yes
medication_templatesarray<MedicationData>Yes
Exact JSON field definition
{
  "properties": {
    "chief_complaints": {
      "title": "Chief Complaints",
      "type": "string"
    },
    "history_of_present_illness": {
      "title": "History Of Present Illness",
      "type": "string"
    },
    "past_history_and_duration": {
      "title": "Past History And Duration",
      "type": "string"
    },
    "family_history": {
      "title": "Family History",
      "type": "string"
    },
    "personal_history": {
      "title": "Personal History",
      "type": "string"
    },
    "menstrual_history": {
      "title": "Menstrual History",
      "type": "string"
    },
    "obstetrical_history": {
      "title": "Obstetrical History",
      "type": "string"
    },
    "allergies": {
      "title": "Allergies",
      "type": "string"
    },
    "blood_group": {
      "title": "Blood Group",
      "type": "string"
    },
    "previous_medication": {
      "title": "Previous Medication",
      "type": "string"
    },
    "present_medication": {
      "title": "Present Medication",
      "type": "string"
    },
    "previous_investigations": {
      "title": "Previous Investigations",
      "type": "string"
    },
    "examination_findings": {
      "title": "Examination Findings",
      "type": "string"
    },
    "provisional_diagnosis": {
      "title": "Provisional Diagnosis",
      "type": "string"
    },
    "plan_of_care": {
      "title": "Plan Of Care",
      "type": "string"
    },
    "surgery_procedure_planned": {
      "title": "Surgery Procedure Planned",
      "type": "string"
    },
    "pre_operative_instructions": {
      "title": "Pre Operative Instructions",
      "type": "string"
    },
    "recommendations": {
      "title": "Recommendations",
      "type": "string"
    },
    "assessment": {
      "items": {
        "$ref": "#/$defs/AssessmentTemplate"
      },
      "title": "Assessment",
      "type": "array"
    },
    "medication_templates": {
      "items": {
        "$ref": "#/$defs/MedicationData"
      },
      "title": "Medication Templates",
      "type": "array"
    }
  },
  "required": [
    "chief_complaints",
    "history_of_present_illness",
    "past_history_and_duration",
    "family_history",
    "personal_history",
    "menstrual_history",
    "obstetrical_history",
    "allergies",
    "previous_medication",
    "present_medication",
    "previous_investigations",
    "examination_findings",
    "provisional_diagnosis",
    "plan_of_care",
    "surgery_procedure_planned",
    "pre_operative_instructions",
    "recommendations",
    "assessment",
    "medication_templates"
  ],
  "title": "DoctorInitialAssessment",
  "type": "object"
}
DoctorInitialAssessmentMale

FieldType / nested definitionRequiredMeaning
chief_complaintsstringYes
history_of_present_illnessstringYes
past_history_and_durationstringYes
family_historystringYes
personal_historystringYes
allergiesstringYes
blood_groupstringOptional / source-dependent
previous_medicationstringYes
present_medicationstringYes
previous_investigationsstringYes
examination_findingsstringYes
provisional_diagnosisstringYes
plan_of_carestringYes
surgery_procedure_plannedstringYes
pre_operative_instructionsstringYes
recommendationsstringYes
assessmentarray<AssessmentTemplate>Yes
medication_templatesarray<MedicationData>Yes
Exact JSON field definition
{
  "properties": {
    "chief_complaints": {
      "title": "Chief Complaints",
      "type": "string"
    },
    "history_of_present_illness": {
      "title": "History Of Present Illness",
      "type": "string"
    },
    "past_history_and_duration": {
      "title": "Past History And Duration",
      "type": "string"
    },
    "family_history": {
      "title": "Family History",
      "type": "string"
    },
    "personal_history": {
      "title": "Personal History",
      "type": "string"
    },
    "allergies": {
      "title": "Allergies",
      "type": "string"
    },
    "blood_group": {
      "title": "Blood Group",
      "type": "string"
    },
    "previous_medication": {
      "title": "Previous Medication",
      "type": "string"
    },
    "present_medication": {
      "title": "Present Medication",
      "type": "string"
    },
    "previous_investigations": {
      "title": "Previous Investigations",
      "type": "string"
    },
    "examination_findings": {
      "title": "Examination Findings",
      "type": "string"
    },
    "provisional_diagnosis": {
      "title": "Provisional Diagnosis",
      "type": "string"
    },
    "plan_of_care": {
      "title": "Plan Of Care",
      "type": "string"
    },
    "surgery_procedure_planned": {
      "title": "Surgery Procedure Planned",
      "type": "string"
    },
    "pre_operative_instructions": {
      "title": "Pre Operative Instructions",
      "type": "string"
    },
    "recommendations": {
      "title": "Recommendations",
      "type": "string"
    },
    "assessment": {
      "items": {
        "$ref": "#/$defs/AssessmentTemplate"
      },
      "title": "Assessment",
      "type": "array"
    },
    "medication_templates": {
      "items": {
        "$ref": "#/$defs/MedicationData"
      },
      "title": "Medication Templates",
      "type": "array"
    }
  },
  "required": [
    "chief_complaints",
    "history_of_present_illness",
    "past_history_and_duration",
    "family_history",
    "personal_history",
    "allergies",
    "previous_medication",
    "present_medication",
    "previous_investigations",
    "examination_findings",
    "provisional_diagnosis",
    "plan_of_care",
    "surgery_procedure_planned",
    "pre_operative_instructions",
    "recommendations",
    "assessment",
    "medication_templates"
  ],
  "title": "DoctorInitialAssessmentMale",
  "type": "object"
}
DoctorNoteEntry

FieldType / nested definitionRequiredMeaning
created_atstringOptional / source-dependent
updated_atstringOptional / source-dependent
interaction_typestringOptional / source-dependent
answerobjectOptional / source-dependent
answer.assessmentstringSource-dependent
answer.clinical_contextstringSource-dependent
answer.clinical_statusstringSource-dependent
answer.comorbidsstringSource-dependent
answer.complaints_and_eventsstringSource-dependent
answer.disposition_planstringSource-dependent
answer.escalation_instructionsstringSource-dependent
answer.planstringSource-dependent
answer.systemic_examinationstringSource-dependent
answer.vitalsstringSource-dependent
doctor_idstringOptional / source-dependent
practitioner_idstringOptional / source-dependent
read_errorstringOptional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "interaction_type": {
      "type": "string"
    },
    "answer": {
      "type": "object",
      "properties": {
        "assessment": {
          "type": "string"
        },
        "clinical_context": {
          "type": "string"
        },
        "clinical_status": {
          "type": "string"
        },
        "comorbids": {
          "type": "string"
        },
        "complaints_and_events": {
          "type": "string"
        },
        "disposition_plan": {
          "type": "string"
        },
        "escalation_instructions": {
          "type": "string"
        },
        "plan": {
          "type": "string"
        },
        "systemic_examination": {
          "type": "string"
        },
        "vitals": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "doctor_id": {
      "type": "string"
    },
    "practitioner_id": {
      "type": "string"
    },
    "read_error": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
DrugChartItem

FieldType / nested definitionRequiredMeaning
medication_namestringYes
dosagestringYes
routestringYes
statusstringYes
start_datestringOptional / source-dependent
prescription_typestringOptional / source-dependent
additional_informationstring | nullOptional / source-dependent
is_statboolean | nullOptional / source-dependent
is_once_onlyboolean | nullOptional / source-dependent
is_sosboolean | nullOptional / source-dependent
is_infusionboolean | nullOptional / source-dependent
frequency_morningstringOptional / source-dependent
frequency_afternoonstringOptional / source-dependent
frequency_eveningstringOptional / source-dependent
frequency_nightstringOptional / source-dependent
created_atstringYes
prescribed_bystringYes
administeredarray<PerDrugAdministration>Optional / source-dependent
Exact JSON field definition
{
  "properties": {
    "medication_name": {
      "title": "Medication Name",
      "type": "string"
    },
    "dosage": {
      "title": "Dosage",
      "type": "string"
    },
    "route": {
      "title": "Route",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "start_date": {
      "format": "date",
      "title": "Start Date",
      "type": "string"
    },
    "prescription_type": {
      "title": "Prescription Type",
      "type": "string"
    },
    "additional_information": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Additional Information"
    },
    "is_stat": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Stat"
    },
    "is_once_only": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Once Only"
    },
    "is_sos": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Sos"
    },
    "is_infusion": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Infusion"
    },
    "frequency_morning": {
      "title": "Frequency Morning",
      "type": "string"
    },
    "frequency_afternoon": {
      "title": "Frequency Afternoon",
      "type": "string"
    },
    "frequency_evening": {
      "title": "Frequency Evening",
      "type": "string"
    },
    "frequency_night": {
      "title": "Frequency Night",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "prescribed_by": {
      "title": "Prescribed By",
      "type": "string"
    },
    "administered": {
      "items": {
        "$ref": "#/$defs/PerDrugAdministration"
      },
      "title": "Administered",
      "type": "array"
    }
  },
  "required": [
    "medication_name",
    "dosage",
    "route",
    "status",
    "created_at",
    "prescribed_by"
  ],
  "title": "DrugChartItem",
  "type": "object"
}
DrugChartPatch

FieldType / nested definitionRequiredMeaning
allergies_to_addarray<AllergyEntry>Optional / source-dependent
administrations_to_addarray<AdministrationRecord>Optional / source-dependent
medications_to_stoparray<StopMedicationCommand>Optional / source-dependent
medications_to_holdarray<StopMedicationCommand>Optional / source-dependent
medications_to_resumearray<StopMedicationCommand>Optional / source-dependent
new_regular_ordersarray<NewRegularOrderCommand>Optional / source-dependent
new_prn_ordersarray<NewPRNOrderCommand>Optional / source-dependent
medication_reconciliationMedicationReconciliationOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "allergies_to_add": {
      "items": {
        "$ref": "#/$defs/AllergyEntry"
      },
      "title": "Allergies To Add",
      "type": "array"
    },
    "administrations_to_add": {
      "items": {
        "$ref": "#/$defs/AdministrationRecord"
      },
      "title": "Administrations To Add",
      "type": "array"
    },
    "medications_to_stop": {
      "items": {
        "$ref": "#/$defs/StopMedicationCommand"
      },
      "title": "Medications To Stop",
      "type": "array"
    },
    "medications_to_hold": {
      "items": {
        "$ref": "#/$defs/StopMedicationCommand"
      },
      "title": "Medications To Hold",
      "type": "array"
    },
    "medications_to_resume": {
      "items": {
        "$ref": "#/$defs/StopMedicationCommand"
      },
      "title": "Medications To Resume",
      "type": "array"
    },
    "new_regular_orders": {
      "items": {
        "$ref": "#/$defs/NewRegularOrderCommand"
      },
      "title": "New Regular Orders",
      "type": "array"
    },
    "new_prn_orders": {
      "items": {
        "$ref": "#/$defs/NewPRNOrderCommand"
      },
      "title": "New Prn Orders",
      "type": "array"
    },
    "medication_reconciliation": {
      "$ref": "#/$defs/MedicationReconciliation"
    }
  },
  "title": "DrugChartPatch",
  "type": "object"
}
DrugChartRoot

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
merged_schemaMergedSchemaOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "patient_id": {
      "title": "Patient Id",
      "type": "string"
    },
    "inpatient_id": {
      "title": "Inpatient Id",
      "type": "string"
    },
    "merged_schema": {
      "$ref": "#/$defs/MergedSchema"
    }
  },
  "required": [
    "patient_id",
    "inpatient_id"
  ],
  "title": "DrugChartRoot",
  "type": "object"
}
EquipMaintenance

FieldType / nested definitionRequiredMeaning
venti_circ_changestringOptional / source-dependent
hme_bactfilt_changestringOptional / source-dependent
humid_water_changestringOptional / source-dependent
suct_cath_changestringOptional / source-dependent
ettube_hold_changestringOptional / source-dependent
ambu_bag_checkstringOptional / source-dependent
alarm_funct_checkstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "venti_circ_change": {
      "title": "Venti Circ Change",
      "type": "string"
    },
    "hme_bactfilt_change": {
      "title": "Hme Bactfilt Change",
      "type": "string"
    },
    "humid_water_change": {
      "title": "Humid Water Change",
      "type": "string"
    },
    "suct_cath_change": {
      "title": "Suct Cath Change",
      "type": "string"
    },
    "ettube_hold_change": {
      "title": "Ettube Hold Change",
      "type": "string"
    },
    "ambu_bag_check": {
      "title": "Ambu Bag Check",
      "type": "string"
    },
    "alarm_funct_check": {
      "title": "Alarm Funct Check",
      "type": "string"
    }
  },
  "title": "EquipMaintenance",
  "type": "object"
}
EyeMovement

FieldType / nested definitionRequiredMeaning
eyestringOptional / source-dependent
right_motresstringOptional / source-dependent
left_motresstringOptional / source-dependent
verbal_responsestringOptional / source-dependent
right_pupilstringOptional / source-dependent
left_pupilstringOptional / source-dependent
power_rulstringOptional / source-dependent
power_rllstringOptional / source-dependent
power_lulstringOptional / source-dependent
power_lllstringOptional / source-dependent
remarksstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "eye": {
      "title": "Eye",
      "type": "string"
    },
    "right_motres": {
      "title": "Right Motres",
      "type": "string"
    },
    "left_motres": {
      "title": "Left Motres",
      "type": "string"
    },
    "verbal_response": {
      "title": "Verbal Response",
      "type": "string"
    },
    "right_pupil": {
      "title": "Right Pupil",
      "type": "string"
    },
    "left_pupil": {
      "title": "Left Pupil",
      "type": "string"
    },
    "power_rul": {
      "title": "Power Rul",
      "type": "string"
    },
    "power_rll": {
      "title": "Power Rll",
      "type": "string"
    },
    "power_lul": {
      "title": "Power Lul",
      "type": "string"
    },
    "power_lll": {
      "title": "Power Lll",
      "type": "string"
    },
    "remarks": {
      "title": "Remarks",
      "type": "string"
    }
  },
  "title": "EyeMovement",
  "type": "object"
}
FastHugEventEntry

FieldType / nested definitionRequiredMeaning
keystringOptional / source-dependent Values: , feeding, analgesia, sedation, thromboprophylaxis, head_up, ulcer_prophylaxis, glycemic_control, spontaneous_breath_o2, bowel_care, indwelling_catheter, deescalation_antibiotics
eventstringOptional / source-dependent Values: , started, administered, rate_changed, dose_changed, paused, resumed, held, restarted, completed, stopped, discontinued, refused, missed, cancelled
textstringOptional / source-dependent
occurred_atstringOptional / source-dependent
rate_ml_hrnumber | nullOptional / source-dependent
volume_mlnumber | nullOptional / source-dependent
duration_hoursnumber | nullOptional / source-dependent
dosestringOptional / source-dependent
routestringOptional / source-dependent
reasonstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "key": {
      "enum": [
        "",
        "feeding",
        "analgesia",
        "sedation",
        "thromboprophylaxis",
        "head_up",
        "ulcer_prophylaxis",
        "glycemic_control",
        "spontaneous_breath_o2",
        "bowel_care",
        "indwelling_catheter",
        "deescalation_antibiotics"
      ],
      "title": "Key",
      "type": "string"
    },
    "event": {
      "enum": [
        "",
        "started",
        "administered",
        "rate_changed",
        "dose_changed",
        "paused",
        "resumed",
        "held",
        "restarted",
        "completed",
        "stopped",
        "discontinued",
        "refused",
        "missed",
        "cancelled"
      ],
      "title": "Event",
      "type": "string"
    },
    "text": {
      "title": "Text",
      "type": "string"
    },
    "occurred_at": {
      "title": "Occurred At",
      "type": "string"
    },
    "rate_ml_hr": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Rate Ml Hr"
    },
    "volume_ml": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Volume Ml"
    },
    "duration_hours": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "title": "Duration Hours"
    },
    "dose": {
      "title": "Dose",
      "type": "string"
    },
    "route": {
      "title": "Route",
      "type": "string"
    },
    "reason": {
      "title": "Reason",
      "type": "string"
    }
  },
  "title": "FastHugEventEntry",
  "type": "object"
}
FastHugsBid

FieldType / nested definitionRequiredMeaning
feedingstringOptional / source-dependent
analgesiastringOptional / source-dependent
sedationstringOptional / source-dependent
thromboprophylaxisstringOptional / source-dependent
head_upstringOptional / source-dependent
ulcer_prophylaxisstringOptional / source-dependent
glycemic_controlstringOptional / source-dependent
spontaneous_breath_o2stringOptional / source-dependent
bowel_carestringOptional / source-dependent
indwelling_catheterstringOptional / source-dependent
deescalation_antibioticsstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "feeding": {
      "title": "Feeding",
      "type": "string"
    },
    "analgesia": {
      "title": "Analgesia",
      "type": "string"
    },
    "sedation": {
      "title": "Sedation",
      "type": "string"
    },
    "thromboprophylaxis": {
      "title": "Thromboprophylaxis",
      "type": "string"
    },
    "head_up": {
      "title": "Head Up",
      "type": "string"
    },
    "ulcer_prophylaxis": {
      "title": "Ulcer Prophylaxis",
      "type": "string"
    },
    "glycemic_control": {
      "title": "Glycemic Control",
      "type": "string"
    },
    "spontaneous_breath_o2": {
      "title": "Spontaneous Breath O2",
      "type": "string"
    },
    "bowel_care": {
      "title": "Bowel Care",
      "type": "string"
    },
    "indwelling_catheter": {
      "title": "Indwelling Catheter",
      "type": "string"
    },
    "deescalation_antibiotics": {
      "title": "Deescalation Antibiotics",
      "type": "string"
    }
  },
  "title": "FastHugsBid",
  "type": "object"
}
FluidsMonitoring

FieldType / nested definitionRequiredMeaning
isMonitoringbooleanYes
typestringYes
Exact JSON field definition
{
  "properties": {
    "isMonitoring": {
      "title": "Ismonitoring",
      "type": "boolean"
    },
    "type": {
      "title": "Type",
      "type": "string"
    }
  },
  "required": [
    "isMonitoring",
    "type"
  ],
  "title": "FluidsMonitoring",
  "type": "object"
}
Frequency

FieldType / nested definitionRequiredMeaning
frequencystringOptional / source-dependent
statusstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "frequency": {
      "title": "Frequency",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    }
  },
  "title": "Frequency",
  "type": "object"
}
FunctionalAssessment

FieldType / nested definitionRequiredMeaning
washingbooleanYes
dressingbooleanYes
feedingbooleanYes
toiletingbooleanYes
transferringbooleanYes
mobilitybooleanYes
Exact JSON field definition
{
  "properties": {
    "washing": {
      "title": "Washing",
      "type": "boolean"
    },
    "dressing": {
      "title": "Dressing",
      "type": "boolean"
    },
    "feeding": {
      "title": "Feeding",
      "type": "boolean"
    },
    "toileting": {
      "title": "Toileting",
      "type": "boolean"
    },
    "transferring": {
      "title": "Transferring",
      "type": "boolean"
    },
    "mobility": {
      "title": "Mobility",
      "type": "boolean"
    }
  },
  "required": [
    "washing",
    "dressing",
    "feeding",
    "toileting",
    "transferring",
    "mobility"
  ],
  "title": "FunctionalAssessment",
  "type": "object"
}
GeneratedDocumentResponse

The Node wrapper guarantees these three fields. data is the upstream generation result; document content depends on the selected form and configured template. It can include an answer object or serialized answer text, rather than a PDF URL.

FieldType / nested definitionRequiredMeaning
successbooleanYes
messagestringYes
dataJSON valueYesService-defined JSON value; preserve its returned type and fields.
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "data": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    }
  },
  "additionalProperties": true,
  "required": [
    "success",
    "message",
    "data"
  ],
  "description": "The Node wrapper guarantees these three fields. data is the upstream generation result; document content depends on the selected form and configured template. It can include an answer object or serialized answer text, rather than a PDF URL."
}
GlobalAdministration

FieldType / nested definitionRequiredMeaning
drug_namestringOptional / source-dependent
scheduled_timestring | nullOptional / source-dependent
administered_timestringYes
administered_bystringYes
doctor_idstring | nullOptional / source-dependent
nurse_idstring | nullOptional / source-dependent
statusstringYes
notesstring | nullOptional / source-dependent
prescribed_bystring | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "drug_name": {
      "title": "Drug Name",
      "type": "string"
    },
    "scheduled_time": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Scheduled Time"
    },
    "administered_time": {
      "format": "date-time",
      "title": "Administered Time",
      "type": "string"
    },
    "administered_by": {
      "title": "Administered By",
      "type": "string"
    },
    "doctor_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Doctor Id"
    },
    "nurse_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Nurse Id"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Notes"
    },
    "prescribed_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Prescribed By"
    }
  },
  "required": [
    "administered_time",
    "administered_by",
    "status"
  ],
  "title": "GlobalAdministration",
  "type": "object"
}
GlucoseConsent

FieldType / nested definitionRequiredMeaning
creatinine_levelstringOptional / source-dependent
consent_for_insulinJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "creatinine_level": {
      "type": "string"
    },
    "consent_for_insulin": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    }
  },
  "additionalProperties": true
}
GlucoseDay

FieldType / nested definitionRequiredMeaning
datestringOptional / source-dependent
entriesarray<GlucoseEntry>Optional / source-dependent
totalstringOptional / source-dependent
remarksstringOptional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "date": {
      "type": "string"
    },
    "entries": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/GlucoseEntry"
      }
    },
    "total": {
      "type": "string"
    },
    "remarks": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
GlucoseEntry

FieldType / nested definitionRequiredMeaning
datestringOptional / source-dependent
timestringOptional / source-dependent
blood_sugarstringOptional / source-dependent
medicationJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
interaction_idstring | integer | nullOptional / source-dependent
doctor_idstring | integer | nullOptional / source-dependent
nurse_idstring | integer | nullOptional / source-dependent
note_timestringOptional / source-dependent
timestampstringOptional / source-dependent
practitioner_idstringOptional / source-dependent
caregiver_idstringOptional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "date": {
      "type": "string"
    },
    "time": {
      "type": "string"
    },
    "blood_sugar": {
      "type": "string"
    },
    "medication": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "interaction_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "doctor_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "nurse_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "note_time": {
      "type": "string"
    },
    "timestamp": {
      "type": "string"
    },
    "practitioner_id": {
      "type": "string"
    },
    "caregiver_id": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
GlucoseResponse

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
structured_dataobjectYes
structured_data.IPD_BLOOD_GLUCOSE_MONITORINGarray<GlucoseDay | GlucoseConsent>Source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_BLOOD_GLUCOSE_MONITORING": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "$ref": "#/$defs/GlucoseDay"
              },
              {
                "$ref": "#/$defs/GlucoseConsent"
              }
            ]
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "inpatient_id",
    "structured_data"
  ]
}
GroupedResponse

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
structured_dataobjectYes
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "inpatient_id",
    "structured_data"
  ]
}
GynecArrivalAndTriage

FieldType / nested definitionRequiredMeaning
triage_timestringOptional / source-dependent
datestringOptional / source-dependent
arrival_timestringOptional / source-dependent
mode_of_arrivalGynecModeOfArrivalOptional / source-dependent
triage_codeGynecTriageCodeOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "triage_time": {
      "title": "Triage Time",
      "type": "string"
    },
    "date": {
      "title": "Date",
      "type": "string"
    },
    "arrival_time": {
      "title": "Arrival Time",
      "type": "string"
    },
    "mode_of_arrival": {
      "$ref": "#/$defs/GynecModeOfArrival"
    },
    "triage_code": {
      "$ref": "#/$defs/GynecTriageCode"
    }
  },
  "title": "GynecArrivalAndTriage",
  "type": "object"
}
GynecBarriersToLearning

FieldType / nested definitionRequiredMeaning
languagestringOptional / source-dependent
verbalstringOptional / source-dependent
hearingstringOptional / source-dependent
othersstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "language": {
      "title": "Language",
      "type": "string"
    },
    "verbal": {
      "title": "Verbal",
      "type": "string"
    },
    "hearing": {
      "title": "Hearing",
      "type": "string"
    },
    "others": {
      "title": "Others",
      "type": "string"
    }
  },
  "title": "GynecBarriersToLearning",
  "type": "object"
}
GynecCaregiverReadinessToLearn

FieldType / nested definitionRequiredMeaning
receptivebooleanOptional / source-dependent
non_receptivebooleanOptional / source-dependent
inability_to_learnbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "receptive": {
      "title": "Receptive",
      "type": "boolean"
    },
    "non_receptive": {
      "title": "Non Receptive",
      "type": "boolean"
    },
    "inability_to_learn": {
      "title": "Inability To Learn",
      "type": "boolean"
    }
  },
  "title": "GynecCaregiverReadinessToLearn",
  "type": "object"
}
GynecDischargePlanning

FieldType / nested definitionRequiredMeaning
yesbooleanOptional / source-dependent
nobooleanOptional / source-dependent
transfer_to_wardbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "yes": {
      "title": "Yes",
      "type": "boolean"
    },
    "no": {
      "title": "No",
      "type": "boolean"
    },
    "transfer_to_ward": {
      "title": "Transfer To Ward",
      "type": "boolean"
    }
  },
  "title": "GynecDischargePlanning",
  "type": "object"
}
GynecFetalStatus

FieldType / nested definitionRequiredMeaning
fetal_movementstringOptional / source-dependent
fetal_heart_ratestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "fetal_movement": {
      "title": "Fetal Movement",
      "type": "string"
    },
    "fetal_heart_rate": {
      "title": "Fetal Heart Rate",
      "type": "string"
    }
  },
  "title": "GynecFetalStatus",
  "type": "object"
}
GynecGravidaAndParity

FieldType / nested definitionRequiredMeaning
gravidastringOptional / source-dependent
termstringOptional / source-dependent
paritystringOptional / source-dependent
abortionsstringOptional / source-dependent
livingstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "gravida": {
      "title": "Gravida",
      "type": "string"
    },
    "term": {
      "title": "Term",
      "type": "string"
    },
    "parity": {
      "title": "Parity",
      "type": "string"
    },
    "abortions": {
      "title": "Abortions",
      "type": "string"
    },
    "living": {
      "title": "Living",
      "type": "string"
    }
  },
  "title": "GynecGravidaAndParity",
  "type": "object"
}
GynecLabourStatus

FieldType / nested definitionRequiredMeaning
uterine_contractionsbooleanOptional / source-dependent
membrane_statusbooleanOptional / source-dependent
time_of_rupturestringOptional / source-dependent
colour_of_liquorstringOptional / source-dependent
odourstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "uterine_contractions": {
      "title": "Uterine Contractions",
      "type": "boolean"
    },
    "membrane_status": {
      "title": "Membrane Status",
      "type": "boolean"
    },
    "time_of_rupture": {
      "title": "Time Of Rupture",
      "type": "string"
    },
    "colour_of_liquor": {
      "title": "Colour Of Liquor",
      "type": "string"
    },
    "odour": {
      "title": "Odour",
      "type": "string"
    }
  },
  "title": "GynecLabourStatus",
  "type": "object"
}
GynecMedicationHistory

FieldType / nested definitionRequiredMeaning
medication_namestringYes
medication_typestring | nullOptional / source-dependent
dosagestring | nullOptional / source-dependent
routestring | nullOptional / source-dependent
frequency_morningstring | nullYes
frequency_afternoonstring | nullYes
frequency_eveningstring | nullYes
frequency_nightstring | nullYes
durationstring | nullOptional / source-dependent
duration_sourcestring | nullOptional / source-dependent
continue_until_stoppedboolean | nullOptional / source-dependent
dosage_timestring | nullOptional / source-dependent
instructionsstring | nullOptional / source-dependent
med_statusstring | nullOptional / source-dependent
is_statboolean | nullOptional / source-dependent
is_once_onlyboolean | nullOptional / source-dependent
is_sosboolean | nullOptional / source-dependent
is_infusionboolean | nullOptional / source-dependent
is_statusstring | nullOptional / source-dependent
time_of_last_dosestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "medication_name": {
      "title": "Medication Name",
      "type": "string"
    },
    "medication_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Medication Type"
    },
    "dosage": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dosage"
    },
    "route": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Route"
    },
    "frequency_morning": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Frequency Morning"
    },
    "frequency_afternoon": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Frequency Afternoon"
    },
    "frequency_evening": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Frequency Evening"
    },
    "frequency_night": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Frequency Night"
    },
    "duration": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Duration"
    },
    "duration_source": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Duration Source"
    },
    "continue_until_stopped": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Continue Until Stopped"
    },
    "dosage_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dosage Time"
    },
    "instructions": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Instructions"
    },
    "med_status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Med Status"
    },
    "is_stat": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Stat"
    },
    "is_once_only": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Once Only"
    },
    "is_sos": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Sos"
    },
    "is_infusion": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Infusion"
    },
    "is_status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Status"
    },
    "time_of_last_dose": {
      "title": "Time Of Last Dose",
      "type": "string"
    }
  },
  "required": [
    "medication_name",
    "frequency_morning",
    "frequency_afternoon",
    "frequency_evening",
    "frequency_night"
  ],
  "title": "GynecMedicationHistory",
  "type": "object"
}
GynecModeOfArrival

FieldType / nested definitionRequiredMeaning
ambulancebooleanOptional / source-dependent
walk_inbooleanOptional / source-dependent
otherstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "ambulance": {
      "title": "Ambulance",
      "type": "boolean"
    },
    "walk_in": {
      "title": "Walk In",
      "type": "boolean"
    },
    "other": {
      "title": "Other",
      "type": "string"
    }
  },
  "title": "GynecModeOfArrival",
  "type": "object"
}
GynecNurseInitialAssessment

FieldType / nested definitionRequiredMeaning
arrivalAndTriageGynecArrivalAndTriageOptional / source-dependent
vitalsGynecVitalsOptional / source-dependent
gravidaAndParityGynecGravidaAndParityOptional / source-dependent
orientationGynecOrientationOptional / source-dependent
chiefComplaintsDescriptionOfSymptomsstringOptional / source-dependent
gynecSpecificAssessmentGynecSpecificAssessmentOptional / source-dependent
obstetricSpecificAssessmentGynecObstetricSpecificAssessmentOptional / source-dependent
vaginalBleedingGynecVaginalBleedingOptional / source-dependent
painAssessmentGynecPainAssessmentOptional / source-dependent
nutritionalAssessmentGynecNutritionalAssessmentOptional / source-dependent
psychosocialIssuesstringOptional / source-dependent
pastMedicalHistoryGynecPastMedicalHistoryOptional / source-dependent
pastSurgicalHistorystringOptional / source-dependent
medicationHistoryarray<GynecMedicationHistory>Optional / source-dependent
allergiesOrReactionsstringOptional / source-dependent
blood_groupstringOptional / source-dependent
exposureToCommunicableDiseasebooleanOptional / source-dependent
dischargePlanningGynecDischargePlanningOptional / source-dependent
caregiverReadinessToLearnGynecCaregiverReadinessToLearnOptional / source-dependent
barriersToLearningGynecBarriersToLearningOptional / source-dependent
nursesNotesstringOptional / source-dependent
valuableHandedOverbooleanOptional / source-dependent
pead_detPeadiatricDet | nullOptional / source-dependent
vitals_abnormalityVitalAbnormalityOptional / source-dependent
monitoring_tasksarray<MonitoringTask>Optional / source-dependent
iv_infusionsarray<IVInfusion>Optional / source-dependent
drug_chart_patchDrugChartPatchOptional / source-dependent
blood_borneBloodBorneOptional / source-dependent
fasthugFastHugsBidOptional / source-dependent
fasthug_eventsarray<FastHugEventEntry>Optional / source-dependent
Exact JSON field definition
{
  "properties": {
    "arrivalAndTriage": {
      "$ref": "#/$defs/GynecArrivalAndTriage"
    },
    "vitals": {
      "$ref": "#/$defs/GynecVitals"
    },
    "gravidaAndParity": {
      "$ref": "#/$defs/GynecGravidaAndParity"
    },
    "orientation": {
      "$ref": "#/$defs/GynecOrientation"
    },
    "chiefComplaintsDescriptionOfSymptoms": {
      "title": "Chiefcomplaintsdescriptionofsymptoms",
      "type": "string"
    },
    "gynecSpecificAssessment": {
      "$ref": "#/$defs/GynecSpecificAssessment"
    },
    "obstetricSpecificAssessment": {
      "$ref": "#/$defs/GynecObstetricSpecificAssessment"
    },
    "vaginalBleeding": {
      "$ref": "#/$defs/GynecVaginalBleeding"
    },
    "painAssessment": {
      "$ref": "#/$defs/GynecPainAssessment"
    },
    "nutritionalAssessment": {
      "$ref": "#/$defs/GynecNutritionalAssessment"
    },
    "psychosocialIssues": {
      "title": "Psychosocialissues",
      "type": "string"
    },
    "pastMedicalHistory": {
      "$ref": "#/$defs/GynecPastMedicalHistory"
    },
    "pastSurgicalHistory": {
      "title": "Pastsurgicalhistory",
      "type": "string"
    },
    "medicationHistory": {
      "items": {
        "$ref": "#/$defs/GynecMedicationHistory"
      },
      "title": "Medicationhistory",
      "type": "array"
    },
    "allergiesOrReactions": {
      "title": "Allergiesorreactions",
      "type": "string"
    },
    "blood_group": {
      "title": "Blood Group",
      "type": "string"
    },
    "exposureToCommunicableDisease": {
      "title": "Exposuretocommunicabledisease",
      "type": "boolean"
    },
    "dischargePlanning": {
      "$ref": "#/$defs/GynecDischargePlanning"
    },
    "caregiverReadinessToLearn": {
      "$ref": "#/$defs/GynecCaregiverReadinessToLearn"
    },
    "barriersToLearning": {
      "$ref": "#/$defs/GynecBarriersToLearning"
    },
    "nursesNotes": {
      "title": "Nursesnotes",
      "type": "string"
    },
    "valuableHandedOver": {
      "title": "Valuablehandedover",
      "type": "boolean"
    },
    "pead_det": {
      "anyOf": [
        {
          "$ref": "#/$defs/PeadiatricDet"
        },
        {
          "type": "null"
        }
      ]
    },
    "vitals_abnormality": {
      "$ref": "#/$defs/VitalAbnormality"
    },
    "monitoring_tasks": {
      "items": {
        "$ref": "#/$defs/MonitoringTask"
      },
      "title": "Monitoring Tasks",
      "type": "array"
    },
    "iv_infusions": {
      "items": {
        "$ref": "#/$defs/IVInfusion"
      },
      "title": "Iv Infusions",
      "type": "array"
    },
    "drug_chart_patch": {
      "$ref": "#/$defs/DrugChartPatch"
    },
    "blood_borne": {
      "$ref": "#/$defs/BloodBorne"
    },
    "fasthug": {
      "$ref": "#/$defs/FastHugsBid"
    },
    "fasthug_events": {
      "items": {
        "$ref": "#/$defs/FastHugEventEntry"
      },
      "title": "Fasthug Events",
      "type": "array"
    }
  },
  "title": "GynecNurseInitialAssessment",
  "type": "object"
}
GynecNutritionalAssessment

FieldType / nested definitionRequiredMeaning
special_dietbooleanOptional / source-dependent
vulnerable_statusbooleanOptional / source-dependent
nutritional_issuesGynecNutritionalIssuesOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "special_diet": {
      "title": "Special Diet",
      "type": "boolean"
    },
    "vulnerable_status": {
      "title": "Vulnerable Status",
      "type": "boolean"
    },
    "nutritional_issues": {
      "$ref": "#/$defs/GynecNutritionalIssues"
    }
  },
  "title": "GynecNutritionalAssessment",
  "type": "object"
}
GynecNutritionalIssues

FieldType / nested definitionRequiredMeaning
presentbooleanOptional / source-dependent
action_takenstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "present": {
      "title": "Present",
      "type": "boolean"
    },
    "action_taken": {
      "title": "Action Taken",
      "type": "string"
    }
  },
  "title": "GynecNutritionalIssues",
  "type": "object"
}
GynecObstetricSpecificAssessment

FieldType / nested definitionRequiredMeaning
last_menstrual_periodstringOptional / source-dependent
expected_date_of_deliverystringOptional / source-dependent
multiple_pregnancystringOptional / source-dependent
fetal_statusGynecFetalStatusOptional / source-dependent
labour_statusGynecLabourStatusOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "last_menstrual_period": {
      "title": "Last Menstrual Period",
      "type": "string"
    },
    "expected_date_of_delivery": {
      "title": "Expected Date Of Delivery",
      "type": "string"
    },
    "multiple_pregnancy": {
      "title": "Multiple Pregnancy",
      "type": "string"
    },
    "fetal_status": {
      "$ref": "#/$defs/GynecFetalStatus"
    },
    "labour_status": {
      "$ref": "#/$defs/GynecLabourStatus"
    }
  },
  "title": "GynecObstetricSpecificAssessment",
  "type": "object"
}
GynecOrientation

FieldType / nested definitionRequiredMeaning
alertbooleanOptional / source-dependent
lethargicbooleanOptional / source-dependent
drowsybooleanOptional / source-dependent
confusedbooleanOptional / source-dependent
unresponsivebooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "alert": {
      "title": "Alert",
      "type": "boolean"
    },
    "lethargic": {
      "title": "Lethargic",
      "type": "boolean"
    },
    "drowsy": {
      "title": "Drowsy",
      "type": "boolean"
    },
    "confused": {
      "title": "Confused",
      "type": "boolean"
    },
    "unresponsive": {
      "title": "Unresponsive",
      "type": "boolean"
    }
  },
  "title": "GynecOrientation",
  "type": "object"
}
GynecPainAssessment

FieldType / nested definitionRequiredMeaning
pain_scoreintegerOptional / source-dependent
pain_locationstringOptional / source-dependent
intensity_of_painstringOptional / source-dependent
pain_characterGynecPainCharacterOptional / source-dependent
what_makes_pain_worsestringOptional / source-dependent
what_makes_pain_betterstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "pain_score": {
      "title": "Pain Score",
      "type": "integer"
    },
    "pain_location": {
      "title": "Pain Location",
      "type": "string"
    },
    "intensity_of_pain": {
      "title": "Intensity Of Pain",
      "type": "string"
    },
    "pain_character": {
      "$ref": "#/$defs/GynecPainCharacter"
    },
    "what_makes_pain_worse": {
      "title": "What Makes Pain Worse",
      "type": "string"
    },
    "what_makes_pain_better": {
      "title": "What Makes Pain Better",
      "type": "string"
    }
  },
  "title": "GynecPainAssessment",
  "type": "object"
}
GynecPainCharacter

FieldType / nested definitionRequiredMeaning
stabbingbooleanOptional / source-dependent
dullbooleanOptional / source-dependent
sharpbooleanOptional / source-dependent
shootingbooleanOptional / source-dependent
burningbooleanOptional / source-dependent
crampingbooleanOptional / source-dependent
tenderbooleanOptional / source-dependent
achingbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "stabbing": {
      "title": "Stabbing",
      "type": "boolean"
    },
    "dull": {
      "title": "Dull",
      "type": "boolean"
    },
    "sharp": {
      "title": "Sharp",
      "type": "boolean"
    },
    "shooting": {
      "title": "Shooting",
      "type": "boolean"
    },
    "burning": {
      "title": "Burning",
      "type": "boolean"
    },
    "cramping": {
      "title": "Cramping",
      "type": "boolean"
    },
    "tender": {
      "title": "Tender",
      "type": "boolean"
    },
    "aching": {
      "title": "Aching",
      "type": "boolean"
    }
  },
  "title": "GynecPainCharacter",
  "type": "object"
}
GynecPastMedicalHistory

FieldType / nested definitionRequiredMeaning
nonebooleanOptional / source-dependent
prematurebooleanOptional / source-dependent
diabetesbooleanOptional / source-dependent
asthmabooleanOptional / source-dependent
cancerbooleanOptional / source-dependent
ihdbooleanOptional / source-dependent
cvabooleanOptional / source-dependent
renalbooleanOptional / source-dependent
htnbooleanOptional / source-dependent
transplantbooleanOptional / source-dependent
cardiacbooleanOptional / source-dependent
serious_injurybooleanOptional / source-dependent
othersstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "none": {
      "title": "None",
      "type": "boolean"
    },
    "premature": {
      "title": "Premature",
      "type": "boolean"
    },
    "diabetes": {
      "title": "Diabetes",
      "type": "boolean"
    },
    "asthma": {
      "title": "Asthma",
      "type": "boolean"
    },
    "cancer": {
      "title": "Cancer",
      "type": "boolean"
    },
    "ihd": {
      "title": "Ihd",
      "type": "boolean"
    },
    "cva": {
      "title": "Cva",
      "type": "boolean"
    },
    "renal": {
      "title": "Renal",
      "type": "boolean"
    },
    "htn": {
      "title": "Htn",
      "type": "boolean"
    },
    "transplant": {
      "title": "Transplant",
      "type": "boolean"
    },
    "cardiac": {
      "title": "Cardiac",
      "type": "boolean"
    },
    "serious_injury": {
      "title": "Serious Injury",
      "type": "boolean"
    },
    "others": {
      "title": "Others",
      "type": "string"
    }
  },
  "title": "GynecPastMedicalHistory",
  "type": "object"
}
GynecSpecificAssessment

FieldType / nested definitionRequiredMeaning
breast_abscessbooleanOptional / source-dependent
vaginal_dischargeGynecVaginalDischargeOptional / source-dependent
urinary_incontinencebooleanOptional / source-dependent
pelvic_organ_prolapsebooleanOptional / source-dependent
sexual_dysfunctionbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "breast_abscess": {
      "title": "Breast Abscess",
      "type": "boolean"
    },
    "vaginal_discharge": {
      "$ref": "#/$defs/GynecVaginalDischarge"
    },
    "urinary_incontinence": {
      "title": "Urinary Incontinence",
      "type": "boolean"
    },
    "pelvic_organ_prolapse": {
      "title": "Pelvic Organ Prolapse",
      "type": "boolean"
    },
    "sexual_dysfunction": {
      "title": "Sexual Dysfunction",
      "type": "boolean"
    }
  },
  "title": "GynecSpecificAssessment",
  "type": "object"
}
GynecTriageCode

FieldType / nested definitionRequiredMeaning
red_critical_unstablebooleanOptional / source-dependent
yellow_potentially_unstablebooleanOptional / source-dependent
green_stablebooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "red_critical_unstable": {
      "title": "Red Critical Unstable",
      "type": "boolean"
    },
    "yellow_potentially_unstable": {
      "title": "Yellow Potentially Unstable",
      "type": "boolean"
    },
    "green_stable": {
      "title": "Green Stable",
      "type": "boolean"
    }
  },
  "title": "GynecTriageCode",
  "type": "object"
}
GynecVaginalBleeding

FieldType / nested definitionRequiredMeaning
presentbooleanOptional / source-dependent
date_timestringOptional / source-dependent
durationstringOptional / source-dependent
associated_eventsstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "present": {
      "title": "Present",
      "type": "boolean"
    },
    "date_time": {
      "title": "Date Time",
      "type": "string"
    },
    "duration": {
      "title": "Duration",
      "type": "string"
    },
    "associated_events": {
      "title": "Associated Events",
      "type": "string"
    }
  },
  "title": "GynecVaginalBleeding",
  "type": "object"
}
GynecVaginalDischarge

FieldType / nested definitionRequiredMeaning
presentbooleanOptional / source-dependent
onsetstringOptional / source-dependent
durationstringOptional / source-dependent
odorstringOptional / source-dependent
frequencystringOptional / source-dependent
colorstringOptional / source-dependent
consistencystringOptional / source-dependent
volumestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "present": {
      "title": "Present",
      "type": "boolean"
    },
    "onset": {
      "title": "Onset",
      "type": "string"
    },
    "duration": {
      "title": "Duration",
      "type": "string"
    },
    "odor": {
      "title": "Odor",
      "type": "string"
    },
    "frequency": {
      "title": "Frequency",
      "type": "string"
    },
    "color": {
      "title": "Color",
      "type": "string"
    },
    "consistency": {
      "title": "Consistency",
      "type": "string"
    },
    "volume": {
      "title": "Volume",
      "type": "string"
    }
  },
  "title": "GynecVaginalDischarge",
  "type": "object"
}
GynecVitals

FieldType / nested definitionRequiredMeaning
height_cmstringOptional / source-dependent
weight_kgstringOptional / source-dependent
temperaturestringOptional / source-dependent
pulsestringOptional / source-dependent
respirationstringOptional / source-dependent
blood_pressurestringOptional / source-dependent
oxygen_saturationstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "height_cm": {
      "title": "Height Cm",
      "type": "string"
    },
    "weight_kg": {
      "title": "Weight Kg",
      "type": "string"
    },
    "temperature": {
      "title": "Temperature",
      "type": "string"
    },
    "pulse": {
      "title": "Pulse",
      "type": "string"
    },
    "respiration": {
      "title": "Respiration",
      "type": "string"
    },
    "blood_pressure": {
      "title": "Blood Pressure",
      "type": "string"
    },
    "oxygen_saturation": {
      "title": "Oxygen Saturation",
      "type": "string"
    }
  },
  "title": "GynecVitals",
  "type": "object"
}
ICUBundle

FieldType / nested definitionRequiredMeaning
eye_movementEyeMovement | nullOptional / source-dependent
position_entPositionEntry | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "eye_movement": {
      "anyOf": [
        {
          "$ref": "#/$defs/EyeMovement"
        },
        {
          "type": "null"
        }
      ]
    },
    "position_ent": {
      "anyOf": [
        {
          "$ref": "#/$defs/PositionEntry"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "title": "ICUBundle",
  "type": "object"
}
ICUEnteralNutritionDetail

FieldType / nested definitionRequiredMeaning
en_access_typestringOptional / source-dependent Values: , NGT, NJT, PEG, Jejunostomy
gi_tolerancestringOptional / source-dependent Values: , Good, Poor, Intolerant
gastric_residual_volume_ml_4hrstringOptional / source-dependent
insulin_protocol_activeboolean | nullOptional / source-dependent
supplement_name_and_dosestringOptional / source-dependent
goals_of_care_discharge_nutrition_targetstringOptional / source-dependent
food_from_homestringOptional / source-dependent Values: , Permitted, Not permitted
patient_family_counselledboolean | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "en_access_type": {
      "enum": [
        "",
        "NGT",
        "NJT",
        "PEG",
        "Jejunostomy"
      ],
      "title": "En Access Type",
      "type": "string"
    },
    "gi_tolerance": {
      "enum": [
        "",
        "Good",
        "Poor",
        "Intolerant"
      ],
      "title": "Gi Tolerance",
      "type": "string"
    },
    "gastric_residual_volume_ml_4hr": {
      "title": "Gastric Residual Volume Ml 4Hr",
      "type": "string"
    },
    "insulin_protocol_active": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Insulin Protocol Active"
    },
    "supplement_name_and_dose": {
      "title": "Supplement Name And Dose",
      "type": "string"
    },
    "goals_of_care_discharge_nutrition_target": {
      "title": "Goals Of Care Discharge Nutrition Target",
      "type": "string"
    },
    "food_from_home": {
      "enum": [
        "",
        "Permitted",
        "Not permitted"
      ],
      "title": "Food From Home",
      "type": "string"
    },
    "patient_family_counselled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Patient Family Counselled"
    }
  },
  "title": "ICUEnteralNutritionDetail",
  "type": "object"
}
IVInfusion

FieldType / nested definitionRequiredMeaning
is_ivbooleanOptional / source-dependent
volume_mlinteger | nullOptional / source-dependent
speed_ml_hrinteger | nullOptional / source-dependent
start_or_stopstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "is_iv": {
      "title": "Is Iv",
      "type": "boolean"
    },
    "volume_ml": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Volume Ml"
    },
    "speed_ml_hr": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Speed Ml Hr"
    },
    "start_or_stop": {
      "title": "Start Or Stop",
      "type": "string"
    }
  },
  "title": "IVInfusion",
  "type": "object"
}
IcuFront

FieldType / nested definitionRequiredMeaning
allergyJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
diagnosisJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
date_of_surgeryJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
consultantJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
procedureJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
height_cmnumber | nullOptional / source-dependent
weight_kgnumber | nullOptional / source-dependent
bminumber | nullOptional / source-dependent
ideal_body_weight_kgnumber | nullOptional / source-dependent
blood_groupstringOptional / source-dependent
fasthugFastHugsBidOptional / source-dependent
intakeoutput_summaryobjectOptional / source-dependent
intakeoutput_summary.today_summaryobjectSource-dependent
intakeoutput_summary.today_summary.datestringSource-dependent
intakeoutput_summary.today_summary.intake_total_mlnumberSource-dependent
intakeoutput_summary.today_summary.output_total_mlnumberSource-dependent
intakeoutput_summary.today_summary.daily_balance_mlnumberSource-dependent
intakeoutput_summary.today_summary.cumulative_balance_mlnumberSource-dependent
intakeoutput_summary.previous_day_summaryJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
bowel_movementJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
pending_reportsJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
cross_referencesarray<JSON value>Optional / source-dependent
plan_for_todayJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
future_planJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "allergy": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "diagnosis": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "date_of_surgery": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "consultant": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "procedure": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "height_cm": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "weight_kg": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "bmi": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "ideal_body_weight_kg": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "blood_group": {
      "type": "string"
    },
    "fasthug": {
      "$ref": "#/$defs/FastHugsBid"
    },
    "intakeoutput_summary": {
      "type": "object",
      "properties": {
        "today_summary": {
          "type": "object",
          "properties": {
            "date": {
              "type": "string"
            },
            "intake_total_ml": {
              "type": "number"
            },
            "output_total_ml": {
              "type": "number"
            },
            "daily_balance_ml": {
              "type": "number"
            },
            "cumulative_balance_ml": {
              "type": "number"
            }
          },
          "additionalProperties": true
        },
        "previous_day_summary": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        }
      },
      "additionalProperties": true
    },
    "bowel_movement": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "pending_reports": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "cross_references": {
      "type": "array",
      "items": {
        "description": "Service-defined JSON value; preserve its returned type and fields."
      }
    },
    "plan_for_today": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "future_plan": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    }
  },
  "additionalProperties": true
}
IcuResponse

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
structured_dataobjectYes
structured_data.IPD_ICU_FORMarray<object>Source-dependent
structured_data.IPD_ICU_FORM[].frontIcuFrontSource-dependent
structured_data.IPD_ICU_FORM[].tprarray<JSON value>Source-dependent
structured_data.IPD_ICU_FORM[].intake_outtakearray<JSON value>Source-dependent
structured_data.IPD_ICU_FORM[].eye_movementarray<EyeMovement>Source-dependent
structured_data.IPD_ICU_FORM[].position_entarray<PositionEntry>Source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_ICU_FORM": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "front": {
                "$ref": "#/$defs/IcuFront"
              },
              "tpr": {
                "type": "array",
                "items": {
                  "description": "Service-defined JSON value; preserve its returned type and fields."
                }
              },
              "intake_outtake": {
                "type": "array",
                "items": {
                  "description": "Service-defined JSON value; preserve its returned type and fields."
                }
              },
              "eye_movement": {
                "type": "array",
                "items": {
                  "$ref": "#/$defs/EyeMovement"
                }
              },
              "position_ent": {
                "type": "array",
                "items": {
                  "$ref": "#/$defs/PositionEntry"
                }
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "inpatient_id",
    "structured_data"
  ]
}
IngestResponse

FieldType / nested definitionRequiredMeaning
statusbooleanYes
messagestringYes
dataJSON valueYesService-defined JSON value; preserve its returned type and fields.
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "status": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "data": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    }
  },
  "additionalProperties": true,
  "required": [
    "status",
    "message",
    "data"
  ]
}
InitialAssessment

FieldType / nested definitionRequiredMeaning
assessment_detailsstringYes
Exact JSON field definition
{
  "properties": {
    "assessment_details": {
      "title": "Assessment Details",
      "type": "string"
    }
  },
  "required": [
    "assessment_details"
  ],
  "title": "InitialAssessment",
  "type": "object"
}
InsertionChecklistForm

FieldType / nested definitionRequiredMeaning
diagnosisstringOptional / source-dependent
device_detailsDeviceDetailsOptional / source-dependent
pre_insertion_checksPreInsertionChecksOptional / source-dependent
insertion_procedureInsertionProcedureOptional / source-dependent
post_insertionPostInsertionOptional / source-dependent
signaturesSignaturesOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "diagnosis": {
      "title": "Diagnosis",
      "type": "string"
    },
    "device_details": {
      "$ref": "#/$defs/DeviceDetails"
    },
    "pre_insertion_checks": {
      "$ref": "#/$defs/PreInsertionChecks"
    },
    "insertion_procedure": {
      "$ref": "#/$defs/InsertionProcedure"
    },
    "post_insertion": {
      "$ref": "#/$defs/PostInsertion"
    },
    "signatures": {
      "$ref": "#/$defs/Signatures"
    }
  },
  "title": "InsertionChecklistForm",
  "type": "object"
}
InsertionProcedure

FieldType / nested definitionRequiredMeaning
sterile_barrier_precautions_usedbooleanOptional / source-dependent
skin_antisepsis_appliedbooleanOptional / source-dependent
aseptic_technique_maintainedbooleanOptional / source-dependent
correct_catheter_size_type_usedbooleanOptional / source-dependent
successful_insertionbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "sterile_barrier_precautions_used": {
      "title": "Sterile Barrier Precautions Used",
      "type": "boolean"
    },
    "skin_antisepsis_applied": {
      "title": "Skin Antisepsis Applied",
      "type": "boolean"
    },
    "aseptic_technique_maintained": {
      "title": "Aseptic Technique Maintained",
      "type": "boolean"
    },
    "correct_catheter_size_type_used": {
      "title": "Correct Catheter Size Type Used",
      "type": "boolean"
    },
    "successful_insertion": {
      "title": "Successful Insertion",
      "type": "boolean"
    }
  },
  "title": "InsertionProcedure",
  "type": "object"
}
IntakeData

FieldType / nested definitionRequiredMeaning
parenteralstring | nullOptional / source-dependent
parenteral_quantity_mlinteger | nullOptional / source-dependent
oral_rtstring | nullOptional / source-dependent
oral_rt_quantity_mlinteger | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "parenteral": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Parenteral"
    },
    "parenteral_quantity_ml": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Parenteral Quantity Ml"
    },
    "oral_rt": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oral Rt"
    },
    "oral_rt_quantity_ml": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Oral Rt Quantity Ml"
    }
  },
  "title": "IntakeData",
  "type": "object"
}
IntakeOutput

FieldType / nested definitionRequiredMeaning
intakearray<IntakeData>Yes
outputarray<OutputData>Yes
Exact JSON field definition
{
  "properties": {
    "intake": {
      "items": {
        "$ref": "#/$defs/IntakeData"
      },
      "title": "Intake",
      "type": "array"
    },
    "output": {
      "items": {
        "$ref": "#/$defs/OutputData"
      },
      "title": "Output",
      "type": "array"
    }
  },
  "required": [
    "intake",
    "output"
  ],
  "title": "IntakeOutput",
  "type": "object"
}
IntubDetails

FieldType / nested definitionRequiredMeaning
routearray<IntubRoute>Optional / source-dependent
endotracheal_tbsizestringOptional / source-dependent
tube_depthstringOptional / source-dependent
laryngoscope_usedstringOptional / source-dependent
no_attemptsstringOptional / source-dependent
intubated_bystringOptional / source-dependent
assisted_bystringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "route": {
      "items": {
        "$ref": "#/$defs/IntubRoute"
      },
      "title": "Route",
      "type": "array"
    },
    "endotracheal_tbsize": {
      "title": "Endotracheal Tbsize",
      "type": "string"
    },
    "tube_depth": {
      "title": "Tube Depth",
      "type": "string"
    },
    "laryngoscope_used": {
      "title": "Laryngoscope Used",
      "type": "string"
    },
    "no_attempts": {
      "title": "No Attempts",
      "type": "string"
    },
    "intubated_by": {
      "title": "Intubated By",
      "type": "string"
    },
    "assisted_by": {
      "title": "Assisted By",
      "type": "string"
    }
  },
  "title": "IntubDetails",
  "type": "object"
}
IntubIndication

FieldType / nested definitionRequiredMeaning
resp_fail_hypobooleanOptional / source-dependent
resp_fail_hyperbooleanOptional / source-dependent
air_protectbooleanOptional / source-dependent
dec_consbooleanOptional / source-dependent
card_arrestbooleanOptional / source-dependent
seiz_stat_epilepticusbooleanOptional / source-dependent
shockbooleanOptional / source-dependent
severe_pneumbooleanOptional / source-dependent
copdbooleanOptional / source-dependent
post_opsupportbooleanOptional / source-dependent
head_inj_icpbooleanOptional / source-dependent
meta_acidbooleanOptional / source-dependent
othersstring | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "resp_fail_hypo": {
      "title": "Resp Fail Hypo",
      "type": "boolean"
    },
    "resp_fail_hyper": {
      "title": "Resp Fail Hyper",
      "type": "boolean"
    },
    "air_protect": {
      "title": "Air Protect",
      "type": "boolean"
    },
    "dec_cons": {
      "title": "Dec Cons",
      "type": "boolean"
    },
    "card_arrest": {
      "title": "Card Arrest",
      "type": "boolean"
    },
    "seiz_stat_epilepticus": {
      "title": "Seiz Stat Epilepticus",
      "type": "boolean"
    },
    "shock": {
      "title": "Shock",
      "type": "boolean"
    },
    "severe_pneum": {
      "title": "Severe Pneum",
      "type": "boolean"
    },
    "copd": {
      "title": "Copd",
      "type": "boolean"
    },
    "post_opsupport": {
      "title": "Post Opsupport",
      "type": "boolean"
    },
    "head_inj_icp": {
      "title": "Head Inj Icp",
      "type": "boolean"
    },
    "meta_acid": {
      "title": "Meta Acid",
      "type": "boolean"
    },
    "others": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Others"
    }
  },
  "title": "IntubIndication",
  "type": "object"
}
IntubRoute

FieldType / nested definitionRequiredMeaning
oralbooleanOptional / source-dependent
nasalbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "oral": {
      "title": "Oral",
      "type": "boolean"
    },
    "nasal": {
      "title": "Nasal",
      "type": "boolean"
    }
  },
  "title": "IntubRoute",
  "type": "object"
}
IntubSetting

FieldType / nested definitionRequiredMeaning
modestringOptional / source-dependent
fio2stringOptional / source-dependent
tidal_volstringOptional / source-dependent
resp_ratestringOptional / source-dependent
peepstringOptional / source-dependent
press_suppstringOptional / source-dependent
peak_pressstringOptional / source-dependent
inspir_timestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "mode": {
      "title": "Mode",
      "type": "string"
    },
    "fio2": {
      "title": "Fio2",
      "type": "string"
    },
    "tidal_vol": {
      "title": "Tidal Vol",
      "type": "string"
    },
    "resp_rate": {
      "title": "Resp Rate",
      "type": "string"
    },
    "peep": {
      "title": "Peep",
      "type": "string"
    },
    "press_supp": {
      "title": "Press Supp",
      "type": "string"
    },
    "peak_press": {
      "title": "Peak Press",
      "type": "string"
    },
    "inspir_time": {
      "title": "Inspir Time",
      "type": "string"
    }
  },
  "title": "IntubSetting",
  "type": "object"
}
Investigation

FieldType / nested definitionRequiredMeaning
investigation_typestringYes
detailsstring | nullOptional / source-dependent
statusstring | nullOptional / source-dependent
sourceTodoSourceOptional / source-dependentDocument provenance; preserve without editing.
todo_idstringOptional / source-dependentOpaque task identifier; preserve it during edits.
todo_versionintegerOptional / source-dependentVersion returned by the service. Preserve it; the software routes do not expose a conditional-update contract.
Exact JSON field definition
{
  "properties": {
    "investigation_type": {
      "title": "Investigation Type",
      "type": "string"
    },
    "details": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Details"
    },
    "status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Status"
    },
    "source": {
      "$ref": "#/$defs/TodoSource",
      "description": "Document provenance; preserve without editing."
    },
    "todo_id": {
      "type": "string",
      "description": "Opaque task identifier; preserve it during edits."
    },
    "todo_version": {
      "type": "integer",
      "description": "Version returned by the service. Preserve it; the software routes do not expose a conditional-update contract."
    }
  },
  "required": [
    "investigation_type"
  ],
  "title": "Investigation",
  "type": "object"
}
MedicationData

FieldType / nested definitionRequiredMeaning
medication_namestringYes
medication_typestring | nullOptional / source-dependent
dosagestring | nullOptional / source-dependent
routestring | nullOptional / source-dependent
frequency_morningstring | nullYes
frequency_afternoonstring | nullYes
frequency_eveningstring | nullYes
frequency_nightstring | nullYes
durationstring | nullOptional / source-dependent
duration_sourcestring | nullOptional / source-dependent
continue_until_stoppedboolean | nullOptional / source-dependent
dosage_timestring | nullOptional / source-dependent
instructionsstring | nullOptional / source-dependent
med_statusstring | nullOptional / source-dependent
is_statboolean | nullOptional / source-dependent
is_once_onlyboolean | nullOptional / source-dependent
is_sosboolean | nullOptional / source-dependent
is_infusionboolean | nullOptional / source-dependent
is_statusstring | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "medication_name": {
      "title": "Medication Name",
      "type": "string"
    },
    "medication_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Medication Type"
    },
    "dosage": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dosage"
    },
    "route": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Route"
    },
    "frequency_morning": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Frequency Morning"
    },
    "frequency_afternoon": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Frequency Afternoon"
    },
    "frequency_evening": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Frequency Evening"
    },
    "frequency_night": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Frequency Night"
    },
    "duration": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Duration"
    },
    "duration_source": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Duration Source"
    },
    "continue_until_stopped": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Continue Until Stopped"
    },
    "dosage_time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dosage Time"
    },
    "instructions": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Instructions"
    },
    "med_status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Med Status"
    },
    "is_stat": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Stat"
    },
    "is_once_only": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Once Only"
    },
    "is_sos": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Sos"
    },
    "is_infusion": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Infusion"
    },
    "is_status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Status"
    }
  },
  "required": [
    "medication_name",
    "frequency_morning",
    "frequency_afternoon",
    "frequency_evening",
    "frequency_night"
  ],
  "title": "MedicationData",
  "type": "object"
}
MedicationReconciliation

FieldType / nested definitionRequiredMeaning
previous_medicationsarray<PreviousMedicationEntry>Optional / source-dependent
Exact JSON field definition
{
  "properties": {
    "previous_medications": {
      "items": {
        "$ref": "#/$defs/PreviousMedicationEntry"
      },
      "title": "Previous Medications",
      "type": "array"
    }
  },
  "title": "MedicationReconciliation",
  "type": "object"
}
MedicationReconciliationItem

FieldType / nested definitionRequiredMeaning
medication_namestringYes
dosagestring | nullOptional / source-dependent
routestring | nullOptional / source-dependent
frequencystring | nullOptional / source-dependent
continue_medicationbooleanOptional / source-dependent
notesstring | nullOptional / source-dependent
reconciled_bystring | nullOptional / source-dependent
reconciled_atstring | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "medication_name": {
      "title": "Medication Name",
      "type": "string"
    },
    "dosage": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dosage"
    },
    "route": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Route"
    },
    "frequency": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Frequency"
    },
    "continue_medication": {
      "title": "Continue Medication",
      "type": "boolean"
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Notes"
    },
    "reconciled_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reconciled By"
    },
    "reconciled_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Reconciled At"
    }
  },
  "required": [
    "medication_name"
  ],
  "title": "MedicationReconciliationItem",
  "type": "object"
}
MergedSchema

FieldType / nested definitionRequiredMeaning
prescription_dataPrescriptionDataOptional / source-dependent
total_recordsTotalRecordsOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "prescription_data": {
      "$ref": "#/$defs/PrescriptionData"
    },
    "total_records": {
      "$ref": "#/$defs/TotalRecords"
    }
  },
  "title": "MergedSchema",
  "type": "object"
}
MergedTodo

FieldType / nested definitionRequiredMeaning
is_mergedbooleanOptional / source-dependent
interaction_idsarray<string | integer | null>Optional / source-dependent
ordered_byarray<string | integer | null>Optional / source-dependent
approved_byarray<string | integer | null>Optional / source-dependent
first_created_atstring | nullOptional / source-dependent
last_created_atstring | nullOptional / source-dependent
todosarray<ToDoList>Optional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "is_merged": {
      "type": "boolean"
    },
    "interaction_ids": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "integer"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "ordered_by": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "integer"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "approved_by": {
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "integer"
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "first_created_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "last_created_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "todos": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ToDoList"
      }
    }
  },
  "additionalProperties": true
}
MonitoringOrder

FieldType / nested definitionRequiredMeaning
monitoring_orderstringYes
instructionsstringOptional / source-dependent
interval_minutesinteger | nullOptional / source-dependent
start_or_stopstringOptional / source-dependent
statusstringOptional / source-dependent
sourceTodoSourceOptional / source-dependentDocument provenance; preserve without editing.
todo_idstringOptional / source-dependentOpaque task identifier; preserve it during edits.
todo_versionintegerOptional / source-dependentVersion returned by the service. Preserve it; the software routes do not expose a conditional-update contract.
Exact JSON field definition
{
  "properties": {
    "monitoring_order": {
      "title": "Monitoring Order",
      "type": "string"
    },
    "instructions": {
      "title": "Instructions",
      "type": "string"
    },
    "interval_minutes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Interval Minutes"
    },
    "start_or_stop": {
      "title": "Start Or Stop",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "source": {
      "$ref": "#/$defs/TodoSource",
      "description": "Document provenance; preserve without editing."
    },
    "todo_id": {
      "type": "string",
      "description": "Opaque task identifier; preserve it during edits."
    },
    "todo_version": {
      "type": "integer",
      "description": "Version returned by the service. Preserve it; the software routes do not expose a conditional-update contract."
    }
  },
  "required": [
    "monitoring_order"
  ],
  "title": "MonitoringOrder",
  "type": "object"
}
MonitoringTask

FieldType / nested definitionRequiredMeaning
is_monitorbooleanOptional / source-dependent
monitoring_messagestringOptional / source-dependent
interval_minutesinteger | nullOptional / source-dependent
start_or_stopstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "is_monitor": {
      "title": "Is Monitor",
      "type": "boolean"
    },
    "monitoring_message": {
      "title": "Monitoring Message",
      "type": "string"
    },
    "interval_minutes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Interval Minutes"
    },
    "start_or_stop": {
      "title": "Start Or Stop",
      "type": "string"
    }
  },
  "title": "MonitoringTask",
  "type": "object"
}
MucousMembranes

FieldType / nested definitionRequiredMeaning
isAssessedbooleanYes
statestringYes
Exact JSON field definition
{
  "properties": {
    "isAssessed": {
      "title": "Isassessed",
      "type": "boolean"
    },
    "state": {
      "title": "State",
      "type": "string"
    }
  },
  "required": [
    "isAssessed",
    "state"
  ],
  "title": "MucousMembranes",
  "type": "object"
}
NewPRNOrderCommand

FieldType / nested definitionRequiredMeaning
drug_namestringOptional / source-dependent
dosestringOptional / source-dependent
routestringOptional / source-dependent
max_frequencystringOptional / source-dependent
indicationstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "drug_name": {
      "title": "Drug Name",
      "type": "string"
    },
    "dose": {
      "title": "Dose",
      "type": "string"
    },
    "route": {
      "title": "Route",
      "type": "string"
    },
    "max_frequency": {
      "title": "Max Frequency",
      "type": "string"
    },
    "indication": {
      "title": "Indication",
      "type": "string"
    }
  },
  "title": "NewPRNOrderCommand",
  "type": "object"
}
NewRegularOrderCommand

FieldType / nested definitionRequiredMeaning
drug_namestringOptional / source-dependent
dosestringOptional / source-dependent
routestringOptional / source-dependent
frequencystringOptional / source-dependent
administration_timesarray<string>Optional / source-dependent
notesstringOptional / source-dependent
is_statboolean | nullOptional / source-dependent
is_once_onlyboolean | nullOptional / source-dependent
is_sosboolean | nullOptional / source-dependent
is_infusionboolean | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "drug_name": {
      "title": "Drug Name",
      "type": "string"
    },
    "dose": {
      "title": "Dose",
      "type": "string"
    },
    "route": {
      "title": "Route",
      "type": "string"
    },
    "frequency": {
      "title": "Frequency",
      "type": "string"
    },
    "administration_times": {
      "items": {
        "type": "string"
      },
      "title": "Administration Times",
      "type": "array"
    },
    "notes": {
      "title": "Notes",
      "type": "string"
    },
    "is_stat": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Stat"
    },
    "is_once_only": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Once Only"
    },
    "is_sos": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Sos"
    },
    "is_infusion": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Infusion"
    }
  },
  "title": "NewRegularOrderCommand",
  "type": "object"
}
NurBloodTrans

FieldType / nested definitionRequiredMeaning
b_grpstring | nullOptional / source-dependent
pck_nostringOptional / source-dependent
bg_prodsstring | nullOptional / source-dependent
noustring | nullOptional / source-dependent
date_cmstring | nullOptional / source-dependent
exp_datestring | nullOptional / source-dependent
consent_transboolean | nullOptional / source-dependent
check_docarray<doc_check>Optional / source-dependent
time_outarray<PreTransfusionCheck>Optional / source-dependent
check_nurarray<nur_check>Optional / source-dependent
checklistBTChecklistOptional / source-dependent
fluid_monitoringarray<BTFluidMonitoring>Optional / source-dependent
post_transfusionBTPostTransfusionOptional / source-dependent
reaction_occurredbooleanOptional / source-dependent
reaction_reportBTReactionReport | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "b_grp": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "B Grp"
    },
    "pck_no": {
      "title": "Pck No",
      "type": "string"
    },
    "bg_prods": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Bg Prods"
    },
    "nou": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Nou"
    },
    "date_cm": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Date Cm"
    },
    "exp_date": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Exp Date"
    },
    "consent_trans": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Consent Trans"
    },
    "check_doc": {
      "items": {
        "$ref": "#/$defs/doc_check"
      },
      "title": "Check Doc",
      "type": "array"
    },
    "time_out": {
      "items": {
        "$ref": "#/$defs/PreTransfusionCheck"
      },
      "title": "Time Out",
      "type": "array"
    },
    "check_nur": {
      "items": {
        "$ref": "#/$defs/nur_check"
      },
      "title": "Check Nur",
      "type": "array"
    },
    "checklist": {
      "$ref": "#/$defs/BTChecklist"
    },
    "fluid_monitoring": {
      "items": {
        "$ref": "#/$defs/BTFluidMonitoring"
      },
      "title": "Fluid Monitoring",
      "type": "array"
    },
    "post_transfusion": {
      "$ref": "#/$defs/BTPostTransfusion"
    },
    "reaction_occurred": {
      "title": "Reaction Occurred",
      "type": "boolean"
    },
    "reaction_report": {
      "anyOf": [
        {
          "$ref": "#/$defs/BTReactionReport"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "title": "NurBloodTrans",
  "type": "object"
}
NurseAssessment

FieldType / nested definitionRequiredMeaning
arrivalAndTriageGynecArrivalAndTriageOptional / source-dependent
basicInformationBasicInformationYes
functionalAssessmentFunctionalAssessmentYes
nutritionalAssessmentNutritionalAssessmentYes
painAssessmentPainAssessmentYes
pastMedicalHistoryGynecPastMedicalHistoryOptional / source-dependent
medicationHistoryarray<GynecMedicationHistory>Optional / source-dependent
pastSurgicalHistorystringOptional / source-dependent
psychosocialIssuesstringOptional / source-dependent
nursesNotesstringOptional / source-dependent
valuableHandedOverbooleanOptional / source-dependent
pead_detPeadiatricDet | nullOptional / source-dependent
vitals_abnormalityVitalAbnormalityOptional / source-dependent
monitoring_tasksarray<MonitoringTask>Optional / source-dependent
iv_infusionsarray<IVInfusion>Optional / source-dependent
drug_chart_patchDrugChartPatchOptional / source-dependent
blood_borneBloodBorneOptional / source-dependent
fasthugFastHugsBidOptional / source-dependent
fasthug_eventsarray<FastHugEventEntry>Optional / source-dependent
Exact JSON field definition
{
  "properties": {
    "arrivalAndTriage": {
      "$ref": "#/$defs/GynecArrivalAndTriage"
    },
    "basicInformation": {
      "$ref": "#/$defs/BasicInformation"
    },
    "functionalAssessment": {
      "$ref": "#/$defs/FunctionalAssessment"
    },
    "nutritionalAssessment": {
      "$ref": "#/$defs/NutritionalAssessment"
    },
    "painAssessment": {
      "$ref": "#/$defs/PainAssessment"
    },
    "pastMedicalHistory": {
      "$ref": "#/$defs/GynecPastMedicalHistory"
    },
    "medicationHistory": {
      "items": {
        "$ref": "#/$defs/GynecMedicationHistory"
      },
      "title": "Medicationhistory",
      "type": "array"
    },
    "pastSurgicalHistory": {
      "title": "Pastsurgicalhistory",
      "type": "string"
    },
    "psychosocialIssues": {
      "title": "Psychosocialissues",
      "type": "string"
    },
    "nursesNotes": {
      "title": "Nursesnotes",
      "type": "string"
    },
    "valuableHandedOver": {
      "title": "Valuablehandedover",
      "type": "boolean"
    },
    "pead_det": {
      "anyOf": [
        {
          "$ref": "#/$defs/PeadiatricDet"
        },
        {
          "type": "null"
        }
      ]
    },
    "vitals_abnormality": {
      "$ref": "#/$defs/VitalAbnormality"
    },
    "monitoring_tasks": {
      "items": {
        "$ref": "#/$defs/MonitoringTask"
      },
      "title": "Monitoring Tasks",
      "type": "array"
    },
    "iv_infusions": {
      "items": {
        "$ref": "#/$defs/IVInfusion"
      },
      "title": "Iv Infusions",
      "type": "array"
    },
    "drug_chart_patch": {
      "$ref": "#/$defs/DrugChartPatch"
    },
    "blood_borne": {
      "$ref": "#/$defs/BloodBorne"
    },
    "fasthug": {
      "$ref": "#/$defs/FastHugsBid"
    },
    "fasthug_events": {
      "items": {
        "$ref": "#/$defs/FastHugEventEntry"
      },
      "title": "Fasthug Events",
      "type": "array"
    }
  },
  "required": [
    "basicInformation",
    "functionalAssessment",
    "nutritionalAssessment",
    "painAssessment"
  ],
  "title": "NurseAssessment",
  "type": "object"
}
NurseAssessmentVitals

FieldType / nested definitionRequiredMeaning
blood_pressurestringYes
pulsestringYes
respirationstringYes
temperaturestringYes
spo2stringYes
blood_sugarstringOptional / source-dependent
abnormality_detectedbooleanOptional / source-dependent
abnormal_vitals_messagestringOptional / source-dependent
overall_severityVitalSeverityOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "blood_pressure": {
      "title": "Blood Pressure",
      "type": "string"
    },
    "pulse": {
      "title": "Pulse",
      "type": "string"
    },
    "respiration": {
      "title": "Respiration",
      "type": "string"
    },
    "temperature": {
      "title": "Temperature",
      "type": "string"
    },
    "spo2": {
      "title": "Spo2",
      "type": "string"
    },
    "blood_sugar": {
      "title": "Blood Sugar",
      "type": "string"
    },
    "abnormality_detected": {
      "title": "Abnormality Detected",
      "type": "boolean"
    },
    "abnormal_vitals_message": {
      "title": "Abnormal Vitals Message",
      "type": "string"
    },
    "overall_severity": {
      "$ref": "#/$defs/VitalSeverity"
    }
  },
  "required": [
    "blood_pressure",
    "pulse",
    "respiration",
    "temperature",
    "spo2"
  ],
  "title": "NurseAssessmentVitals",
  "type": "object"
}
NurseBloodGlucoseMonitoring

FieldType / nested definitionRequiredMeaning
blood_sugarstring | nullOptional / source-dependent
medicationstring | nullOptional / source-dependent
creatinine_levelstring | nullOptional / source-dependent
consent_for_insulinboolean | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "blood_sugar": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Blood Sugar"
    },
    "medication": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Medication"
    },
    "creatinine_level": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Creatinine Level"
    },
    "consent_for_insulin": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Consent For Insulin"
    }
  },
  "title": "NurseBloodGlucoseMonitoring",
  "type": "object"
}
NurseCarePlanSchema

FieldType / nested definitionRequiredMeaning
care_planarray<NursingDiagnosisPlan>Yes
Exact JSON field definition
{
  "properties": {
    "care_plan": {
      "items": {
        "$ref": "#/$defs/NursingDiagnosisPlan"
      },
      "title": "Care Plan",
      "type": "array"
    }
  },
  "required": [
    "care_plan"
  ],
  "title": "NurseCarePlanSchema",
  "type": "object"
}
NurseNoteRecord

FieldType / nested definitionRequiredMeaning
created_atstringOptional / source-dependent
updated_atstringOptional / source-dependent
interaction_typestringOptional / source-dependent
answerJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
nurse_idstring | integer | nullOptional / source-dependent
caregiver_idstringOptional / source-dependent
handovered_nursearray<JSON value>Optional / source-dependent
read_errorstringOptional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "interaction_type": {
      "type": "string"
    },
    "answer": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "nurse_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "caregiver_id": {
      "type": "string"
    },
    "handovered_nurse": {
      "type": "array",
      "items": {
        "description": "Service-defined JSON value; preserve its returned type and fields."
      }
    },
    "read_error": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
NurseNoteSet

FieldType / nested definitionRequiredMeaning
notesmap<string, NurseNoteRecord>Optional / source-dependent
pain_assessmentJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
care_givenJSON valueOptional / source-dependentService-defined JSON value; preserve its returned type and fields.
braden_scaleBradenScale | nullOptional / source-dependent
section_errorstringOptional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "notes": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/NurseNoteRecord"
      }
    },
    "pain_assessment": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "care_given": {
      "description": "Service-defined JSON value; preserve its returned type and fields."
    },
    "braden_scale": {
      "anyOf": [
        {
          "$ref": "#/$defs/BradenScale"
        },
        {
          "type": "null"
        }
      ]
    },
    "section_error": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
NurseNotes

FieldType / nested definitionRequiredMeaning
situationstringOptional / source-dependent
backgroundstringOptional / source-dependent
assessmentstringYes
investigationsstringOptional / source-dependent
interventionsstringYes
medical_administrationstringYes
patient_responsestringYes
clinician_communicationstringOptional / source-dependent
care_instructionsstringOptional / source-dependent
recommendationstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "situation": {
      "title": "Situation",
      "type": "string"
    },
    "background": {
      "title": "Background",
      "type": "string"
    },
    "assessment": {
      "title": "Assessment",
      "type": "string"
    },
    "investigations": {
      "title": "Investigations",
      "type": "string"
    },
    "interventions": {
      "title": "Interventions",
      "type": "string"
    },
    "medical_administration": {
      "title": "Medical Administration",
      "type": "string"
    },
    "patient_response": {
      "title": "Patient Response",
      "type": "string"
    },
    "clinician_communication": {
      "title": "Clinician Communication",
      "type": "string"
    },
    "care_instructions": {
      "title": "Care Instructions",
      "type": "string"
    },
    "recommendation": {
      "title": "Recommendation",
      "type": "string"
    }
  },
  "required": [
    "assessment",
    "interventions",
    "medical_administration",
    "patient_response"
  ],
  "title": "NurseNotes",
  "type": "object"
}
NurseTaskResponse

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
todo_dataarray<TaskRecord>Yes
merged_todoMergedTodoOptional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "todo_data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/TaskRecord"
      }
    },
    "merged_todo": {
      "$ref": "#/$defs/MergedTodo"
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "inpatient_id",
    "todo_data"
  ]
}
NursingCareOrder

FieldType / nested definitionRequiredMeaning
nursing_care_orderstringYes
instructionsstringOptional / source-dependent
statusstringOptional / source-dependent
sourceTodoSourceOptional / source-dependentDocument provenance; preserve without editing.
todo_idstringOptional / source-dependentOpaque task identifier; preserve it during edits.
todo_versionintegerOptional / source-dependentVersion returned by the service. Preserve it; the software routes do not expose a conditional-update contract.
Exact JSON field definition
{
  "properties": {
    "nursing_care_order": {
      "title": "Nursing Care Order",
      "type": "string"
    },
    "instructions": {
      "title": "Instructions",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "source": {
      "$ref": "#/$defs/TodoSource",
      "description": "Document provenance; preserve without editing."
    },
    "todo_id": {
      "type": "string",
      "description": "Opaque task identifier; preserve it during edits."
    },
    "todo_version": {
      "type": "integer",
      "description": "Version returned by the service. Preserve it; the software routes do not expose a conditional-update contract."
    }
  },
  "required": [
    "nursing_care_order"
  ],
  "title": "NursingCareOrder",
  "type": "object"
}
NursingDiagnosisPlan

FieldType / nested definitionRequiredMeaning
diagnosisstringYes
goalstringYes
interventionsarray<string>Yes
evaluationstring | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "diagnosis": {
      "title": "Diagnosis",
      "type": "string"
    },
    "goal": {
      "title": "Goal",
      "type": "string"
    },
    "interventions": {
      "items": {
        "type": "string"
      },
      "title": "Interventions",
      "type": "array"
    },
    "evaluation": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Evaluation"
    }
  },
  "required": [
    "diagnosis",
    "goal",
    "interventions"
  ],
  "title": "NursingDiagnosisPlan",
  "type": "object"
}
NutritionDailyProgressEntry

FieldType / nested definitionRequiredMeaning
datestringOptional / source-dependent
weight_kgstringOptional / source-dependent
prescribed_kcal_and_proteinstringOptional / source-dependent
actual_intakestringOptional / source-dependent
percent_metstringOptional / source-dependent
reason_for_gapstringOptional / source-dependent
progress_notes_tolerancestringOptional / source-dependent
goal_next_visitstringOptional / source-dependent
signstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "date": {
      "title": "Date",
      "type": "string"
    },
    "weight_kg": {
      "title": "Weight Kg",
      "type": "string"
    },
    "prescribed_kcal_and_protein": {
      "title": "Prescribed Kcal And Protein",
      "type": "string"
    },
    "actual_intake": {
      "title": "Actual Intake",
      "type": "string"
    },
    "percent_met": {
      "title": "Percent Met",
      "type": "string"
    },
    "reason_for_gap": {
      "title": "Reason For Gap",
      "type": "string"
    },
    "progress_notes_tolerance": {
      "title": "Progress Notes Tolerance",
      "type": "string"
    },
    "goal_next_visit": {
      "title": "Goal Next Visit",
      "type": "string"
    },
    "sign": {
      "title": "Sign",
      "type": "string"
    }
  },
  "title": "NutritionDailyProgressEntry",
  "type": "object"
}
NutritionDischargeSummary

FieldType / nested definitionRequiredMeaning
discharge_weight_kgstringOptional / source-dependent
sga_pem_grade_at_dischargestringOptional / source-dependent
nutritional_goal_achievedstringOptional / source-dependent Values: , Fully, Partially, Not achieved
follow_up_opd_dietitian_referral_datestringOptional / source-dependent
discharge_diet_advice_written_planstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "discharge_weight_kg": {
      "title": "Discharge Weight Kg",
      "type": "string"
    },
    "sga_pem_grade_at_discharge": {
      "title": "Sga Pem Grade At Discharge",
      "type": "string"
    },
    "nutritional_goal_achieved": {
      "enum": [
        "",
        "Fully",
        "Partially",
        "Not achieved"
      ],
      "title": "Nutritional Goal Achieved",
      "type": "string"
    },
    "follow_up_opd_dietitian_referral_date": {
      "title": "Follow Up Opd Dietitian Referral Date",
      "type": "string"
    },
    "discharge_diet_advice_written_plan": {
      "title": "Discharge Diet Advice Written Plan",
      "type": "string"
    }
  },
  "title": "NutritionDischargeSummary",
  "type": "object"
}
NutritionNotes

FieldType / nested definitionRequiredMeaning
sga_pem_gradingSGAPEMGrading | nullOptional / source-dependent
paediatric_pem_gradingPaediatricPEMGrading | nullOptional / source-dependent
diet_pattern_and_allergiesDietPatternAndAllergies | nullOptional / source-dependent
nutritional_interventionNutritionalIntervention | nullOptional / source-dependent
nutritional_intervention_entriesNutritionalIntervention | nullOptional / source-dependent
daily_progress_monitoringNutritionDailyProgressEntry | nullOptional / source-dependent
discharge_summaryNutritionDischargeSummary | nullOptional / source-dependent
special_notesstringOptional / source-dependent
monitoring_tasksarray<MonitoringTask>Optional / source-dependent
Exact JSON field definition
{
  "properties": {
    "sga_pem_grading": {
      "anyOf": [
        {
          "$ref": "#/$defs/SGAPEMGrading"
        },
        {
          "type": "null"
        }
      ]
    },
    "paediatric_pem_grading": {
      "anyOf": [
        {
          "$ref": "#/$defs/PaediatricPEMGrading"
        },
        {
          "type": "null"
        }
      ]
    },
    "diet_pattern_and_allergies": {
      "anyOf": [
        {
          "$ref": "#/$defs/DietPatternAndAllergies"
        },
        {
          "type": "null"
        }
      ]
    },
    "nutritional_intervention": {
      "anyOf": [
        {
          "$ref": "#/$defs/NutritionalIntervention"
        },
        {
          "type": "null"
        }
      ]
    },
    "nutritional_intervention_entries": {
      "anyOf": [
        {
          "$ref": "#/$defs/NutritionalIntervention"
        },
        {
          "type": "null"
        }
      ]
    },
    "daily_progress_monitoring": {
      "anyOf": [
        {
          "$ref": "#/$defs/NutritionDailyProgressEntry"
        },
        {
          "type": "null"
        }
      ]
    },
    "discharge_summary": {
      "anyOf": [
        {
          "$ref": "#/$defs/NutritionDischargeSummary"
        },
        {
          "type": "null"
        }
      ]
    },
    "special_notes": {
      "title": "Special Notes",
      "type": "string"
    },
    "monitoring_tasks": {
      "items": {
        "$ref": "#/$defs/MonitoringTask"
      },
      "title": "Monitoring Tasks",
      "type": "array"
    }
  },
  "title": "NutritionNotes",
  "type": "object"
}
NutritionResponse

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
structured_dataobjectYes
structured_data.IPD_NUTRITION_FORMarray<NutritionNotes>Source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_NUTRITION_FORM": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/NutritionNotes"
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "inpatient_id",
    "structured_data"
  ]
}
NutritionalAssessment

FieldType / nested definitionRequiredMeaning
dietDietYes
recentWeightChangesbooleanYes
supplementsbooleanYes
conditionsAffectingEatingbooleanYes
monitoringRequiredAtMealTimesbooleanYes
fluidsMonitoringFluidsMonitoringYes
mucousMembranesMucousMembranesYes
skinTurgorSkinTurgorYes
Exact JSON field definition
{
  "properties": {
    "diet": {
      "$ref": "#/$defs/Diet"
    },
    "recentWeightChanges": {
      "title": "Recentweightchanges",
      "type": "boolean"
    },
    "supplements": {
      "title": "Supplements",
      "type": "boolean"
    },
    "conditionsAffectingEating": {
      "title": "Conditionsaffectingeating",
      "type": "boolean"
    },
    "monitoringRequiredAtMealTimes": {
      "title": "Monitoringrequiredatmealtimes",
      "type": "boolean"
    },
    "fluidsMonitoring": {
      "$ref": "#/$defs/FluidsMonitoring"
    },
    "mucousMembranes": {
      "$ref": "#/$defs/MucousMembranes"
    },
    "skinTurgor": {
      "$ref": "#/$defs/SkinTurgor"
    }
  },
  "required": [
    "diet",
    "recentWeightChanges",
    "supplements",
    "conditionsAffectingEating",
    "monitoringRequiredAtMealTimes",
    "fluidsMonitoring",
    "mucousMembranes",
    "skinTurgor"
  ],
  "title": "NutritionalAssessment",
  "type": "object"
}
NutritionalIntervention

FieldType / nested definitionRequiredMeaning
intervention_datestringOptional / source-dependent
diet_advisedstringOptional / source-dependent
energy_prescribed_kcal_daystringOptional / source-dependent
protein_prescribed_g_daystringOptional / source-dependent
calorie_gap_kcalstringOptional / source-dependent
diet_orderstringOptional / source-dependent
feeding_routestringOptional / source-dependent Values: , NPO, Oral, Enteral nutrition (EN), Parenteral nutrition (PN), EN + PN combined
current_feeding_pattern_on_admissionstringOptional / source-dependent
fluid_restrictionboolean | nullOptional / source-dependent
fluid_restriction_volume_ml_daystringOptional / source-dependent
supplement_name_and_dosestringOptional / source-dependent
goals_of_care_discharge_nutrition_targetstringOptional / source-dependent
food_from_homestringOptional / source-dependent Values: , Permitted, Not permitted
patient_family_counselledboolean | nullOptional / source-dependent
icu_enteral_nutrition_detailICUEnteralNutritionDetailOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "intervention_date": {
      "title": "Intervention Date",
      "type": "string"
    },
    "diet_advised": {
      "title": "Diet Advised",
      "type": "string"
    },
    "energy_prescribed_kcal_day": {
      "title": "Energy Prescribed Kcal Day",
      "type": "string"
    },
    "protein_prescribed_g_day": {
      "title": "Protein Prescribed G Day",
      "type": "string"
    },
    "calorie_gap_kcal": {
      "title": "Calorie Gap Kcal",
      "type": "string"
    },
    "diet_order": {
      "title": "Diet Order",
      "type": "string"
    },
    "feeding_route": {
      "enum": [
        "",
        "NPO",
        "Oral",
        "Enteral nutrition (EN)",
        "Parenteral nutrition (PN)",
        "EN + PN combined"
      ],
      "title": "Feeding Route",
      "type": "string"
    },
    "current_feeding_pattern_on_admission": {
      "title": "Current Feeding Pattern On Admission",
      "type": "string"
    },
    "fluid_restriction": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Fluid Restriction"
    },
    "fluid_restriction_volume_ml_day": {
      "title": "Fluid Restriction Volume Ml Day",
      "type": "string"
    },
    "supplement_name_and_dose": {
      "title": "Supplement Name And Dose",
      "type": "string"
    },
    "goals_of_care_discharge_nutrition_target": {
      "title": "Goals Of Care Discharge Nutrition Target",
      "type": "string"
    },
    "food_from_home": {
      "enum": [
        "",
        "Permitted",
        "Not permitted"
      ],
      "title": "Food From Home",
      "type": "string"
    },
    "patient_family_counselled": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Patient Family Counselled"
    },
    "icu_enteral_nutrition_detail": {
      "$ref": "#/$defs/ICUEnteralNutritionDetail"
    }
  },
  "title": "NutritionalIntervention",
  "type": "object"
}
OnceOnlyDrug

FieldType / nested definitionRequiredMeaning
medication_namestringYes
dosagestringYes
routestringYes
statusstringYes
start_datestringOptional / source-dependent
prescription_typestringOptional / source-dependent
additional_informationstring | nullOptional / source-dependent
is_statboolean | nullOptional / source-dependent
is_once_onlyboolean | nullOptional / source-dependent
is_sosboolean | nullOptional / source-dependent
is_infusionboolean | nullOptional / source-dependent
frequency_morningstringOptional / source-dependent
frequency_afternoonstringOptional / source-dependent
frequency_eveningstringOptional / source-dependent
frequency_nightstringOptional / source-dependent
created_atstringYes
prescribed_bystringYes
administeredarray<PerDrugAdministration>Optional / source-dependent
Exact JSON field definition
{
  "properties": {
    "medication_name": {
      "title": "Medication Name",
      "type": "string"
    },
    "dosage": {
      "title": "Dosage",
      "type": "string"
    },
    "route": {
      "title": "Route",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "start_date": {
      "format": "date",
      "title": "Start Date",
      "type": "string"
    },
    "prescription_type": {
      "title": "Prescription Type",
      "type": "string"
    },
    "additional_information": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Additional Information"
    },
    "is_stat": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Stat"
    },
    "is_once_only": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Once Only"
    },
    "is_sos": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Sos"
    },
    "is_infusion": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Infusion"
    },
    "frequency_morning": {
      "title": "Frequency Morning",
      "type": "string"
    },
    "frequency_afternoon": {
      "title": "Frequency Afternoon",
      "type": "string"
    },
    "frequency_evening": {
      "title": "Frequency Evening",
      "type": "string"
    },
    "frequency_night": {
      "title": "Frequency Night",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "prescribed_by": {
      "title": "Prescribed By",
      "type": "string"
    },
    "administered": {
      "items": {
        "$ref": "#/$defs/PerDrugAdministration"
      },
      "title": "Administered",
      "type": "array"
    }
  },
  "required": [
    "medication_name",
    "dosage",
    "route",
    "status",
    "created_at",
    "prescribed_by"
  ],
  "title": "OnceOnlyDrug",
  "type": "object"
}
OutputData

FieldType / nested definitionRequiredMeaning
urine_mlinteger | nullOptional / source-dependent
drainage_mlinteger | nullOptional / source-dependent
right_drain_mlinteger | nullOptional / source-dependent
left_drain_mlinteger | nullOptional / source-dependent
vomitus_bowels_mlinteger | nullOptional / source-dependent
ryles_aspiration_mlinteger | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "urine_ml": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Urine Ml"
    },
    "drainage_ml": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Drainage Ml"
    },
    "right_drain_ml": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Right Drain Ml"
    },
    "left_drain_ml": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Left Drain Ml"
    },
    "vomitus_bowels_ml": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Vomitus Bowels Ml"
    },
    "ryles_aspiration_ml": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Ryles Aspiration Ml"
    }
  },
  "title": "OutputData",
  "type": "object"
}
OxygenItem

FieldType / nested definitionRequiredMeaning
devicestringOptional / source-dependent
flow_ratestringOptional / source-dependent
identifiersstringOptional / source-dependent
target_saturationstringOptional / source-dependent
additional_informationstringOptional / source-dependent
statusstringOptional / source-dependent
start_datestring | nullOptional / source-dependent
created_atstring | nullOptional / source-dependent
prescribed_bystringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "device": {
      "title": "Device",
      "type": "string"
    },
    "flow_rate": {
      "title": "Flow Rate",
      "type": "string"
    },
    "identifiers": {
      "title": "Identifiers",
      "type": "string"
    },
    "target_saturation": {
      "title": "Target Saturation",
      "type": "string"
    },
    "additional_information": {
      "title": "Additional Information",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "start_date": {
      "anyOf": [
        {
          "format": "date",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Start Date"
    },
    "created_at": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created At"
    },
    "prescribed_by": {
      "title": "Prescribed By",
      "type": "string"
    }
  },
  "title": "OxygenItem",
  "type": "object"
}
PRNDrug

FieldType / nested definitionRequiredMeaning
medication_namestringYes
dosagestringYes
routestringYes
statusstringYes
start_datestringOptional / source-dependent
prescription_typestringOptional / source-dependent
additional_informationstring | nullOptional / source-dependent
is_statboolean | nullOptional / source-dependent
is_once_onlyboolean | nullOptional / source-dependent
is_sosboolean | nullOptional / source-dependent
is_infusionboolean | nullOptional / source-dependent
frequency_morningstringOptional / source-dependent
frequency_afternoonstringOptional / source-dependent
frequency_eveningstringOptional / source-dependent
frequency_nightstringOptional / source-dependent
created_atstringYes
prescribed_bystringYes
max_frequencystring | nullOptional / source-dependent
indicationstring | nullOptional / source-dependent
administeredarray<PerDrugAdministration>Optional / source-dependent
Exact JSON field definition
{
  "properties": {
    "medication_name": {
      "title": "Medication Name",
      "type": "string"
    },
    "dosage": {
      "title": "Dosage",
      "type": "string"
    },
    "route": {
      "title": "Route",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "start_date": {
      "format": "date",
      "title": "Start Date",
      "type": "string"
    },
    "prescription_type": {
      "title": "Prescription Type",
      "type": "string"
    },
    "additional_information": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Additional Information"
    },
    "is_stat": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Stat"
    },
    "is_once_only": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Once Only"
    },
    "is_sos": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Sos"
    },
    "is_infusion": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Infusion"
    },
    "frequency_morning": {
      "title": "Frequency Morning",
      "type": "string"
    },
    "frequency_afternoon": {
      "title": "Frequency Afternoon",
      "type": "string"
    },
    "frequency_evening": {
      "title": "Frequency Evening",
      "type": "string"
    },
    "frequency_night": {
      "title": "Frequency Night",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "title": "Created At",
      "type": "string"
    },
    "prescribed_by": {
      "title": "Prescribed By",
      "type": "string"
    },
    "max_frequency": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Max Frequency"
    },
    "indication": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Indication"
    },
    "administered": {
      "items": {
        "$ref": "#/$defs/PerDrugAdministration"
      },
      "title": "Administered",
      "type": "array"
    }
  },
  "required": [
    "medication_name",
    "dosage",
    "route",
    "status",
    "created_at",
    "prescribed_by"
  ],
  "title": "PRNDrug",
  "type": "object"
}
PaediatricPEMGrading

FieldType / nested definitionRequiredMeaning
ipa_percentstringOptional / source-dependent
pem_gradestringOptional / source-dependent Values: , > 90% - Normal, 75-89% - Mild (grade I), 60-74% - Moderate (grade II), < 60% - Severe (grade III)
breastfeeding_statusstringOptional / source-dependent Values: , Exclusive, Partial, Weaned, Not breastfed
formula_namestringOptional / source-dependent
dietary_recall_24hrstringOptional / source-dependent
developmental_milestonestringOptional / source-dependent Values: , Normal, Delayed, Not assessed
Exact JSON field definition
{
  "properties": {
    "ipa_percent": {
      "title": "Ipa Percent",
      "type": "string"
    },
    "pem_grade": {
      "enum": [
        "",
        "> 90% - Normal",
        "75-89% - Mild (grade I)",
        "60-74% - Moderate (grade II)",
        "< 60% - Severe (grade III)"
      ],
      "title": "Pem Grade",
      "type": "string"
    },
    "breastfeeding_status": {
      "enum": [
        "",
        "Exclusive",
        "Partial",
        "Weaned",
        "Not breastfed"
      ],
      "title": "Breastfeeding Status",
      "type": "string"
    },
    "formula_name": {
      "title": "Formula Name",
      "type": "string"
    },
    "dietary_recall_24hr": {
      "title": "Dietary Recall 24Hr",
      "type": "string"
    },
    "developmental_milestone": {
      "enum": [
        "",
        "Normal",
        "Delayed",
        "Not assessed"
      ],
      "title": "Developmental Milestone",
      "type": "string"
    }
  },
  "title": "PaediatricPEMGrading",
  "type": "object"
}
PainAssessment

FieldType / nested definitionRequiredMeaning
numericalPainScoreintegerYes
wongBakerPainScoreintegerYes
interventionsarray<PainIntervention>Yes
Exact JSON field definition
{
  "properties": {
    "numericalPainScore": {
      "title": "Numericalpainscore",
      "type": "integer"
    },
    "wongBakerPainScore": {
      "title": "Wongbakerpainscore",
      "type": "integer"
    },
    "interventions": {
      "items": {
        "$ref": "#/$defs/PainIntervention"
      },
      "title": "Interventions",
      "type": "array"
    }
  },
  "required": [
    "numericalPainScore",
    "wongBakerPainScore",
    "interventions"
  ],
  "title": "PainAssessment",
  "type": "object"
}
PainIntervention

FieldType / nested definitionRequiredMeaning
assessmentDateTimestringYes
painScoreintegerYes
locationstringYes
interventionDateTimestringYes
interventionstringYes
postInterventionDateTimestringYes
postInterventionScoreintegerYes
Exact JSON field definition
{
  "properties": {
    "assessmentDateTime": {
      "title": "Assessmentdatetime",
      "type": "string"
    },
    "painScore": {
      "title": "Painscore",
      "type": "integer"
    },
    "location": {
      "title": "Location",
      "type": "string"
    },
    "interventionDateTime": {
      "title": "Interventiondatetime",
      "type": "string"
    },
    "intervention": {
      "title": "Intervention",
      "type": "string"
    },
    "postInterventionDateTime": {
      "title": "Postinterventiondatetime",
      "type": "string"
    },
    "postInterventionScore": {
      "title": "Postinterventionscore",
      "type": "integer"
    }
  },
  "required": [
    "assessmentDateTime",
    "painScore",
    "location",
    "interventionDateTime",
    "intervention",
    "postInterventionDateTime",
    "postInterventionScore"
  ],
  "title": "PainIntervention",
  "type": "object"
}
PeadiatricDet

FieldType / nested definitionRequiredMeaning
guard_namestring | nullOptional / source-dependent
agestring | nullOptional / source-dependent
feed_methstring | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "guard_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Guard Name"
    },
    "age": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Age"
    },
    "feed_meth": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Feed Meth"
    }
  },
  "title": "PeadiatricDet",
  "type": "object"
}
PerDrugAdministration

FieldType / nested definitionRequiredMeaning
administered_by_nurse_idstring | nullOptional / source-dependent
administered_timestringYes
statusstringYes
Exact JSON field definition
{
  "properties": {
    "administered_by_nurse_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Administered By Nurse Id"
    },
    "administered_time": {
      "format": "date-time",
      "title": "Administered Time",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    }
  },
  "required": [
    "administered_time",
    "status"
  ],
  "title": "PerDrugAdministration",
  "type": "object"
}
PositionEntry

FieldType / nested definitionRequiredMeaning
positionstringOptional / source-dependent
mth_bk_bs_carebooleanOptional / source-dependent
suctionbooleanOptional / source-dependent
spirometrybooleanOptional / source-dependent
abdominal_girthstringOptional / source-dependent
calf_muscle_grith_tendstringOptional / source-dependent
pressurePressure | nullOptional / source-dependent
remarksstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "position": {
      "title": "Position",
      "type": "string"
    },
    "mth_bk_bs_care": {
      "title": "Mth Bk Bs Care",
      "type": "boolean"
    },
    "suction": {
      "title": "Suction",
      "type": "boolean"
    },
    "spirometry": {
      "title": "Spirometry",
      "type": "boolean"
    },
    "abdominal_girth": {
      "title": "Abdominal Girth",
      "type": "string"
    },
    "calf_muscle_grith_tend": {
      "title": "Calf Muscle Grith Tend",
      "type": "string"
    },
    "pressure": {
      "anyOf": [
        {
          "$ref": "#/$defs/Pressure"
        },
        {
          "type": "null"
        }
      ]
    },
    "remarks": {
      "title": "Remarks",
      "type": "string"
    }
  },
  "title": "PositionEntry",
  "type": "object"
}
PostInsertion

FieldType / nested definitionRequiredMeaning
line_flushed_and_patentbooleanOptional / source-dependent
dressing_applied_sterilebooleanOptional / source-dependent
line_securedbooleanOptional / source-dependent
label_applied_date_timebooleanOptional / source-dependent
patient_tolerated_procedurebooleanOptional / source-dependent
pain_scorestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "line_flushed_and_patent": {
      "title": "Line Flushed And Patent",
      "type": "boolean"
    },
    "dressing_applied_sterile": {
      "title": "Dressing Applied Sterile",
      "type": "boolean"
    },
    "line_secured": {
      "title": "Line Secured",
      "type": "boolean"
    },
    "label_applied_date_time": {
      "title": "Label Applied Date Time",
      "type": "boolean"
    },
    "patient_tolerated_procedure": {
      "title": "Patient Tolerated Procedure",
      "type": "boolean"
    },
    "pain_score": {
      "title": "Pain Score",
      "type": "string"
    }
  },
  "title": "PostInsertion",
  "type": "object"
}
PostRemovalObservation

FieldType / nested definitionRequiredMeaning
bleedingbooleanOptional / source-dependent
painbooleanOptional / source-dependent
swellingbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "bleeding": {
      "title": "Bleeding",
      "type": "boolean"
    },
    "pain": {
      "title": "Pain",
      "type": "boolean"
    },
    "swelling": {
      "title": "Swelling",
      "type": "boolean"
    }
  },
  "title": "PostRemovalObservation",
  "type": "object"
}
PreInsertionChecks

FieldType / nested definitionRequiredMeaning
patient_identity_confirmedbooleanOptional / source-dependent
informed_consent_obtainedbooleanOptional / source-dependent
allergy_checkedbooleanOptional / source-dependent
indication_for_vad_confirmedbooleanOptional / source-dependent
hand_hygiene_performedbooleanOptional / source-dependent
prepared_sterilebooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "patient_identity_confirmed": {
      "title": "Patient Identity Confirmed",
      "type": "boolean"
    },
    "informed_consent_obtained": {
      "title": "Informed Consent Obtained",
      "type": "boolean"
    },
    "allergy_checked": {
      "title": "Allergy Checked",
      "type": "boolean"
    },
    "indication_for_vad_confirmed": {
      "title": "Indication For Vad Confirmed",
      "type": "boolean"
    },
    "hand_hygiene_performed": {
      "title": "Hand Hygiene Performed",
      "type": "boolean"
    },
    "prepared_sterile": {
      "title": "Prepared Sterile",
      "type": "boolean"
    }
  },
  "title": "PreInsertionChecks",
  "type": "object"
}
PreTransfusionCheck

FieldType / nested definitionRequiredMeaning
timestring | nullOptional / source-dependent
crt_patientboolean | nullOptional / source-dependent
crt_bgboolean | nullOptional / source-dependent
crt_compboolean | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "time": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Time"
    },
    "crt_patient": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Crt Patient"
    },
    "crt_bg": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Crt Bg"
    },
    "crt_comp": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Crt Comp"
    }
  },
  "title": "PreTransfusionCheck",
  "type": "object"
}
PreprocedAssess

FieldType / nested definitionRequiredMeaning
bpstringOptional / source-dependent
prstringOptional / source-dependent
resp_ratestringOptional / source-dependent
spo2stringOptional / source-dependent
gcs_scorestringOptional / source-dependent
aw_assessstringOptional / source-dependent
consent_obtbooleanOptional / source-dependent
emr_procbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "bp": {
      "title": "Bp",
      "type": "string"
    },
    "pr": {
      "title": "Pr",
      "type": "string"
    },
    "resp_rate": {
      "title": "Resp Rate",
      "type": "string"
    },
    "spo2": {
      "title": "Spo2",
      "type": "string"
    },
    "gcs_score": {
      "title": "Gcs Score",
      "type": "string"
    },
    "aw_assess": {
      "title": "Aw Assess",
      "type": "string"
    },
    "consent_obt": {
      "title": "Consent Obt",
      "type": "boolean"
    },
    "emr_proc": {
      "title": "Emr Proc",
      "type": "boolean"
    }
  },
  "title": "PreprocedAssess",
  "type": "object"
}
PrescriptionAdministration

FieldType / nested definitionRequiredMeaning
medication_namestringYes
medication_typestring | nullOptional / source-dependent
dosagestring | nullOptional / source-dependent
routestring | nullOptional / source-dependent
administration_timestringYes
statusstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "medication_name": {
      "title": "Medication Name",
      "type": "string"
    },
    "medication_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Medication Type"
    },
    "dosage": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dosage"
    },
    "route": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Route"
    },
    "administration_time": {
      "title": "Administration Time",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    }
  },
  "required": [
    "medication_name",
    "administration_time"
  ],
  "title": "PrescriptionAdministration",
  "type": "object"
}
PrescriptionData

FieldType / nested definitionRequiredMeaning
allergiesAllergySectionOptional / source-dependent
once_only_drugsarray<OnceOnlyDrug>Optional / source-dependent
oral_anticoagulationarray<DrugChartItem>Optional / source-dependent
thromboprophylaxisarray<DrugChartItem>Optional / source-dependent
antiplateletarray<DrugChartItem>Optional / source-dependent
drug_chartarray<DrugChartItem>Optional / source-dependent
prn_drugsarray<PRNDrug>Optional / source-dependent
infusionsarray<DrugChartItem>Optional / source-dependent
iv_fluidsarray<DrugChartItem>Optional / source-dependent
oxygenarray<OxygenItem>Optional / source-dependent
administrationsarray<GlobalAdministration>Optional / source-dependent
medication_reconciliationMedicationReconciliationOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "allergies": {
      "$ref": "#/$defs/AllergySection"
    },
    "once_only_drugs": {
      "items": {
        "$ref": "#/$defs/OnceOnlyDrug"
      },
      "title": "Once Only Drugs",
      "type": "array"
    },
    "oral_anticoagulation": {
      "items": {
        "$ref": "#/$defs/DrugChartItem"
      },
      "title": "Oral Anticoagulation",
      "type": "array"
    },
    "thromboprophylaxis": {
      "items": {
        "$ref": "#/$defs/DrugChartItem"
      },
      "title": "Thromboprophylaxis",
      "type": "array"
    },
    "antiplatelet": {
      "items": {
        "$ref": "#/$defs/DrugChartItem"
      },
      "title": "Antiplatelet",
      "type": "array"
    },
    "drug_chart": {
      "items": {
        "$ref": "#/$defs/DrugChartItem"
      },
      "title": "Drug Chart",
      "type": "array"
    },
    "prn_drugs": {
      "items": {
        "$ref": "#/$defs/PRNDrug"
      },
      "title": "Prn Drugs",
      "type": "array"
    },
    "infusions": {
      "items": {
        "$ref": "#/$defs/DrugChartItem"
      },
      "title": "Infusions",
      "type": "array"
    },
    "iv_fluids": {
      "items": {
        "$ref": "#/$defs/DrugChartItem"
      },
      "title": "Iv Fluids",
      "type": "array"
    },
    "oxygen": {
      "items": {
        "$ref": "#/$defs/OxygenItem"
      },
      "title": "Oxygen",
      "type": "array"
    },
    "administrations": {
      "items": {
        "$ref": "#/$defs/GlobalAdministration"
      },
      "title": "Administrations",
      "type": "array"
    },
    "medication_reconciliation": {
      "$ref": "#/$defs/MedicationReconciliation"
    }
  },
  "title": "PrescriptionData",
  "type": "object"
}
Pressure

FieldType / nested definitionRequiredMeaning
augstringOptional / source-dependent
mapstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "aug": {
      "title": "Aug",
      "type": "string"
    },
    "map": {
      "title": "Map",
      "type": "string"
    }
  },
  "title": "Pressure",
  "type": "object"
}
PreviousMedicationEntry

FieldType / nested definitionRequiredMeaning
drug_namestringOptional / source-dependent
dosestring | nullOptional / source-dependent
routestring | nullOptional / source-dependent
frequencystring | nullOptional / source-dependent
indicationstring | nullOptional / source-dependent
notesstring | nullOptional / source-dependent
dispositionstring | nullOptional / source-dependent
is_antiplateletbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "drug_name": {
      "title": "Drug Name",
      "type": "string"
    },
    "dose": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dose"
    },
    "route": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Route"
    },
    "frequency": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Frequency"
    },
    "indication": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Indication"
    },
    "notes": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Notes"
    },
    "disposition": {
      "anyOf": [
        {
          "enum": [
            "continued",
            "held",
            "stopped",
            "modified",
            "new_in_hospital"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Disposition"
    },
    "is_antiplatelet": {
      "title": "Is Antiplatelet",
      "type": "boolean"
    }
  },
  "title": "PreviousMedicationEntry",
  "type": "object"
}
ProcedureOrder

FieldType / nested definitionRequiredMeaning
procedure_orderstringYes
statusstringOptional / source-dependent
sourceTodoSourceOptional / source-dependentDocument provenance; preserve without editing.
todo_idstringOptional / source-dependentOpaque task identifier; preserve it during edits.
todo_versionintegerOptional / source-dependentVersion returned by the service. Preserve it; the software routes do not expose a conditional-update contract.
Exact JSON field definition
{
  "properties": {
    "procedure_order": {
      "title": "Procedure Order",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "source": {
      "$ref": "#/$defs/TodoSource",
      "description": "Document provenance; preserve without editing."
    },
    "todo_id": {
      "type": "string",
      "description": "Opaque task identifier; preserve it during edits."
    },
    "todo_version": {
      "type": "integer",
      "description": "Version returned by the service. Preserve it; the software routes do not expose a conditional-update contract."
    }
  },
  "required": [
    "procedure_order"
  ],
  "title": "ProcedureOrder",
  "type": "object"
}
PtExtubSup

FieldType / nested definitionRequiredMeaning
o2booleanOptional / source-dependent
nivbooleanOptional / source-dependent
othersstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "o2": {
      "title": "O2",
      "type": "boolean"
    },
    "niv": {
      "title": "Niv",
      "type": "boolean"
    },
    "others": {
      "title": "Others",
      "type": "string"
    }
  },
  "title": "PtExtubSup",
  "type": "object"
}
ReasExtub

FieldType / nested definitionRequiredMeaning
improvementbooleanOptional / source-dependent
wean_successbooleanOptional / source-dependent
otherstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "improvement": {
      "title": "Improvement",
      "type": "boolean"
    },
    "wean_success": {
      "title": "Wean Success",
      "type": "boolean"
    },
    "other": {
      "title": "Other",
      "type": "string"
    }
  },
  "title": "ReasExtub",
  "type": "object"
}
RemovExtub

FieldType / nested definitionRequiredMeaning
dt_tmstringOptional / source-dependent
extub_bystringOptional / source-dependent
reason_extubarray<ReasExtub>Optional / source-dependent
cond_extubarray<ConExtub>Optional / source-dependent
post_extubarray<PtExtubSup>Optional / source-dependent
remarksstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "dt_tm": {
      "title": "Dt Tm",
      "type": "string"
    },
    "extub_by": {
      "title": "Extub By",
      "type": "string"
    },
    "reason_extub": {
      "items": {
        "$ref": "#/$defs/ReasExtub"
      },
      "title": "Reason Extub",
      "type": "array"
    },
    "cond_extub": {
      "items": {
        "$ref": "#/$defs/ConExtub"
      },
      "title": "Cond Extub",
      "type": "array"
    },
    "post_extub": {
      "items": {
        "$ref": "#/$defs/PtExtubSup"
      },
      "title": "Post Extub",
      "type": "array"
    },
    "remarks": {
      "title": "Remarks",
      "type": "string"
    }
  },
  "title": "RemovExtub",
  "type": "object"
}
RemovalChecklist

FieldType / nested definitionRequiredMeaning
doctor_order_verifiedbooleanOptional / source-dependent
hand_hygiene_performedbooleanOptional / source-dependent
ppe_usedbooleanOptional / source-dependent
tip_intactbooleanOptional / source-dependent
catheter_venflon_removed_safelybooleanOptional / source-dependent
hemostasis_achievedbooleanOptional / source-dependent
sterile_dressing_appliedbooleanOptional / source-dependent
othersbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "doctor_order_verified": {
      "title": "Doctor Order Verified",
      "type": "boolean"
    },
    "hand_hygiene_performed": {
      "title": "Hand Hygiene Performed",
      "type": "boolean"
    },
    "ppe_used": {
      "title": "Ppe Used",
      "type": "boolean"
    },
    "tip_intact": {
      "title": "Tip Intact",
      "type": "boolean"
    },
    "catheter_venflon_removed_safely": {
      "title": "Catheter Venflon Removed Safely",
      "type": "boolean"
    },
    "hemostasis_achieved": {
      "title": "Hemostasis Achieved",
      "type": "boolean"
    },
    "sterile_dressing_applied": {
      "title": "Sterile Dressing Applied",
      "type": "boolean"
    },
    "others": {
      "title": "Others",
      "type": "boolean"
    }
  },
  "title": "RemovalChecklist",
  "type": "object"
}
Response_CLABSI_Bundle

FieldType / nested definitionRequiredMeaning
patient_idstringOptional / source-dependent
inpatient_idstringOptional / source-dependent
structured_dataobjectOptional / source-dependent
structured_data.IPD_CLABSI_BUNDLEarray<object>Source-dependent
structured_data.IPD_CLABSI_BUNDLE[].interaction_idstring | integer | nullSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].doctor_idstring | integer | nullSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].nurse_idstring | integer | nullSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].note_timestringSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].timestampstringSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].practitioner_idstringSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].caregiver_idstringSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].central_line_insertionClabsiCentralLineInsertion | nullSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].indication_for_central_lineClabsiIndicationForCentralLine | nullSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].clabsi_bundle_complianceClabsiBundleCompliance | nullSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].signaturesClabsiSignatures | nullSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].daily_maintenancearray<ClabsiDailyMaintenanceEntry>Source-dependent
structured_data.IPD_CLABSI_BUNDLE[].dressing_change_checklistClabsiDressingChangeChecklist | nullSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].central_line_removalClabsiCentralLineRemoval | nullSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].culturebooleanSource-dependent
structured_data.IPD_CLABSI_BUNDLE[].antibioticsstringSource-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_CLABSI_BUNDLE": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "interaction_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "doctor_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "nurse_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "note_time": {
                "type": "string"
              },
              "timestamp": {
                "type": "string"
              },
              "practitioner_id": {
                "type": "string"
              },
              "caregiver_id": {
                "type": "string"
              },
              "central_line_insertion": {
                "anyOf": [
                  {
                    "$ref": "#/$defs/ClabsiCentralLineInsertion"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "indication_for_central_line": {
                "anyOf": [
                  {
                    "$ref": "#/$defs/ClabsiIndicationForCentralLine"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "clabsi_bundle_compliance": {
                "anyOf": [
                  {
                    "$ref": "#/$defs/ClabsiBundleCompliance"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "signatures": {
                "anyOf": [
                  {
                    "$ref": "#/$defs/ClabsiSignatures"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "daily_maintenance": {
                "items": {
                  "$ref": "#/$defs/ClabsiDailyMaintenanceEntry"
                },
                "title": "Daily Maintenance",
                "type": "array"
              },
              "dressing_change_checklist": {
                "anyOf": [
                  {
                    "$ref": "#/$defs/ClabsiDressingChangeChecklist"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "central_line_removal": {
                "anyOf": [
                  {
                    "$ref": "#/$defs/ClabsiCentralLineRemoval"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "culture": {
                "title": "Culture",
                "type": "boolean"
              },
              "antibiotics": {
                "title": "Antibiotics",
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}
Response_IPD_ASSESSMENT_DETAILS

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
structured_dataobjectYes
structured_data.IPD_ASSESSMENT_DETAILSarray<JSON value>Source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_ASSESSMENT_DETAILS": {
          "type": "array",
          "items": {
            "description": "Service-defined JSON value; preserve its returned type and fields."
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "inpatient_id",
    "structured_data"
  ]
}
Response_IPD_GENERAL_OBSERVATIONS

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
structured_dataobjectYes
structured_data.IPD_GENERAL_OBSERVATIONSarray<JSON value>Source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_GENERAL_OBSERVATIONS": {
          "type": "array",
          "items": {
            "description": "Service-defined JSON value; preserve its returned type and fields."
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "inpatient_id",
    "structured_data"
  ]
}
Response_IPD_INTAKE_OUTTAKE

FieldType / nested definitionRequiredMeaning
patient_idstringOptional / source-dependent
inpatient_idstringOptional / source-dependent
structured_dataobjectOptional / source-dependent
structured_data.IPD_INTAKE_OUTTAKEarray<object | object>Source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_INTAKE_OUTTAKE": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "note_time": {
                    "type": "string"
                  },
                  "intake": {
                    "type": "array",
                    "items": {
                      "description": "Service-defined JSON value; preserve its returned type and fields."
                    }
                  },
                  "output": {
                    "type": "array",
                    "items": {
                      "description": "Service-defined JSON value; preserve its returned type and fields."
                    }
                  },
                  "intake_description": {
                    "type": "string"
                  },
                  "output_description": {
                    "type": "string"
                  },
                  "infusion_fluids_ml": {
                    "type": "number"
                  },
                  "intake_total_ml": {
                    "type": "number"
                  },
                  "output_total_ml": {
                    "type": "number"
                  },
                  "balance_ml": {
                    "type": "number"
                  },
                  "interaction_id": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              },
              {
                "type": "object",
                "properties": {
                  "note_time": {
                    "type": "string"
                  },
                  "intake": {
                    "type": "array",
                    "items": {
                      "anyOf": [
                        {
                          "type": "object",
                          "properties": {
                            "oral_rt": {
                              "description": "Service-defined JSON value; preserve its returned type and fields."
                            },
                            "oral_rt_quantity_ml": {
                              "description": "Service-defined JSON value; preserve its returned type and fields."
                            },
                            "parenteral": {
                              "type": "string"
                            },
                            "parenteral_quantity_ml": {
                              "type": "number"
                            }
                          },
                          "additionalProperties": true
                        },
                        {
                          "type": "object",
                          "properties": {
                            "oral_rt": {
                              "type": "string"
                            },
                            "oral_rt_quantity_ml": {
                              "type": "number"
                            },
                            "parenteral": {
                              "description": "Service-defined JSON value; preserve its returned type and fields."
                            },
                            "parenteral_quantity_ml": {
                              "description": "Service-defined JSON value; preserve its returned type and fields."
                            }
                          },
                          "additionalProperties": true
                        }
                      ]
                    }
                  },
                  "output": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "drainage_ml": {
                          "description": "Service-defined JSON value; preserve its returned type and fields."
                        },
                        "ryles_aspiration_ml": {
                          "description": "Service-defined JSON value; preserve its returned type and fields."
                        },
                        "urine_ml": {
                          "type": "number"
                        },
                        "vomitus_bowels_ml": {
                          "type": "number"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "intake_description": {
                    "type": "string"
                  },
                  "output_description": {
                    "type": "string"
                  },
                  "infusion_fluids_ml": {
                    "type": "number"
                  },
                  "intake_total_ml": {
                    "type": "number"
                  },
                  "output_total_ml": {
                    "type": "number"
                  },
                  "balance_ml": {
                    "type": "number"
                  },
                  "interaction_id": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            ]
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}
Response_IPD_PRESCRIPTION_ADMINISTRATIONS

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
structured_dataobjectYes
structured_data.IPD_PRESCRIPTION_ADMINISTRATIONSarray<PrescriptionAdministration>Source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_PRESCRIPTION_ADMINISTRATIONS": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/PrescriptionAdministration"
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "inpatient_id",
    "structured_data"
  ]
}
Response_IPD_VITALS

FieldType / nested definitionRequiredMeaning
patient_idstringOptional / source-dependent
inpatient_idstringOptional / source-dependent
structured_dataobjectOptional / source-dependent
structured_data.IPD_VITALSarray<object | object | object | object>Source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_VITALS": {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "object",
                "properties": {
                  "date": {
                    "type": "string"
                  },
                  "noOfDays": {
                    "type": "string"
                  },
                  "daysPostOp": {
                    "type": "string"
                  },
                  "time": {
                    "type": "string"
                  },
                  "pulse": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "temperature": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "respiration": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "blood_pressure": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "blood_sugar": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "spo2": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "interaction_id": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              },
              {
                "type": "object",
                "properties": {
                  "date": {
                    "type": "string"
                  },
                  "noOfDays": {
                    "type": "string"
                  },
                  "daysPostOp": {
                    "type": "string"
                  },
                  "time": {
                    "type": "string"
                  },
                  "pulse": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "temperature": {
                    "type": "string"
                  },
                  "respiration": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "blood_pressure": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "blood_sugar": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "spo2": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "interaction_id": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              },
              {
                "type": "object",
                "properties": {
                  "date": {
                    "type": "string"
                  },
                  "noOfDays": {
                    "type": "string"
                  },
                  "daysPostOp": {
                    "type": "string"
                  },
                  "time": {
                    "type": "string"
                  },
                  "pulse": {
                    "type": "string"
                  },
                  "temperature": {
                    "type": "string"
                  },
                  "respiration": {
                    "type": "string"
                  },
                  "blood_pressure": {
                    "type": "string"
                  },
                  "blood_sugar": {
                    "type": "string"
                  },
                  "spo2": {
                    "type": "string"
                  },
                  "interaction_id": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              },
              {
                "type": "object",
                "properties": {
                  "date": {
                    "type": "string"
                  },
                  "noOfDays": {
                    "type": "string"
                  },
                  "daysPostOp": {
                    "type": "string"
                  },
                  "time": {
                    "type": "string"
                  },
                  "pulse": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "temperature": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "respiration": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "blood_pressure": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "blood_sugar": {
                    "type": "string"
                  },
                  "spo2": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "interaction_id": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            ]
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}
Response_Vascular_Bundle

FieldType / nested definitionRequiredMeaning
patient_idstringOptional / source-dependent
inpatient_idstringOptional / source-dependent
structured_dataobjectOptional / source-dependent
structured_data.IPD_VASCULAR_BUNDLEarray<object>Source-dependent
structured_data.IPD_VASCULAR_BUNDLE[].interaction_idstring | integer | nullSource-dependent
structured_data.IPD_VASCULAR_BUNDLE[].doctor_idstring | integer | nullSource-dependent
structured_data.IPD_VASCULAR_BUNDLE[].nurse_idstring | integer | nullSource-dependent
structured_data.IPD_VASCULAR_BUNDLE[].note_timestringSource-dependent
structured_data.IPD_VASCULAR_BUNDLE[].timestampstringSource-dependent
structured_data.IPD_VASCULAR_BUNDLE[].practitioner_idstringSource-dependent
structured_data.IPD_VASCULAR_BUNDLE[].caregiver_idstringSource-dependent
structured_data.IPD_VASCULAR_BUNDLE[].vascular_bundleVascularAccessDeviceBundleSource-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_VASCULAR_BUNDLE": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "interaction_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "doctor_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "nurse_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "note_time": {
                "type": "string"
              },
              "timestamp": {
                "type": "string"
              },
              "practitioner_id": {
                "type": "string"
              },
              "caregiver_id": {
                "type": "string"
              },
              "vascular_bundle": {
                "$ref": "#/$defs/VascularAccessDeviceBundle"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}
Response_case_sheet

FieldType / nested definitionRequiredMeaning
patient_idstringOptional / source-dependent
inpatient_idstringOptional / source-dependent
doctor_initial_assessmentobjectOptional / source-dependent
doctor_initial_assessment.interaction_idstringSource-dependent
doctor_initial_assessment.time_stampstringSource-dependent
doctor_initial_assessment.doctor_idnumberSource-dependent
doctor_initial_assessment.nurse_idJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
doctor_initial_assessment.interaction_detail_typestringSource-dependent
doctor_initial_assessment.attachment_urlstringSource-dependent
doctor_initial_assessment.responseobjectSource-dependent
doctor_initial_assessment.response.responseobjectSource-dependent
doctor_initial_assessment.response.response.chief_complaintsstringSource-dependent
doctor_initial_assessment.response.response.history_of_present_illnessstringSource-dependent
doctor_initial_assessment.response.response.provisional_diagnosisstringSource-dependent
doctor_initial_assessment.response.response.plan_of_carestringSource-dependent
doctor_initial_assessment.response.response.medication_templatesarray<JSON value>Source-dependent
doctor_initial_assessment.response.assessmentJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
doctor_initial_assessment.response.additional_responseJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
doctor_initial_assessment.practitioner_idstringSource-dependent
nurse_initial_assessmentobjectOptional / source-dependent
nurse_initial_assessment.interaction_idstringSource-dependent
nurse_initial_assessment.time_stampstringSource-dependent
nurse_initial_assessment.doctor_idJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
nurse_initial_assessment.nurse_idnumberSource-dependent
nurse_initial_assessment.interaction_detail_typestringSource-dependent
nurse_initial_assessment.responseobjectSource-dependent
nurse_initial_assessment.response.basicInformationobjectSource-dependent
nurse_initial_assessment.response.basicInformation.how_admittedstringSource-dependent
nurse_initial_assessment.response.basicInformation.mother_tonguestringSource-dependent
nurse_initial_assessment.response.basicInformation.heightstringSource-dependent
nurse_initial_assessment.response.basicInformation.weightstringSource-dependent
nurse_initial_assessment.response.basicInformation.vitalsarray<object>Source-dependent
nurse_initial_assessment.response.basicInformation.vitals[].blood_pressurestringSource-dependent
nurse_initial_assessment.response.basicInformation.vitals[].pulsestringSource-dependent
nurse_initial_assessment.response.basicInformation.vitals[].respirationstringSource-dependent
nurse_initial_assessment.response.basicInformation.vitals[].temperaturestringSource-dependent
nurse_initial_assessment.response.basicInformation.vitals[].spo2stringSource-dependent
nurse_initial_assessment.response.painAssessmentobjectSource-dependent
nurse_initial_assessment.response.painAssessment.numericalPainScorenumberSource-dependent
nurse_initial_assessment.response.painAssessment.wongBakerPainScorenumberSource-dependent
nurse_initial_assessment.response.painAssessment.interventionsarray<JSON value>Source-dependent
nurse_initial_assessment.caregiver_idstringSource-dependent
gynec_initial_assessmentobjectOptional / source-dependent
surgery_notesmap<string, JSON value>Optional / source-dependent
counsellingobjectOptional / source-dependent
counselling.interaction_idstringSource-dependent
counselling.doctor_idnumberSource-dependent
counselling.interaction_detail_typestringSource-dependent
counselling.responseobjectSource-dependent
counselling.response.interaction_idstringSource-dependent
counselling.response.patient_idstringSource-dependent
counselling.response.payloadstringSource-dependent
counselling.practitioner_idstringSource-dependent
ipd_dataGroupedResponseOptional / source-dependent
drug_chartResponse_get_drug_chartOptional / source-dependent
progress_notesResponse_doctor_notesOptional / source-dependent
nurse_notesResponse_nurse_notesOptional / source-dependent
nurse_care_planobjectOptional / source-dependent
nurse_care_plan.created_atstringSource-dependent
nurse_care_plan.responseNurseCarePlanSchema | stringSource-dependent
nurse_care_plan.is_approvedbooleanSource-dependent
blood_glucose_monitoring_chartGlucoseResponseOptional / source-dependent
anaesthesia_formsobjectOptional / source-dependent
anaesthesia_forms.pre_anaesthetic_evaluation_formobjectSource-dependent
anaesthesia_forms.anaesthesia_preoperative_reevaluation_formobjectSource-dependent
anaesthesia_forms.post_anaesthesia_care_formobjectSource-dependent
anaesthesia_forms.anaesthesia_record_formobjectSource-dependent
procedure_notesobjectOptional / source-dependentProcedure document records keyed by interaction ID. Contents depend on the procedure template.
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "doctor_initial_assessment": {
      "type": "object",
      "properties": {
        "interaction_id": {
          "type": "string"
        },
        "time_stamp": {
          "type": "string"
        },
        "doctor_id": {
          "type": "number"
        },
        "nurse_id": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "interaction_detail_type": {
          "type": "string"
        },
        "attachment_url": {
          "type": "string"
        },
        "response": {
          "type": "object",
          "properties": {
            "response": {
              "type": "object",
              "properties": {
                "chief_complaints": {
                  "type": "string"
                },
                "history_of_present_illness": {
                  "type": "string"
                },
                "provisional_diagnosis": {
                  "type": "string"
                },
                "plan_of_care": {
                  "type": "string"
                },
                "medication_templates": {
                  "type": "array",
                  "items": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  }
                }
              },
              "additionalProperties": true
            },
            "assessment": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "additional_response": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            }
          },
          "additionalProperties": true
        },
        "practitioner_id": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "nurse_initial_assessment": {
      "type": "object",
      "properties": {
        "interaction_id": {
          "type": "string"
        },
        "time_stamp": {
          "type": "string"
        },
        "doctor_id": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "nurse_id": {
          "type": "number"
        },
        "interaction_detail_type": {
          "type": "string"
        },
        "response": {
          "type": "object",
          "properties": {
            "basicInformation": {
              "type": "object",
              "properties": {
                "how_admitted": {
                  "type": "string"
                },
                "mother_tongue": {
                  "type": "string"
                },
                "height": {
                  "type": "string"
                },
                "weight": {
                  "type": "string"
                },
                "vitals": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "blood_pressure": {
                        "type": "string"
                      },
                      "pulse": {
                        "type": "string"
                      },
                      "respiration": {
                        "type": "string"
                      },
                      "temperature": {
                        "type": "string"
                      },
                      "spo2": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  }
                }
              },
              "additionalProperties": true
            },
            "painAssessment": {
              "type": "object",
              "properties": {
                "numericalPainScore": {
                  "type": "number"
                },
                "wongBakerPainScore": {
                  "type": "number"
                },
                "interventions": {
                  "type": "array",
                  "items": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  }
                }
              },
              "additionalProperties": true
            }
          },
          "additionalProperties": true
        },
        "caregiver_id": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "gynec_initial_assessment": {
      "type": "object",
      "properties": {},
      "additionalProperties": true
    },
    "surgery_notes": {
      "type": "object",
      "additionalProperties": {
        "description": "Service-defined JSON value; preserve its returned type and fields."
      }
    },
    "counselling": {
      "type": "object",
      "properties": {
        "interaction_id": {
          "type": "string"
        },
        "doctor_id": {
          "type": "number"
        },
        "interaction_detail_type": {
          "type": "string"
        },
        "response": {
          "type": "object",
          "properties": {
            "interaction_id": {
              "type": "string"
            },
            "patient_id": {
              "type": "string"
            },
            "payload": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "practitioner_id": {
          "type": "string"
        }
      },
      "additionalProperties": true
    },
    "ipd_data": {
      "$ref": "#/$defs/GroupedResponse"
    },
    "drug_chart": {
      "$ref": "#/$defs/Response_get_drug_chart"
    },
    "progress_notes": {
      "$ref": "#/$defs/Response_doctor_notes"
    },
    "nurse_notes": {
      "$ref": "#/$defs/Response_nurse_notes"
    },
    "nurse_care_plan": {
      "type": "object",
      "properties": {
        "created_at": {
          "type": "string"
        },
        "response": {
          "anyOf": [
            {
              "$ref": "#/$defs/NurseCarePlanSchema"
            },
            {
              "type": "string"
            }
          ]
        },
        "is_approved": {
          "type": "boolean"
        }
      },
      "additionalProperties": true
    },
    "blood_glucose_monitoring_chart": {
      "$ref": "#/$defs/GlucoseResponse"
    },
    "anaesthesia_forms": {
      "type": "object",
      "properties": {
        "pre_anaesthetic_evaluation_form": {
          "type": "object",
          "properties": {},
          "additionalProperties": true
        },
        "anaesthesia_preoperative_reevaluation_form": {
          "type": "object",
          "properties": {},
          "additionalProperties": true
        },
        "post_anaesthesia_care_form": {
          "type": "object",
          "properties": {},
          "additionalProperties": true
        },
        "anaesthesia_record_form": {
          "type": "object",
          "properties": {},
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "procedure_notes": {
      "type": "object",
      "properties": {},
      "additionalProperties": true,
      "description": "Procedure document records keyed by interaction ID. Contents depend on the procedure template."
    }
  },
  "additionalProperties": true
}
Response_cauti_bundle

FieldType / nested definitionRequiredMeaning
patient_idstringOptional / source-dependent
inpatient_idstringOptional / source-dependent
structured_dataobjectOptional / source-dependent
structured_data.IPD_CAUTI_BUNDLEarray<object>Source-dependent
structured_data.IPD_CAUTI_BUNDLE[].interaction_idstring | integer | nullSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].doctor_idstring | integer | nullSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].nurse_idstring | integer | nullSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].note_timestringSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].timestampstringSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].practitioner_idstringSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].caregiver_idstringSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].insertion_checklist_formCautiInsertionChecklistFormSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].daily_maintenance_checklist_formCautiDailyMaintenanceChecklistFormSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].removal_checklist_formCautiRemovalChecklistFormSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].summary_formCautiSummaryFormSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].is_form_completedbooleanSource-dependent
structured_data.IPD_CAUTI_BUNDLE[].form_completed_date_timestringSource-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_CAUTI_BUNDLE": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "interaction_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "doctor_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "nurse_id": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "integer"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "note_time": {
                "type": "string"
              },
              "timestamp": {
                "type": "string"
              },
              "practitioner_id": {
                "type": "string"
              },
              "caregiver_id": {
                "type": "string"
              },
              "insertion_checklist_form": {
                "$ref": "#/$defs/CautiInsertionChecklistForm"
              },
              "daily_maintenance_checklist_form": {
                "$ref": "#/$defs/CautiDailyMaintenanceChecklistForm"
              },
              "removal_checklist_form": {
                "$ref": "#/$defs/CautiRemovalChecklistForm"
              },
              "summary_form": {
                "$ref": "#/$defs/CautiSummaryForm"
              },
              "is_form_completed": {
                "title": "Is Form Completed",
                "type": "boolean"
              },
              "form_completed_date_time": {
                "title": "Form Completed Date Time",
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}
Response_doctor_notes

FieldType / nested definitionRequiredMeaning
statusstringOptional / source-dependent
patient_idstringOptional / source-dependent
inpatient_idstringOptional / source-dependent
doctor_idstringOptional / source-dependent
casesheetbooleanOptional / source-dependent
question_textstringOptional / source-dependent
notesmap<string, DoctorNoteEntry>Optional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "doctor_id": {
      "type": "string"
    },
    "casesheet": {
      "type": "boolean"
    },
    "question_text": {
      "type": "string"
    },
    "notes": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/$defs/DoctorNoteEntry"
      }
    }
  },
  "additionalProperties": true
}
Response_get_drug_chart

FieldType / nested definitionRequiredMeaning
patient_idstringOptional / source-dependent
inpatient_idstringOptional / source-dependent
height_cmnumberOptional / source-dependent
weight_kgnumberOptional / source-dependent
special_dietstringOptional / source-dependent
blood_groupstringOptional / source-dependent
merged_schemaobjectOptional / source-dependent
merged_schema.prescription_dataobjectSource-dependent
merged_schema.prescription_data.allergiesobjectSource-dependent
merged_schema.prescription_data.allergies.has_known_allergiesbooleanSource-dependent
merged_schema.prescription_data.allergies.allergiesarray<object>Source-dependent
merged_schema.prescription_data.allergies.allergies[].substancestringSource-dependent
merged_schema.prescription_data.allergies.allergies[].reactionstringSource-dependent
merged_schema.prescription_data.allergies.allergies[].severityJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
merged_schema.prescription_data.allergies.allergies[].recorded_atstringSource-dependent
merged_schema.prescription_data.allergies.allergies[].recorded_bystringSource-dependent
merged_schema.prescription_data.allergies.allergies[].sourcestringSource-dependent
merged_schema.prescription_data.once_only_drugsarray<JSON value>Source-dependent
merged_schema.prescription_data.oral_anticoagulationarray<JSON value>Source-dependent
merged_schema.prescription_data.thromboprophylaxisarray<JSON value>Source-dependent
merged_schema.prescription_data.antiplateletarray<JSON value>Source-dependent
merged_schema.prescription_data.drug_chartarray<object>Source-dependent
merged_schema.prescription_data.drug_chart[].medication_namestringSource-dependent
merged_schema.prescription_data.drug_chart[].dosagestringSource-dependent
merged_schema.prescription_data.drug_chart[].routestringSource-dependent
merged_schema.prescription_data.drug_chart[].frequencystringSource-dependent
merged_schema.prescription_data.drug_chart[].statusstringSource-dependent
merged_schema.prescription_data.drug_chart[].start_datestringSource-dependent
merged_schema.prescription_data.drug_chart[].administration_timesarray<JSON value>Source-dependent
merged_schema.prescription_data.drug_chart[].prescription_typestringSource-dependent
merged_schema.prescription_data.drug_chart[].additional_informationstringSource-dependent
merged_schema.prescription_data.drug_chart[].created_atstringSource-dependent
merged_schema.prescription_data.drug_chart[].prescribed_bystringSource-dependent
merged_schema.prescription_data.drug_chart[].is_statbooleanSource-dependent
merged_schema.prescription_data.drug_chart[].is_once_onlybooleanSource-dependent
merged_schema.prescription_data.drug_chart[].is_sosbooleanSource-dependent
merged_schema.prescription_data.drug_chart[].administeredarray<object>Source-dependent
merged_schema.prescription_data.drug_chart[].administered[].administered_by_nurse_idstringSource-dependent
merged_schema.prescription_data.drug_chart[].administered[].administered_timestringSource-dependent
merged_schema.prescription_data.drug_chart[].administered[].statusstringSource-dependent
merged_schema.prescription_data.drug_chart[].actual_medication_namestringSource-dependent
merged_schema.prescription_data.drug_chart[].brand_namestringSource-dependent
merged_schema.prescription_data.drug_chart[].generic_namestringSource-dependent
merged_schema.prescription_data.drug_chart[].auto_correctbooleanSource-dependent
merged_schema.prescription_data.drug_chart[].med_from_llmbooleanSource-dependent
merged_schema.prescription_data.drug_chart[].medication_typestringSource-dependent
merged_schema.prescription_data.drug_chart[].drug_namestringSource-dependent
merged_schema.prescription_data.prn_drugsarray<JSON value>Source-dependent
merged_schema.prescription_data.infusionsarray<JSON value>Source-dependent
merged_schema.prescription_data.iv_fluidsarray<JSON value>Source-dependent
merged_schema.prescription_data.oxygenarray<JSON value>Source-dependent
merged_schema.prescription_data.administrationsarray<object>Source-dependent
merged_schema.prescription_data.administrations[].drug_namestringSource-dependent
merged_schema.prescription_data.administrations[].scheduled_timeJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
merged_schema.prescription_data.administrations[].administered_timestringSource-dependent
merged_schema.prescription_data.administrations[].administered_bystringSource-dependent
merged_schema.prescription_data.administrations[].doctor_idstringSource-dependent
merged_schema.prescription_data.administrations[].nurse_idstringSource-dependent
merged_schema.prescription_data.administrations[].statusstringSource-dependent
merged_schema.prescription_data.administrations[].notesstringSource-dependent
merged_schema.prescription_data.administrations[].prescribed_bystringSource-dependent
merged_schema.prescription_data.administrations[].caregiver_idstringSource-dependent
merged_schema.prescription_data.medication_reconciliationobjectSource-dependent
merged_schema.prescription_data.medication_reconciliation.previous_medicationsarray<object>Source-dependent
merged_schema.prescription_data.medication_reconciliation.previous_medications[].drug_namestringSource-dependent
merged_schema.prescription_data.medication_reconciliation.previous_medications[].dosestringSource-dependent
merged_schema.prescription_data.medication_reconciliation.previous_medications[].routestringSource-dependent
merged_schema.prescription_data.medication_reconciliation.previous_medications[].frequencystringSource-dependent
merged_schema.prescription_data.medication_reconciliation.previous_medications[].dispositionstringSource-dependent
merged_schema.prescription_data.medication_reconciliation.previous_medications[].is_antiplateletbooleanSource-dependent
merged_schema.prescription_data.medication_reconciliation.previous_medications[].interaction_idstringSource-dependent
merged_schema.prescription_data.medication_reconciliation.past_long_term_medicationsarray<object>Source-dependent
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].medication_namestringSource-dependent
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].dosagestringSource-dependent
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].routestringSource-dependent
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].frequencystringSource-dependent
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].continue_medicationbooleanSource-dependent
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].notesstringSource-dependent
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].actual_medication_namestringSource-dependent
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].brand_namestringSource-dependent
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].generic_namestringSource-dependent
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].medication_typestringSource-dependent
merged_schema.total_recordsobjectSource-dependent
merged_schema.total_records.drug_chartnumberSource-dependent
merged_schema.total_records.once_only_drugsnumberSource-dependent
merged_schema.total_records.oral_anticoagulationnumberSource-dependent
merged_schema.total_records.thromboprophylaxisnumberSource-dependent
merged_schema.total_records.antiplateletnumberSource-dependent
merged_schema.total_records.prn_drugsnumberSource-dependent
merged_schema.total_records.infusionsnumberSource-dependent
merged_schema.total_records.iv_fluidsnumberSource-dependent
merged_schema.total_records.oxygennumberSource-dependent
merged_schema.total_records.administerednumberSource-dependent
execution_time_secondsnumberOptional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "height_cm": {
      "type": "number"
    },
    "weight_kg": {
      "type": "number"
    },
    "special_diet": {
      "type": "string"
    },
    "blood_group": {
      "type": "string"
    },
    "merged_schema": {
      "type": "object",
      "properties": {
        "prescription_data": {
          "type": "object",
          "properties": {
            "allergies": {
              "type": "object",
              "properties": {
                "has_known_allergies": {
                  "type": "boolean"
                },
                "allergies": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "substance": {
                        "type": "string"
                      },
                      "reaction": {
                        "type": "string"
                      },
                      "severity": {
                        "description": "Service-defined JSON value; preserve its returned type and fields."
                      },
                      "recorded_at": {
                        "type": "string"
                      },
                      "recorded_by": {
                        "type": "string"
                      },
                      "source": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  }
                }
              },
              "additionalProperties": true
            },
            "once_only_drugs": {
              "type": "array",
              "items": {
                "description": "Service-defined JSON value; preserve its returned type and fields."
              }
            },
            "oral_anticoagulation": {
              "type": "array",
              "items": {
                "description": "Service-defined JSON value; preserve its returned type and fields."
              }
            },
            "thromboprophylaxis": {
              "type": "array",
              "items": {
                "description": "Service-defined JSON value; preserve its returned type and fields."
              }
            },
            "antiplatelet": {
              "type": "array",
              "items": {
                "description": "Service-defined JSON value; preserve its returned type and fields."
              }
            },
            "drug_chart": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "medication_name": {
                    "type": "string"
                  },
                  "dosage": {
                    "type": "string"
                  },
                  "route": {
                    "type": "string"
                  },
                  "frequency": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "start_date": {
                    "type": "string"
                  },
                  "administration_times": {
                    "type": "array",
                    "items": {
                      "description": "Service-defined JSON value; preserve its returned type and fields."
                    }
                  },
                  "prescription_type": {
                    "type": "string"
                  },
                  "additional_information": {
                    "type": "string"
                  },
                  "created_at": {
                    "type": "string"
                  },
                  "prescribed_by": {
                    "type": "string"
                  },
                  "is_stat": {
                    "type": "boolean"
                  },
                  "is_once_only": {
                    "type": "boolean"
                  },
                  "is_sos": {
                    "type": "boolean"
                  },
                  "administered": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "administered_by_nurse_id": {
                          "type": "string"
                        },
                        "administered_time": {
                          "type": "string"
                        },
                        "status": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "actual_medication_name": {
                    "type": "string"
                  },
                  "brand_name": {
                    "type": "string"
                  },
                  "generic_name": {
                    "type": "string"
                  },
                  "auto_correct": {
                    "type": "boolean"
                  },
                  "med_from_llm": {
                    "type": "boolean"
                  },
                  "medication_type": {
                    "type": "string"
                  },
                  "drug_name": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            },
            "prn_drugs": {
              "type": "array",
              "items": {
                "description": "Service-defined JSON value; preserve its returned type and fields."
              }
            },
            "infusions": {
              "type": "array",
              "items": {
                "description": "Service-defined JSON value; preserve its returned type and fields."
              }
            },
            "iv_fluids": {
              "type": "array",
              "items": {
                "description": "Service-defined JSON value; preserve its returned type and fields."
              }
            },
            "oxygen": {
              "type": "array",
              "items": {
                "description": "Service-defined JSON value; preserve its returned type and fields."
              }
            },
            "administrations": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "drug_name": {
                    "type": "string"
                  },
                  "scheduled_time": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  },
                  "administered_time": {
                    "type": "string"
                  },
                  "administered_by": {
                    "type": "string"
                  },
                  "doctor_id": {
                    "type": "string"
                  },
                  "nurse_id": {
                    "type": "string"
                  },
                  "status": {
                    "type": "string"
                  },
                  "notes": {
                    "type": "string"
                  },
                  "prescribed_by": {
                    "type": "string"
                  },
                  "caregiver_id": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            },
            "medication_reconciliation": {
              "type": "object",
              "properties": {
                "previous_medications": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "drug_name": {
                        "type": "string"
                      },
                      "dose": {
                        "type": "string"
                      },
                      "route": {
                        "type": "string"
                      },
                      "frequency": {
                        "type": "string"
                      },
                      "disposition": {
                        "type": "string"
                      },
                      "is_antiplatelet": {
                        "type": "boolean"
                      },
                      "interaction_id": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  }
                },
                "past_long_term_medications": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "medication_name": {
                        "type": "string"
                      },
                      "dosage": {
                        "type": "string"
                      },
                      "route": {
                        "type": "string"
                      },
                      "frequency": {
                        "type": "string"
                      },
                      "continue_medication": {
                        "type": "boolean"
                      },
                      "notes": {
                        "type": "string"
                      },
                      "actual_medication_name": {
                        "type": "string"
                      },
                      "brand_name": {
                        "type": "string"
                      },
                      "generic_name": {
                        "type": "string"
                      },
                      "medication_type": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true
                  }
                }
              },
              "additionalProperties": true
            }
          },
          "additionalProperties": true
        },
        "total_records": {
          "type": "object",
          "properties": {
            "drug_chart": {
              "type": "number"
            },
            "once_only_drugs": {
              "type": "number"
            },
            "oral_anticoagulation": {
              "type": "number"
            },
            "thromboprophylaxis": {
              "type": "number"
            },
            "antiplatelet": {
              "type": "number"
            },
            "prn_drugs": {
              "type": "number"
            },
            "infusions": {
              "type": "number"
            },
            "iv_fluids": {
              "type": "number"
            },
            "oxygen": {
              "type": "number"
            },
            "administered": {
              "type": "number"
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    },
    "execution_time_seconds": {
      "type": "number"
    }
  },
  "additionalProperties": true
}
Response_initial_assessment

FieldType / nested definitionRequiredMeaning
successbooleanOptional / source-dependent
messagestringOptional / source-dependent
dataobjectOptional / source-dependent
data.session_idstringSource-dependent
data.patient_idstringSource-dependent
data.inpatient_idstringSource-dependent
data.nurse_idJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.doctor_idnumberSource-dependent
data.questionstringSource-dependent
data.questioned_atnumberSource-dependent
data.patient_typestringSource-dependent
data.interaction_idstringSource-dependent
data.organization_idstringSource-dependent
data.answerobjectSource-dependent
data.answer.responseobjectSource-dependent
data.answer.response.chief_complaintsstringSource-dependent
data.answer.response.history_of_present_illnessstringSource-dependent
data.answer.response.past_history_and_durationstringSource-dependent
data.answer.response.family_historystringSource-dependent
data.answer.response.personal_historystringSource-dependent
data.answer.response.allergiesstringSource-dependent
data.answer.response.blood_groupstringSource-dependent
data.answer.response.previous_medicationstringSource-dependent
data.answer.response.present_medicationstringSource-dependent
data.answer.response.previous_investigationsstringSource-dependent
data.answer.response.examination_findingsstringSource-dependent
data.answer.response.provisional_diagnosisstringSource-dependent
data.answer.response.plan_of_carestringSource-dependent
data.answer.response.surgery_procedure_plannedstringSource-dependent
data.answer.response.pre_operative_instructionsstringSource-dependent
data.answer.response.recommendationsstringSource-dependent
data.answer.response.assessmentarray<JSON value>Source-dependent
data.answer.response.medication_templatesarray<object | object | object>Source-dependent
data.answer.response.phonetic_uristringSource-dependent
data.answer.assessmentJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.answer.additional_responseJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.answer.created_atstringSource-dependent
data.answer.phonetic_uristringSource-dependent
data.summaryJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.question_audio_linkJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.answer_audio_linkJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.funct_namestringSource-dependent
data.answered_atnumberSource-dependent
data.phonetic_uristringSource-dependent
data.practitioner_idstringSource-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "session_id": {
          "type": "string"
        },
        "patient_id": {
          "type": "string"
        },
        "inpatient_id": {
          "type": "string"
        },
        "nurse_id": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "doctor_id": {
          "type": "number"
        },
        "question": {
          "type": "string"
        },
        "questioned_at": {
          "type": "number"
        },
        "patient_type": {
          "type": "string"
        },
        "interaction_id": {
          "type": "string"
        },
        "organization_id": {
          "type": "string"
        },
        "answer": {
          "type": "object",
          "properties": {
            "response": {
              "type": "object",
              "properties": {
                "chief_complaints": {
                  "type": "string"
                },
                "history_of_present_illness": {
                  "type": "string"
                },
                "past_history_and_duration": {
                  "type": "string"
                },
                "family_history": {
                  "type": "string"
                },
                "personal_history": {
                  "type": "string"
                },
                "allergies": {
                  "type": "string"
                },
                "blood_group": {
                  "type": "string"
                },
                "previous_medication": {
                  "type": "string"
                },
                "present_medication": {
                  "type": "string"
                },
                "previous_investigations": {
                  "type": "string"
                },
                "examination_findings": {
                  "type": "string"
                },
                "provisional_diagnosis": {
                  "type": "string"
                },
                "plan_of_care": {
                  "type": "string"
                },
                "surgery_procedure_planned": {
                  "type": "string"
                },
                "pre_operative_instructions": {
                  "type": "string"
                },
                "recommendations": {
                  "type": "string"
                },
                "assessment": {
                  "type": "array",
                  "items": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  }
                },
                "medication_templates": {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "medication_name": {
                            "type": "string"
                          },
                          "medication_type": {
                            "type": "string"
                          },
                          "dosage": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          },
                          "route": {
                            "type": "string"
                          },
                          "frequency_morning": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          },
                          "frequency_afternoon": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          },
                          "frequency_evening": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          },
                          "frequency_night": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          },
                          "duration": {
                            "type": "string"
                          },
                          "duration_source": {
                            "type": "string"
                          },
                          "continue_until_stopped": {
                            "type": "boolean"
                          },
                          "dosage_time": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          },
                          "instructions": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          },
                          "med_status": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          },
                          "is_stat": {
                            "type": "boolean"
                          },
                          "is_once_only": {
                            "type": "boolean"
                          },
                          "is_sos": {
                            "type": "boolean"
                          },
                          "is_status": {
                            "type": "string"
                          },
                          "actual_medication_name": {
                            "type": "string"
                          },
                          "brand_name": {
                            "type": "string"
                          },
                          "generic_name": {
                            "type": "string"
                          },
                          "auto_correct": {
                            "type": "boolean"
                          },
                          "med_from_llm": {
                            "type": "boolean"
                          }
                        },
                        "additionalProperties": true
                      },
                      {
                        "type": "object",
                        "properties": {
                          "medication_name": {
                            "type": "string"
                          },
                          "medication_type": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          },
                          "dosage": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          },
                          "route": {
                            "type": "string"
                          },
                          "duration": {
                            "type": "string"
                          },
                          "duration_source": {
                            "type": "string"
                          },
                          "continue_until_stopped": {
                            "type": "boolean"
                          },
                          "is_stat": {
                            "type": "boolean"
                          },
                          "is_once_only": {
                            "type": "boolean"
                          },
                          "is_sos": {
                            "type": "boolean"
                          },
                          "is_status": {
                            "type": "string"
                          },
                          "actual_medication_name": {
                            "type": "string"
                          },
                          "brand_name": {
                            "type": "string"
                          },
                          "auto_correct": {
                            "type": "boolean"
                          },
                          "med_from_llm": {
                            "type": "boolean"
                          }
                        },
                        "additionalProperties": true
                      },
                      {
                        "type": "object",
                        "properties": {
                          "medication_name": {
                            "type": "string"
                          },
                          "medication_type": {
                            "type": "string"
                          },
                          "dosage": {
                            "type": "string"
                          },
                          "route": {
                            "type": "string"
                          },
                          "duration": {
                            "type": "string"
                          },
                          "continue_until_stopped": {
                            "type": "boolean"
                          },
                          "is_stat": {
                            "type": "boolean"
                          },
                          "is_once_only": {
                            "type": "boolean"
                          },
                          "is_sos": {
                            "type": "boolean"
                          },
                          "is_status": {
                            "type": "string"
                          },
                          "actual_medication_name": {
                            "type": "string"
                          },
                          "brand_name": {
                            "type": "string"
                          },
                          "auto_correct": {
                            "type": "boolean"
                          },
                          "med_from_llm": {
                            "type": "boolean"
                          }
                        },
                        "additionalProperties": true
                      }
                    ]
                  }
                },
                "phonetic_uri": {
                  "type": "string"
                }
              },
              "additionalProperties": true
            },
            "assessment": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "additional_response": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            },
            "created_at": {
              "type": "string"
            },
            "phonetic_uri": {
              "type": "string"
            }
          },
          "additionalProperties": true
        },
        "summary": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "question_audio_link": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "answer_audio_link": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "funct_name": {
          "type": "string"
        },
        "answered_at": {
          "type": "number"
        },
        "phonetic_uri": {
          "type": "string"
        },
        "practitioner_id": {
          "type": "string"
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}
Response_nurse_notes

FieldType / nested definitionRequiredMeaning
statusstringOptional / source-dependent
patient_idstringOptional / source-dependent
inpatient_idstringOptional / source-dependent
nurse_idstringOptional / source-dependent
casesheetbooleanOptional / source-dependent
question_textstringOptional / source-dependent
notesarray<NurseNoteSet> | objectOptional / source-dependent
handover_interactionsarray<object>Optional / source-dependent
handover_interactions[].interaction_idstringSource-dependent
handover_interactions[].created_atstringSource-dependent
handover_interactions[].updated_atstringSource-dependent
handover_interactions[].handovered_nursearray<JSON value>Source-dependent
pain_grapharray<object>Optional / source-dependent
pain_graph[].pain_scorestringSource-dependent
pain_graph[].timestringSource-dependent
pain_graph[].datestringSource-dependent
caregiver_idstringOptional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "nurse_id": {
      "type": "string"
    },
    "casesheet": {
      "type": "boolean"
    },
    "question_text": {
      "type": "string"
    },
    "notes": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/NurseNoteSet"
          }
        },
        {
          "type": "object",
          "properties": {},
          "additionalProperties": true
        }
      ]
    },
    "handover_interactions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "interaction_id": {
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "handovered_nurse": {
            "type": "array",
            "items": {
              "description": "Service-defined JSON value; preserve its returned type and fields."
            }
          }
        },
        "additionalProperties": true
      }
    },
    "pain_graph": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "pain_score": {
            "type": "string"
          },
          "time": {
            "type": "string"
          },
          "date": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "caregiver_id": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Response_surgery_notes

FieldType / nested definitionRequiredMeaning
successbooleanOptional / source-dependent
messagestringOptional / source-dependent
dataobjectOptional / source-dependent
data.session_idstringSource-dependent
data.patient_idstringSource-dependent
data.inpatient_idstringSource-dependent
data.nurse_idJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.doctor_idnumberSource-dependent
data.questionstringSource-dependent
data.questioned_atnumberSource-dependent
data.patient_typestringSource-dependent
data.interaction_idstringSource-dependent
data.organization_idstringSource-dependent
data.answerobjectSource-dependent
data.answer.123277objectSource-dependent
data.answer.123277.pre_operative_diagnosisstringSource-dependent
data.answer.123277.post_operative_diagnosisstringSource-dependent
data.answer.123277.surgeonstringSource-dependent
data.answer.123277.assistant1stringSource-dependent
data.answer.123277.assistant2stringSource-dependent
data.answer.123277.anesthetiststringSource-dependent
data.answer.123277.scrub_nursestringSource-dependent
data.answer.123277.circ_nursestringSource-dependent
data.answer.123277.skin_wound_conditionstringSource-dependent
data.answer.123277.findingsstringSource-dependent
data.answer.123277.name_of_operationstringSource-dependent
data.answer.123277.procedurestringSource-dependent
data.answer.123277.post_operative_ordersstringSource-dependent
data.answer.123277.dietstringSource-dependent
data.answer.123277.postoperative_conditionstringSource-dependent
data.answer.123277.surgeon_remarksstringSource-dependent
data.answer.123277.biopsy_specimenstringSource-dependent
data.answer.123277.medication_templatesarray<JSON value>Source-dependent
data.answer.123277.vitals_abnormalityobjectSource-dependent
data.answer.123277.vitals_abnormality.abnormality_detectedbooleanSource-dependent
data.answer.123277.vitals_abnormality.abnormal_vitals_messagestringSource-dependent
data.answer.123277.vitals_abnormality.overall_severitystringSource-dependent
data.answer.123277.monitoring_tasksarray<object | object>Source-dependent
data.answer.123277.drug_chart_patchobjectSource-dependent
data.answer.123277.drug_chart_patch.allergies_to_addarray<JSON value>Source-dependent
data.answer.123277.drug_chart_patch.administrations_to_addarray<JSON value>Source-dependent
data.answer.123277.drug_chart_patch.medications_to_stoparray<JSON value>Source-dependent
data.answer.123277.drug_chart_patch.medications_to_holdarray<JSON value>Source-dependent
data.answer.123277.drug_chart_patch.medications_to_resumearray<JSON value>Source-dependent
data.answer.123277.drug_chart_patch.new_regular_ordersarray<JSON value>Source-dependent
data.answer.123277.drug_chart_patch.new_prn_ordersarray<JSON value>Source-dependent
data.answer.123277.drug_chart_patch.medication_reconciliationobjectSource-dependent
data.answer.123277.drug_chart_patch.medication_reconciliation.previous_medicationsarray<JSON value>Source-dependent
data.answer.123277.blood_borneobjectSource-dependent
data.answer.123277.blood_borne.hivJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.answer.123277.blood_borne.hcvJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.answer.123277.blood_borne.hbvJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.answer.123277.blood_borne.syphilisJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.answer.123277.blood_borne.htlvJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.answer.123277.blood_borne.malariaJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.answer.123277.blood_borne.cmvJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.answer.123277.phonetic_uristringSource-dependent
data.summaryJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.question_audio_linkJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.answer_audio_linkJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
data.funct_namestringSource-dependent
data.answered_atnumberSource-dependent
data.phonetic_uristringSource-dependent
data.practitioner_idstringSource-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "session_id": {
          "type": "string"
        },
        "patient_id": {
          "type": "string"
        },
        "inpatient_id": {
          "type": "string"
        },
        "nurse_id": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "doctor_id": {
          "type": "number"
        },
        "question": {
          "type": "string"
        },
        "questioned_at": {
          "type": "number"
        },
        "patient_type": {
          "type": "string"
        },
        "interaction_id": {
          "type": "string"
        },
        "organization_id": {
          "type": "string"
        },
        "answer": {
          "type": "object",
          "properties": {
            "123277": {
              "type": "object",
              "properties": {
                "pre_operative_diagnosis": {
                  "type": "string"
                },
                "post_operative_diagnosis": {
                  "type": "string"
                },
                "surgeon": {
                  "type": "string"
                },
                "assistant1": {
                  "type": "string"
                },
                "assistant2": {
                  "type": "string"
                },
                "anesthetist": {
                  "type": "string"
                },
                "scrub_nurse": {
                  "type": "string"
                },
                "circ_nurse": {
                  "type": "string"
                },
                "skin_wound_condition": {
                  "type": "string"
                },
                "findings": {
                  "type": "string"
                },
                "name_of_operation": {
                  "type": "string"
                },
                "procedure": {
                  "type": "string"
                },
                "post_operative_orders": {
                  "type": "string"
                },
                "diet": {
                  "type": "string"
                },
                "postoperative_condition": {
                  "type": "string"
                },
                "surgeon_remarks": {
                  "type": "string"
                },
                "biopsy_specimen": {
                  "type": "string"
                },
                "medication_templates": {
                  "type": "array",
                  "items": {
                    "description": "Service-defined JSON value; preserve its returned type and fields."
                  }
                },
                "vitals_abnormality": {
                  "type": "object",
                  "properties": {
                    "abnormality_detected": {
                      "type": "boolean"
                    },
                    "abnormal_vitals_message": {
                      "type": "string"
                    },
                    "overall_severity": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": true
                },
                "monitoring_tasks": {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "is_monitor": {
                            "type": "boolean"
                          },
                          "monitoring_message": {
                            "type": "string"
                          },
                          "interval_minutes": {
                            "type": "number"
                          },
                          "start_or_stop": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      },
                      {
                        "type": "object",
                        "properties": {
                          "is_monitor": {
                            "type": "boolean"
                          },
                          "monitoring_message": {
                            "type": "string"
                          },
                          "interval_minutes": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          },
                          "start_or_stop": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      }
                    ]
                  }
                },
                "drug_chart_patch": {
                  "type": "object",
                  "properties": {
                    "allergies_to_add": {
                      "type": "array",
                      "items": {
                        "description": "Service-defined JSON value; preserve its returned type and fields."
                      }
                    },
                    "administrations_to_add": {
                      "type": "array",
                      "items": {
                        "description": "Service-defined JSON value; preserve its returned type and fields."
                      }
                    },
                    "medications_to_stop": {
                      "type": "array",
                      "items": {
                        "description": "Service-defined JSON value; preserve its returned type and fields."
                      }
                    },
                    "medications_to_hold": {
                      "type": "array",
                      "items": {
                        "description": "Service-defined JSON value; preserve its returned type and fields."
                      }
                    },
                    "medications_to_resume": {
                      "type": "array",
                      "items": {
                        "description": "Service-defined JSON value; preserve its returned type and fields."
                      }
                    },
                    "new_regular_orders": {
                      "type": "array",
                      "items": {
                        "description": "Service-defined JSON value; preserve its returned type and fields."
                      }
                    },
                    "new_prn_orders": {
                      "type": "array",
                      "items": {
                        "description": "Service-defined JSON value; preserve its returned type and fields."
                      }
                    },
                    "medication_reconciliation": {
                      "type": "object",
                      "properties": {
                        "previous_medications": {
                          "type": "array",
                          "items": {
                            "description": "Service-defined JSON value; preserve its returned type and fields."
                          }
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "additionalProperties": true
                },
                "blood_borne": {
                  "type": "object",
                  "properties": {
                    "hiv": {
                      "description": "Service-defined JSON value; preserve its returned type and fields."
                    },
                    "hcv": {
                      "description": "Service-defined JSON value; preserve its returned type and fields."
                    },
                    "hbv": {
                      "description": "Service-defined JSON value; preserve its returned type and fields."
                    },
                    "syphilis": {
                      "description": "Service-defined JSON value; preserve its returned type and fields."
                    },
                    "htlv": {
                      "description": "Service-defined JSON value; preserve its returned type and fields."
                    },
                    "malaria": {
                      "description": "Service-defined JSON value; preserve its returned type and fields."
                    },
                    "cmv": {
                      "description": "Service-defined JSON value; preserve its returned type and fields."
                    }
                  },
                  "additionalProperties": true
                },
                "phonetic_uri": {
                  "type": "string"
                }
              },
              "additionalProperties": true
            }
          },
          "additionalProperties": true
        },
        "summary": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "question_audio_link": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "answer_audio_link": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "funct_name": {
          "type": "string"
        },
        "answered_at": {
          "type": "number"
        },
        "phonetic_uri": {
          "type": "string"
        },
        "practitioner_id": {
          "type": "string"
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true
}
SGAPEMGrading

FieldType / nested definitionRequiredMeaning
weight_changeinteger | nullOptional / source-dependent
dietary_intakeinteger | nullOptional / source-dependent
gi_symptomsinteger | nullOptional / source-dependent
functional_capacityinteger | nullOptional / source-dependent
disease_metabolic_demandinteger | nullOptional / source-dependent
physical_exam_fat_storesinteger | nullOptional / source-dependent
physical_exam_muscle_wastinginteger | nullOptional / source-dependent
total_scoreinteger | nullOptional / source-dependent
sga_ratingstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "weight_change": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Weight Change"
    },
    "dietary_intake": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dietary Intake"
    },
    "gi_symptoms": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Gi Symptoms"
    },
    "functional_capacity": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Functional Capacity"
    },
    "disease_metabolic_demand": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Disease Metabolic Demand"
    },
    "physical_exam_fat_stores": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Physical Exam Fat Stores"
    },
    "physical_exam_muscle_wasting": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Physical Exam Muscle Wasting"
    },
    "total_score": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Total Score"
    },
    "sga_rating": {
      "title": "Sga Rating",
      "type": "string"
    }
  },
  "title": "SGAPEMGrading",
  "type": "object"
}
Signatures

FieldType / nested definitionRequiredMeaning
inserted_bystringOptional / source-dependent
verified_bystringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "inserted_by": {
      "title": "Inserted By",
      "type": "string"
    },
    "verified_by": {
      "title": "Verified By",
      "type": "string"
    }
  },
  "title": "Signatures",
  "type": "object"
}
SkinTurgor

FieldType / nested definitionRequiredMeaning
isAssessedbooleanYes
statestringYes
Exact JSON field definition
{
  "properties": {
    "isAssessed": {
      "title": "Isassessed",
      "type": "boolean"
    },
    "state": {
      "title": "State",
      "type": "string"
    }
  },
  "required": [
    "isAssessed",
    "state"
  ],
  "title": "SkinTurgor",
  "type": "object"
}
StopMedicationCommand

FieldType / nested definitionRequiredMeaning
drug_namestringOptional / source-dependent
dosestringOptional / source-dependent
actionstringOptional / source-dependent Values: stop, hold, discontinue
Exact JSON field definition
{
  "properties": {
    "drug_name": {
      "title": "Drug Name",
      "type": "string"
    },
    "dose": {
      "title": "Dose",
      "type": "string"
    },
    "action": {
      "enum": [
        "stop",
        "hold",
        "discontinue"
      ],
      "title": "Action",
      "type": "string"
    }
  },
  "title": "StopMedicationCommand",
  "type": "object"
}
StoredNoteResponse

FieldType / nested definitionRequiredMeaning
patient_idstringYes
resultDataobjectYes
resultData.detail_idstring | integer | nullSource-dependent
resultData.interaction_idstring | integer | nullSource-dependent
resultData.interaction_detail_typestringSource-dependent
resultData.attachment_urlstring | nullSource-dependent
resultData.answerJSON valueSource-dependentService-defined JSON value; preserve its returned type and fields.
resultData.questionstringSource-dependent
resultData.created_atstringSource-dependent
resultData.updated_atstringSource-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "resultData": {
      "type": "object",
      "properties": {
        "detail_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "interaction_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "interaction_detail_type": {
          "type": "string"
        },
        "attachment_url": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "answer": {
          "description": "Service-defined JSON value; preserve its returned type and fields."
        },
        "question": {
          "type": "string"
        },
        "created_at": {
          "type": "string"
        },
        "updated_at": {
          "type": "string"
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "resultData"
  ]
}
TaskRecord

FieldType / nested definitionRequiredMeaning
interaction_idstring | integer | nullYes
gcs_uristring | nullOptional / source-dependent
created_atstringOptional / source-dependent
phonetic_uristring | nullOptional / source-dependent
doctor_idstring | integer | nullOptional / source-dependent
ordered_bystring | integer | nullOptional / source-dependent
approved_bystring | integer | nullOptional / source-dependent
todosarray<ToDoList>Yes
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "interaction_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "gcs_uri": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "created_at": {
      "type": "string"
    },
    "phonetic_uri": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "doctor_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "ordered_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "approved_by": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "todos": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ToDoList"
      }
    }
  },
  "additionalProperties": true,
  "required": [
    "interaction_id",
    "todos"
  ]
}
TaskResponse

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
todo_dataarray<TaskRecord>Yes
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "todo_data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/TaskRecord"
      }
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "inpatient_id",
    "todo_data"
  ]
}
TaskUpdate

Copy a returned TaskRecord, preserve its opaque identifiers and all task arrays, and change only the intended execution fields. gcs_uri is preserved for compatibility; current storage locates the record by interaction_id.

FieldType / nested definitionRequiredMeaning
interaction_idstring | integer | nullYes
gcs_uristringOptional / source-dependent
todosarray<ToDoList>Yes
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "interaction_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "gcs_uri": {
      "type": "string"
    },
    "todos": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ToDoList"
      }
    }
  },
  "additionalProperties": true,
  "required": [
    "interaction_id",
    "todos"
  ],
  "description": "Copy a returned TaskRecord, preserve its opaque identifiers and all task arrays, and change only the intended execution fields. gcs_uri is preserved for compatibility; current storage locates the record by interaction_id."
}
ToDoList

FieldType / nested definitionRequiredMeaning
investigationsarray<Investigation>Optional / source-dependentRequested tests and investigations.
opinionsarray<ToDoOpinionTask>Optional / source-dependentRequested clinician/specialty opinions.
prescription_tasksarray<ToDoPrescriptionTask>Optional / source-dependentMedication orders, schedules and dose execution slots.
monitoring_ordersarray<MonitoringOrder>Optional / source-dependentMonitoring instructions and intervals.
nursing_care_ordersarray<NursingCareOrder>Optional / source-dependentNursing care instructions.
procedure_ordersarray<ProcedureOrder>Optional / source-dependentRequested procedures.
deferred_ordersarray<DeferredOrder>Optional / source-dependentOrders gated on a future date or unmet condition.
Exact JSON field definition
{
  "properties": {
    "investigations": {
      "items": {
        "$ref": "#/$defs/Investigation"
      },
      "title": "Investigations",
      "type": "array",
      "description": "Requested tests and investigations."
    },
    "opinions": {
      "items": {
        "$ref": "#/$defs/ToDoOpinionTask"
      },
      "title": "Opinions",
      "type": "array",
      "description": "Requested clinician/specialty opinions."
    },
    "prescription_tasks": {
      "items": {
        "$ref": "#/$defs/ToDoPrescriptionTask"
      },
      "title": "Prescription Tasks",
      "type": "array",
      "description": "Medication orders, schedules and dose execution slots."
    },
    "monitoring_orders": {
      "items": {
        "$ref": "#/$defs/MonitoringOrder"
      },
      "title": "Monitoring Orders",
      "type": "array",
      "description": "Monitoring instructions and intervals."
    },
    "nursing_care_orders": {
      "items": {
        "$ref": "#/$defs/NursingCareOrder"
      },
      "title": "Nursing Care Orders",
      "type": "array",
      "description": "Nursing care instructions."
    },
    "procedure_orders": {
      "items": {
        "$ref": "#/$defs/ProcedureOrder"
      },
      "title": "Procedure Orders",
      "type": "array",
      "description": "Requested procedures."
    },
    "deferred_orders": {
      "items": {
        "$ref": "#/$defs/DeferredOrder"
      },
      "title": "Deferred Orders",
      "type": "array",
      "description": "Orders gated on a future date or unmet condition."
    }
  },
  "title": "ToDoList",
  "type": "object"
}
ToDoOpinionTask

FieldType / nested definitionRequiredMeaning
specialtystringYes
consultant_namestringOptional / source-dependent
reasonstringYes
statusstringOptional / source-dependent
sourceTodoSourceOptional / source-dependentDocument provenance; preserve without editing.
todo_idstringOptional / source-dependentOpaque task identifier; preserve it during edits.
todo_versionintegerOptional / source-dependentVersion returned by the service. Preserve it; the software routes do not expose a conditional-update contract.
Exact JSON field definition
{
  "properties": {
    "specialty": {
      "title": "Specialty",
      "type": "string"
    },
    "consultant_name": {
      "title": "Consultant Name",
      "type": "string"
    },
    "reason": {
      "title": "Reason",
      "type": "string"
    },
    "status": {
      "title": "Status",
      "type": "string"
    },
    "source": {
      "$ref": "#/$defs/TodoSource",
      "description": "Document provenance; preserve without editing."
    },
    "todo_id": {
      "type": "string",
      "description": "Opaque task identifier; preserve it during edits."
    },
    "todo_version": {
      "type": "integer",
      "description": "Version returned by the service. Preserve it; the software routes do not expose a conditional-update contract."
    }
  },
  "required": [
    "specialty",
    "reason"
  ],
  "title": "ToDoOpinionTask",
  "type": "object"
}
ToDoPrescriptionTask

FieldType / nested definitionRequiredMeaning
medication_namestringYes
medication_typestring | nullOptional / source-dependent
dosagestringOptional / source-dependent
routestringOptional / source-dependent
frequency_morningarray<Frequency>Optional / source-dependent
frequency_afternoonarray<Frequency>Optional / source-dependent
frequency_eveningarray<Frequency>Optional / source-dependent
frequency_nightarray<Frequency>Optional / source-dependent
durationstringOptional / source-dependent
duration_sourcestringOptional / source-dependent
continue_until_stoppedbooleanOptional / source-dependent
dosage_timearray<string> | nullOptional / source-dependentScheduled dose times returned by the service.
scheduled_datesarray<scheduler>Optional / source-dependent
actual_medication_namestringOptional / source-dependent
brand_namestring | nullOptional / source-dependent
generic_namestring | nullOptional / source-dependent
auto_correctboolean | nullOptional / source-dependent
med_from_llmboolean | nullOptional / source-dependent
brand_idstring | integer | nullOptional / source-dependent
instructionsstringOptional / source-dependent
interval_minutesinteger | nullOptional / source-dependent
med_statusstringOptional / source-dependentMedication order action/state; distinct from administration completion.
is_statboolean | nullOptional / source-dependent
is_once_onlyboolean | nullOptional / source-dependent
is_sosboolean | nullOptional / source-dependent
is_infusionboolean | nullOptional / source-dependent
is_statusstring | nullOptional / source-dependent
sourceTodoSourceOptional / source-dependentDocument provenance; preserve without editing.
todo_idstringOptional / source-dependentOpaque task identifier; preserve it during edits.
todo_versionintegerOptional / source-dependentVersion returned by the service. Preserve it; the software routes do not expose a conditional-update contract.
Exact JSON field definition
{
  "properties": {
    "medication_name": {
      "minLength": 1,
      "title": "Medication Name",
      "type": "string"
    },
    "medication_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Medication Type"
    },
    "dosage": {
      "title": "Dosage",
      "type": "string"
    },
    "route": {
      "title": "Route",
      "type": "string"
    },
    "frequency_morning": {
      "items": {
        "$ref": "#/$defs/Frequency"
      },
      "title": "Frequency Morning",
      "type": "array"
    },
    "frequency_afternoon": {
      "items": {
        "$ref": "#/$defs/Frequency"
      },
      "title": "Frequency Afternoon",
      "type": "array"
    },
    "frequency_evening": {
      "items": {
        "$ref": "#/$defs/Frequency"
      },
      "title": "Frequency Evening",
      "type": "array"
    },
    "frequency_night": {
      "items": {
        "$ref": "#/$defs/Frequency"
      },
      "title": "Frequency Night",
      "type": "array"
    },
    "duration": {
      "title": "Duration",
      "type": "string"
    },
    "duration_source": {
      "title": "Duration Source",
      "type": "string"
    },
    "continue_until_stopped": {
      "title": "Continue Until Stopped",
      "type": "boolean"
    },
    "dosage_time": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "title": "Dosage Time",
      "description": "Scheduled dose times returned by the service."
    },
    "scheduled_dates": {
      "items": {
        "$ref": "#/$defs/scheduler"
      },
      "title": "Scheduled Dates",
      "type": "array"
    },
    "actual_medication_name": {
      "title": "Actual Medication Name",
      "type": "string"
    },
    "brand_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Brand Name"
    },
    "generic_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Generic Name"
    },
    "auto_correct": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Auto Correct"
    },
    "med_from_llm": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Med From Llm"
    },
    "brand_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Brand Id"
    },
    "instructions": {
      "title": "Instructions",
      "type": "string"
    },
    "interval_minutes": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Interval Minutes"
    },
    "med_status": {
      "title": "Med Status",
      "type": "string",
      "description": "Medication order action/state; distinct from administration completion."
    },
    "is_stat": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Stat"
    },
    "is_once_only": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Once Only"
    },
    "is_sos": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Sos"
    },
    "is_infusion": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Infusion"
    },
    "is_status": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Is Status"
    },
    "source": {
      "$ref": "#/$defs/TodoSource",
      "description": "Document provenance; preserve without editing."
    },
    "todo_id": {
      "type": "string",
      "description": "Opaque task identifier; preserve it during edits."
    },
    "todo_version": {
      "type": "integer",
      "description": "Version returned by the service. Preserve it; the software routes do not expose a conditional-update contract."
    }
  },
  "required": [
    "medication_name"
  ],
  "title": "ToDoPrescriptionTask",
  "type": "object"
}
TodoSource

FieldType / nested definitionRequiredMeaning
document_idstringOptional / source-dependent
element_idstringOptional / source-dependent
segment_idstringOptional / source-dependent
sectionstringOptional / source-dependent
fieldstringOptional / source-dependent
textstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "document_id": {
      "title": "Document Id",
      "type": "string"
    },
    "element_id": {
      "title": "Element Id",
      "type": "string"
    },
    "segment_id": {
      "title": "Segment Id",
      "type": "string"
    },
    "section": {
      "title": "Section",
      "type": "string"
    },
    "field": {
      "title": "Field",
      "type": "string"
    },
    "text": {
      "title": "Text",
      "type": "string"
    }
  },
  "title": "TodoSource",
  "type": "object"
}
TotalRecords

FieldType / nested definitionRequiredMeaning
drug_chartintegerOptional / source-dependent
once_only_drugsintegerOptional / source-dependent
oral_anticoagulationintegerOptional / source-dependent
thromboprophylaxisintegerOptional / source-dependent
antiplateletintegerOptional / source-dependent
prn_drugsintegerOptional / source-dependent
infusionsintegerOptional / source-dependent
iv_fluidsintegerOptional / source-dependent
oxygenintegerOptional / source-dependent
administeredintegerOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "drug_chart": {
      "title": "Drug Chart",
      "type": "integer"
    },
    "once_only_drugs": {
      "title": "Once Only Drugs",
      "type": "integer"
    },
    "oral_anticoagulation": {
      "title": "Oral Anticoagulation",
      "type": "integer"
    },
    "thromboprophylaxis": {
      "title": "Thromboprophylaxis",
      "type": "integer"
    },
    "antiplatelet": {
      "title": "Antiplatelet",
      "type": "integer"
    },
    "prn_drugs": {
      "title": "Prn Drugs",
      "type": "integer"
    },
    "infusions": {
      "title": "Infusions",
      "type": "integer"
    },
    "iv_fluids": {
      "title": "Iv Fluids",
      "type": "integer"
    },
    "oxygen": {
      "title": "Oxygen",
      "type": "integer"
    },
    "administered": {
      "title": "Administered",
      "type": "integer"
    }
  },
  "title": "TotalRecords",
  "type": "object"
}
TubePlaceConfirm

FieldType / nested definitionRequiredMeaning
bilateral_chest_risebooleanOptional / source-dependent
eq_air_entrybooleanOptional / source-dependent
end_tidal_co2booleanOptional / source-dependent
chest_xraybooleanOptional / source-dependent
auscultationbooleanOptional / source-dependent
spo2_improvbooleanOptional / source-dependent
othersstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "bilateral_chest_rise": {
      "title": "Bilateral Chest Rise",
      "type": "boolean"
    },
    "eq_air_entry": {
      "title": "Eq Air Entry",
      "type": "boolean"
    },
    "end_tidal_co2": {
      "title": "End Tidal Co2",
      "type": "boolean"
    },
    "chest_xray": {
      "title": "Chest Xray",
      "type": "boolean"
    },
    "auscultation": {
      "title": "Auscultation",
      "type": "boolean"
    },
    "spo2_improv": {
      "title": "Spo2 Improv",
      "type": "boolean"
    },
    "others": {
      "title": "Others",
      "type": "string"
    }
  },
  "title": "TubePlaceConfirm",
  "type": "object"
}
VadRemovalChecklistForm

FieldType / nested definitionRequiredMeaning
type_of_vadstringOptional / source-dependent
sitestringOptional / source-dependent
date_of_removalstringOptional / source-dependent
removal_checklistRemovalChecklistOptional / source-dependent
reason_for_removalstringOptional / source-dependent
post_removal_observationPostRemovalObservationOptional / source-dependent
nursestringOptional / source-dependent
datestringOptional / source-dependent
signaturestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "type_of_vad": {
      "title": "Type Of Vad",
      "type": "string"
    },
    "site": {
      "title": "Site",
      "type": "string"
    },
    "date_of_removal": {
      "title": "Date Of Removal",
      "type": "string"
    },
    "removal_checklist": {
      "$ref": "#/$defs/RemovalChecklist"
    },
    "reason_for_removal": {
      "title": "Reason For Removal",
      "type": "string"
    },
    "post_removal_observation": {
      "$ref": "#/$defs/PostRemovalObservation"
    },
    "nurse": {
      "title": "Nurse",
      "type": "string"
    },
    "date": {
      "title": "Date",
      "type": "string"
    },
    "signature": {
      "title": "Signature",
      "type": "string"
    }
  },
  "title": "VadRemovalChecklistForm",
  "type": "object"
}
VadTypeOptions

FieldType / nested definitionRequiredMeaning
piccbooleanOptional / source-dependent
portbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "picc": {
      "title": "Picc",
      "type": "boolean"
    },
    "port": {
      "title": "Port",
      "type": "boolean"
    }
  },
  "title": "VadTypeOptions",
  "type": "object"
}
VascularAccessDeviceBundle

FieldType / nested definitionRequiredMeaning
insertion_checklist_formInsertionChecklistFormOptional / source-dependent
daily_maintenance_checklist_formDailyMaintenanceChecklistFormOptional / source-dependent
vad_removal_checklist_formVadRemovalChecklistFormOptional / source-dependent
complication_report_formComplicationReportFormOptional / source-dependent
is_form_completedbooleanOptional / source-dependent
form_completed_date_timestringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "insertion_checklist_form": {
      "$ref": "#/$defs/InsertionChecklistForm"
    },
    "daily_maintenance_checklist_form": {
      "$ref": "#/$defs/DailyMaintenanceChecklistForm"
    },
    "vad_removal_checklist_form": {
      "$ref": "#/$defs/VadRemovalChecklistForm"
    },
    "complication_report_form": {
      "$ref": "#/$defs/ComplicationReportForm"
    },
    "is_form_completed": {
      "title": "Is Form Completed",
      "type": "boolean"
    },
    "form_completed_date_time": {
      "title": "Form Completed Date Time",
      "type": "string"
    }
  },
  "title": "VascularAccessDeviceBundle",
  "type": "object"
}
VentiDailyChart

FieldType / nested definitionRequiredMeaning
pain_assessbooleanOptional / source-dependent
setting_verifiedbooleanOptional / source-dependent
endo_tube_checkedbooleanOptional / source-dependent
ettube_securedbooleanOptional / source-dependent
oral_carebooleanOptional / source-dependent
suct_donebooleanOptional / source-dependent
suct_typestringOptional / source-dependent
ettube_cuff_pressbooleanOptional / source-dependent
humid_checkbooleanOptional / source-dependent
venti_circ_checkbooleanOptional / source-dependent
filterbooleanOptional / source-dependent
neb_givenbooleanOptional / source-dependent
physio_donebooleanOptional / source-dependent
pos_changedbooleanOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "pain_assess": {
      "title": "Pain Assess",
      "type": "boolean"
    },
    "setting_verified": {
      "title": "Setting Verified",
      "type": "boolean"
    },
    "endo_tube_checked": {
      "title": "Endo Tube Checked",
      "type": "boolean"
    },
    "ettube_secured": {
      "title": "Ettube Secured",
      "type": "boolean"
    },
    "oral_care": {
      "title": "Oral Care",
      "type": "boolean"
    },
    "suct_done": {
      "title": "Suct Done",
      "type": "boolean"
    },
    "suct_type": {
      "title": "Suct Type",
      "type": "string"
    },
    "ettube_cuff_press": {
      "title": "Ettube Cuff Press",
      "type": "boolean"
    },
    "humid_check": {
      "title": "Humid Check",
      "type": "boolean"
    },
    "venti_circ_check": {
      "title": "Venti Circ Check",
      "type": "boolean"
    },
    "filter": {
      "title": "Filter",
      "type": "boolean"
    },
    "neb_given": {
      "title": "Neb Given",
      "type": "boolean"
    },
    "physio_done": {
      "title": "Physio Done",
      "type": "boolean"
    },
    "pos_changed": {
      "title": "Pos Changed",
      "type": "boolean"
    }
  },
  "title": "VentiDailyChart",
  "type": "object"
}
VentiInsert

FieldType / nested definitionRequiredMeaning
intubindicarray<IntubIndication>Optional / source-dependent
preproc_assessarray<PreprocedAssess>Optional / source-dependent
intubdetailarray<IntubDetails>Optional / source-dependent
med_usedarray<MedicationData>Optional / source-dependent
ventub_setarray<IntubSetting>Optional / source-dependent
tube_place_confirmarray<TubePlaceConfirm>Optional / source-dependent
complic_procarray<ComplicProcedure>Optional / source-dependent
remov_extubarray<RemovExtub>Optional / source-dependent
Exact JSON field definition
{
  "properties": {
    "intubindic": {
      "items": {
        "$ref": "#/$defs/IntubIndication"
      },
      "title": "Intubindic",
      "type": "array"
    },
    "preproc_assess": {
      "items": {
        "$ref": "#/$defs/PreprocedAssess"
      },
      "title": "Preproc Assess",
      "type": "array"
    },
    "intubdetail": {
      "items": {
        "$ref": "#/$defs/IntubDetails"
      },
      "title": "Intubdetail",
      "type": "array"
    },
    "med_used": {
      "items": {
        "$ref": "#/$defs/MedicationData"
      },
      "title": "Med Used",
      "type": "array"
    },
    "ventub_set": {
      "items": {
        "$ref": "#/$defs/IntubSetting"
      },
      "title": "Ventub Set",
      "type": "array"
    },
    "tube_place_confirm": {
      "items": {
        "$ref": "#/$defs/TubePlaceConfirm"
      },
      "title": "Tube Place Confirm",
      "type": "array"
    },
    "complic_proc": {
      "items": {
        "$ref": "#/$defs/ComplicProcedure"
      },
      "title": "Complic Proc",
      "type": "array"
    },
    "remov_extub": {
      "items": {
        "$ref": "#/$defs/RemovExtub"
      },
      "title": "Remov Extub",
      "type": "array"
    }
  },
  "title": "VentiInsert",
  "type": "object"
}
VentiMaintain

FieldType / nested definitionRequiredMeaning
venti_mainarray<VentiDailyChart>Optional / source-dependent
equip_mainarray<EquipMaintenance>Optional / source-dependent
remarksstringOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "venti_main": {
      "items": {
        "$ref": "#/$defs/VentiDailyChart"
      },
      "title": "Venti Main",
      "type": "array"
    },
    "equip_main": {
      "items": {
        "$ref": "#/$defs/EquipMaintenance"
      },
      "title": "Equip Main",
      "type": "array"
    },
    "remarks": {
      "title": "Remarks",
      "type": "string"
    }
  },
  "title": "VentiMaintain",
  "type": "object"
}
VentilationResponse

FieldType / nested definitionRequiredMeaning
patient_idstringYes
inpatient_idstringYes
structured_dataobjectYes
structured_data.IPD_VENTI_FORMobjectSource-dependent
structured_data.IPD_VENTI_FORM.venti_insertarray<VentiInsert>Source-dependent
structured_data.IPD_VENTI_FORM.venti_maintainarray<VentiMaintain>Source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "patient_id": {
      "type": "string"
    },
    "inpatient_id": {
      "type": "string"
    },
    "structured_data": {
      "type": "object",
      "properties": {
        "IPD_VENTI_FORM": {
          "type": "object",
          "properties": {
            "venti_insert": {
              "type": "array",
              "items": {
                "$ref": "#/$defs/VentiInsert"
              }
            },
            "venti_maintain": {
              "type": "array",
              "items": {
                "$ref": "#/$defs/VentiMaintain"
              }
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    }
  },
  "additionalProperties": true,
  "required": [
    "patient_id",
    "inpatient_id",
    "structured_data"
  ]
}
VitalAbnormality

FieldType / nested definitionRequiredMeaning
abnormality_detectedbooleanOptional / source-dependent
abnormal_vitals_messagestringOptional / source-dependent
overall_severityVitalSeverityOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "abnormality_detected": {
      "title": "Abnormality Detected",
      "type": "boolean"
    },
    "abnormal_vitals_message": {
      "title": "Abnormal Vitals Message",
      "type": "string"
    },
    "overall_severity": {
      "$ref": "#/$defs/VitalSeverity"
    }
  },
  "title": "VitalAbnormality",
  "type": "object"
}
VitalSeverity

Service-defined content; retain unknown fields.

Exact JSON field definition
{
  "enum": [
    "normal",
    "low",
    "medium",
    "critical"
  ],
  "title": "VitalSeverity",
  "type": "string"
}
VitalSigns

FieldType / nested definitionRequiredMeaning
temperaturestring | nullOptional / source-dependent
pulsestring | nullOptional / source-dependent
respirationstring | nullOptional / source-dependent
blood_pressurestring | nullOptional / source-dependent
blood_sugarstring | nullOptional / source-dependent
spo2string | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "temperature": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Temperature"
    },
    "pulse": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Pulse"
    },
    "respiration": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Respiration"
    },
    "blood_pressure": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Blood Pressure"
    },
    "blood_sugar": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Blood Sugar"
    },
    "spo2": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Spo2"
    }
  },
  "title": "VitalSigns",
  "type": "object"
}
WriteResponse

Upstream write acknowledgement. Verify the result by reading the corresponding form again.

FieldType / nested definitionRequiredMeaning
messagestringOptional / source-dependent
Exact JSON field definition
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string"
    }
  },
  "additionalProperties": true,
  "description": "Upstream write acknowledgement. Verify the result by reading the corresponding form again."
}
doc_check

FieldType / nested definitionRequiredMeaning
doc_namestring | nullOptional / source-dependent
signaturestring | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "doc_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Doc Name"
    },
    "signature": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Signature"
    }
  },
  "title": "doc_check",
  "type": "object"
}
nur_check

FieldType / nested definitionRequiredMeaning
nur_namestring | nullOptional / source-dependent
cross_checkedstring | nullOptional / source-dependent
Exact JSON field definition
{
  "properties": {
    "nur_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Nur Name"
    },
    "cross_checked": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Cross Checked"
    }
  },
  "title": "nur_check",
  "type": "object"
}
scheduler

FieldType / nested definitionRequiredMeaning
current_datestringYes
countstringYes
Exact JSON field definition
{
  "properties": {
    "current_date": {
      "title": "Current Date",
      "type": "string"
    },
    "count": {
      "title": "Count",
      "type": "string"
    }
  },
  "required": [
    "current_date",
    "count"
  ],
  "title": "scheduler",
  "type": "object"
}