/
CL
clinicos
/
PawthosX.Business.API | v1
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2h ago · Updated 2d ago
View markdown
clinicos
PawthosX.Business.API | v1
patch
Update a protocol
v2
latest
OpenAPI 3.1.1
2026-08-07
854
993
2.4 MB
AdminS3
2
ApiKeys
7
Appointments
21
AppointmentTypes
10
BillableItems
5
Breeds
5
BulkClientExport
2
BulkPatientExport
2
CareQueue
2
CaseMilestones
6
Cases
5
ChatExport
1
ClientAppInvite
3
ClientExport
3
Clients
5
ClinicConfig
29
ClinicSettings
2
Clocking
6
Compliance
1
ConsentDocuments
2
DeaBooks
9
DeaExport
2
DiagnosisTerms
1
DiscountCodes
7
Drafts
7
EdgePrinters
3
EdgePrintJobs
2
EmailVerification
2
Estimates
25
ExamTemplates
5
Expenses
6
Featurebase
2
Flowboard
10
GroupCodes
5
GroupVisits
6
Health
1
HomeAgain
4
IntegrationCredentials
15
InternalPrescribing
1
InternalWidget
1
Inventory
23
InventoryApprovals
5
InventoryLocations
7
Invoices
24
JourneyMilestones
6
Kiosk
4
LabPanels
5
Labs
16
LocationClosures
4
Locations
11
Logos
7
MedicationRequests
7
MentorMetrics
5
Metrics
31
NpsAnalytics
3
Partners
6
PatientGroups
9
PatientMasses
6
PatientProblems
4
PatientRecordExport
3
Patients
20
Payments
19
PaymentTokens
5
Pharmacies
5
Phones
2
PriceRules
6
Printers
6
PrintJobs
4
PtoRequests
6
PublicNps
2
PublicPriceList
5
PublicQuestionnaires
2
PublicSmsConsent
2
PurchaseOrders
11
QiEvents
9
QuestionnaireResponses
6
Questionnaires
10
RabiesTags
10
RdvmPortal
22
Recordings
7
RecurringExpenses
5
ReferralMessages
2
Referrals
20
Reminders
14
Reports
2
RetailItems
11
Roles
6
RoomDayAssignments
3
RxGovernance
25
get
Get previous dispense details for auto-fill. Tries same patient first, falls back to any patient.
get
Get prescriptions with governance data
get
Get a single prescription with events
patch
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.
post
Route prescription to fulfillment method
post
Mark prescription as dispensed — a governance-status flip only, for confirming an EXTERNAL fulfillment (same-day delivery / online pharmacy / print-retail) was handed off. Moves no stock. In-house prescriptions must use `dispense-inventory`, which runs the real dispense engine; this endpoint rejects them so a status-only call can't fake an in-house dispense (no decrement, no DEA entry, no estimate-line stamp).
post
Dispense from inventory and update governance status in one operation. For in-house routed prescriptions only.
post
Send client follow-up notification
post
Close/archive prescription
post
Generate and queue an Rx label for printing
get
Render an Rx label as a PDF for browser viewing / "Save as PDF" (no print job queued).
get
Get dashboard KPIs
get
Get Rx governance settings
patch
Update Rx governance settings
get
Look up a prescription by its inventory transaction ID
patch
Update prescription instructions (dosage, frequency, duration, instructions).
get
List amendments for a prescription (newest first).
get
List all protocols
post
Create a new protocol
get
Get a single protocol by ID
delete
Delete a protocol
patch
Update a protocol
get
Get the matching protocol for a medication
post
Create a prescription for an already-dispensed transaction (post-dispense flow)
post
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.
SavedReports
5
ScheduleItems
10
ServiceCatalog
5
Shifts
5
ShiftSwaps
8
SlotConfigurations
6
SmsConsent
9
Species
5
Subscriptions
8
SurgicalRecords
6
TagAssignments
4
Tags
5
TelnyxCallControl
1
Templates
10
TenantKnowledge
4
TimeEntries
5
Transparency
3
Users
11
Vaccinations
9
VaccineAdministration
3
VaccineCertificateRecords
6
VaccineCertificates
2
VaccineTypes
5
Vendors
6
Vitals
2
VitalTypes
6
Widget
17
WidgetChatbot
4
WorkItemRules
5
WorkTasks
13
RxGovernance
Update a protocol
patch
/rx/governance/protocols/{id}
Path parameters
id
string
required
Request body
UpdateRxProtocolDto
required
name
string
nullable
description
string
nullable
scope
string
nullable
scopeMedicationId
string
nullable
scopeMedicationName
string
nullable
scopeCategory
string
nullable
inHouseAllowed
boolean
nullable
sameDayAllowed
boolean
nullable
onlinePharmacyAllowed
boolean
nullable
printRetailAllowed
boolean
nullable
requireDoseCheck
boolean
nullable
requireInteractionCheck
boolean
nullable
requireAllergyCheck
boolean
nullable
priority
union
isActive
boolean
nullable
Response
OK
RxProtocolDto
required
id
string
name
string
description
string
nullable
isDefault
boolean
scope
string
scopeMedicationId
string
nullable
scopeMedicationName
string
nullable
scopeCategory
string
nullable
inHouseAllowed
boolean
sameDayAllowed
boolean
onlinePharmacyAllowed
boolean
printRetailAllowed
boolean
requireDoseCheck
boolean
requireInteractionCheck
boolean
requireAllergyCheck
boolean
priority
union
isActive
boolean
createdAt
string
date-time