{ "openapi": "3.0.3", "info": { "title": "Conviction API", "version": "0.1.0", "description": "Reference for sign-in, orders, patients, prescribers, webhooks, reports, products, materials, and related routes." }, "servers": [ { "url": "/app/api", "description": "Conviction API" } ], "tags": [ { "name": "Health" }, { "name": "Auth" }, { "name": "Composite Creation" }, { "name": "Orders" }, { "name": "Patients" }, { "name": "Prescribers" }, { "name": "Prescriptions" }, { "name": "Search" }, { "name": "Lookups And Reference Data" }, { "name": "Catalog" }, { "name": "Home Dashboards" }, { "name": "Pharmacy Commercial Data" }, { "name": "Notifications And Webhooks" }, { "name": "Reports" }, { "name": "Admin And Debug" }, { "name": "Documentation" } ], "paths": { "/": { "get": { "tags": [ "Health" ], "summary": "GET /", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getRoot", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/auth/demo/{role}": { "get": { "tags": [ "Auth" ], "summary": "GET /auth/demo/{role}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getAuthDemoRole", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "role", "required": true, "schema": { "type": "string" } } ] } }, "/auth/expire": { "post": { "tags": [ "Auth" ], "summary": "POST /auth/expire", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postAuthExpire", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/auth/forgot-password": { "post": { "tags": [ "Auth" ], "summary": "POST /auth/forgot-password", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postAuthForgotPassword", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/auth/login": { "get": { "tags": [ "Auth" ], "summary": "GET /auth/login", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getAuthLogin", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Auth" ], "summary": "POST /auth/login", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postAuthLogin", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/auth/logout": { "post": { "tags": [ "Auth" ], "summary": "POST /auth/logout", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postAuthLogout", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/auth/refresh": { "post": { "tags": [ "Auth" ], "summary": "POST /auth/refresh", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postAuthRefresh", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/auth/session": { "get": { "tags": [ "Auth" ], "summary": "GET /auth/session", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getAuthSession", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Auth" ], "summary": "POST /auth/session", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postAuthSession", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/auth/verify": { "get": { "tags": [ "Auth" ], "summary": "GET /auth/verify", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getAuthVerify", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/composite/prescription-order": { "post": { "tags": [ "Composite Creation" ], "summary": "POST /composite/prescription-order", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postCompositePrescriptionOrder", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/compounding-reasons": { "get": { "tags": [ "Orders" ], "summary": "GET /compounding-reasons", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getCompoundingReasons", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Orders" ], "summary": "POST /compounding-reasons", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postCompoundingReasons", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/compounding-reasons/{id}": { "patch": { "tags": [ "Orders" ], "summary": "PATCH /compounding-reasons/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchCompoundingReasonsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/contracts/{entity}/{id}": { "get": { "tags": [ "Admin And Debug" ], "summary": "GET /contracts/{entity}/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getContractsEntityId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "entity", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/customer-accounts": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /customer-accounts", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getCustomerAccounts", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Pharmacy Commercial Data" ], "summary": "POST /customer-accounts", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postCustomerAccounts", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/customer-accounts/{id}": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /customer-accounts/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getCustomerAccountsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/customer-accounts/{id}/subscriptions": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /customer-accounts/{id}/subscriptions", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getCustomerAccountsIdSubscriptions", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Pharmacy Commercial Data" ], "summary": "POST /customer-accounts/{id}/subscriptions", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postCustomerAccountsIdSubscriptions", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/email-subscriptions/deactivate": { "post": { "tags": [ "Notifications And Webhooks" ], "summary": "POST /email-subscriptions/deactivate", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postEmailSubscriptionsDeactivate", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/feature-flags": { "get": { "tags": [ "Admin And Debug" ], "summary": "GET /feature-flags", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getFeatureFlags", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Admin And Debug" ], "summary": "POST /feature-flags", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postFeatureFlags", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/feature-flags/{key}": { "get": { "tags": [ "Admin And Debug" ], "summary": "GET /feature-flags/{key}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getFeatureFlagsKey", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Admin And Debug" ], "summary": "PATCH /feature-flags/{key}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchFeatureFlagsKey", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "type": "string" } } ] } }, "/invoices": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /invoices", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getInvoices", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Pharmacy Commercial Data" ], "summary": "POST /invoices", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postInvoices", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/invoices/{id}": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /invoices/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getInvoicesId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/invoices/{id}/finalize": { "post": { "tags": [ "Pharmacy Commercial Data" ], "summary": "POST /invoices/{id}/finalize", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postInvoicesIdFinalize", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/invoices/{id}/line-items": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /invoices/{id}/line-items", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getInvoicesIdLineItems", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Pharmacy Commercial Data" ], "summary": "POST /invoices/{id}/line-items", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postInvoicesIdLineItems", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/invoices/{id}/payments": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /invoices/{id}/payments", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getInvoicesIdPayments", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Pharmacy Commercial Data" ], "summary": "POST /invoices/{id}/payments", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postInvoicesIdPayments", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/lookups": { "get": { "tags": [ "Lookups And Reference Data" ], "summary": "GET /lookups", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getLookups", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/lookups/guardian-relationship-types": { "get": { "tags": [ "Lookups And Reference Data" ], "summary": "GET /lookups/guardian-relationship-types", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getLookupsGuardianRelationshipTypes", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/lookups/quantity-units": { "get": { "tags": [ "Lookups And Reference Data" ], "summary": "GET /lookups/quantity-units", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getLookupsQuantityUnits", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/lookups/shipping-options": { "get": { "tags": [ "Lookups And Reference Data" ], "summary": "GET /lookups/shipping-options", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getLookupsShippingOptions", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/materials": { "get": { "tags": [ "Catalog" ], "summary": "GET /materials", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getMaterials", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/materials/{id}": { "get": { "tags": [ "Catalog" ], "summary": "GET /materials/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getMaterialsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Catalog" ], "summary": "PATCH /materials/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchMaterialsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/materials/order": { "get": { "tags": [ "Catalog" ], "summary": "GET /materials/order", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getMaterialsOrder", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/materials/order/{id}": { "get": { "tags": [ "Catalog" ], "summary": "GET /materials/order/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getMaterialsOrderId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Catalog" ], "summary": "PATCH /materials/order/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchMaterialsOrderId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/notification-settings": { "get": { "tags": [ "Notifications And Webhooks" ], "summary": "GET /notification-settings", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getNotificationSettings", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "patch": { "tags": [ "Notifications And Webhooks" ], "summary": "PATCH /notification-settings", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchNotificationSettings", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/notifications": { "get": { "tags": [ "Notifications And Webhooks" ], "summary": "GET /notifications", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getNotifications", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Notifications And Webhooks" ], "summary": "POST /notifications", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postNotifications", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/notifications/event-types": { "get": { "tags": [ "Notifications And Webhooks" ], "summary": "GET /notifications/event-types", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getNotificationsEventTypes", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/offers": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /offers", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOffers", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/offers/{id}": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /offers/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOffersId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Pharmacy Commercial Data" ], "summary": "PATCH /offers/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchOffersId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/openapi": { "get": { "tags": [ "Documentation" ], "summary": "GET /openapi", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOpenapi", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/order-issues/{id}": { "get": { "tags": [ "Orders" ], "summary": "GET /order-issues/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOrderIssuesId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Orders" ], "summary": "PATCH /order-issues/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchOrderIssuesId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/order-issues/{id}/comments": { "get": { "tags": [ "Orders" ], "summary": "GET /order-issues/{id}/comments", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOrderIssuesIdComments", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Orders" ], "summary": "POST /order-issues/{id}/comments", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postOrderIssuesIdComments", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/orders": { "get": { "tags": [ "Orders" ], "summary": "GET /orders", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOrders", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Orders" ], "summary": "POST /orders", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postOrders", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/orders/{id}": { "get": { "tags": [ "Orders" ], "summary": "GET /orders/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOrdersId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Orders" ], "summary": "PATCH /orders/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchOrdersId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/orders/{id}/actions": { "post": { "tags": [ "Orders" ], "summary": "POST /orders/{id}/actions", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postOrdersIdActions", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/orders/{id}/commercial": { "get": { "tags": [ "Orders" ], "summary": "GET /orders/{id}/commercial", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOrdersIdCommercial", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/orders/{id}/context": { "get": { "tags": [ "Orders" ], "summary": "GET /orders/{id}/context", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOrdersIdContext", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/orders/{id}/issues": { "get": { "tags": [ "Orders" ], "summary": "GET /orders/{id}/issues", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOrdersIdIssues", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Orders" ], "summary": "POST /orders/{id}/issues", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postOrdersIdIssues", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/orders/{id}/status-history": { "get": { "tags": [ "Orders" ], "summary": "GET /orders/{id}/status-history", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOrdersIdStatusHistory", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/orders/statuses": { "get": { "tags": [ "Orders" ], "summary": "GET /orders/statuses", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getOrdersStatuses", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/patient-risk-factors/{id}/deactivate": { "post": { "tags": [ "Patients" ], "summary": "POST /patient-risk-factors/{id}/deactivate", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPatientRiskFactorsIdDeactivate", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/patients": { "get": { "tags": [ "Patients" ], "summary": "GET /patients", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPatients", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Patients" ], "summary": "POST /patients", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPatients", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/patients/{id}": { "get": { "tags": [ "Patients" ], "summary": "GET /patients/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPatientsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Patients" ], "summary": "PATCH /patients/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchPatientsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/patients/{id}/context": { "get": { "tags": [ "Patients" ], "summary": "GET /patients/{id}/context", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPatientsIdContext", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/patients/{id}/orders": { "get": { "tags": [ "Patients" ], "summary": "GET /patients/{id}/orders", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPatientsIdOrders", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/patients/{id}/refill-reminder": { "post": { "tags": [ "Patients" ], "summary": "POST /patients/{id}/refill-reminder", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPatientsIdRefillReminder", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/patients/{id}/risk-factors": { "get": { "tags": [ "Patients" ], "summary": "GET /patients/{id}/risk-factors", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPatientsIdRiskFactors", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Patients" ], "summary": "POST /patients/{id}/risk-factors", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPatientsIdRiskFactors", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/patients/{id}/risk-factors/freeform": { "post": { "tags": [ "Patients" ], "summary": "POST /patients/{id}/risk-factors/freeform", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPatientsIdRiskFactorsFreeform", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/pharmacies": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /pharmacies", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPharmacies", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Pharmacy Commercial Data" ], "summary": "POST /pharmacies", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPharmacies", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/pharmacies/{id}": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /pharmacies/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPharmaciesId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Pharmacy Commercial Data" ], "summary": "PATCH /pharmacies/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchPharmaciesId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/pharmacies/{id}/offers": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /pharmacies/{id}/offers", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPharmaciesIdOffers", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Pharmacy Commercial Data" ], "summary": "POST /pharmacies/{id}/offers", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPharmaciesIdOffers", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/pharmacy-memberships": { "get": { "tags": [ "Pharmacy Commercial Data" ], "summary": "GET /pharmacy-memberships", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPharmacyMemberships", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Pharmacy Commercial Data" ], "summary": "POST /pharmacy-memberships", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPharmacyMemberships", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/pharmacy/home": { "get": { "tags": [ "Home Dashboards" ], "summary": "GET /pharmacy/home", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPharmacyHome", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/prescriber-qualifications/{id}": { "patch": { "tags": [ "Prescribers" ], "summary": "PATCH /prescriber-qualifications/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchPrescriberQualificationsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/prescriber-supervisions": { "post": { "tags": [ "Prescribers" ], "summary": "POST /prescriber-supervisions", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPrescriberSupervisions", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/prescriber-supervisions/{id}": { "delete": { "tags": [ "Prescribers" ], "summary": "DELETE /prescriber-supervisions/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "deletePrescriberSupervisionsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/prescribers": { "get": { "tags": [ "Prescribers" ], "summary": "GET /prescribers", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPrescribers", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Prescribers" ], "summary": "POST /prescribers", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPrescribers", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/prescribers/{id}": { "get": { "tags": [ "Prescribers" ], "summary": "GET /prescribers/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPrescribersId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Prescribers" ], "summary": "PATCH /prescribers/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchPrescribersId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/prescribers/{id}/context": { "get": { "tags": [ "Prescribers" ], "summary": "GET /prescribers/{id}/context", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPrescribersIdContext", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/prescribers/{id}/qualifications": { "get": { "tags": [ "Prescribers" ], "summary": "GET /prescribers/{id}/qualifications", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPrescribersIdQualifications", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "post": { "tags": [ "Prescribers" ], "summary": "POST /prescribers/{id}/qualifications", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPrescribersIdQualifications", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/prescribers/{id}/supervisees": { "get": { "tags": [ "Prescribers" ], "summary": "GET /prescribers/{id}/supervisees", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPrescribersIdSupervisees", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/prescribers/{id}/supervisors": { "get": { "tags": [ "Prescribers" ], "summary": "GET /prescribers/{id}/supervisors", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPrescribersIdSupervisors", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/prescribers/credentials": { "get": { "tags": [ "Prescribers" ], "summary": "GET /prescribers/credentials", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPrescribersCredentials", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/prescriptions": { "get": { "tags": [ "Prescriptions" ], "summary": "GET /prescriptions", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPrescriptions", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Prescriptions" ], "summary": "POST /prescriptions", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postPrescriptions", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/prescriptions/{id}": { "get": { "tags": [ "Prescriptions" ], "summary": "GET /prescriptions/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getPrescriptionsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Prescriptions" ], "summary": "PATCH /prescriptions/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchPrescriptionsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/products": { "get": { "tags": [ "Catalog" ], "summary": "GET /products", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getProducts", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/products/{id}": { "get": { "tags": [ "Catalog" ], "summary": "GET /products/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getProductsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Catalog" ], "summary": "PATCH /products/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchProductsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/products/all": { "get": { "tags": [ "Catalog" ], "summary": "GET /products/all", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getProductsAll", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/products/non-prescription": { "get": { "tags": [ "Catalog" ], "summary": "GET /products/non-prescription", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getProductsNonPrescription", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/products/non-prescription/{id}": { "get": { "tags": [ "Catalog" ], "summary": "GET /products/non-prescription/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getProductsNonPrescriptionId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Catalog" ], "summary": "PATCH /products/non-prescription/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchProductsNonPrescriptionId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/products/prescription": { "get": { "tags": [ "Catalog" ], "summary": "GET /products/prescription", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getProductsPrescription", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/products/prescription/{id}": { "get": { "tags": [ "Catalog" ], "summary": "GET /products/prescription/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getProductsPrescriptionId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Catalog" ], "summary": "PATCH /products/prescription/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchProductsPrescriptionId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/provider/home": { "get": { "tags": [ "Home Dashboards" ], "summary": "GET /provider/home", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getProviderHome", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/reports/daily": { "get": { "tags": [ "Reports" ], "summary": "GET /reports/daily", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getReportsDaily", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/reports/orders": { "get": { "tags": [ "Reports" ], "summary": "GET /reports/orders", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getReportsOrders", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/reports/overview": { "get": { "tags": [ "Reports" ], "summary": "GET /reports/overview", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getReportsOverview", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/reports/queue": { "get": { "tags": [ "Reports" ], "summary": "GET /reports/queue", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getReportsQueue", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/search": { "get": { "tags": [ "Search" ], "summary": "GET /search", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getSearch", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/search/{entity}": { "get": { "tags": [ "Search" ], "summary": "GET /search/{entity}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getSearchEntity", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "entity", "required": true, "schema": { "type": "string" } } ] } }, "/search/tasks": { "get": { "tags": [ "Search" ], "summary": "GET /search/tasks", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getSearchTasks", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/subscriptions": { "get": { "tags": [ "Notifications And Webhooks" ], "summary": "GET /subscriptions", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getSubscriptions", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Notifications And Webhooks" ], "summary": "POST /subscriptions", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postSubscriptions", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/subscriptions/{id}/deactivate": { "post": { "tags": [ "Notifications And Webhooks" ], "summary": "POST /subscriptions/{id}/deactivate", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postSubscriptionsIdDeactivate", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/webhooks/events": { "get": { "tags": [ "Notifications And Webhooks" ], "summary": "GET /webhooks/events", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getWebhooksEvents", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/webhooks/preview": { "post": { "tags": [ "Notifications And Webhooks" ], "summary": "POST /webhooks/preview", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postWebhooksPreview", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/webhooks/secret": { "post": { "tags": [ "Notifications And Webhooks" ], "summary": "POST /webhooks/secret", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postWebhooksSecret", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/webhooks/send": { "post": { "tags": [ "Notifications And Webhooks" ], "summary": "POST /webhooks/send", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postWebhooksSend", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/webhooks/subscriptions": { "get": { "tags": [ "Notifications And Webhooks" ], "summary": "GET /webhooks/subscriptions", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getWebhooksSubscriptions", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } }, "post": { "tags": [ "Notifications And Webhooks" ], "summary": "POST /webhooks/subscriptions", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "postWebhooksSubscriptions", "responses": { "200": { "description": "Successful response. Some POST handlers return 201 Created." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } } } }, "/webhooks/subscriptions/{id}": { "get": { "tags": [ "Notifications And Webhooks" ], "summary": "GET /webhooks/subscriptions/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "getWebhooksSubscriptionsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "patch": { "tags": [ "Notifications And Webhooks" ], "summary": "PATCH /webhooks/subscriptions/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "patchWebhooksSubscriptionsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] }, "delete": { "tags": [ "Notifications And Webhooks" ], "summary": "DELETE /webhooks/subscriptions/{id}", "description": "Route reference. Request and response schemas are not expanded yet.", "operationId": "deleteWebhooksSubscriptionsId", "responses": { "200": { "description": "Successful response." }, "400": { "description": "Bad request or validation error." }, "401": { "description": "Authentication required for protected routes." }, "404": { "description": "Requested resource was not found." }, "500": { "description": "Server error." } }, "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } } } }