RxGovernance

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

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

Request

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.

overrideValidationboolean

The user confirmed dispensing past stock (ITE-1410, Warn mode) with string? DispenseFromInventoryDto.OverrideReason. This door already waives VCPR / quantity on the user's behalf; this only covers a stock shortfall going on the overdraft lot.

overrideReasonstring nullable

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.

estimateIdstring nullable

The draft Estimate the dispense-from-inventory landed on (the single billing path — the request's own quote estimate, fulfilled by the dispense). The payments panel converts this estimate instead of direct-creating a parallel bill (ITE-678). Mutually exclusive with string? RxGovernanceDto.InvoiceLineItemId.

estimateLineItemIdstring nullable

The Performed estimate line the dispense fulfilled, when string? RxGovernanceDto.EstimateId is set.

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).

refillsPrnboolean

PRN refills: unlimited until string? RxGovernanceDto.ValidUntil; RefillsAllowed is then 0.

medicationExpirationDatestring nullable

ISO date string (YYYY-MM-DD). Medication expiration entered on the Rx.

withdrawalPeriodstring nullable

Changes

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: text/json)

    • info

      added the new optional request property (media type: application/*+json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)