v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
RxGovernance

Full prescription edit. Pre-Dispensed prescriptions are updated in place; Dispensed prescriptions require a `reason` and the change is recorded as an amendment. DEA-tracked field changes on a controlled substance are blocked — caller must cancel-and-recreate instead.

patch/rx/governance/{id}

Path parameters

idstring required

Request body

medicationNamestring nullable
inventoryItemIdstring nullable
dosagestring nullable
unitstring nullable
frequencystring nullable
durationstring nullable
instructionsstring nullable
notesstring nullable
reasonstring nullable

Required for post-Dispensed amendments; ignored otherwise.

Response

OK

idstring
createdDatestring
patientNamestring
speciesstring
clientNamestring
medicationstring
medicationIdstring nullable
medicationCategorystring nullable
deaSchedulestring nullable
strengthstring nullable
providerstring
statusstring
lastExamDatestring nullable

Patient's last exam date (VCPR - Veterinary-Client-Patient Relationship)

patientIdstring nullable
prescriptionItemIdstring nullable
transactionIdstring nullable
invoiceLineItemIdstring nullable

Set when the dispense-from-inventory call included an InvoiceId and a line item was created atomically with the dispense. Lets clients append the line item locally without refetching.

invoiceIdstring nullable

The estimate the dispense was attached to — either the one the caller supplied or one auto-created/resolved server-side. Lets a client that had no estimate of its own adopt the server's estimate instead of failing to reconcile the line.

dosagestring nullable
frequencystring nullable
durationstring nullable
instructionsstring nullable
prescriberLicenseNumberstring nullable
distributionCategorySnapshotstring nullable
isCascadeboolean
cascadeReasonstring nullable
antimicrobialUseTypestring nullable
antimicrobialJustificationstring nullable
clinicalAssessmentPerformedboolean
physicalExamPerformedboolean
physicalExamJustificationstring nullable
validUntilstring nullable

ISO date string (YYYY-MM-DD).

withdrawalPeriodstring nullable