Update Medication by User ID

patch

https://api.medocity.net/v3/medication/{medicationId}/user/{userId}

Update the details of a specific medication for a specific user by their user ID. ( Others ) [scope: Medication, claim: Update]

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

medicationId

string

required

The unique identifier of the medication to update.

userId

string

required

The unique identifier of the user associated with the medication.

Body Params

asNeeded

boolean

Indicates if the medication is taken as needed.

directions

string

Directions for taking the medication.

schedule

object

Medication schedule details.

reminder

boolean

Enable medication reminder.

color1

string

First color hex code for the medication.

color2

string

Second color hex code for the medication.

prescribeName

string

Prescribed name of the medication.

rruleSetting

object

Object of a Events.

foodInstruction

string

Food instructions for taking the medication.

form

string

Form of the medication (e.g., Pill, Syringe).

name

string

Name of the medication.

pharmacyId

string

ID of the pharmacy where the medication is filled.

route

string

Route of administration for the medication (e.g., Oral, Topical).

specialInstructions

string

Special instructions for taking the medication.

strength

string

Strength of the medication.

rxNumber

string

Prescription (Rx) number for the medication.

ndc_code

string

National Drug Code (NDC) for the medication.

drugBank_id

string

DrugBank ID for the medication.

units

string

Units of the medication.

missed

number

required

Missed Medication

unreported

number

required

Unreported Medication

taken

number

required

Taken Medication

status

string

required

Taken Medication

reason

string

required

Reason For Medication status update "Missed"

medicationDate

string

required

Medication Date For Medication status update "Taken" || "Missed

comment

string

required

Medication Date For Medication status update "Taken" || "Missed

dosage

string

required

Medication Date For Medication status update "Taken" || "Missed

Response

200Successfully updated the medication.