Appointment Availability1

Appointment Reminders3

Appointment Types2

Appointments5

Charges6

Deltas1

Drugs3

Encounter Types1

Encounters4

Extended Patient Details1

Facilities1

Health Maintenance2

Inventory4

Partner Applications3

Patient Allergies1

Patient Charges3

Patient Documents5

Patient Emails1

Patient Facilities/Specialists7

Patient Free-Text Notes4

Patient Health Maintenance2

Patient Images5

Patient Invoices2

Patient Lab Results1

Patient Orders2

Patient Past Medical History1

Patient Portal4

Patient Prescriptions5

Patient Subscriptions2

Patient Supplements4

Patient Tags3

Patient Vaccines1

Patient Vitals8

Patients6

Questionnaires3

Secure Messages2

Supplements5

Tags4

Tasks4

Users3

Vitals3

Patient Supplements

Discontinue a patient supplement

Marks a patient's supplement prescription as discontinued. This does not delete the record - the supplement will remain in the patient's history with a discontinued status.

patch/patients/{pt_id}/supplements/{pt_plan_other_id}/discontinue

Request

Base URL: https://clinic-subdomain.md-hq.com/api/v1
URL: https://clinic-subdomain.md-hq.com/api/v1/patients/{pt_id}/supplements/{pt_plan_other_id}/discontinue
Auth: HTTP basic

Path parameters

pt_idinteger required

ID of the patient

pt_plan_other_idinteger required

ID of the patient's supplement prescription to discontinue

Request body

discontinued_datestring date-time

Date and time when the supplement was discontinued. If not provided, defaults to the current date/time.

discontinued_notestring

Reason for discontinuing the supplement

Example request

{
  "discontinued_date": "2024-01-15T14:30:00Z",
  "discontinued_note": "No longer needed per provider recommendation"
}

Response

Supplement successfully discontinued. Returns the full supplement object.

objectstring

The plan type (e.g., "supplement", "supplement_otc")

idinteger

ID of the patient's supplement prescription

namestring

Name of the supplement

plan_typestring

Type classification of the plan

is_discontinuedboolean

Whether the supplement has been discontinued

associated_plan_idinteger

encounter_idinteger nullable

url_encounterstring nullable

URL to the associated encounter

createdstring date-time

Example response

{
  "object": "supplement"
}

Changes

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