Encounters

Create a New Encounter on a Patient Chart

post/encounters

Request

  • Base URL: https://clinic-subdomain.md-hq.com/api/v1
  • URL: https://clinic-subdomain.md-hq.com/api/v1/encounters
  • Auth: HTTP basic

Request body

pt_idinteger

A valid ID of a non-archived patient.

date_of_servicestring date

A time stamp (YYYY-MM-DD format preferred) representing the date the encounter took or will take place. Can be future or past.

titlestring

The title of the encounter note.

contentstring

The plaintext-formatted text of the encounter note.

encounter_typestring

The two-letter abbreviation of the type of encounter note you are creating.

ownerinteger

A valid ID of a non-archived, non-resource user who is the expected owner/manager of the note. Default is the API “user” itself.

parent_encounterinteger

The valid ID of an existing encounter for the designated patient. If set, the new note will be filed as a sub-note of the designated parent encounter. The parent note must belong to the patient set by pt_id and it must not be a sub-note itself.

Response

Encounter created successfully

Changes

No recorded changes to this operation across all 1 revision of this API.