Prescription Management Platform API - Healthcare Prescribing Solution
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Retrieves a ConstraintViolation resource.
RFC 5545 RRULE for recurring appointments
Video room ID from provider (Daily.co room name, Zoom meeting ID, etc.)
Who cancelled: 'patient', 'provider', 'system'
Appointment entity for scheduling patient visits. Supports video telehealth, in-person, and phone appointments. Integrates with video providers (Daily.co, Google Meet, Zoom).
The Source of Truth: Link to the audit event that triggered this charge.
Clinic entity - Medical facility where providers work. Clinics belong to a BusinessUnit and contain Providers and serve Patients.
Provider entity - Prescribing healthcare professional. Providers (doctors, NPs, PAs) write prescriptions and are associated with clinics. Contains credentials for external systems like ScriptSure for e-prescribing.
Line items from e-commerce order (SKUs and quantities).
AI Analysis result (risk assessment, recommendations).
EcommerceOrder entity - Tracks orders coming from e-commerce platforms. Orders flow: Received → Processing → Patient Matched → Drafts Created → Pending Review → Approved/Rejected → Completed
SkuMapping entity - Maps e-commerce SKUs to medications per BusinessUnit. Each business unit can have their own SKU naming convention that maps to the canonical medication records in the system. Supports bundles via SkuMappingItem children (one SKU → multiple medications).
Encounter entity - Universal container for patient actions.
Medication entity - Drug catalog entry. Contains drug information from rx_mapping_3 table. Prices stored in cents to avoid floating point issues.
BusinessUnit entity - Sub-tenant with branding within an Organization. Business units own clinics and can have custom branding (logo, colors).
Organization entity - Top-level tenant in the multi-tenant hierarchy. Organizations own business units, which own clinics, which have providers and patients.
External identifiers linking this patient to external pharmacy systems.
Patient biometrics (height, weight, BMI).
Patient entity - Person receiving prescriptions. HIPAA-sensitive: Contains PHI (Protected Health Information).
Height in inches (static, rarely changes).
Cached weight in pounds (synced from latest observation).
Replaces the PatientBiometrics resource.
PatientBiometrics entity - Static biometric data for a patient. Stores height (rarely changes) and caches latest weight from observations. One-to-one relationship with Patient. HIPAA-sensitive: Contains PHI (Protected Health Information).
PatientChartNote entity - Free-text clinical notes. Simple notes that can be pinned, linked to encounters, and filtered by type. HIPAA-sensitive: Contains PHI (Protected Health Information).
Custom name if using CUSTOM code, or override display name.
Category: 'indication' (medical reason) or 'goal' (health objective).
Retrieves a TreatmentIndication resource.
Replaces the TreatmentIndication resource.
Deletes the TreatmentIndication resource.
TreatmentIndication entity - Custom problem list for functional medicine. NOT ICD codes - these are wellness-oriented treatment categories. HIPAA-sensitive: Contains PHI (Protected Health Information).
Pharmacy entity - Dispensing pharmacy. Contains pharmacy information and API configuration for prescription transmission. Relationships: - OneToMany with PharmacyChannel (transmission channels with credentials) - OneToMany with Medication (pharmacy's drug catalog)
AI context - stores AI recommendation metadata when source=AI.
Where to ship the prescription (Patient address or Clinic for pickup).
UUID of the user who signed this prescription.
Display name of the signer for audit trail.
UUID of the scribe who performed the signing action on behalf of the provider.
Display name of the proxy signer (preserved if user deleted).
UUID of the user who entered this prescription (scribe attribution).
Display name of the user who entered this prescription.
Context type used when creating the prescription.
When the clinical context was set for this prescription.
Prescription entity - Core business object for medication orders. Represents a prescription written by a provider for a patient, to be filled by a pharmacy.
Retrieves a PrescriptionAuditLog resource.
PrescriptionDraft entity - Draft prescriptions created from e-commerce orders. These are auto-generated from SKU mappings and require provider review before becoming actual prescriptions. HIPAA-sensitive: Contains PHI (Protected Health Information).
ProductSku entity - Maps e-commerce SKUs to internal Medications. Each SKU is unique within its source platform.
Raw order items from e-commerce (e.g., SKUs).
AI Analysis result from RxGenie or other AI services.
QueueItem entity - Represents an item in the provider review queue. Queue items are created when prescriptions need provider review. AI analysis (RxGenie) results are stored in the aiAnalysis JSON field. HIPAA-sensitive: Contains PHI (Protected Health Information).
Retrieves the collection of Appointment resources.
Retrieves the collection of BillingPeriod resources.
The collection of BillingPeriod resources
Retrieves the collection of Invoice resources.
Retrieves the collection of Clinic resources.
Retrieves the collection of Provider resources.
Retrieves the collection of EcommerceOrder resources.
The collection of EcommerceOrder resources
Retrieves the collection of SkuMapping resources.
Retrieves the collection of Encounter resources.
Retrieves the collection of Medication resources.
Retrieves the collection of BusinessUnit resources.
The collection of BusinessUnit resources
Retrieves the collection of Organization resources.
The collection of Organization resources
Retrieves the collection of Patient resources.
Retrieves the collection of PatientChartNote resources.
The collection of PatientChartNote resources
Retrieves the collection of TreatmentIndication resources.
The collection of TreatmentIndication resources
Retrieves the collection of Pharmacy resources.
Retrieves the collection of Prescription resources.
The collection of Prescription resources
Retrieves the collection of PrescriptionAuditLog resources.
The collection of PrescriptionAuditLog resources
Retrieves the collection of PrescriptionDraft resources.
The collection of PrescriptionDraft resources
Retrieves the collection of ProductSku resources.
Retrieves the collection of QueueItem resources.
The message associated with the violation