Create Health History Item

post

https://unify.kolla.dev/dental/v1/contacts/{contact}/healthHistoryItems

Records a medical condition, allergy or medication against a patient. Most practice management systems store these as a reference to a practice-owned catalog rather than as free text, so the definition a patient's answer resolved to should be supplied wherever the system requires one; see List Health History Definitions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

contact

string

required

The contact id.

Body Params

A single entry in a patient's health history: one medical condition, one allergy, or one medication they take.

name

string

^contacts/[a-z2-7]{26}/healthHistoryItems/[a-z2-7]{26}$

Resource name of the item, in the format contacts/{contact}/healthHistoryItems/{health_history_item}.

remote_id

string

The unique identifier for this item in the upstream practice management system. Practice management systems that keep conditions, allergies and medications in separate tables carry a per-kind prefix here, so the identifier stays unique across the collection.

contact

string

required

Resource name of the patient contact this item belongs to, in the format contacts/{contact}.

type

string

enum

What kind of health history this item records.

Allowed:

definition

string

Resource name of the catalog entry this item was recorded against, in the format healthHistoryDefinitions/{health_history_definition}. Absent when the practice management system stored the item as free text rather than as a catalog reference.

display_name

string

The human-readable label for this item, such as "Penicillin". Always populated, whether or not the item resolved to a catalog entry, so that a caller never has to read the catalog to render the record.

active

boolean

Whether the item is currently in effect. Conditions that have been resolved, allergies marked inactive, and medications the patient has stopped taking are not active.

start_date

string

^\d{4}-\d{2}-\d{2}$

The date the condition began, the medication was started, or the allergy was recorded, in YYYY-MM-DD format.

stop_date

string

^\d{4}-\d{2}-\d{2}$

The date the condition resolved or the medication was stopped, in YYYY-MM-DD format. Absent while the item is still in effect.

notes

string

Free-text notes the practice or the patient recorded against this item.

hash

string

An optional hash value used for change detection on the health history item record.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

defaultDefault error response