CAcarecycle
Customers.Prescriptions

Update customer prescription

Change a prescription on a customer's record.

patch/v2/customers/{id}/prescriptions/{prescriptionId}

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/customers/{id}/prescriptions/{prescriptionId}
  • Auth
    API key in header x-api-key

Path parameters

idstring uuid required

Customer ID

prescriptionIdstring uuid required

Prescription ID

Request body

customerIdstring uuid
namestring nullable
dosagestring nullable
frequencystring nullable
route'Oral' | 'Topical' | 'Injection' | 'Inhalation' | 'Sublingual' | 'Rectal' | 'Intravenous' | 'null' nullable
status'Active' | 'Expired' | 'Discontinued' | 'null' nullable
connectureDrugIdstring nullable
connectureDosageIdstring nullable
connecturePackageIdstring nullable
ndcstring nullable
dosageNamestring nullable
drugTypeIdinteger nullable
userQuantitynumber nullable
metricQuantitynumber nullable
daysSupplyinteger nullable
packageDescriptionstring nullable
packageSizenumber nullable
packageQuantitynumber nullable

Response

PATCH /v2/customers/:id/prescriptions/:prescriptionId Positive response

idstring uuid required
createdAtstring date-time nullable required

Prescription creation time. ISO 8601 timestamp

updatedAtstring date-time nullable required

Prescription last update time. ISO 8601 timestamp

customerIdstring uuid required
namestring nullable required
dosagestring nullable required
frequencystring nullable required
route'Oral' | 'Topical' | 'Injection' | 'Inhalation' | 'Sublingual' | 'Rectal' | 'Intravenous' | 'null' nullable required
status'Active' | 'Expired' | 'Discontinued' | 'null' nullable required
connectureDrugIdstring nullable required
connectureDosageIdstring nullable required
connecturePackageIdstring nullable required
ndcstring nullable required
dosageNamestring nullable required
drugTypeIdinteger nullable required
userQuantitynumber nullable required
metricQuantitynumber nullable required
daysSupplyinteger nullable required
packageDescriptionstring nullable required
packageSizenumber nullable required
packageQuantitynumber nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.