Sign in

v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Clinical

Retrieve an existing clinical note field value

get/api/clinical_note_field_values/{id}

Path parameters

idstring required

Query parameters

clinical_note_fieldinteger
sincestring
appointmentinteger
clinical_note_templateinteger
doctorinteger

Response

OK

clinical_note_fieldinteger required

ID of /api/clinical_note_field_types object that indicates type of the value

created_atstring
updated_atstring
valuestring required

Value of the field. Interpretation varies by field type.

clinical_note_field.data_typeValueDescription
"Header"string
"SubHeader"string
"String"stringIf field is single/multiple select field, make sure value presents in allowed values set.
"TwoStrings"stringString is seperated by "/"
"NullCheckbox"stringCan be "0", "1", "2", "0"-Not selected, "1"-No, "2"-Yes
"Checkbox"stringCan be "True", "False"
appointmentinteger required

ID of appointment that the value applies to

idinteger