CLclinicos
RxGovernance

Route prescription to fulfillment method

Changed on
post/rx/governance/{id}/route

Request

Path parameters

idstring required

Request body

methodstring
pharmacyIdstring nullable
externalRxNumberstring nullable

The outside pharmacy's own Rx number, printed on the written script (ITE-1233).

inventoryLotIdstring nullable
estimatedDeliveryTimestring nullable
notesstring nullable
autoPrintLabelboolean

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

  • 099cf36186e0Revision 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)

  • 85ee96c0bb96Revision 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)