API Vitalsigns
Vitalsigns are a way to document a patient's vital signs, including height, weight, blood pressure, and pulse.
Anyone using the API should also become very familiar with our schema documentation which contains important details about individual database table columns.
See Vitalsigns Database Schema.
Vitalsigns GET (single)
Version Added: 25.3.41
Gets a single vitalsign.
VitalsignNum: Required in URL.
Example Request:
GET /vitalsigns/2
Example Response:
{
"VitalsignNum": 2,
"PatNum": 11,
"Height": 73.0,
"Weight": 215.0,
"BpSystolic": 76,
"BpDiastolic": 120,
"DateTaken": "2025-09-17",
"Documentation": "Vitals recorded before dental surgery.",
"Pulse": 82
}
200 OK
404 NotFound (with explanation)
Vitalsigns GET (multiple)
Version Added: 25.3.41
Get a list of vitalsigns.
Parameters: All optional.
PatNum: Optional. FK to patient.PatNum.Example Request:
GET /vitalsigns
GET /vitalsigns?PatNum=11
Example Responses:
[
{
"VitalsignNum": 2,
"PatNum": 11,
"Height": 73.0,
"Weight": 215.0,
"BpSystolic": 76,
"BpDiastolic": 120,
"DateTaken": "2025-09-17",
"Documentation": "Vitals recorded before dental surgery.",
"Pulse": 82
},
{
"VitalsignNum": 3,
"PatNum": 12,
"Height": 65.0,
"Weight": 135,
"BpSystolic": 82,
"BpDiastolic": 125,
"DateTaken": "2025-08-27",
"Documentation": "Vitals recorded after follow-up appointment.",
"Pulse": 90
},
{
"VitalsignNum": 4,
"PatNum": 13,
"Height": 68.0,
"Weight": 170.0,
"BpSystolic": 83,
"BpDiastolic": 117,
"DateTaken": "2025-10-07",
"Documentation": "Routine vitals at annual checkup.",
"Pulse": 102
}
etc...
]
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)
Vitalsigns POST (create)
Version Added: 25.3.41
Creates a new vitalsign.
PatNum: Required. FK to patient.PatNum.Height: Optional. Height of patient in inches. Default 0.
Weight: Optional. Weight of patient in pounds. Default 0.
BpSystolic: Optional. Units are mmHg (millimeters of mercury). Default 0.
BpDiastolic: Optional. Units are mmHg (millimeters of mercury). Default 0.
DateTaken: Optional. The date that the vitalsigns were taken. String in "yyyy-MM-dd" format. Defaults to the date the vitalsign was created.
Documentation: Optional. A general note. Default empty string.
Pulse: Optional. Pulse of patient in beats per minute. Default 0.
Example Request:
POST /vitalsigns
{
"PatNum": 11,
"Height": 73.0,
"Weight": 215.0,
"BpSystolic": 76,
"BpDiastolic": 120,
"DateTaken": "2025-09-17",
"Documentation": "Vitals recorded before dental surgery.",
"Pulse": 82
}
{
"VitalsignNum": 2,
"PatNum": 11,
"Height": 73.0,
"Weight": 215.0,
"BpSystolic": 76,
"BpDiastolic": 120,
"DateTaken": "2025-09-17",
"Documentation": "Vitals recorded before dental surgery.",
"Pulse": 82
}
201 Created
400 BadRequest (with explanation)
404 NotFound (with explanation)
Vitalsigns PUT (update)
Version Added: 25.3.41
Updates an existing vitalsign.
VitalsignNum: Required in the URL.Height: Optional. Height of patient in inches. Allowed to be 0.
Weight: Optional. Weight of patient in pounds. Allowed to be 0.
BpSystolic: Optional. Units are mmHg (millimeters of mercury). Allowed to be 0.
BpDiastolic: Optional. Units are mmHg (millimeters of mercury). Allowed to be 0.
DateTaken: Optional. The date that the vitalsigns were taken. String in "yyyy-MM-dd" format.
Documentation: Optional. A general note.
Pulse: Optional. Pulse of patient in beats per minute.
Example Requests:
PUT /vitalsigns/2
{
"Documentation": "Pulse taken again before dental surgery.",
"Pulse": 79
}
or
{
"Weight": 207.0,
}
{
"VitalsignNum": 2,
"PatNum": 11,
"Height": 73.0,
"Weight": 215.0,
"BpSystolic": 76,
"BpDiastolic": 120,
"DateTaken": "2025-09-17",
"Documentation": "Pulse taken again before dental surgery.",
"Pulse": 79
}
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)
Vitalsigns DELETE
Version Added: 25.3.41
Deletes a vitalsign.
VitalsignNum: Required in the URL.
Example Request:
DELETE /vitalsigns/115
Example Responses:
200 OK
400 BadRequest (with explanation)
404 NotFound (with explanation)