v2

latestOpenAPI 3.1.12026-08-078549932.4 MB

RxGovernance

Dispense from inventory and update governance status in one operation. For in-house routed prescriptions only.

post/rx/governance/{id}/dispense-inventory

Path parameters

idstring required

Request body

lotIdstring

containerIdstring nullable

ITE-157: explicit container within the lot; null for auto (open-first).

locationIdstring

witnessUserIdstring nullable

notesstring nullable

invoiceIdstring nullable

When supplied, the dispense transaction is also attached to this estimate as an InvoiceLineItem in the same request cycle.

collectorNamestring nullable

UK CDR: collector name for Schedule 2–5 dispenses.

collectorIdCheckedboolean nullable

UK CDR: photo ID verification flag.

Response

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