CLclinicos
Vitals

Record a new vital measurement for a patient. Triggers VitalsOutOfRange automation if the value is outside normal range.

Changed on
post/patients/{patientId}/Vitals

Request

Path parameters

patientIdstring required

Request body

vitalTypeCodestring required
unitstring nullable

Unit decimal? RecordVitalRequest.Value was taken in (ITE-829): "kg" | "lb" | "g" | "oz" for weight, "c" | "f" for temperature (symbols and plurals like "°C", "lbs" are accepted). Omit for single-unit types and to mean "the vital type's own unit". Clients send what the user typed and never convert; a unit of the wrong quantity is a 400.

valueTextstring nullable

Text reading ("Bright", "pale pink"). Required for Text vital types.

appointmentIdstring nullable
takenByIdstring nullable
notesstring nullable
extractedByAiboolean

True when the value came from AI transcript extraction and was accepted by the user (PAW-806). Drives the AI badge in the readings list; a human still confirmed it.

Response

OK

idstring required
patientIdstring required
vitalTypeCodestring required
vitalTypeLabelstring required
valueTextstring nullable

Text reading; null for numeric readings.

unitstring required

Display label of the unit the reading was entered in ("kg", "°C"); the type's unit for text readings.

canonicalUnitstring nullable

Unit code of decimal? RecordVitalResponse.CanonicalValue: "kg", "c", or the entered unit for single-unit types.

takenAtstring date-time required

Changes

  • d4ae30be0619Revision changes
    • warning

      changed the pattern of the request property from ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ to ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ (media type: application/json)

    • warning

      changed the pattern of the request property from ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ to ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ (media type: text/json)

    • warning

      changed the pattern of the request property from ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ to ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      the response's property pattern was changed from ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ to ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ for the status (media type: text/plain)

    • info

      the response's property pattern was changed from ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ to ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ for the status (media type: application/json)

    • info

      the response's property pattern was changed from ^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$ to ^-?(?:0|[1-9]\d*)(?:\.\d+)?$ for the status (media type: text/json)

  • 503cd0546309Revision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)