v2

latestOpenAPI 3.1.12026-08-078549932.4 MB
RxGovernance

Create a new medication request (prescription or OTC). This is the compound walk-up operation: capture, approve, and dispense are applied in one call, each step gated by the caller's permissions (design §4). A front-desk caller with only the Inventory permission stops at Requested; a provider's submit collapses to today's one-step flow.

post/rx/governance/request

Request body

patientIdstring
inventoryItemIdstring
medicationCategorystring nullable
providerIdstring nullable
dosagestring nullable
frequencystring nullable
durationstring nullable
instructionsstring nullable
isOtcboolean
fulfillmentMethodstring
pharmacyIdstring nullable
notesstring nullable
invoiceIdstring nullable

When supplied, the created dispense transaction is also attached to this estimate as an InvoiceLineItem in the same request. Used by the inline payments flow so dispense + bill land together.

estimateIdstring nullable

Billing target for a clinic-dispensed (in-house / same-day) request. When set, the request's billable line is added to this existing estimate. Mutually exclusive with bool CreateMedicationRequestDto.CreateNewEstimate. Ignored for external (online-pharmacy / print-retail) requests, which are non-billable.

createNewEstimateboolean

When true (and no string? CreateMedicationRequestDto.EstimateId), the request's billable line goes onto a new standalone draft estimate for the patient instead of the patient's current open draft.

isCascadeboolean nullable
cascadeReasonstring nullable
antimicrobialUseTypestring nullable

"Therapeutic" | "Prophylactic" | "Metaphylactic". Required when the medication is antimicrobial.

antimicrobialJustificationstring nullable
clinicalAssessmentPerformedboolean nullable
physicalExamPerformedboolean nullable
physicalExamJustificationstring nullable
withdrawalPeriodstring nullable

Required for food-producing species. Free-form label text (e.g., "Meat: 28 days; Milk: 7 days").

collectorNamestring nullable

UK CDR collector name (Schedule 2–5 controlled drugs).

collectorIdCheckedboolean nullable

UK CDR: was the collector's photo ID verified?

Response

Created

successboolean
prescriptionIdstring nullable
transactionIdstring nullable
patientIdstring
messagestring
invoiceLineItemIdstring nullable

Populated when the request supplied string? CreateMedicationRequestDto.InvoiceId and an estimate line item was created in the same call.

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 estimate the request's billable line was placed on at creation (in-house / same-day requests). Null for external (non-billable) requests.

estimateLineItemIdstring nullable

The Pending estimate line created for this request at creation, if any.

medicationRequestIdstring nullable

The lifecycle MedicationRequest recorded for this operation. The compound endpoint applies capture → approve → dispense as far as the caller's permissions allow; string? MedicationRequestResultDto.RequestStatus says where it stopped.

requestStatusstring nullable

Lifecycle status after this call: requested | approved | dispensed.