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.
New integration: follow this order
- Hospital setup → floors → wards and beds, if used.
- Register doctors/nurses → identify or create the admission.
- Record audio → retrieve the required output.
- 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.
| Field | Meaning | Used by |
|---|---|---|
hospital_id | Provisioned hospital identifier. | Socket initialization and REST APIs. |
hospital_patient_id | Your HMS patient identifier; stable across admissions. | Socket initialization / patient mapping. |
hospital_inpatient_id | Your HMS admission identifier; stable within one admission. | Socket initialization, dynamic forms and task APIs. |
practitioner_id | Your registered doctor identifier. | Doctor recordings and doctor form requests. |
caregiver_id | Your registered nurse identifier. | Nurse recordings and nurse form requests. |
patient_id | CareScribe patient identifier. | Returned by CareScribe; required by certain downstream APIs. |
inpatient_id | CareScribe admission identifier. | Grouped notes, drug chart and assignment APIs. |
interaction_id | CareScribe 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
| Field | Type / meaning |
|---|---|
| floor_id | integer; generated CareScribe floor ID |
| floor_name | string; configured name |
| organization_id | integer; internal organization ID |
| created_at, updated_at | serialized timestamps |
| update_logs | JSON 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
| Fields | Type / meaning |
|---|---|
| bed_id, organization_id | strings; generated bed UUID and internal organization ID |
| bed_no, ward, bed_type | strings; bed number and configured names |
| floor_id | integer; parent floor |
| floor | list endpoint association: {floor_id: integer, floor_name: string}, or null |
| active, is_occupied, need_maintenance | booleans; activity, occupancy and maintenance state |
| status | string; defaults to available; occupied is used during assignment |
| room_no | string or null; returned metadata, not writable through these two bed routes |
| patient_id, inpatient_id | internal CareScribe ID strings or null |
| admitted_at, last_cleaned_at | serialized timestamps or null |
| created_at, updated_at | serialized timestamps |
| update_logs | JSON 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
- Open the authenticated
/wsaudiosocket. - Send one JSON initialization message with the admission and clinician identifiers.
- Wait for the exact acknowledgement
status: "init-received". - Stream binary WebM/Opus audio chunks. The example uses one-second chunks.
- Stop the recorder, send its final audio chunk, then send
{"type":"stop"}. - 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"
}
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 / field | Value or type | Meaning and client handling |
|---|---|---|
| Initialization: status | string, exactly init-received | Start sending binary audio after this message. |
| Initialization: file | string | Generated audio object path. It is not a downloadable URL, a clinical form or a task gcs_uri. |
| Initialization echo | status: init-received -data, initPayload: object | The current binary handler may also echo initialization fields. This is not the exact readiness acknowledgement; do not start the recorder twice. |
| Creation: status, message | boolean true, string | Interaction creation succeeded. Store result identifiers; keep the socket open. |
| Creation: result.patient_id | returned identifier | Internal CareScribe patient ID. Preserve its returned representation; it differs from hospital_patient_id. |
| Creation: result.inpatient_id | returned identifier or null | Resolved CareScribe admission ID. Retain the original HMS hospital_inpatient_id separately for forms and TODO calls. |
| Creation: result.interaction_id | returned identifier | Recording/interaction ID for tracking. For task edits, use the interaction_id on the selected returned task record. |
| Creation: result.doctor_id, result.nurse_id | returned identifiers or null | Internal recording actor IDs. They do not replace the HMS practitioner_id/caregiver_id in form requests. |
| Creation: result.interaction_status, result.token_number | stored database values | Interaction metadata; neither is a processing-completion signal. Retain unknown/null values. |
| Creation: result.Patient | object {patient_id, patient_category} | Patient context; patient_id repeats the internal patient ID. Expected category for this flow is Inpatient. |
| Creation: result.interaction_detail_type | string | Submitted detail type, default Audio url. |
| Creation: result.audio_url | string or null | Stored recording location. Do not assume it is public or use it as a TODO record location. |
| Creation: result.patient_status, result.mhc_id | stored values or null | Additional patient/interaction metadata, unrelated to TODO completion. |
| Creation: audiointeraction | service-built JSON or null | Additional interaction/detail representation. Not the final form response; no fixed nested field contract is asserted here. |
| Creation: opd | boolean | Current implementation derives this flag from the presence of a doctor. It does not prove that the admission was routed as OPD. |
| Completion: status | string, exactly processed | The processed-result service delivered the result; the server then closes this socket. |
| Completion: allData | upstream result object | Passed 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.processedText | JSON string or service-provided value | Parse 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, message | boolean false, string | Creation/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
- Keep
hospital_id,hospital_patient_id,hospital_inpatient_idand the recording clinician's HMS ID from initialization. Save the returned internal patient, admission and interaction IDs separately. - 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. - For generated tasks, call
GET /software/doctortodowith the HMS hospital/admission query parameters. The TODO section below shows the response, review/approval payload and nurse execution update using actual returned records. - Read
GET /software/nurse/todoafter 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.
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 field | Type | Required / meaning |
|---|---|---|
| hospital_id | string | Required: your configured HMS hospital ID. |
| hospital_inpatient_id | string | Required: your HMS admission ID. Must resolve to a patient in this hospital. |
| form_name | string | Required: exact operation listed below. |
| practitioner_id | string | HMS doctor identifier; required for doctor_notes, raw_doctor_notes and surgery_notes. |
| caregiver_id | string | HMS 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
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
- Read the exact form and retain its full record, including nested interaction IDs.
- Modify only the intended values. Missing values are not equivalent to false or zero.
- 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.
- 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 status | Meaning |
|---|---|
| 400 | Missing 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 / 403 | API-key/hospital access failure; mismatched org_id on update_ipd_data. |
| 404 | Hospital/admission/clinician or stored note not found; no interaction for discharge generation. |
| 422 | Upstream validation error where the delegated proxy preserves it. |
| 500 | Unhandled form/generation error; doctor/nurse notes failures can be flattened to the generic form error. |
| 502 / 503 | Delegated 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.
| Step | Route | Payload / response |
|---|---|---|
| 1. Review tasks | GET /software/doctortodo | No body. TaskResponse. |
| 2. Approve interaction | PUT /software/doctor/approvetodo | Also 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 tasks | GET /software/nurse/todo | No body. NurseTaskResponse, including merged_todo when supplied. |
| 4. Record execution | PUT /software/nurse/updatestatus | JSON 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 field | Required | Meaning |
|---|---|---|
| hospital_id | Yes | HMS hospital ID. |
| patient_id | Yes | HMS patient ID for this endpoint, despite its name; resolves hospital_patient_id. |
| hospital_inpatient_id | Yes | HMS admission ID belonging to that patient. |
| caregiver_id | Yes | Registered HMS nurse ID. |
| type | No | Defaults 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.
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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
drug_name | string | Optional / source-dependent | |
administered_time | string | null | Optional / source-dependent | |
administered_by | string | Optional / source-dependent | |
status | string | null | Optional / source-dependent | |
notes | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
substance | string | Optional / source-dependent | |
reaction | string | Optional / source-dependent | |
severity | string | null | Optional / source-dependent | |
recorded_by | string | null | Optional / source-dependent | |
source | string | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
has_known_allergies | boolean | Optional / source-dependent | |
allergies | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
template_tests | string | Yes |
Exact JSON field definition
{
"properties": {
"template_tests": {
"title": "Template Tests",
"type": "string"
}
},
"required": [
"template_tests"
],
"title": "AssessmentTemplate",
"type": "object"
}BTChecklist
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
consent_signed | boolean | null | Optional / source-dependent | |
pt_voided | boolean | null | Optional / source-dependent | |
bowel_emptied | boolean | null | Optional / source-dependent | |
bt_set_valid | boolean | null | Optional / source-dependent | |
cannula_potency | boolean | null | Optional / source-dependent | |
blood_warmth | boolean | null | Optional / source-dependent | |
blood_clots_checked | boolean | null | Optional / source-dependent | |
pre_med_given | boolean | null | Optional / source-dependent | |
ns_flush | boolean | null | Optional / source-dependent | |
post_bt_med_order | boolean | null | Optional / source-dependent | |
informed_supervisor | boolean | null | Optional / source-dependent | |
informed_doctor | boolean | null | Optional / source-dependent | |
billing_updated | boolean | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
pt_id_correct | boolean | null | Optional / source-dependent | |
blood_pack_correct | boolean | null | Optional / source-dependent | |
bt_record_correct | boolean | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
interval | string | Optional / source-dependent | |
time | string | Optional / source-dependent | |
temp | string | Optional / source-dependent | |
pulse | string | Optional / source-dependent | |
resp | string | Optional / source-dependent | |
bp | string | Optional / source-dependent | |
observations | string | Optional / source-dependent | |
urine_output | string | Optional / source-dependent | |
reaction_detected | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
urine_color_qty | boolean | null | Optional / source-dependent | |
chest_breath_sounds | boolean | null | Optional / source-dependent | |
bag_saved_24hrs | boolean | null | Optional / source-dependent | |
blood_sent_hb | boolean | null | Optional / source-dependent | |
post_bt_med_given | boolean | null | Optional / source-dependent | |
specify | string | Optional / source-dependent | |
staff_sign | string | Optional / source-dependent | |
date | string | Optional / source-dependent | |
time | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
donor_unit_no | string | Optional / source-dependent | |
product_type | string | Optional / source-dependent | |
date | string | Optional / source-dependent | |
time_units | string | Optional / source-dependent | |
volume | string | Optional / source-dependent | |
reaction | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
clinical_diagnosis | string | Optional / source-dependent | |
product_transfused | string | Optional / source-dependent | |
time_commenced | string | Optional / source-dependent | |
donation_pack_no | string | Optional / source-dependent | |
volume_transfused | string | Optional / source-dependent | |
clerical_check | BTClericalCheck | Optional / source-dependent | |
temp_24h_prior | string | Optional / source-dependent | Values: , febrile, afebrile |
pre_reaction_vitals | BTReactionVitals | Optional / source-dependent | |
post_reaction_vitals | BTReactionVitals | Optional / source-dependent | |
signs_symptoms | BTReactionSigns | Optional / source-dependent | |
prev_blood_products | array<BTPrevBloodProduct> | Optional / source-dependent | |
reviewing_doctors | string | Optional / source-dependent | |
signature | string | Optional / source-dependent | |
name | string | Optional / source-dependent | |
sign_date | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
fever | boolean | Optional / source-dependent | |
chills | boolean | Optional / source-dependent | |
nausea_vomiting | boolean | Optional / source-dependent | |
hives_itching | boolean | Optional / source-dependent | |
lower_back_pain | boolean | Optional / source-dependent | |
chest_pain | boolean | Optional / source-dependent | |
anxiety | boolean | Optional / source-dependent | |
headache | boolean | Optional / source-dependent | |
skin_pallor | boolean | Optional / source-dependent | |
dark_urine | boolean | Optional / source-dependent | |
dyspnoea | boolean | Optional / source-dependent | |
bleeding_iv_site | boolean | Optional / source-dependent | |
others | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
time | string | Optional / source-dependent | |
temp | string | Optional / source-dependent | |
resp_rate | string | Optional / source-dependent | |
bp | string | Optional / source-dependent | |
pulse_rate | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
how_admitted | string | Yes | |
attendant_present | string | Yes | |
mother_tongue | string | Yes | |
allergies | string | Yes | |
blood_group | string | Optional / source-dependent | |
height | string | Yes | |
weight | string | Yes | |
vitals | array<NurseAssessmentVitals> | Yes | |
special_notes | string | Yes | |
consultant | string | Yes | |
oral | string | Yes |
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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
hiv | string | null | Optional / source-dependent | |
hcv | string | null | Optional / source-dependent | |
hbv | string | null | Optional / source-dependent | |
syphilis | string | null | Optional / source-dependent | |
htlv | string | null | Optional / source-dependent | |
malaria | string | null | Optional / source-dependent | |
cmv | string | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
blood_transfusion_reaction_report | object | Optional / source-dependent | |
blood_transfusion_reaction_report.date | string | Source-dependent | |
blood_transfusion_reaction_report.clinical_diagnosis | string | Source-dependent | |
blood_transfusion_reaction_report.product_transfused | string | Source-dependent | |
blood_transfusion_reaction_report.time_commenced | string | Source-dependent | |
blood_transfusion_reaction_report.donation_pack_number | string | Source-dependent | |
blood_transfusion_reaction_report.volume_transfused | string | Source-dependent | |
blood_transfusion_reaction_report.patient_id_correct | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_reaction_report.blood_pack_correct | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_reaction_report.blood_transfusion_record_correct | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_reaction_report.febrile | boolean | Source-dependent | |
blood_transfusion_reaction_report.afebrile | boolean | Source-dependent | |
blood_transfusion_reaction_report.vital_signs | object | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.pre_reaction | object | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.pre_reaction.time | string | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.pre_reaction.temperature | string | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.pre_reaction.respiratory_rate | string | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.pre_reaction.bp | string | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.pre_reaction.pulse_rate | string | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.post_reaction | object | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.post_reaction.time | string | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.post_reaction.temperature | string | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.post_reaction.respiratory_rate | string | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.post_reaction.bp | string | Source-dependent | |
blood_transfusion_reaction_report.vital_signs.post_reaction.pulse_rate | string | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms | object | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.fever | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.chills | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.nausea_vomiting | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.hives_itching | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.lower_back_pain | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.chest_pain | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.anxiety | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.headache | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.skin_pallor | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.dark_urine | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.dyspnoea | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.bleeding_from_wound_or_iv_site | boolean | Source-dependent | |
blood_transfusion_reaction_report.signs_and_symptoms.others | string | Source-dependent | |
blood_transfusion_reaction_report.previous_blood_products | array<object> | Source-dependent | |
blood_transfusion_reaction_report.previous_blood_products[].date | string | Source-dependent | |
blood_transfusion_reaction_report.previous_blood_products[].donor_unit_no | string | Source-dependent | |
blood_transfusion_reaction_report.previous_blood_products[].product_type | string | Source-dependent | |
blood_transfusion_reaction_report.previous_blood_products[].reaction | string | Source-dependent | |
blood_transfusion_reaction_report.previous_blood_products[].time_units | string | Source-dependent | |
blood_transfusion_reaction_report.previous_blood_products[].volume | string | Source-dependent | |
blood_transfusion_reaction_report.reviewing_doctors | string | Source-dependent | |
blood_transfusion_reaction_report.signature | string | Source-dependent | |
blood_transfusion_reaction_report.name | string | Source-dependent | |
blood_transfusion_reaction_report.sign_date | string | Source-dependent | |
blood_transfusion_reaction_report.note_time | string | Source-dependent | |
blood_transfusion_reaction_report.timestamp | string | Source-dependent | |
blood_transfusion_reaction_report.interaction_id | string | Source-dependent | |
blood_transfusion_monitoring_sheet | object | Optional / source-dependent | |
blood_transfusion_monitoring_sheet.location_of_blood_transfusion | string | Source-dependent | |
blood_transfusion_monitoring_sheet.blood_group | string | Source-dependent | |
blood_transfusion_monitoring_sheet.diagnosis | string | Source-dependent | |
blood_transfusion_monitoring_sheet.indication | string | Source-dependent | |
blood_transfusion_monitoring_sheet.number_of_units | string | Source-dependent | |
blood_transfusion_monitoring_sheet.type_of_component | string | Source-dependent | |
blood_transfusion_monitoring_sheet.pack_no | string | Source-dependent | |
blood_transfusion_monitoring_sheet.blood_group_of_products | string | Source-dependent | |
blood_transfusion_monitoring_sheet.date_of_cross_match | string | Source-dependent | |
blood_transfusion_monitoring_sheet.expiry_date | string | Source-dependent | |
blood_transfusion_monitoring_sheet.checked_by_doctor_name | string | Source-dependent | |
blood_transfusion_monitoring_sheet.checked_by_signature | string | Source-dependent | |
blood_transfusion_monitoring_sheet.checked_by_date | string | Source-dependent | |
blood_transfusion_monitoring_sheet.checked_by_time | string | Source-dependent | |
blood_transfusion_monitoring_sheet.time_out_before_transfusion | object | Source-dependent | |
blood_transfusion_monitoring_sheet.time_out_before_transfusion.correct_patient | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.time_out_before_transfusion.correct_blood_group | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.time_out_before_transfusion.correct_component | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.pre_medication | array<JSON value> | Source-dependent | |
blood_transfusion_monitoring_sheet.post_medication | array<JSON value> | Source-dependent | |
blood_transfusion_monitoring_sheet.doctor_name | string | Source-dependent | |
blood_transfusion_monitoring_sheet.doctor_signature | string | Source-dependent | |
blood_transfusion_monitoring_sheet.bt_nurses_record | object | Source-dependent | |
blood_transfusion_monitoring_sheet.bt_nurses_record.consent_for_transfusion | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.bt_nurses_record.assigned_nurse_signature | string | Source-dependent | |
blood_transfusion_monitoring_sheet.bt_nurses_record.cross_checked_by | string | Source-dependent | |
blood_transfusion_monitoring_sheet.note_time | string | Source-dependent | |
blood_transfusion_monitoring_sheet.timestamp | string | Source-dependent | |
blood_transfusion_monitoring_sheet.interaction_id | string | Source-dependent | |
blood_transfusion_monitoring_sheet.fluid_volume_infused | string | Source-dependent | |
blood_transfusion_monitoring_sheet.checklist | object | Source-dependent | |
blood_transfusion_monitoring_sheet.checklist.bt_consent_signed | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.patient_voided | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.bowel_emptied | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.validity_of_blood_transfusion_set_checked | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.cannula_potency_checked | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.blood_warmth_checked | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.check_blood_clots_any_visible_particle | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.pre_medication_given | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.ns_100ml_50ml_transfused | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.post_bt_medication_order | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.informed_nursing_supervisor | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.information_to_doctor_concerned | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.checklist.updating_billing_sheet | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.fluid_monitoring | array<object> | Source-dependent | |
blood_transfusion_monitoring_sheet.fluid_monitoring[].label | string | Source-dependent | |
blood_transfusion_monitoring_sheet.fluid_monitoring[].time | string | Source-dependent | |
blood_transfusion_monitoring_sheet.fluid_monitoring[].temperature | string | Source-dependent | |
blood_transfusion_monitoring_sheet.fluid_monitoring[].pulse | string | Source-dependent | |
blood_transfusion_monitoring_sheet.fluid_monitoring[].respiration | string | Source-dependent | |
blood_transfusion_monitoring_sheet.fluid_monitoring[].bp | string | Source-dependent | |
blood_transfusion_monitoring_sheet.fluid_monitoring[].observations | string | Source-dependent | |
blood_transfusion_monitoring_sheet.fluid_monitoring[].urine_output | string | Source-dependent | |
blood_transfusion_monitoring_sheet.fluid_monitoring[].reaction_detected | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.post_transfusion_record | object | Source-dependent | |
blood_transfusion_monitoring_sheet.post_transfusion_record.observe_urine_color_and_quantity | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.post_transfusion_record.assess_chest_and_breath_sounds | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.post_transfusion_record.save_transfusion_bag_for_24hrs | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.post_transfusion_record.send_blood_for_reevaluation_of_hb_percent | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.post_transfusion_record.post_bt_medication_given | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
blood_transfusion_monitoring_sheet.post_transfusion_record.specify | string | Source-dependent | |
note_time | string | Optional / source-dependent | |
timestamp | string | Optional / source-dependent | |
interaction_id | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
structured_data | object | Yes | |
structured_data.IPD_BLOOD_TRANSFUSION | BloodTransfusionFields | Source-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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
sensory_perception | integer | null | Optional / source-dependent | |
moisture | integer | null | Optional / source-dependent | |
activity | integer | null | Optional / source-dependent | |
mobility | integer | null | Optional / source-dependent | |
nutrition | integer | null | Optional / source-dependent | |
friction_and_shear | integer | null | Optional / source-dependent | |
total_score | integer | null | Optional / source-dependent | |
risk_level | string | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
action | string | Optional / source-dependent | |
date | string | Optional / source-dependent | |
signature | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
insertion_checklist_form | CautiInsertionChecklistForm | Optional / source-dependent | |
daily_maintenance_checklist_form | CautiDailyMaintenanceChecklistForm | Optional / source-dependent | |
removal_checklist_form | CautiRemovalChecklistForm | Optional / source-dependent | |
summary_form | CautiSummaryForm | Optional / source-dependent | |
is_form_completed | boolean | Optional / source-dependent | |
form_completed_date_time | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
type_of_catheter | string | Optional / source-dependent | Values: , foley, suprapubic, other |
type_options | CautiCatheterTypeOptions | Optional / source-dependent | |
size | string | Optional / source-dependent | |
date_time_of_insertion | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
foley | boolean | Optional / source-dependent | |
suprapubic | boolean | Optional / source-dependent | |
other | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
date_of_insertion | string | Optional / source-dependent | |
assessments | array<CautiDailyMonitoringEntry> | Optional / source-dependent | |
signs_of_infection | CautiSignsOfInfection | Optional / source-dependent | |
action_taken | CautiActionTaken | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
date | string | Optional / source-dependent | |
time | string | Optional / source-dependent | |
catheter_still_indicated | boolean | Optional / source-dependent | |
hand_hygiene_before_after_care | boolean | Optional / source-dependent | |
catheter_secured_properly | boolean | Optional / source-dependent | |
drainage_bag_below_bladder | boolean | Optional / source-dependent | |
no_kinks_in_tubing | boolean | Optional / source-dependent | |
closed_drainage_system_intact | boolean | Optional / source-dependent | |
perineal_care_performed | boolean | Optional / source-dependent | |
bag_not_touching_floor | boolean | Optional / source-dependent | |
urine_clear_no_infection_signs | boolean | Optional / source-dependent | |
culture | boolean | Optional / source-dependent | |
pain_score | string | Optional / source-dependent | |
remarks | string | Optional / source-dependent | |
signature | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
acute_urinary_retention | boolean | Optional / source-dependent | |
accurate_urine_output_monitoring_critically_ill | boolean | Optional / source-dependent | |
perioperative_use | boolean | Optional / source-dependent | |
pressure_ulcer_management | boolean | Optional / source-dependent | |
other | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_identity_confirmed | boolean | Optional / source-dependent | |
informed_consent_obtained | boolean | Optional / source-dependent | |
hand_hygiene_performed | boolean | Optional / source-dependent | |
sterile_gloves_ppe_used | boolean | Optional / source-dependent | |
perineal_area_cleaned | boolean | Optional / source-dependent | |
aseptic_technique_maintained | boolean | Optional / source-dependent | |
sterile_catheter_used | boolean | Optional / source-dependent | |
closed_drainage_system_maintained | boolean | Optional / source-dependent | |
catheter_secured_properly | boolean | Optional / source-dependent | |
drainage_bag_below_bladder_level | boolean | Optional / source-dependent | |
no_kinks_obstruction_in_tubing | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
diagnosis | string | Optional / source-dependent | |
catheter_details | CautiCatheterDetails | Optional / source-dependent | |
indication_for_catheter | CautiIndicationForCatheter | Optional / source-dependent | |
insertion_bundle_checklist | CautiInsertionBundleChecklist | Optional / source-dependent | |
post_insertion_care | CautiPostInsertionCare | Optional / source-dependent | |
signatures | Signatures | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
urine_flow_confirmed | boolean | Optional / source-dependent | |
patient_comfortable | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
able_to_void | boolean | Optional / source-dependent | |
pain_discomfort | boolean | Optional / source-dependent | |
retention | boolean | Optional / source-dependent | |
others | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
doctors_order_verified | boolean | Optional / source-dependent | |
catheter_no_longer_indicated | boolean | Optional / source-dependent | |
hand_hygiene_performed | boolean | Optional / source-dependent | |
ppe_used | boolean | Optional / source-dependent | |
balloon_deflated_completely | boolean | Optional / source-dependent | |
catheter_removed_gently | boolean | Optional / source-dependent | |
patient_monitored_post_removal | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
type_of_catheter | string | Optional / source-dependent | |
date_of_removal | string | Optional / source-dependent | |
removal_checklist | CautiRemovalChecklist | Optional / source-dependent | |
post_removal_observation | CautiPostRemovalObservation | Optional / source-dependent | |
date | string | Optional / source-dependent | |
signature | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
fever | boolean | Optional / source-dependent | |
burning_sensation | boolean | Optional / source-dependent | |
cloudy_urine | boolean | Optional / source-dependent | |
foul_smell | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
unit | string | Optional / source-dependent | |
month | string | Optional / source-dependent | |
catheter_date | string | Optional / source-dependent | |
indication_days | string | Optional / source-dependent | |
insitu_infection | boolean | Optional / source-dependent | |
remarks | string | Optional / source-dependent | |
total_catheter_days | string | Optional / source-dependent | |
total_cauti_cases | string | Optional / source-dependent | |
infection_control_nurse_signature | string | Optional / source-dependent | |
date | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
central_line_insertion | ClabsiCentralLineInsertion | null | Optional / source-dependent | |
indication_for_central_line | ClabsiIndicationForCentralLine | null | Optional / source-dependent | |
clabsi_bundle_compliance | ClabsiBundleCompliance | null | Optional / source-dependent | |
signatures | ClabsiSignatures | null | Optional / source-dependent | |
daily_maintenance | array<ClabsiDailyMaintenanceEntry> | Optional / source-dependent | |
dressing_change_checklist | ClabsiDressingChangeChecklist | null | Optional / source-dependent | |
central_line_removal | ClabsiCentralLineRemoval | null | Optional / source-dependent | |
culture | boolean | Optional / source-dependent | |
antibiotics | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_identity_confirmed | boolean | Optional / source-dependent | |
informed_consent_obtained | boolean | Optional / source-dependent | |
hand_hygiene_performed | boolean | Optional / source-dependent | |
full_sterile_barrier_precautions_used | boolean | Optional / source-dependent | |
skin_antisepsis_with_chlorhexidine | boolean | Optional / source-dependent | |
appropriate_site_selected | boolean | Optional / source-dependent | |
aseptic_technique_maintained | boolean | Optional / source-dependent | |
ultrasound_guidance_used | boolean | Optional / source-dependent | |
sterile_dressing_applied | boolean | Optional / source-dependent | |
line_secured_properly | boolean | Optional / source-dependent | |
line_flushed_and_patent | boolean | Optional / source-dependent | |
all_lumens_capped | boolean | Optional / source-dependent | |
dressing_clean_dry_intact | boolean | Optional / source-dependent | |
date_time_label_applied | boolean | Optional / source-dependent | |
chest_xray_done | boolean | Optional / source-dependent | |
procedure_documented | boolean | Optional / source-dependent | |
review_catheter_necessity_daily_and_remove_promptly | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
line_type | ClabsiCentralLineType | Optional / source-dependent | |
site | ClabsiCentralLineSite | Optional / source-dependent | |
date_of_insertion | string | Optional / source-dependent | |
time_of_insertion | string | Optional / source-dependent | |
central_line_placed_in | string | Optional / source-dependent | |
reasons_for_insertion | string | Optional / source-dependent | |
inserted_by_name | string | Optional / source-dependent | |
no_of_attempts | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
line_type | string | Optional / source-dependent | |
site | string | Optional / source-dependent | |
date_of_removal | string | Optional / source-dependent | |
doctors_order_verified | boolean | Optional / source-dependent | |
line_no_longer_indicated | boolean | Optional / source-dependent | |
hand_hygiene_performed | boolean | Optional / source-dependent | |
ppe_used | boolean | Optional / source-dependent | |
line_removed_using_aseptic_technique | boolean | Optional / source-dependent | |
catheter_tip_intact | boolean | Optional / source-dependent | |
hemostasis_achieved | boolean | Optional / source-dependent | |
sterile_dressing_applied | boolean | Optional / source-dependent | |
post_removal_monitoring | ClabsiPostRemovalMonitoring | Optional / source-dependent | |
others | string | Optional / source-dependent | |
doctor_nurse | string | Optional / source-dependent | |
date | string | Optional / source-dependent | |
signature | string | Optional / source-dependent | |
reasons_for_removal | string | Optional / source-dependent | |
removed_by | string | Optional / source-dependent | |
sign | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
site | string | Optional / source-dependent | |
internal_jugular | boolean | Optional / source-dependent | |
subclavian | boolean | Optional / source-dependent | |
femoral | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
cvc | boolean | Optional / source-dependent | |
dialysis_line | boolean | Optional / source-dependent | |
other | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
line_type | string | Optional / source-dependent | |
site | string | Optional / source-dependent | |
line_detail_date | string | Optional / source-dependent | |
date | string | Optional / source-dependent | |
time | string | Optional / source-dependent | |
day | integer | Optional / source-dependent | |
central_line_still_indicated | boolean | Optional / source-dependent | |
hand_hygiene_before_handling | boolean | Optional / source-dependent | |
hub_port_disinfected_before_access | boolean | Optional / source-dependent | |
dressing_clean_dry_intact | boolean | Optional / source-dependent | |
dressing_change_daily | boolean | Optional / source-dependent | |
no_redness_swelling_at_site | boolean | Optional / source-dependent | |
no_discharge_pus | boolean | Optional / source-dependent | |
line_secured_properly | boolean | Optional / source-dependent | |
tubing_cap_changed_as_per_policy | boolean | Optional / source-dependent | |
fever | string | Optional / source-dependent | |
chills | boolean | Optional / source-dependent | |
local_site_infection | boolean | Optional / source-dependent | |
positive_blood_culture | boolean | Optional / source-dependent | |
action_taken | string | Optional / source-dependent | |
nurse_name | string | Optional / source-dependent | |
reviewed_by | string | Optional / source-dependent | |
hand_hygiene_before_accessing | boolean | Optional / source-dependent | |
scrub_the_hub | boolean | Optional / source-dependent | |
redness | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
site | string | Optional / source-dependent | |
date | string | Optional / source-dependent | |
hand_hygiene_performed | boolean | Optional / source-dependent | |
sterile_gloves_used | boolean | Optional / source-dependent | |
old_dressing_removed_aseptically | boolean | Optional / source-dependent | |
site_inspected | boolean | Optional / source-dependent | |
skin_cleaned_with_chlorhexidine | boolean | Optional / source-dependent | |
allowed_to_dry_completely | boolean | Optional / source-dependent | |
sterile_dressing_applied | boolean | Optional / source-dependent | |
date_time_labeled | boolean | Optional / source-dependent | |
remarks | string | Optional / source-dependent | |
nurse | string | Optional / source-dependent | |
signature | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
hemodynamic_monitoring | boolean | Optional / source-dependent | |
iv_medications | boolean | Optional / source-dependent | |
difficult_peripheral_access | boolean | Optional / source-dependent | |
dialysis | boolean | Optional / source-dependent | |
other | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
bleeding | boolean | Optional / source-dependent | |
pain | boolean | Optional / source-dependent | |
air_embolism_signs | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
inserted_by | string | Optional / source-dependent | |
verified_by | string | Optional / source-dependent | |
assistant_nurse | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
hypotens | boolean | Optional / source-dependent | |
hypoxemia | boolean | Optional / source-dependent | |
bradycardia | boolean | Optional / source-dependent | |
bleeding | boolean | Optional / source-dependent | |
dental_inj | boolean | Optional / source-dependent | |
esophageal_intub | boolean | Optional / source-dependent | |
diff_intub | boolean | Optional / source-dependent | |
others | string | Optional / source-dependent | |
details | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
type | string | Optional / source-dependent | |
site | string | Optional / source-dependent | |
complication_type | ComplicationType | Optional / source-dependent | |
signs_symptoms | string | Optional / source-dependent | |
action_taken | string | Optional / source-dependent | |
reported_to | string | Optional / source-dependent | |
nurse | string | Optional / source-dependent | |
date | string | Optional / source-dependent | |
signature | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
infection | boolean | Optional / source-dependent | |
occlusion | boolean | Optional / source-dependent | |
infiltration | boolean | Optional / source-dependent | |
dislodgement | boolean | Optional / source-dependent | |
other | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
awake | boolean | Optional / source-dependent | |
follow_comm | boolean | Optional / source-dependent | |
stable | boolean | Optional / source-dependent | |
on_sup | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
date | string | Optional / source-dependent | |
time | string | Optional / source-dependent | |
site | string | Optional / source-dependent | |
vad_still_required | boolean | Optional / source-dependent | |
site_clean_dry | boolean | Optional / source-dependent | |
redness_swelling_present | boolean | Optional / source-dependent | |
dressing_intact | boolean | Optional / source-dependent | |
line_patent_flush_working | boolean | Optional / source-dependent | |
signs_of_infection | boolean | Optional / source-dependent | |
hub_disinfected_before_use | boolean | Optional / source-dependent | |
pain_score | string | Optional / source-dependent | |
signature | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
type_of_vad | string | Optional / source-dependent | |
site | string | Optional / source-dependent | |
assessments | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
deferred_order | string | Yes | |
trigger_condition | string | Optional / source-dependent | |
order_type | string | Optional / source-dependent | |
status | string | Optional / source-dependent | |
source | TodoSource | Optional / source-dependent | Document provenance; preserve without editing. |
todo_id | string | Optional / source-dependent | Opaque task identifier; preserve it during edits. |
todo_version | integer | Optional / source-dependent | Version 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
type_of_vad | string | Optional / source-dependent | Values: , picc, port |
type_options | VadTypeOptions | Optional / source-dependent | |
site_selected | string | Optional / source-dependent | |
date_time | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
isSpecialDiet | boolean | Yes | |
type | string | Yes |
Exact JSON field definition
{
"properties": {
"isSpecialDiet": {
"title": "Isspecialdiet",
"type": "boolean"
},
"type": {
"title": "Type",
"type": "string"
}
},
"required": [
"isSpecialDiet",
"type"
],
"title": "Diet",
"type": "object"
}DietPatternAndAllergies
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
diet_type | string | Optional / source-dependent | Values: , Vegetarian, Non-vegetarian, Eggetarian, Vegan, Other |
diet_type_other | string | Optional / source-dependent | |
has_food_allergies | boolean | Optional / source-dependent | |
food_allergies | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
diagnosis | string | null | Optional / source-dependent | |
indication | string | Optional / source-dependent | |
nou | string | Optional / source-dependent | |
comp_type | string | Optional / source-dependent | |
pre_med | array<MedicationData> | Optional / source-dependent | |
post_med | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
blood_sugar | string | null | Optional / source-dependent | |
medication | string | null | Optional / source-dependent | |
creatinine_level | string | null | Optional / source-dependent | |
consent_for_insulin | boolean | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
chief_complaints | string | Yes | |
history_of_present_illness | string | Yes | |
past_history_and_duration | string | Yes | |
family_history | string | Yes | |
personal_history | string | Yes | |
menstrual_history | string | Yes | |
obstetrical_history | string | Yes | |
allergies | string | Yes | |
blood_group | string | Optional / source-dependent | |
previous_medication | string | Yes | |
present_medication | string | Yes | |
previous_investigations | string | Yes | |
examination_findings | string | Yes | |
provisional_diagnosis | string | Yes | |
plan_of_care | string | Yes | |
surgery_procedure_planned | string | Yes | |
pre_operative_instructions | string | Yes | |
recommendations | string | Yes | |
assessment | array<AssessmentTemplate> | Yes | |
medication_templates | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
chief_complaints | string | Yes | |
history_of_present_illness | string | Yes | |
past_history_and_duration | string | Yes | |
family_history | string | Yes | |
personal_history | string | Yes | |
allergies | string | Yes | |
blood_group | string | Optional / source-dependent | |
previous_medication | string | Yes | |
present_medication | string | Yes | |
previous_investigations | string | Yes | |
examination_findings | string | Yes | |
provisional_diagnosis | string | Yes | |
plan_of_care | string | Yes | |
surgery_procedure_planned | string | Yes | |
pre_operative_instructions | string | Yes | |
recommendations | string | Yes | |
assessment | array<AssessmentTemplate> | Yes | |
medication_templates | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
created_at | string | Optional / source-dependent | |
updated_at | string | Optional / source-dependent | |
interaction_type | string | Optional / source-dependent | |
answer | object | Optional / source-dependent | |
answer.assessment | string | Source-dependent | |
answer.clinical_context | string | Source-dependent | |
answer.clinical_status | string | Source-dependent | |
answer.comorbids | string | Source-dependent | |
answer.complaints_and_events | string | Source-dependent | |
answer.disposition_plan | string | Source-dependent | |
answer.escalation_instructions | string | Source-dependent | |
answer.plan | string | Source-dependent | |
answer.systemic_examination | string | Source-dependent | |
answer.vitals | string | Source-dependent | |
doctor_id | string | Optional / source-dependent | |
practitioner_id | string | Optional / source-dependent | |
read_error | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
medication_name | string | Yes | |
dosage | string | Yes | |
route | string | Yes | |
status | string | Yes | |
start_date | string | Optional / source-dependent | |
prescription_type | string | Optional / source-dependent | |
additional_information | string | null | Optional / source-dependent | |
is_stat | boolean | null | Optional / source-dependent | |
is_once_only | boolean | null | Optional / source-dependent | |
is_sos | boolean | null | Optional / source-dependent | |
is_infusion | boolean | null | Optional / source-dependent | |
frequency_morning | string | Optional / source-dependent | |
frequency_afternoon | string | Optional / source-dependent | |
frequency_evening | string | Optional / source-dependent | |
frequency_night | string | Optional / source-dependent | |
created_at | string | Yes | |
prescribed_by | string | Yes | |
administered | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
allergies_to_add | array<AllergyEntry> | Optional / source-dependent | |
administrations_to_add | array<AdministrationRecord> | Optional / source-dependent | |
medications_to_stop | array<StopMedicationCommand> | Optional / source-dependent | |
medications_to_hold | array<StopMedicationCommand> | Optional / source-dependent | |
medications_to_resume | array<StopMedicationCommand> | Optional / source-dependent | |
new_regular_orders | array<NewRegularOrderCommand> | Optional / source-dependent | |
new_prn_orders | array<NewPRNOrderCommand> | Optional / source-dependent | |
medication_reconciliation | MedicationReconciliation | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
merged_schema | MergedSchema | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
venti_circ_change | string | Optional / source-dependent | |
hme_bactfilt_change | string | Optional / source-dependent | |
humid_water_change | string | Optional / source-dependent | |
suct_cath_change | string | Optional / source-dependent | |
ettube_hold_change | string | Optional / source-dependent | |
ambu_bag_check | string | Optional / source-dependent | |
alarm_funct_check | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
eye | string | Optional / source-dependent | |
right_motres | string | Optional / source-dependent | |
left_motres | string | Optional / source-dependent | |
verbal_response | string | Optional / source-dependent | |
right_pupil | string | Optional / source-dependent | |
left_pupil | string | Optional / source-dependent | |
power_rul | string | Optional / source-dependent | |
power_rll | string | Optional / source-dependent | |
power_lul | string | Optional / source-dependent | |
power_lll | string | Optional / source-dependent | |
remarks | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
key | string | Optional / source-dependent | Values: , feeding, analgesia, sedation, thromboprophylaxis, head_up, ulcer_prophylaxis, glycemic_control, spontaneous_breath_o2, bowel_care, indwelling_catheter, deescalation_antibiotics |
event | string | Optional / source-dependent | Values: , started, administered, rate_changed, dose_changed, paused, resumed, held, restarted, completed, stopped, discontinued, refused, missed, cancelled |
text | string | Optional / source-dependent | |
occurred_at | string | Optional / source-dependent | |
rate_ml_hr | number | null | Optional / source-dependent | |
volume_ml | number | null | Optional / source-dependent | |
duration_hours | number | null | Optional / source-dependent | |
dose | string | Optional / source-dependent | |
route | string | Optional / source-dependent | |
reason | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
feeding | string | Optional / source-dependent | |
analgesia | string | Optional / source-dependent | |
sedation | string | Optional / source-dependent | |
thromboprophylaxis | string | Optional / source-dependent | |
head_up | string | Optional / source-dependent | |
ulcer_prophylaxis | string | Optional / source-dependent | |
glycemic_control | string | Optional / source-dependent | |
spontaneous_breath_o2 | string | Optional / source-dependent | |
bowel_care | string | Optional / source-dependent | |
indwelling_catheter | string | Optional / source-dependent | |
deescalation_antibiotics | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
isMonitoring | boolean | Yes | |
type | string | Yes |
Exact JSON field definition
{
"properties": {
"isMonitoring": {
"title": "Ismonitoring",
"type": "boolean"
},
"type": {
"title": "Type",
"type": "string"
}
},
"required": [
"isMonitoring",
"type"
],
"title": "FluidsMonitoring",
"type": "object"
}Frequency
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
frequency | string | Optional / source-dependent | |
status | string | Optional / source-dependent |
Exact JSON field definition
{
"properties": {
"frequency": {
"title": "Frequency",
"type": "string"
},
"status": {
"title": "Status",
"type": "string"
}
},
"title": "Frequency",
"type": "object"
}FunctionalAssessment
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
washing | boolean | Yes | |
dressing | boolean | Yes | |
feeding | boolean | Yes | |
toileting | boolean | Yes | |
transferring | boolean | Yes | |
mobility | boolean | Yes |
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.
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
success | boolean | Yes | |
message | string | Yes | |
data | JSON value | Yes | Service-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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
drug_name | string | Optional / source-dependent | |
scheduled_time | string | null | Optional / source-dependent | |
administered_time | string | Yes | |
administered_by | string | Yes | |
doctor_id | string | null | Optional / source-dependent | |
nurse_id | string | null | Optional / source-dependent | |
status | string | Yes | |
notes | string | null | Optional / source-dependent | |
prescribed_by | string | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
creatinine_level | string | Optional / source-dependent | |
consent_for_insulin | JSON value | Optional / source-dependent | Service-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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
date | string | Optional / source-dependent | |
entries | array<GlucoseEntry> | Optional / source-dependent | |
total | string | Optional / source-dependent | |
remarks | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
date | string | Optional / source-dependent | |
time | string | Optional / source-dependent | |
blood_sugar | string | Optional / source-dependent | |
medication | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
interaction_id | string | integer | null | Optional / source-dependent | |
doctor_id | string | integer | null | Optional / source-dependent | |
nurse_id | string | integer | null | Optional / source-dependent | |
note_time | string | Optional / source-dependent | |
timestamp | string | Optional / source-dependent | |
practitioner_id | string | Optional / source-dependent | |
caregiver_id | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
structured_data | object | Yes | |
structured_data.IPD_BLOOD_GLUCOSE_MONITORING | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
structured_data | object | Yes |
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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
triage_time | string | Optional / source-dependent | |
date | string | Optional / source-dependent | |
arrival_time | string | Optional / source-dependent | |
mode_of_arrival | GynecModeOfArrival | Optional / source-dependent | |
triage_code | GynecTriageCode | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
language | string | Optional / source-dependent | |
verbal | string | Optional / source-dependent | |
hearing | string | Optional / source-dependent | |
others | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
receptive | boolean | Optional / source-dependent | |
non_receptive | boolean | Optional / source-dependent | |
inability_to_learn | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
yes | boolean | Optional / source-dependent | |
no | boolean | Optional / source-dependent | |
transfer_to_ward | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
fetal_movement | string | Optional / source-dependent | |
fetal_heart_rate | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
gravida | string | Optional / source-dependent | |
term | string | Optional / source-dependent | |
parity | string | Optional / source-dependent | |
abortions | string | Optional / source-dependent | |
living | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
uterine_contractions | boolean | Optional / source-dependent | |
membrane_status | boolean | Optional / source-dependent | |
time_of_rupture | string | Optional / source-dependent | |
colour_of_liquor | string | Optional / source-dependent | |
odour | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
medication_name | string | Yes | |
medication_type | string | null | Optional / source-dependent | |
dosage | string | null | Optional / source-dependent | |
route | string | null | Optional / source-dependent | |
frequency_morning | string | null | Yes | |
frequency_afternoon | string | null | Yes | |
frequency_evening | string | null | Yes | |
frequency_night | string | null | Yes | |
duration | string | null | Optional / source-dependent | |
duration_source | string | null | Optional / source-dependent | |
continue_until_stopped | boolean | null | Optional / source-dependent | |
dosage_time | string | null | Optional / source-dependent | |
instructions | string | null | Optional / source-dependent | |
med_status | string | null | Optional / source-dependent | |
is_stat | boolean | null | Optional / source-dependent | |
is_once_only | boolean | null | Optional / source-dependent | |
is_sos | boolean | null | Optional / source-dependent | |
is_infusion | boolean | null | Optional / source-dependent | |
is_status | string | null | Optional / source-dependent | |
time_of_last_dose | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
ambulance | boolean | Optional / source-dependent | |
walk_in | boolean | Optional / source-dependent | |
other | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
arrivalAndTriage | GynecArrivalAndTriage | Optional / source-dependent | |
vitals | GynecVitals | Optional / source-dependent | |
gravidaAndParity | GynecGravidaAndParity | Optional / source-dependent | |
orientation | GynecOrientation | Optional / source-dependent | |
chiefComplaintsDescriptionOfSymptoms | string | Optional / source-dependent | |
gynecSpecificAssessment | GynecSpecificAssessment | Optional / source-dependent | |
obstetricSpecificAssessment | GynecObstetricSpecificAssessment | Optional / source-dependent | |
vaginalBleeding | GynecVaginalBleeding | Optional / source-dependent | |
painAssessment | GynecPainAssessment | Optional / source-dependent | |
nutritionalAssessment | GynecNutritionalAssessment | Optional / source-dependent | |
psychosocialIssues | string | Optional / source-dependent | |
pastMedicalHistory | GynecPastMedicalHistory | Optional / source-dependent | |
pastSurgicalHistory | string | Optional / source-dependent | |
medicationHistory | array<GynecMedicationHistory> | Optional / source-dependent | |
allergiesOrReactions | string | Optional / source-dependent | |
blood_group | string | Optional / source-dependent | |
exposureToCommunicableDisease | boolean | Optional / source-dependent | |
dischargePlanning | GynecDischargePlanning | Optional / source-dependent | |
caregiverReadinessToLearn | GynecCaregiverReadinessToLearn | Optional / source-dependent | |
barriersToLearning | GynecBarriersToLearning | Optional / source-dependent | |
nursesNotes | string | Optional / source-dependent | |
valuableHandedOver | boolean | Optional / source-dependent | |
pead_det | PeadiatricDet | null | Optional / source-dependent | |
vitals_abnormality | VitalAbnormality | Optional / source-dependent | |
monitoring_tasks | array<MonitoringTask> | Optional / source-dependent | |
iv_infusions | array<IVInfusion> | Optional / source-dependent | |
drug_chart_patch | DrugChartPatch | Optional / source-dependent | |
blood_borne | BloodBorne | Optional / source-dependent | |
fasthug | FastHugsBid | Optional / source-dependent | |
fasthug_events | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
special_diet | boolean | Optional / source-dependent | |
vulnerable_status | boolean | Optional / source-dependent | |
nutritional_issues | GynecNutritionalIssues | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
present | boolean | Optional / source-dependent | |
action_taken | string | Optional / source-dependent |
Exact JSON field definition
{
"properties": {
"present": {
"title": "Present",
"type": "boolean"
},
"action_taken": {
"title": "Action Taken",
"type": "string"
}
},
"title": "GynecNutritionalIssues",
"type": "object"
}GynecObstetricSpecificAssessment
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
last_menstrual_period | string | Optional / source-dependent | |
expected_date_of_delivery | string | Optional / source-dependent | |
multiple_pregnancy | string | Optional / source-dependent | |
fetal_status | GynecFetalStatus | Optional / source-dependent | |
labour_status | GynecLabourStatus | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
alert | boolean | Optional / source-dependent | |
lethargic | boolean | Optional / source-dependent | |
drowsy | boolean | Optional / source-dependent | |
confused | boolean | Optional / source-dependent | |
unresponsive | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
pain_score | integer | Optional / source-dependent | |
pain_location | string | Optional / source-dependent | |
intensity_of_pain | string | Optional / source-dependent | |
pain_character | GynecPainCharacter | Optional / source-dependent | |
what_makes_pain_worse | string | Optional / source-dependent | |
what_makes_pain_better | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
stabbing | boolean | Optional / source-dependent | |
dull | boolean | Optional / source-dependent | |
sharp | boolean | Optional / source-dependent | |
shooting | boolean | Optional / source-dependent | |
burning | boolean | Optional / source-dependent | |
cramping | boolean | Optional / source-dependent | |
tender | boolean | Optional / source-dependent | |
aching | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
none | boolean | Optional / source-dependent | |
premature | boolean | Optional / source-dependent | |
diabetes | boolean | Optional / source-dependent | |
asthma | boolean | Optional / source-dependent | |
cancer | boolean | Optional / source-dependent | |
ihd | boolean | Optional / source-dependent | |
cva | boolean | Optional / source-dependent | |
renal | boolean | Optional / source-dependent | |
htn | boolean | Optional / source-dependent | |
transplant | boolean | Optional / source-dependent | |
cardiac | boolean | Optional / source-dependent | |
serious_injury | boolean | Optional / source-dependent | |
others | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
breast_abscess | boolean | Optional / source-dependent | |
vaginal_discharge | GynecVaginalDischarge | Optional / source-dependent | |
urinary_incontinence | boolean | Optional / source-dependent | |
pelvic_organ_prolapse | boolean | Optional / source-dependent | |
sexual_dysfunction | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
red_critical_unstable | boolean | Optional / source-dependent | |
yellow_potentially_unstable | boolean | Optional / source-dependent | |
green_stable | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
present | boolean | Optional / source-dependent | |
date_time | string | Optional / source-dependent | |
duration | string | Optional / source-dependent | |
associated_events | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
present | boolean | Optional / source-dependent | |
onset | string | Optional / source-dependent | |
duration | string | Optional / source-dependent | |
odor | string | Optional / source-dependent | |
frequency | string | Optional / source-dependent | |
color | string | Optional / source-dependent | |
consistency | string | Optional / source-dependent | |
volume | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
height_cm | string | Optional / source-dependent | |
weight_kg | string | Optional / source-dependent | |
temperature | string | Optional / source-dependent | |
pulse | string | Optional / source-dependent | |
respiration | string | Optional / source-dependent | |
blood_pressure | string | Optional / source-dependent | |
oxygen_saturation | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
eye_movement | EyeMovement | null | Optional / source-dependent | |
position_ent | PositionEntry | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
en_access_type | string | Optional / source-dependent | Values: , NGT, NJT, PEG, Jejunostomy |
gi_tolerance | string | Optional / source-dependent | Values: , Good, Poor, Intolerant |
gastric_residual_volume_ml_4hr | string | Optional / source-dependent | |
insulin_protocol_active | boolean | null | Optional / source-dependent | |
supplement_name_and_dose | string | Optional / source-dependent | |
goals_of_care_discharge_nutrition_target | string | Optional / source-dependent | |
food_from_home | string | Optional / source-dependent | Values: , Permitted, Not permitted |
patient_family_counselled | boolean | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
is_iv | boolean | Optional / source-dependent | |
volume_ml | integer | null | Optional / source-dependent | |
speed_ml_hr | integer | null | Optional / source-dependent | |
start_or_stop | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
allergy | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
diagnosis | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
date_of_surgery | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
consultant | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
procedure | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
height_cm | number | null | Optional / source-dependent | |
weight_kg | number | null | Optional / source-dependent | |
bmi | number | null | Optional / source-dependent | |
ideal_body_weight_kg | number | null | Optional / source-dependent | |
blood_group | string | Optional / source-dependent | |
fasthug | FastHugsBid | Optional / source-dependent | |
intakeoutput_summary | object | Optional / source-dependent | |
intakeoutput_summary.today_summary | object | Source-dependent | |
intakeoutput_summary.today_summary.date | string | Source-dependent | |
intakeoutput_summary.today_summary.intake_total_ml | number | Source-dependent | |
intakeoutput_summary.today_summary.output_total_ml | number | Source-dependent | |
intakeoutput_summary.today_summary.daily_balance_ml | number | Source-dependent | |
intakeoutput_summary.today_summary.cumulative_balance_ml | number | Source-dependent | |
intakeoutput_summary.previous_day_summary | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
bowel_movement | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
pending_reports | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
cross_references | array<JSON value> | Optional / source-dependent | |
plan_for_today | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
future_plan | JSON value | Optional / source-dependent | Service-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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
structured_data | object | Yes | |
structured_data.IPD_ICU_FORM | array<object> | Source-dependent | |
structured_data.IPD_ICU_FORM[].front | IcuFront | Source-dependent | |
structured_data.IPD_ICU_FORM[].tpr | array<JSON value> | Source-dependent | |
structured_data.IPD_ICU_FORM[].intake_outtake | array<JSON value> | Source-dependent | |
structured_data.IPD_ICU_FORM[].eye_movement | array<EyeMovement> | Source-dependent | |
structured_data.IPD_ICU_FORM[].position_ent | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
status | boolean | Yes | |
message | string | Yes | |
data | JSON value | Yes | Service-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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
assessment_details | string | Yes |
Exact JSON field definition
{
"properties": {
"assessment_details": {
"title": "Assessment Details",
"type": "string"
}
},
"required": [
"assessment_details"
],
"title": "InitialAssessment",
"type": "object"
}InsertionChecklistForm
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
diagnosis | string | Optional / source-dependent | |
device_details | DeviceDetails | Optional / source-dependent | |
pre_insertion_checks | PreInsertionChecks | Optional / source-dependent | |
insertion_procedure | InsertionProcedure | Optional / source-dependent | |
post_insertion | PostInsertion | Optional / source-dependent | |
signatures | Signatures | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
sterile_barrier_precautions_used | boolean | Optional / source-dependent | |
skin_antisepsis_applied | boolean | Optional / source-dependent | |
aseptic_technique_maintained | boolean | Optional / source-dependent | |
correct_catheter_size_type_used | boolean | Optional / source-dependent | |
successful_insertion | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
parenteral | string | null | Optional / source-dependent | |
parenteral_quantity_ml | integer | null | Optional / source-dependent | |
oral_rt | string | null | Optional / source-dependent | |
oral_rt_quantity_ml | integer | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
intake | array<IntakeData> | Yes | |
output | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
route | array<IntubRoute> | Optional / source-dependent | |
endotracheal_tbsize | string | Optional / source-dependent | |
tube_depth | string | Optional / source-dependent | |
laryngoscope_used | string | Optional / source-dependent | |
no_attempts | string | Optional / source-dependent | |
intubated_by | string | Optional / source-dependent | |
assisted_by | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
resp_fail_hypo | boolean | Optional / source-dependent | |
resp_fail_hyper | boolean | Optional / source-dependent | |
air_protect | boolean | Optional / source-dependent | |
dec_cons | boolean | Optional / source-dependent | |
card_arrest | boolean | Optional / source-dependent | |
seiz_stat_epilepticus | boolean | Optional / source-dependent | |
shock | boolean | Optional / source-dependent | |
severe_pneum | boolean | Optional / source-dependent | |
copd | boolean | Optional / source-dependent | |
post_opsupport | boolean | Optional / source-dependent | |
head_inj_icp | boolean | Optional / source-dependent | |
meta_acid | boolean | Optional / source-dependent | |
others | string | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
oral | boolean | Optional / source-dependent | |
nasal | boolean | Optional / source-dependent |
Exact JSON field definition
{
"properties": {
"oral": {
"title": "Oral",
"type": "boolean"
},
"nasal": {
"title": "Nasal",
"type": "boolean"
}
},
"title": "IntubRoute",
"type": "object"
}IntubSetting
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
mode | string | Optional / source-dependent | |
fio2 | string | Optional / source-dependent | |
tidal_vol | string | Optional / source-dependent | |
resp_rate | string | Optional / source-dependent | |
peep | string | Optional / source-dependent | |
press_supp | string | Optional / source-dependent | |
peak_press | string | Optional / source-dependent | |
inspir_time | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
investigation_type | string | Yes | |
details | string | null | Optional / source-dependent | |
status | string | null | Optional / source-dependent | |
source | TodoSource | Optional / source-dependent | Document provenance; preserve without editing. |
todo_id | string | Optional / source-dependent | Opaque task identifier; preserve it during edits. |
todo_version | integer | Optional / source-dependent | Version 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
medication_name | string | Yes | |
medication_type | string | null | Optional / source-dependent | |
dosage | string | null | Optional / source-dependent | |
route | string | null | Optional / source-dependent | |
frequency_morning | string | null | Yes | |
frequency_afternoon | string | null | Yes | |
frequency_evening | string | null | Yes | |
frequency_night | string | null | Yes | |
duration | string | null | Optional / source-dependent | |
duration_source | string | null | Optional / source-dependent | |
continue_until_stopped | boolean | null | Optional / source-dependent | |
dosage_time | string | null | Optional / source-dependent | |
instructions | string | null | Optional / source-dependent | |
med_status | string | null | Optional / source-dependent | |
is_stat | boolean | null | Optional / source-dependent | |
is_once_only | boolean | null | Optional / source-dependent | |
is_sos | boolean | null | Optional / source-dependent | |
is_infusion | boolean | null | Optional / source-dependent | |
is_status | string | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
previous_medications | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
medication_name | string | Yes | |
dosage | string | null | Optional / source-dependent | |
route | string | null | Optional / source-dependent | |
frequency | string | null | Optional / source-dependent | |
continue_medication | boolean | Optional / source-dependent | |
notes | string | null | Optional / source-dependent | |
reconciled_by | string | null | Optional / source-dependent | |
reconciled_at | string | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
prescription_data | PrescriptionData | Optional / source-dependent | |
total_records | TotalRecords | Optional / source-dependent |
Exact JSON field definition
{
"properties": {
"prescription_data": {
"$ref": "#/$defs/PrescriptionData"
},
"total_records": {
"$ref": "#/$defs/TotalRecords"
}
},
"title": "MergedSchema",
"type": "object"
}MergedTodo
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
is_merged | boolean | Optional / source-dependent | |
interaction_ids | array<string | integer | null> | Optional / source-dependent | |
ordered_by | array<string | integer | null> | Optional / source-dependent | |
approved_by | array<string | integer | null> | Optional / source-dependent | |
first_created_at | string | null | Optional / source-dependent | |
last_created_at | string | null | Optional / source-dependent | |
todos | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
monitoring_order | string | Yes | |
instructions | string | Optional / source-dependent | |
interval_minutes | integer | null | Optional / source-dependent | |
start_or_stop | string | Optional / source-dependent | |
status | string | Optional / source-dependent | |
source | TodoSource | Optional / source-dependent | Document provenance; preserve without editing. |
todo_id | string | Optional / source-dependent | Opaque task identifier; preserve it during edits. |
todo_version | integer | Optional / source-dependent | Version 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
is_monitor | boolean | Optional / source-dependent | |
monitoring_message | string | Optional / source-dependent | |
interval_minutes | integer | null | Optional / source-dependent | |
start_or_stop | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
isAssessed | boolean | Yes | |
state | string | Yes |
Exact JSON field definition
{
"properties": {
"isAssessed": {
"title": "Isassessed",
"type": "boolean"
},
"state": {
"title": "State",
"type": "string"
}
},
"required": [
"isAssessed",
"state"
],
"title": "MucousMembranes",
"type": "object"
}NewPRNOrderCommand
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
drug_name | string | Optional / source-dependent | |
dose | string | Optional / source-dependent | |
route | string | Optional / source-dependent | |
max_frequency | string | Optional / source-dependent | |
indication | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
drug_name | string | Optional / source-dependent | |
dose | string | Optional / source-dependent | |
route | string | Optional / source-dependent | |
frequency | string | Optional / source-dependent | |
administration_times | array<string> | Optional / source-dependent | |
notes | string | Optional / source-dependent | |
is_stat | boolean | null | Optional / source-dependent | |
is_once_only | boolean | null | Optional / source-dependent | |
is_sos | boolean | null | Optional / source-dependent | |
is_infusion | boolean | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
b_grp | string | null | Optional / source-dependent | |
pck_no | string | Optional / source-dependent | |
bg_prods | string | null | Optional / source-dependent | |
nou | string | null | Optional / source-dependent | |
date_cm | string | null | Optional / source-dependent | |
exp_date | string | null | Optional / source-dependent | |
consent_trans | boolean | null | Optional / source-dependent | |
check_doc | array<doc_check> | Optional / source-dependent | |
time_out | array<PreTransfusionCheck> | Optional / source-dependent | |
check_nur | array<nur_check> | Optional / source-dependent | |
checklist | BTChecklist | Optional / source-dependent | |
fluid_monitoring | array<BTFluidMonitoring> | Optional / source-dependent | |
post_transfusion | BTPostTransfusion | Optional / source-dependent | |
reaction_occurred | boolean | Optional / source-dependent | |
reaction_report | BTReactionReport | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
arrivalAndTriage | GynecArrivalAndTriage | Optional / source-dependent | |
basicInformation | BasicInformation | Yes | |
functionalAssessment | FunctionalAssessment | Yes | |
nutritionalAssessment | NutritionalAssessment | Yes | |
painAssessment | PainAssessment | Yes | |
pastMedicalHistory | GynecPastMedicalHistory | Optional / source-dependent | |
medicationHistory | array<GynecMedicationHistory> | Optional / source-dependent | |
pastSurgicalHistory | string | Optional / source-dependent | |
psychosocialIssues | string | Optional / source-dependent | |
nursesNotes | string | Optional / source-dependent | |
valuableHandedOver | boolean | Optional / source-dependent | |
pead_det | PeadiatricDet | null | Optional / source-dependent | |
vitals_abnormality | VitalAbnormality | Optional / source-dependent | |
monitoring_tasks | array<MonitoringTask> | Optional / source-dependent | |
iv_infusions | array<IVInfusion> | Optional / source-dependent | |
drug_chart_patch | DrugChartPatch | Optional / source-dependent | |
blood_borne | BloodBorne | Optional / source-dependent | |
fasthug | FastHugsBid | Optional / source-dependent | |
fasthug_events | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
blood_pressure | string | Yes | |
pulse | string | Yes | |
respiration | string | Yes | |
temperature | string | Yes | |
spo2 | string | Yes | |
blood_sugar | string | Optional / source-dependent | |
abnormality_detected | boolean | Optional / source-dependent | |
abnormal_vitals_message | string | Optional / source-dependent | |
overall_severity | VitalSeverity | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
blood_sugar | string | null | Optional / source-dependent | |
medication | string | null | Optional / source-dependent | |
creatinine_level | string | null | Optional / source-dependent | |
consent_for_insulin | boolean | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
care_plan | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
created_at | string | Optional / source-dependent | |
updated_at | string | Optional / source-dependent | |
interaction_type | string | Optional / source-dependent | |
answer | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
nurse_id | string | integer | null | Optional / source-dependent | |
caregiver_id | string | Optional / source-dependent | |
handovered_nurse | array<JSON value> | Optional / source-dependent | |
read_error | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
notes | map<string, NurseNoteRecord> | Optional / source-dependent | |
pain_assessment | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
care_given | JSON value | Optional / source-dependent | Service-defined JSON value; preserve its returned type and fields. |
braden_scale | BradenScale | null | Optional / source-dependent | |
section_error | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
situation | string | Optional / source-dependent | |
background | string | Optional / source-dependent | |
assessment | string | Yes | |
investigations | string | Optional / source-dependent | |
interventions | string | Yes | |
medical_administration | string | Yes | |
patient_response | string | Yes | |
clinician_communication | string | Optional / source-dependent | |
care_instructions | string | Optional / source-dependent | |
recommendation | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
todo_data | array<TaskRecord> | Yes | |
merged_todo | MergedTodo | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
nursing_care_order | string | Yes | |
instructions | string | Optional / source-dependent | |
status | string | Optional / source-dependent | |
source | TodoSource | Optional / source-dependent | Document provenance; preserve without editing. |
todo_id | string | Optional / source-dependent | Opaque task identifier; preserve it during edits. |
todo_version | integer | Optional / source-dependent | Version 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
diagnosis | string | Yes | |
goal | string | Yes | |
interventions | array<string> | Yes | |
evaluation | string | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
date | string | Optional / source-dependent | |
weight_kg | string | Optional / source-dependent | |
prescribed_kcal_and_protein | string | Optional / source-dependent | |
actual_intake | string | Optional / source-dependent | |
percent_met | string | Optional / source-dependent | |
reason_for_gap | string | Optional / source-dependent | |
progress_notes_tolerance | string | Optional / source-dependent | |
goal_next_visit | string | Optional / source-dependent | |
sign | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
discharge_weight_kg | string | Optional / source-dependent | |
sga_pem_grade_at_discharge | string | Optional / source-dependent | |
nutritional_goal_achieved | string | Optional / source-dependent | Values: , Fully, Partially, Not achieved |
follow_up_opd_dietitian_referral_date | string | Optional / source-dependent | |
discharge_diet_advice_written_plan | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
sga_pem_grading | SGAPEMGrading | null | Optional / source-dependent | |
paediatric_pem_grading | PaediatricPEMGrading | null | Optional / source-dependent | |
diet_pattern_and_allergies | DietPatternAndAllergies | null | Optional / source-dependent | |
nutritional_intervention | NutritionalIntervention | null | Optional / source-dependent | |
nutritional_intervention_entries | NutritionalIntervention | null | Optional / source-dependent | |
daily_progress_monitoring | NutritionDailyProgressEntry | null | Optional / source-dependent | |
discharge_summary | NutritionDischargeSummary | null | Optional / source-dependent | |
special_notes | string | Optional / source-dependent | |
monitoring_tasks | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
structured_data | object | Yes | |
structured_data.IPD_NUTRITION_FORM | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
diet | Diet | Yes | |
recentWeightChanges | boolean | Yes | |
supplements | boolean | Yes | |
conditionsAffectingEating | boolean | Yes | |
monitoringRequiredAtMealTimes | boolean | Yes | |
fluidsMonitoring | FluidsMonitoring | Yes | |
mucousMembranes | MucousMembranes | Yes | |
skinTurgor | SkinTurgor | Yes |
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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
intervention_date | string | Optional / source-dependent | |
diet_advised | string | Optional / source-dependent | |
energy_prescribed_kcal_day | string | Optional / source-dependent | |
protein_prescribed_g_day | string | Optional / source-dependent | |
calorie_gap_kcal | string | Optional / source-dependent | |
diet_order | string | Optional / source-dependent | |
feeding_route | string | Optional / source-dependent | Values: , NPO, Oral, Enteral nutrition (EN), Parenteral nutrition (PN), EN + PN combined |
current_feeding_pattern_on_admission | string | Optional / source-dependent | |
fluid_restriction | boolean | null | Optional / source-dependent | |
fluid_restriction_volume_ml_day | string | Optional / source-dependent | |
supplement_name_and_dose | string | Optional / source-dependent | |
goals_of_care_discharge_nutrition_target | string | Optional / source-dependent | |
food_from_home | string | Optional / source-dependent | Values: , Permitted, Not permitted |
patient_family_counselled | boolean | null | Optional / source-dependent | |
icu_enteral_nutrition_detail | ICUEnteralNutritionDetail | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
medication_name | string | Yes | |
dosage | string | Yes | |
route | string | Yes | |
status | string | Yes | |
start_date | string | Optional / source-dependent | |
prescription_type | string | Optional / source-dependent | |
additional_information | string | null | Optional / source-dependent | |
is_stat | boolean | null | Optional / source-dependent | |
is_once_only | boolean | null | Optional / source-dependent | |
is_sos | boolean | null | Optional / source-dependent | |
is_infusion | boolean | null | Optional / source-dependent | |
frequency_morning | string | Optional / source-dependent | |
frequency_afternoon | string | Optional / source-dependent | |
frequency_evening | string | Optional / source-dependent | |
frequency_night | string | Optional / source-dependent | |
created_at | string | Yes | |
prescribed_by | string | Yes | |
administered | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
urine_ml | integer | null | Optional / source-dependent | |
drainage_ml | integer | null | Optional / source-dependent | |
right_drain_ml | integer | null | Optional / source-dependent | |
left_drain_ml | integer | null | Optional / source-dependent | |
vomitus_bowels_ml | integer | null | Optional / source-dependent | |
ryles_aspiration_ml | integer | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
device | string | Optional / source-dependent | |
flow_rate | string | Optional / source-dependent | |
identifiers | string | Optional / source-dependent | |
target_saturation | string | Optional / source-dependent | |
additional_information | string | Optional / source-dependent | |
status | string | Optional / source-dependent | |
start_date | string | null | Optional / source-dependent | |
created_at | string | null | Optional / source-dependent | |
prescribed_by | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
medication_name | string | Yes | |
dosage | string | Yes | |
route | string | Yes | |
status | string | Yes | |
start_date | string | Optional / source-dependent | |
prescription_type | string | Optional / source-dependent | |
additional_information | string | null | Optional / source-dependent | |
is_stat | boolean | null | Optional / source-dependent | |
is_once_only | boolean | null | Optional / source-dependent | |
is_sos | boolean | null | Optional / source-dependent | |
is_infusion | boolean | null | Optional / source-dependent | |
frequency_morning | string | Optional / source-dependent | |
frequency_afternoon | string | Optional / source-dependent | |
frequency_evening | string | Optional / source-dependent | |
frequency_night | string | Optional / source-dependent | |
created_at | string | Yes | |
prescribed_by | string | Yes | |
max_frequency | string | null | Optional / source-dependent | |
indication | string | null | Optional / source-dependent | |
administered | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
ipa_percent | string | Optional / source-dependent | |
pem_grade | string | Optional / source-dependent | Values: , > 90% - Normal, 75-89% - Mild (grade I), 60-74% - Moderate (grade II), < 60% - Severe (grade III) |
breastfeeding_status | string | Optional / source-dependent | Values: , Exclusive, Partial, Weaned, Not breastfed |
formula_name | string | Optional / source-dependent | |
dietary_recall_24hr | string | Optional / source-dependent | |
developmental_milestone | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
numericalPainScore | integer | Yes | |
wongBakerPainScore | integer | Yes | |
interventions | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
assessmentDateTime | string | Yes | |
painScore | integer | Yes | |
location | string | Yes | |
interventionDateTime | string | Yes | |
intervention | string | Yes | |
postInterventionDateTime | string | Yes | |
postInterventionScore | integer | Yes |
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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
guard_name | string | null | Optional / source-dependent | |
age | string | null | Optional / source-dependent | |
feed_meth | string | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
administered_by_nurse_id | string | null | Optional / source-dependent | |
administered_time | string | Yes | |
status | string | Yes |
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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
position | string | Optional / source-dependent | |
mth_bk_bs_care | boolean | Optional / source-dependent | |
suction | boolean | Optional / source-dependent | |
spirometry | boolean | Optional / source-dependent | |
abdominal_girth | string | Optional / source-dependent | |
calf_muscle_grith_tend | string | Optional / source-dependent | |
pressure | Pressure | null | Optional / source-dependent | |
remarks | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
line_flushed_and_patent | boolean | Optional / source-dependent | |
dressing_applied_sterile | boolean | Optional / source-dependent | |
line_secured | boolean | Optional / source-dependent | |
label_applied_date_time | boolean | Optional / source-dependent | |
patient_tolerated_procedure | boolean | Optional / source-dependent | |
pain_score | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
bleeding | boolean | Optional / source-dependent | |
pain | boolean | Optional / source-dependent | |
swelling | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_identity_confirmed | boolean | Optional / source-dependent | |
informed_consent_obtained | boolean | Optional / source-dependent | |
allergy_checked | boolean | Optional / source-dependent | |
indication_for_vad_confirmed | boolean | Optional / source-dependent | |
hand_hygiene_performed | boolean | Optional / source-dependent | |
prepared_sterile | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
time | string | null | Optional / source-dependent | |
crt_patient | boolean | null | Optional / source-dependent | |
crt_bg | boolean | null | Optional / source-dependent | |
crt_comp | boolean | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
bp | string | Optional / source-dependent | |
pr | string | Optional / source-dependent | |
resp_rate | string | Optional / source-dependent | |
spo2 | string | Optional / source-dependent | |
gcs_score | string | Optional / source-dependent | |
aw_assess | string | Optional / source-dependent | |
consent_obt | boolean | Optional / source-dependent | |
emr_proc | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
medication_name | string | Yes | |
medication_type | string | null | Optional / source-dependent | |
dosage | string | null | Optional / source-dependent | |
route | string | null | Optional / source-dependent | |
administration_time | string | Yes | |
status | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
allergies | AllergySection | Optional / source-dependent | |
once_only_drugs | array<OnceOnlyDrug> | Optional / source-dependent | |
oral_anticoagulation | array<DrugChartItem> | Optional / source-dependent | |
thromboprophylaxis | array<DrugChartItem> | Optional / source-dependent | |
antiplatelet | array<DrugChartItem> | Optional / source-dependent | |
drug_chart | array<DrugChartItem> | Optional / source-dependent | |
prn_drugs | array<PRNDrug> | Optional / source-dependent | |
infusions | array<DrugChartItem> | Optional / source-dependent | |
iv_fluids | array<DrugChartItem> | Optional / source-dependent | |
oxygen | array<OxygenItem> | Optional / source-dependent | |
administrations | array<GlobalAdministration> | Optional / source-dependent | |
medication_reconciliation | MedicationReconciliation | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
aug | string | Optional / source-dependent | |
map | string | Optional / source-dependent |
Exact JSON field definition
{
"properties": {
"aug": {
"title": "Aug",
"type": "string"
},
"map": {
"title": "Map",
"type": "string"
}
},
"title": "Pressure",
"type": "object"
}PreviousMedicationEntry
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
drug_name | string | Optional / source-dependent | |
dose | string | null | Optional / source-dependent | |
route | string | null | Optional / source-dependent | |
frequency | string | null | Optional / source-dependent | |
indication | string | null | Optional / source-dependent | |
notes | string | null | Optional / source-dependent | |
disposition | string | null | Optional / source-dependent | |
is_antiplatelet | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
procedure_order | string | Yes | |
status | string | Optional / source-dependent | |
source | TodoSource | Optional / source-dependent | Document provenance; preserve without editing. |
todo_id | string | Optional / source-dependent | Opaque task identifier; preserve it during edits. |
todo_version | integer | Optional / source-dependent | Version 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
o2 | boolean | Optional / source-dependent | |
niv | boolean | Optional / source-dependent | |
others | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
improvement | boolean | Optional / source-dependent | |
wean_success | boolean | Optional / source-dependent | |
other | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
dt_tm | string | Optional / source-dependent | |
extub_by | string | Optional / source-dependent | |
reason_extub | array<ReasExtub> | Optional / source-dependent | |
cond_extub | array<ConExtub> | Optional / source-dependent | |
post_extub | array<PtExtubSup> | Optional / source-dependent | |
remarks | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
doctor_order_verified | boolean | Optional / source-dependent | |
hand_hygiene_performed | boolean | Optional / source-dependent | |
ppe_used | boolean | Optional / source-dependent | |
tip_intact | boolean | Optional / source-dependent | |
catheter_venflon_removed_safely | boolean | Optional / source-dependent | |
hemostasis_achieved | boolean | Optional / source-dependent | |
sterile_dressing_applied | boolean | Optional / source-dependent | |
others | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Optional / source-dependent | |
inpatient_id | string | Optional / source-dependent | |
structured_data | object | Optional / source-dependent | |
structured_data.IPD_CLABSI_BUNDLE | array<object> | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].interaction_id | string | integer | null | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].doctor_id | string | integer | null | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].nurse_id | string | integer | null | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].note_time | string | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].timestamp | string | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].practitioner_id | string | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].caregiver_id | string | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].central_line_insertion | ClabsiCentralLineInsertion | null | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].indication_for_central_line | ClabsiIndicationForCentralLine | null | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].clabsi_bundle_compliance | ClabsiBundleCompliance | null | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].signatures | ClabsiSignatures | null | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].daily_maintenance | array<ClabsiDailyMaintenanceEntry> | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].dressing_change_checklist | ClabsiDressingChangeChecklist | null | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].central_line_removal | ClabsiCentralLineRemoval | null | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].culture | boolean | Source-dependent | |
structured_data.IPD_CLABSI_BUNDLE[].antibiotics | string | Source-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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
structured_data | object | Yes | |
structured_data.IPD_ASSESSMENT_DETAILS | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
structured_data | object | Yes | |
structured_data.IPD_GENERAL_OBSERVATIONS | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Optional / source-dependent | |
inpatient_id | string | Optional / source-dependent | |
structured_data | object | Optional / source-dependent | |
structured_data.IPD_INTAKE_OUTTAKE | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
structured_data | object | Yes | |
structured_data.IPD_PRESCRIPTION_ADMINISTRATIONS | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Optional / source-dependent | |
inpatient_id | string | Optional / source-dependent | |
structured_data | object | Optional / source-dependent | |
structured_data.IPD_VITALS | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Optional / source-dependent | |
inpatient_id | string | Optional / source-dependent | |
structured_data | object | Optional / source-dependent | |
structured_data.IPD_VASCULAR_BUNDLE | array<object> | Source-dependent | |
structured_data.IPD_VASCULAR_BUNDLE[].interaction_id | string | integer | null | Source-dependent | |
structured_data.IPD_VASCULAR_BUNDLE[].doctor_id | string | integer | null | Source-dependent | |
structured_data.IPD_VASCULAR_BUNDLE[].nurse_id | string | integer | null | Source-dependent | |
structured_data.IPD_VASCULAR_BUNDLE[].note_time | string | Source-dependent | |
structured_data.IPD_VASCULAR_BUNDLE[].timestamp | string | Source-dependent | |
structured_data.IPD_VASCULAR_BUNDLE[].practitioner_id | string | Source-dependent | |
structured_data.IPD_VASCULAR_BUNDLE[].caregiver_id | string | Source-dependent | |
structured_data.IPD_VASCULAR_BUNDLE[].vascular_bundle | VascularAccessDeviceBundle | Source-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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Optional / source-dependent | |
inpatient_id | string | Optional / source-dependent | |
doctor_initial_assessment | object | Optional / source-dependent | |
doctor_initial_assessment.interaction_id | string | Source-dependent | |
doctor_initial_assessment.time_stamp | string | Source-dependent | |
doctor_initial_assessment.doctor_id | number | Source-dependent | |
doctor_initial_assessment.nurse_id | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
doctor_initial_assessment.interaction_detail_type | string | Source-dependent | |
doctor_initial_assessment.attachment_url | string | Source-dependent | |
doctor_initial_assessment.response | object | Source-dependent | |
doctor_initial_assessment.response.response | object | Source-dependent | |
doctor_initial_assessment.response.response.chief_complaints | string | Source-dependent | |
doctor_initial_assessment.response.response.history_of_present_illness | string | Source-dependent | |
doctor_initial_assessment.response.response.provisional_diagnosis | string | Source-dependent | |
doctor_initial_assessment.response.response.plan_of_care | string | Source-dependent | |
doctor_initial_assessment.response.response.medication_templates | array<JSON value> | Source-dependent | |
doctor_initial_assessment.response.assessment | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
doctor_initial_assessment.response.additional_response | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
doctor_initial_assessment.practitioner_id | string | Source-dependent | |
nurse_initial_assessment | object | Optional / source-dependent | |
nurse_initial_assessment.interaction_id | string | Source-dependent | |
nurse_initial_assessment.time_stamp | string | Source-dependent | |
nurse_initial_assessment.doctor_id | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
nurse_initial_assessment.nurse_id | number | Source-dependent | |
nurse_initial_assessment.interaction_detail_type | string | Source-dependent | |
nurse_initial_assessment.response | object | Source-dependent | |
nurse_initial_assessment.response.basicInformation | object | Source-dependent | |
nurse_initial_assessment.response.basicInformation.how_admitted | string | Source-dependent | |
nurse_initial_assessment.response.basicInformation.mother_tongue | string | Source-dependent | |
nurse_initial_assessment.response.basicInformation.height | string | Source-dependent | |
nurse_initial_assessment.response.basicInformation.weight | string | Source-dependent | |
nurse_initial_assessment.response.basicInformation.vitals | array<object> | Source-dependent | |
nurse_initial_assessment.response.basicInformation.vitals[].blood_pressure | string | Source-dependent | |
nurse_initial_assessment.response.basicInformation.vitals[].pulse | string | Source-dependent | |
nurse_initial_assessment.response.basicInformation.vitals[].respiration | string | Source-dependent | |
nurse_initial_assessment.response.basicInformation.vitals[].temperature | string | Source-dependent | |
nurse_initial_assessment.response.basicInformation.vitals[].spo2 | string | Source-dependent | |
nurse_initial_assessment.response.painAssessment | object | Source-dependent | |
nurse_initial_assessment.response.painAssessment.numericalPainScore | number | Source-dependent | |
nurse_initial_assessment.response.painAssessment.wongBakerPainScore | number | Source-dependent | |
nurse_initial_assessment.response.painAssessment.interventions | array<JSON value> | Source-dependent | |
nurse_initial_assessment.caregiver_id | string | Source-dependent | |
gynec_initial_assessment | object | Optional / source-dependent | |
surgery_notes | map<string, JSON value> | Optional / source-dependent | |
counselling | object | Optional / source-dependent | |
counselling.interaction_id | string | Source-dependent | |
counselling.doctor_id | number | Source-dependent | |
counselling.interaction_detail_type | string | Source-dependent | |
counselling.response | object | Source-dependent | |
counselling.response.interaction_id | string | Source-dependent | |
counselling.response.patient_id | string | Source-dependent | |
counselling.response.payload | string | Source-dependent | |
counselling.practitioner_id | string | Source-dependent | |
ipd_data | GroupedResponse | Optional / source-dependent | |
drug_chart | Response_get_drug_chart | Optional / source-dependent | |
progress_notes | Response_doctor_notes | Optional / source-dependent | |
nurse_notes | Response_nurse_notes | Optional / source-dependent | |
nurse_care_plan | object | Optional / source-dependent | |
nurse_care_plan.created_at | string | Source-dependent | |
nurse_care_plan.response | NurseCarePlanSchema | string | Source-dependent | |
nurse_care_plan.is_approved | boolean | Source-dependent | |
blood_glucose_monitoring_chart | GlucoseResponse | Optional / source-dependent | |
anaesthesia_forms | object | Optional / source-dependent | |
anaesthesia_forms.pre_anaesthetic_evaluation_form | object | Source-dependent | |
anaesthesia_forms.anaesthesia_preoperative_reevaluation_form | object | Source-dependent | |
anaesthesia_forms.post_anaesthesia_care_form | object | Source-dependent | |
anaesthesia_forms.anaesthesia_record_form | object | Source-dependent | |
procedure_notes | object | Optional / source-dependent | Procedure 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Optional / source-dependent | |
inpatient_id | string | Optional / source-dependent | |
structured_data | object | Optional / source-dependent | |
structured_data.IPD_CAUTI_BUNDLE | array<object> | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].interaction_id | string | integer | null | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].doctor_id | string | integer | null | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].nurse_id | string | integer | null | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].note_time | string | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].timestamp | string | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].practitioner_id | string | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].caregiver_id | string | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].insertion_checklist_form | CautiInsertionChecklistForm | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].daily_maintenance_checklist_form | CautiDailyMaintenanceChecklistForm | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].removal_checklist_form | CautiRemovalChecklistForm | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].summary_form | CautiSummaryForm | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].is_form_completed | boolean | Source-dependent | |
structured_data.IPD_CAUTI_BUNDLE[].form_completed_date_time | string | Source-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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
status | string | Optional / source-dependent | |
patient_id | string | Optional / source-dependent | |
inpatient_id | string | Optional / source-dependent | |
doctor_id | string | Optional / source-dependent | |
casesheet | boolean | Optional / source-dependent | |
question_text | string | Optional / source-dependent | |
notes | map<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Optional / source-dependent | |
inpatient_id | string | Optional / source-dependent | |
height_cm | number | Optional / source-dependent | |
weight_kg | number | Optional / source-dependent | |
special_diet | string | Optional / source-dependent | |
blood_group | string | Optional / source-dependent | |
merged_schema | object | Optional / source-dependent | |
merged_schema.prescription_data | object | Source-dependent | |
merged_schema.prescription_data.allergies | object | Source-dependent | |
merged_schema.prescription_data.allergies.has_known_allergies | boolean | Source-dependent | |
merged_schema.prescription_data.allergies.allergies | array<object> | Source-dependent | |
merged_schema.prescription_data.allergies.allergies[].substance | string | Source-dependent | |
merged_schema.prescription_data.allergies.allergies[].reaction | string | Source-dependent | |
merged_schema.prescription_data.allergies.allergies[].severity | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
merged_schema.prescription_data.allergies.allergies[].recorded_at | string | Source-dependent | |
merged_schema.prescription_data.allergies.allergies[].recorded_by | string | Source-dependent | |
merged_schema.prescription_data.allergies.allergies[].source | string | Source-dependent | |
merged_schema.prescription_data.once_only_drugs | array<JSON value> | Source-dependent | |
merged_schema.prescription_data.oral_anticoagulation | array<JSON value> | Source-dependent | |
merged_schema.prescription_data.thromboprophylaxis | array<JSON value> | Source-dependent | |
merged_schema.prescription_data.antiplatelet | array<JSON value> | Source-dependent | |
merged_schema.prescription_data.drug_chart | array<object> | Source-dependent | |
merged_schema.prescription_data.drug_chart[].medication_name | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].dosage | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].route | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].frequency | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].status | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].start_date | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].administration_times | array<JSON value> | Source-dependent | |
merged_schema.prescription_data.drug_chart[].prescription_type | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].additional_information | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].created_at | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].prescribed_by | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].is_stat | boolean | Source-dependent | |
merged_schema.prescription_data.drug_chart[].is_once_only | boolean | Source-dependent | |
merged_schema.prescription_data.drug_chart[].is_sos | boolean | Source-dependent | |
merged_schema.prescription_data.drug_chart[].administered | array<object> | Source-dependent | |
merged_schema.prescription_data.drug_chart[].administered[].administered_by_nurse_id | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].administered[].administered_time | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].administered[].status | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].actual_medication_name | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].brand_name | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].generic_name | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].auto_correct | boolean | Source-dependent | |
merged_schema.prescription_data.drug_chart[].med_from_llm | boolean | Source-dependent | |
merged_schema.prescription_data.drug_chart[].medication_type | string | Source-dependent | |
merged_schema.prescription_data.drug_chart[].drug_name | string | Source-dependent | |
merged_schema.prescription_data.prn_drugs | array<JSON value> | Source-dependent | |
merged_schema.prescription_data.infusions | array<JSON value> | Source-dependent | |
merged_schema.prescription_data.iv_fluids | array<JSON value> | Source-dependent | |
merged_schema.prescription_data.oxygen | array<JSON value> | Source-dependent | |
merged_schema.prescription_data.administrations | array<object> | Source-dependent | |
merged_schema.prescription_data.administrations[].drug_name | string | Source-dependent | |
merged_schema.prescription_data.administrations[].scheduled_time | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
merged_schema.prescription_data.administrations[].administered_time | string | Source-dependent | |
merged_schema.prescription_data.administrations[].administered_by | string | Source-dependent | |
merged_schema.prescription_data.administrations[].doctor_id | string | Source-dependent | |
merged_schema.prescription_data.administrations[].nurse_id | string | Source-dependent | |
merged_schema.prescription_data.administrations[].status | string | Source-dependent | |
merged_schema.prescription_data.administrations[].notes | string | Source-dependent | |
merged_schema.prescription_data.administrations[].prescribed_by | string | Source-dependent | |
merged_schema.prescription_data.administrations[].caregiver_id | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation | object | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.previous_medications | array<object> | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.previous_medications[].drug_name | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.previous_medications[].dose | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.previous_medications[].route | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.previous_medications[].frequency | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.previous_medications[].disposition | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.previous_medications[].is_antiplatelet | boolean | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.previous_medications[].interaction_id | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications | array<object> | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].medication_name | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].dosage | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].route | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].frequency | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].continue_medication | boolean | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].notes | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].actual_medication_name | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].brand_name | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].generic_name | string | Source-dependent | |
merged_schema.prescription_data.medication_reconciliation.past_long_term_medications[].medication_type | string | Source-dependent | |
merged_schema.total_records | object | Source-dependent | |
merged_schema.total_records.drug_chart | number | Source-dependent | |
merged_schema.total_records.once_only_drugs | number | Source-dependent | |
merged_schema.total_records.oral_anticoagulation | number | Source-dependent | |
merged_schema.total_records.thromboprophylaxis | number | Source-dependent | |
merged_schema.total_records.antiplatelet | number | Source-dependent | |
merged_schema.total_records.prn_drugs | number | Source-dependent | |
merged_schema.total_records.infusions | number | Source-dependent | |
merged_schema.total_records.iv_fluids | number | Source-dependent | |
merged_schema.total_records.oxygen | number | Source-dependent | |
merged_schema.total_records.administered | number | Source-dependent | |
execution_time_seconds | number | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
success | boolean | Optional / source-dependent | |
message | string | Optional / source-dependent | |
data | object | Optional / source-dependent | |
data.session_id | string | Source-dependent | |
data.patient_id | string | Source-dependent | |
data.inpatient_id | string | Source-dependent | |
data.nurse_id | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.doctor_id | number | Source-dependent | |
data.question | string | Source-dependent | |
data.questioned_at | number | Source-dependent | |
data.patient_type | string | Source-dependent | |
data.interaction_id | string | Source-dependent | |
data.organization_id | string | Source-dependent | |
data.answer | object | Source-dependent | |
data.answer.response | object | Source-dependent | |
data.answer.response.chief_complaints | string | Source-dependent | |
data.answer.response.history_of_present_illness | string | Source-dependent | |
data.answer.response.past_history_and_duration | string | Source-dependent | |
data.answer.response.family_history | string | Source-dependent | |
data.answer.response.personal_history | string | Source-dependent | |
data.answer.response.allergies | string | Source-dependent | |
data.answer.response.blood_group | string | Source-dependent | |
data.answer.response.previous_medication | string | Source-dependent | |
data.answer.response.present_medication | string | Source-dependent | |
data.answer.response.previous_investigations | string | Source-dependent | |
data.answer.response.examination_findings | string | Source-dependent | |
data.answer.response.provisional_diagnosis | string | Source-dependent | |
data.answer.response.plan_of_care | string | Source-dependent | |
data.answer.response.surgery_procedure_planned | string | Source-dependent | |
data.answer.response.pre_operative_instructions | string | Source-dependent | |
data.answer.response.recommendations | string | Source-dependent | |
data.answer.response.assessment | array<JSON value> | Source-dependent | |
data.answer.response.medication_templates | array<object | object | object> | Source-dependent | |
data.answer.response.phonetic_uri | string | Source-dependent | |
data.answer.assessment | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.answer.additional_response | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.answer.created_at | string | Source-dependent | |
data.answer.phonetic_uri | string | Source-dependent | |
data.summary | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.question_audio_link | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.answer_audio_link | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.funct_name | string | Source-dependent | |
data.answered_at | number | Source-dependent | |
data.phonetic_uri | string | Source-dependent | |
data.practitioner_id | string | Source-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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
status | string | Optional / source-dependent | |
patient_id | string | Optional / source-dependent | |
inpatient_id | string | Optional / source-dependent | |
nurse_id | string | Optional / source-dependent | |
casesheet | boolean | Optional / source-dependent | |
question_text | string | Optional / source-dependent | |
notes | array<NurseNoteSet> | object | Optional / source-dependent | |
handover_interactions | array<object> | Optional / source-dependent | |
handover_interactions[].interaction_id | string | Source-dependent | |
handover_interactions[].created_at | string | Source-dependent | |
handover_interactions[].updated_at | string | Source-dependent | |
handover_interactions[].handovered_nurse | array<JSON value> | Source-dependent | |
pain_graph | array<object> | Optional / source-dependent | |
pain_graph[].pain_score | string | Source-dependent | |
pain_graph[].time | string | Source-dependent | |
pain_graph[].date | string | Source-dependent | |
caregiver_id | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
success | boolean | Optional / source-dependent | |
message | string | Optional / source-dependent | |
data | object | Optional / source-dependent | |
data.session_id | string | Source-dependent | |
data.patient_id | string | Source-dependent | |
data.inpatient_id | string | Source-dependent | |
data.nurse_id | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.doctor_id | number | Source-dependent | |
data.question | string | Source-dependent | |
data.questioned_at | number | Source-dependent | |
data.patient_type | string | Source-dependent | |
data.interaction_id | string | Source-dependent | |
data.organization_id | string | Source-dependent | |
data.answer | object | Source-dependent | |
data.answer.123277 | object | Source-dependent | |
data.answer.123277.pre_operative_diagnosis | string | Source-dependent | |
data.answer.123277.post_operative_diagnosis | string | Source-dependent | |
data.answer.123277.surgeon | string | Source-dependent | |
data.answer.123277.assistant1 | string | Source-dependent | |
data.answer.123277.assistant2 | string | Source-dependent | |
data.answer.123277.anesthetist | string | Source-dependent | |
data.answer.123277.scrub_nurse | string | Source-dependent | |
data.answer.123277.circ_nurse | string | Source-dependent | |
data.answer.123277.skin_wound_condition | string | Source-dependent | |
data.answer.123277.findings | string | Source-dependent | |
data.answer.123277.name_of_operation | string | Source-dependent | |
data.answer.123277.procedure | string | Source-dependent | |
data.answer.123277.post_operative_orders | string | Source-dependent | |
data.answer.123277.diet | string | Source-dependent | |
data.answer.123277.postoperative_condition | string | Source-dependent | |
data.answer.123277.surgeon_remarks | string | Source-dependent | |
data.answer.123277.biopsy_specimen | string | Source-dependent | |
data.answer.123277.medication_templates | array<JSON value> | Source-dependent | |
data.answer.123277.vitals_abnormality | object | Source-dependent | |
data.answer.123277.vitals_abnormality.abnormality_detected | boolean | Source-dependent | |
data.answer.123277.vitals_abnormality.abnormal_vitals_message | string | Source-dependent | |
data.answer.123277.vitals_abnormality.overall_severity | string | Source-dependent | |
data.answer.123277.monitoring_tasks | array<object | object> | Source-dependent | |
data.answer.123277.drug_chart_patch | object | Source-dependent | |
data.answer.123277.drug_chart_patch.allergies_to_add | array<JSON value> | Source-dependent | |
data.answer.123277.drug_chart_patch.administrations_to_add | array<JSON value> | Source-dependent | |
data.answer.123277.drug_chart_patch.medications_to_stop | array<JSON value> | Source-dependent | |
data.answer.123277.drug_chart_patch.medications_to_hold | array<JSON value> | Source-dependent | |
data.answer.123277.drug_chart_patch.medications_to_resume | array<JSON value> | Source-dependent | |
data.answer.123277.drug_chart_patch.new_regular_orders | array<JSON value> | Source-dependent | |
data.answer.123277.drug_chart_patch.new_prn_orders | array<JSON value> | Source-dependent | |
data.answer.123277.drug_chart_patch.medication_reconciliation | object | Source-dependent | |
data.answer.123277.drug_chart_patch.medication_reconciliation.previous_medications | array<JSON value> | Source-dependent | |
data.answer.123277.blood_borne | object | Source-dependent | |
data.answer.123277.blood_borne.hiv | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.answer.123277.blood_borne.hcv | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.answer.123277.blood_borne.hbv | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.answer.123277.blood_borne.syphilis | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.answer.123277.blood_borne.htlv | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.answer.123277.blood_borne.malaria | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.answer.123277.blood_borne.cmv | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.answer.123277.phonetic_uri | string | Source-dependent | |
data.summary | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.question_audio_link | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.answer_audio_link | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
data.funct_name | string | Source-dependent | |
data.answered_at | number | Source-dependent | |
data.phonetic_uri | string | Source-dependent | |
data.practitioner_id | string | Source-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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
weight_change | integer | null | Optional / source-dependent | |
dietary_intake | integer | null | Optional / source-dependent | |
gi_symptoms | integer | null | Optional / source-dependent | |
functional_capacity | integer | null | Optional / source-dependent | |
disease_metabolic_demand | integer | null | Optional / source-dependent | |
physical_exam_fat_stores | integer | null | Optional / source-dependent | |
physical_exam_muscle_wasting | integer | null | Optional / source-dependent | |
total_score | integer | null | Optional / source-dependent | |
sga_rating | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
inserted_by | string | Optional / source-dependent | |
verified_by | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
isAssessed | boolean | Yes | |
state | string | Yes |
Exact JSON field definition
{
"properties": {
"isAssessed": {
"title": "Isassessed",
"type": "boolean"
},
"state": {
"title": "State",
"type": "string"
}
},
"required": [
"isAssessed",
"state"
],
"title": "SkinTurgor",
"type": "object"
}StopMedicationCommand
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
drug_name | string | Optional / source-dependent | |
dose | string | Optional / source-dependent | |
action | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
resultData | object | Yes | |
resultData.detail_id | string | integer | null | Source-dependent | |
resultData.interaction_id | string | integer | null | Source-dependent | |
resultData.interaction_detail_type | string | Source-dependent | |
resultData.attachment_url | string | null | Source-dependent | |
resultData.answer | JSON value | Source-dependent | Service-defined JSON value; preserve its returned type and fields. |
resultData.question | string | Source-dependent | |
resultData.created_at | string | Source-dependent | |
resultData.updated_at | string | Source-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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
interaction_id | string | integer | null | Yes | |
gcs_uri | string | null | Optional / source-dependent | |
created_at | string | Optional / source-dependent | |
phonetic_uri | string | null | Optional / source-dependent | |
doctor_id | string | integer | null | Optional / source-dependent | |
ordered_by | string | integer | null | Optional / source-dependent | |
approved_by | string | integer | null | Optional / source-dependent | |
todos | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
todo_data | array<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.
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
interaction_id | string | integer | null | Yes | |
gcs_uri | string | Optional / source-dependent | |
todos | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
investigations | array<Investigation> | Optional / source-dependent | Requested tests and investigations. |
opinions | array<ToDoOpinionTask> | Optional / source-dependent | Requested clinician/specialty opinions. |
prescription_tasks | array<ToDoPrescriptionTask> | Optional / source-dependent | Medication orders, schedules and dose execution slots. |
monitoring_orders | array<MonitoringOrder> | Optional / source-dependent | Monitoring instructions and intervals. |
nursing_care_orders | array<NursingCareOrder> | Optional / source-dependent | Nursing care instructions. |
procedure_orders | array<ProcedureOrder> | Optional / source-dependent | Requested procedures. |
deferred_orders | array<DeferredOrder> | Optional / source-dependent | Orders 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
specialty | string | Yes | |
consultant_name | string | Optional / source-dependent | |
reason | string | Yes | |
status | string | Optional / source-dependent | |
source | TodoSource | Optional / source-dependent | Document provenance; preserve without editing. |
todo_id | string | Optional / source-dependent | Opaque task identifier; preserve it during edits. |
todo_version | integer | Optional / source-dependent | Version 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
medication_name | string | Yes | |
medication_type | string | null | Optional / source-dependent | |
dosage | string | Optional / source-dependent | |
route | string | Optional / source-dependent | |
frequency_morning | array<Frequency> | Optional / source-dependent | |
frequency_afternoon | array<Frequency> | Optional / source-dependent | |
frequency_evening | array<Frequency> | Optional / source-dependent | |
frequency_night | array<Frequency> | Optional / source-dependent | |
duration | string | Optional / source-dependent | |
duration_source | string | Optional / source-dependent | |
continue_until_stopped | boolean | Optional / source-dependent | |
dosage_time | array<string> | null | Optional / source-dependent | Scheduled dose times returned by the service. |
scheduled_dates | array<scheduler> | Optional / source-dependent | |
actual_medication_name | string | Optional / source-dependent | |
brand_name | string | null | Optional / source-dependent | |
generic_name | string | null | Optional / source-dependent | |
auto_correct | boolean | null | Optional / source-dependent | |
med_from_llm | boolean | null | Optional / source-dependent | |
brand_id | string | integer | null | Optional / source-dependent | |
instructions | string | Optional / source-dependent | |
interval_minutes | integer | null | Optional / source-dependent | |
med_status | string | Optional / source-dependent | Medication order action/state; distinct from administration completion. |
is_stat | boolean | null | Optional / source-dependent | |
is_once_only | boolean | null | Optional / source-dependent | |
is_sos | boolean | null | Optional / source-dependent | |
is_infusion | boolean | null | Optional / source-dependent | |
is_status | string | null | Optional / source-dependent | |
source | TodoSource | Optional / source-dependent | Document provenance; preserve without editing. |
todo_id | string | Optional / source-dependent | Opaque task identifier; preserve it during edits. |
todo_version | integer | Optional / source-dependent | Version 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
document_id | string | Optional / source-dependent | |
element_id | string | Optional / source-dependent | |
segment_id | string | Optional / source-dependent | |
section | string | Optional / source-dependent | |
field | string | Optional / source-dependent | |
text | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
drug_chart | integer | Optional / source-dependent | |
once_only_drugs | integer | Optional / source-dependent | |
oral_anticoagulation | integer | Optional / source-dependent | |
thromboprophylaxis | integer | Optional / source-dependent | |
antiplatelet | integer | Optional / source-dependent | |
prn_drugs | integer | Optional / source-dependent | |
infusions | integer | Optional / source-dependent | |
iv_fluids | integer | Optional / source-dependent | |
oxygen | integer | Optional / source-dependent | |
administered | integer | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
bilateral_chest_rise | boolean | Optional / source-dependent | |
eq_air_entry | boolean | Optional / source-dependent | |
end_tidal_co2 | boolean | Optional / source-dependent | |
chest_xray | boolean | Optional / source-dependent | |
auscultation | boolean | Optional / source-dependent | |
spo2_improv | boolean | Optional / source-dependent | |
others | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
type_of_vad | string | Optional / source-dependent | |
site | string | Optional / source-dependent | |
date_of_removal | string | Optional / source-dependent | |
removal_checklist | RemovalChecklist | Optional / source-dependent | |
reason_for_removal | string | Optional / source-dependent | |
post_removal_observation | PostRemovalObservation | Optional / source-dependent | |
nurse | string | Optional / source-dependent | |
date | string | Optional / source-dependent | |
signature | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
picc | boolean | Optional / source-dependent | |
port | boolean | Optional / source-dependent |
Exact JSON field definition
{
"properties": {
"picc": {
"title": "Picc",
"type": "boolean"
},
"port": {
"title": "Port",
"type": "boolean"
}
},
"title": "VadTypeOptions",
"type": "object"
}VascularAccessDeviceBundle
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
insertion_checklist_form | InsertionChecklistForm | Optional / source-dependent | |
daily_maintenance_checklist_form | DailyMaintenanceChecklistForm | Optional / source-dependent | |
vad_removal_checklist_form | VadRemovalChecklistForm | Optional / source-dependent | |
complication_report_form | ComplicationReportForm | Optional / source-dependent | |
is_form_completed | boolean | Optional / source-dependent | |
form_completed_date_time | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
pain_assess | boolean | Optional / source-dependent | |
setting_verified | boolean | Optional / source-dependent | |
endo_tube_checked | boolean | Optional / source-dependent | |
ettube_secured | boolean | Optional / source-dependent | |
oral_care | boolean | Optional / source-dependent | |
suct_done | boolean | Optional / source-dependent | |
suct_type | string | Optional / source-dependent | |
ettube_cuff_press | boolean | Optional / source-dependent | |
humid_check | boolean | Optional / source-dependent | |
venti_circ_check | boolean | Optional / source-dependent | |
filter | boolean | Optional / source-dependent | |
neb_given | boolean | Optional / source-dependent | |
physio_done | boolean | Optional / source-dependent | |
pos_changed | boolean | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
intubindic | array<IntubIndication> | Optional / source-dependent | |
preproc_assess | array<PreprocedAssess> | Optional / source-dependent | |
intubdetail | array<IntubDetails> | Optional / source-dependent | |
med_used | array<MedicationData> | Optional / source-dependent | |
ventub_set | array<IntubSetting> | Optional / source-dependent | |
tube_place_confirm | array<TubePlaceConfirm> | Optional / source-dependent | |
complic_proc | array<ComplicProcedure> | Optional / source-dependent | |
remov_extub | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
venti_main | array<VentiDailyChart> | Optional / source-dependent | |
equip_main | array<EquipMaintenance> | Optional / source-dependent | |
remarks | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
patient_id | string | Yes | |
inpatient_id | string | Yes | |
structured_data | object | Yes | |
structured_data.IPD_VENTI_FORM | object | Source-dependent | |
structured_data.IPD_VENTI_FORM.venti_insert | array<VentiInsert> | Source-dependent | |
structured_data.IPD_VENTI_FORM.venti_maintain | array<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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
abnormality_detected | boolean | Optional / source-dependent | |
abnormal_vitals_message | string | Optional / source-dependent | |
overall_severity | VitalSeverity | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
temperature | string | null | Optional / source-dependent | |
pulse | string | null | Optional / source-dependent | |
respiration | string | null | Optional / source-dependent | |
blood_pressure | string | null | Optional / source-dependent | |
blood_sugar | string | null | Optional / source-dependent | |
spo2 | string | null | Optional / 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.
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
message | string | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
doc_name | string | null | Optional / source-dependent | |
signature | string | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
nur_name | string | null | Optional / source-dependent | |
cross_checked | string | null | Optional / 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
| Field | Type / nested definition | Required | Meaning |
|---|---|---|---|
current_date | string | Yes | |
count | string | Yes |
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"
}