Vitals Logs
Function-calling namespace: vitalsLogs
- Base URL:
https://api.aivida.in - Engine endpoint:
POST /api - Auth: Stack token middleware enabled in
optionalmode. - Send token in header:
x-stack-access-token: <access_token>(orAuthorization: Bearer <access_token>). - In
optionalmode: no token is allowed; invalid token is rejected with401.
create
Source: backend/endpoints/vitals-logs/create
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
organizationId | string | Yes | - |
patientId | string | Yes | - |
appointmentId | string | No | - |
consultationId | string | No | - |
admissionId | string | No | - |
recordedByUserId | string | Yes | - |
recordedByRole | string | Yes | - |
context | string | Yes | - |
vitals | object | No | nullable |
recordedAt | integer | Yes | unix-ms timestamp |
Nested Field Structures
vitals
| Field | Type | Required | Constraints |
|---|---|---|---|
bloodPressure | string | No | - |
heartRate | number | No | nullable |
temperature | object | No | nullable |
oxygenSaturation | number | No | nullable |
respiratoryRate | number | No | nullable |
weight | number | No | nullable |
height | number | No | nullable |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "vitalsLogs",
"apiName": "create",
"data": {
"organizationId": "org_123",
"patientId": "patient_123",
"recordedByUserId": "recordedbyuser_123",
"recordedByRole": "value",
"context": "value",
"recordedAt": 1710201600000
}
}'Example Response
{ "status": "ok", "data": {} }createByAppointmentId
Source: backend/endpoints/vitals-logs/create-by-appointment-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
organizationId | string | Yes | - |
appointmentId | string | Yes | - |
consultationId | string | No | - |
admissionId | string | No | - |
recordedByUserId | string | Yes | - |
recordedByRole | string | Yes | - |
context | string | Yes | - |
vitals | object | Yes | nullable |
recordedAt | integer | No | unix-ms timestamp |
Nested Field Structures
vitals
| Field | Type | Required | Constraints |
|---|---|---|---|
bloodPressure | string | No | - |
heartRate | number | No | nullable |
temperature | object | No | nullable |
oxygenSaturation | number | No | nullable |
respiratoryRate | number | No | nullable |
weight | number | No | nullable |
height | number | No | nullable |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "vitalsLogs",
"apiName": "createByAppointmentId",
"data": {
"organizationId": "org_123",
"appointmentId": "appointment_123",
"recordedByUserId": "recordedbyuser_123",
"recordedByRole": "value",
"context": "value",
"vitals": {
"bloodPressure": "value",
"heartRate": 1,
"temperature": {
"value": 1,
"unit": {}
},
"oxygenSaturation": 1,
"respiratoryRate": 1,
"weight": 1,
"height": 1
}
}
}'Example Response
{ "status": "ok", "data": {} }delete
Source: backend/endpoints/vitals-logs/delete
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "vitalsLogs",
"apiName": "delete",
"data": {
"id": "id_123",
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }deleteByAppointmentId
Source: backend/endpoints/vitals-logs/delete-by-appointment-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
appointmentId | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "vitalsLogs",
"apiName": "deleteByAppointmentId",
"data": {
"id": "id_123",
"organizationId": "org_123",
"appointmentId": "appointment_123"
}
}'Example Response
{ "status": "ok", "data": {} }getByAppointmentId
Source: backend/endpoints/vitals-logs/get-by-appointment-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
appointmentId | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "vitalsLogs",
"apiName": "getByAppointmentId",
"data": {
"id": "id_123",
"organizationId": "org_123",
"appointmentId": "appointment_123"
}
}'Example Response
{ "status": "ok", "data": {} }getById
Source: backend/endpoints/vitals-logs/get-by-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "vitalsLogs",
"apiName": "getById",
"data": {
"id": "id_123",
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }listByAppointmentId
Source: backend/endpoints/vitals-logs/list-by-appointment-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
organizationId | string | Yes | - |
appointmentId | string | Yes | - |
recordedByUserId | string | No | - |
firstCreatedAt | boolean | No | - |
lastCreatedAt | boolean | No | - |
page | integer | No | - |
pageSize | integer | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "vitalsLogs",
"apiName": "listByAppointmentId",
"data": {
"organizationId": "org_123",
"appointmentId": "appointment_123"
}
}'Example Response
{ "status": "ok", "data": {} }listByOrganization
Source: backend/endpoints/vitals-logs/list-by-organization
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
organizationId | string | Yes | - |
search | string | No | - |
page | integer | No | - |
pageSize | integer | No | - |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "vitalsLogs",
"apiName": "listByOrganization",
"data": {
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }update
Source: backend/endpoints/vitals-logs/update
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | Yes | - |
organizationId | string | Yes | - |
patientId | string | No | nullable |
appointmentId | string | No | nullable |
consultationId | string | No | nullable |
admissionId | string | No | nullable |
recordedByUserId | string | No | nullable |
recordedByRole | string | No | nullable |
context | string | No | nullable |
vitals | object | No | nullable |
recordedAt | integer | No | unix-ms timestamp; nullable |
createdAt | integer | No | unix-ms timestamp; nullable |
Nested Field Structures
vitals
| Field | Type | Required | Constraints |
|---|---|---|---|
bloodPressure | string | No | - |
heartRate | number | No | nullable |
temperature | object | No | nullable |
oxygenSaturation | number | No | nullable |
respiratoryRate | number | No | nullable |
weight | number | No | nullable |
height | number | No | nullable |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "vitalsLogs",
"apiName": "update",
"data": {
"id": "id_123",
"organizationId": "org_123"
}
}'Example Response
{ "status": "ok", "data": {} }updateByAppointmentId
Source: backend/endpoints/vitals-logs/update-by-appointment-id
Input Fields
| Field | Type | Required | Constraints |
|---|---|---|---|
id | string | No | - |
organizationId | string | Yes | - |
appointmentId | string | Yes | - |
patientId | string | No | nullable |
consultationId | string | No | nullable |
admissionId | string | No | nullable |
recordedByUserId | string | No | nullable |
recordedByRole | string | No | nullable |
context | string | No | nullable |
vitals | object | No | nullable |
recordedAt | integer | No | unix-ms timestamp; nullable |
createdAt | integer | No | unix-ms timestamp; nullable |
Nested Field Structures
vitals
| Field | Type | Required | Constraints |
|---|---|---|---|
bloodPressure | string | No | - |
heartRate | number | No | nullable |
temperature | object | No | nullable |
oxygenSaturation | number | No | nullable |
respiratoryRate | number | No | nullable |
weight | number | No | nullable |
height | number | No | nullable |
Example Request
curl -X POST https://api.aivida.in/api \
-H "Content-Type: application/json" \
-H "x-stack-access-token: <access_token_optional>" \
-d '{
"namespace": "vitalsLogs",
"apiName": "updateByAppointmentId",
"data": {
"organizationId": "org_123",
"appointmentId": "appointment_123"
}
}'Example Response
{ "status": "ok", "data": {} }