Aidbox User Docs
CtrlK
Run Aidbox locallyRun Aidbox in SandboxTalk to us Ask community
  • Aidbox FHIR Platform Documentation
    • Features
    • Architecture
  • Getting Started
    • Run Aidbox in Sandbox
    • Run Aidbox Locally
    • Run Aidbox on AWS
    • Upload Sample Data
  • Tutorials
    • CRUD, Search Tutorials
      • Delete Data
      • Set up Uniqueness in Resource
      • Search Tutorials
        • Custom SearchParameter Tutorial
        • Create Custom Aidbox Search Resource
        • Multilingual Search Tutorial
        • Migrate from Aidbox SearchParameter to FHIR SearchParameter
        • Change Sort Order by Locale Collation
    • Bulk API Tutorials
      • Synthea by Bulk API
      • $dump-sql tutorial
    • Security and Access Control Tutorials
      • Allow Patients to See Their Own Data
      • Restrict Operations on Resource Type
      • Relationship-based Access Control
      • Creating User and Set up Full User Access
      • Restricting Access to Patient Data
      • Create and Test Access Control
      • RBAC
        • Flexible RBAC Built-in to Aidbox
        • RBAC with JWT Containing Role
        • RBAC with ACL
      • Set-up Token Introspection
      • Prohibit User to Login
      • Managing Admin Access to the Aidbox UI Using Okta Groups
      • Run Multibox Locally
      • How to Enable Labels-Based Access Control
      • How to Enable Patient Data Access API
      • How to Enable SMART on FHIR on Patient Access API
      • How to Enable Hierarchical Access Control
      • How to Configure FHIR Audit Log
      • How Is an HTTP Request Processed in Aidbox
      • How to Configure SSO with Another Aidbox Instance to Access Aidbox UI
      • How to Configure SSO with Okta to Access Aidbox UI
      • How to Configure Sign-in with Apple for Access to the Aidbox UI
      • How to Configure Azure AD SSO for Access to the Aidbox UI
      • How to Configure Microsoft AD FS for Access to the Aidbox UI
      • How to Configure Azure AD SSO with Certificate Authentication for Access to the Aidbox UI
      • How to Configure GitHub SSO for Access to Aidbox UI
      • How to Configure Keycloak for Access for AidboxUI
      • How to Implement Consent-based Access Control Using FHIR Search and Aidbox Access Policy
      • Debug Access Control
      • AccessPolicy Best Practices
      • How to Configure Basic Auth Flow
      • How to Configure Authorization Code Grant
      • How to Configure Client Credentials Grant
      • How to Configure Implicit Grant
      • How to Configure Token Exchange
      • How to Configure Resource Owner Grant Flow
      • Configuring Two Factor Authentication in Aidbox Identity Provider
      • SSO with External OAuth Identity Provider
    • Terminology Tutorials
      • Load ICD-10 Terminology into Aidbox
      • Uploading IG Terminology Content to External FHIR Terminology Server
      • Local Terminlogy
    • Validation Tutorials
      • Upload FHIR Implementation Guide
        • Environment Variable
        • Aidbox UI
          • IG Package from Aidbox Registry
          • Public URL to IG Package
          • Local IG Package
        • Aidbox FHIR API
        • UploadFIG Tool
      • ISiK
      • Carin BB
      • US Core
      • Davinci Pdex
      • mCode
    • Integration Toolkit Tutorials
      • Postmark Integration Tutorial
      • Mailgun Integration Tutorial
    • Subscriptions Tutorials
      • Kafka AidboxTopicDestination
      • ClickHouse AidboxTopicDestination
      • Tutorial: Produce QuestionnaireResponse to Kafka Topic
      • GCP Pub/Sub AidboxTopicDestination
      • Webhook AidboxTopicDestination
      • AidboxTopicSubscription NATS Tutorial
    • Other Tutorials
      • Run Aidbox with FHIR R6
      • Migrate from Multibox to Aidbox
      • SDC with Custom Resources
      • How to Create FHIR NPM Package
      • Migrate from Legacy Licence Portal to Aidbox Portal
      • Set up Aidbox with Postman
      • How to Run Aidbox in GCP Cloud Run
      • How to Run Aidbox Using a Different Java Version
  • Overview
    • Licensing and Support
    • Aidbox User Portal
      • Projects
      • Licenses
      • Members
    • Aidbox UI
      • Aidbox Notebooks
      • REST Console
      • Database Console
      • Attrs Stats
      • DB Tables
      • DB Queries
    • Versioning
    • Release Notes
    • FAQ
    • Contact Us
  • Configuration
    • Settings
    • Configure Aidbox and Multibox
    • Init Bundle
  • API
    • API Overview
    • REST API
      • CRUD
        • Create
        • Read
        • Update
        • Patch
        • Delete
      • FHIR Search
        • SearchParameter
        • Include and Revinclude
        • Chaining
      • Aidbox Search
      • Bundle
      • History
      • $everything on Patient
      • Other
        • Aidbox and FHIR Formats
        • Capability Statement
        • $document
        • Observation/$lastn
        • $validate
        • SQL Endpoints
        • $matcho
        • $to-format
        • Aidbox Version
        • Health Check
    • Bulk API
      • Configure Access Policies for Bulk API
      • $dump
      • $dump-sql
      • $dump-csv
      • $export
      • $load and /fhir/$load
      • $import and /fhir/$import
      • Aidbox.bulk Data Import
      • Bulk Import from an S3 Bucket
    • Batch/Transaction
    • GraphQL API
    • Other APIs
      • Plan API
        • Provider Directory API
          • Practitioner
          • PractitionerRole
          • Organization
          • OrganizationAffiliation
        • Plan API Overview
      • Archive/Restore API
        • Create-Archive
        • Restore-Archive
        • Prune-Archived-Data
        • Delete-Archive
      • ETAG Support
      • Cache
      • Changes API
      • RPC API
      • Sequence API
      • Encryption API
      • Batch Upsert
  • Access Control
    • Overview
    • Identity Management
      • User Management
      • Application/Client Management
    • Authentication
      • Basic HTTP Authentication
      • OAuth 2.0
      • Token Introspector
      • SSO with External Identity Provider
    • Authorization
      • Access Policies
      • SMART on FHIR
        • SMART Client Authorization
          • SMART App Launch
          • SMART Backend Services
        • SMART Client Authentication
          • SMART: Asymmetric (/"private Key JWT") Authentication
          • SMART: Symmetric (/"client Secret") Authentication
        • SMART: Scopes for Limiting Access
        • Pass Inferno Tests with Aidbox
        • Example: SMART App Launch Using Aidbox and Keycloak
        • Example: SMART App Launch Using Smartbox and Keycloak
      • Scoped API
        • Organization-based Hierarchical Access Control
        • Compartments API
        • Patient Data Access API
      • Label-based Access Control
    • Audit and Logging
  • Artifact Registry
    • Artifact Registry Overview
    • Define Extensions
      • Extensions Using StructureDefinition
      • Extensions Using FHIRSchema
    • Custom Resources
      • Custom Resources Using FHIR Schema
      • Custom Resources Using StructureDefinition
      • Migrate to FHIR Schema
        • Migrate Custom Resources Defined with Entity and Attributes to FHIR Schema
        • Migrate Custom Resources Defined with Zen to FHIR Schema
  • Terminology Module
    • Terminology Overview
    • FHIR Terminology
      • Coded Values
      • CodeSystem
      • ValueSet
      • ConceptMap
      • Profiles, Binding, and Validation
    • Aidbox Terminology Module
      • Setup
      • Hybrid Mode
      • Capabilities
  • Database
    • Database Overview
    • PostgreSQL Requirements
    • Database Schema
    • PostgreSQL Extensions
    • AidboxDB
      • HA AidboxDB
    • Tutorials
      • Migrate to AidboxDB 16
      • Working with pgAgent
  • Modules
    • Profiling and Validation
      • FHIR Schema Validator
        • Supported FHIR Implementation Guides (IGs)
        • Setup Aidbox with FHIR Schema Validation Engine
      • Skip Validation of References in Resource Using Request Header
      • Asynchronous Resource Validation
    • Observability
      • Getting Started
        • Run Aidbox with OpenTelemetry Locally
        • How to Export Telemetry to the OTEL Collector
      • Logs
        • How-to Guides
          • OpenTelemetry Logs
          • Elastic Logs and Monitoring Integration
          • Datadog Log Management Integration
          • Loki Log Management Integration
        • Tutorials
          • Log Analysis and Visualization Tutorial
          • Export Logs to Datadog Tutorial
        • Extending Aidbox Logs
        • Technical Reference
          • Log Appenders
          • Log Transformations
          • Log Schema
          • OTEL Logs Exporter Parameters
      • Metrics
        • How-to Guides
          • How to Export Metrics to the OTEL Collector
          • Use Aidbox Metrics Server
          • Set-up Grafana Integration
        • Technical Reference
          • OpenTelemetry Metrics
          • OTEL Metrics Exporter Parameters
      • Traces
        • How to Use Tracing
        • OTEL Traces Exporter Parameters
    • Subscriptions
      • Aidbox Topic-Based Subscriptions
      • Aidbox SubSubscriptions
    • Aidbox Forms
      • Getting Started
      • Aidbox Forms Interface
      • Aidbox UI Builder
        • UI Builder Interface
        • AI Assistant
        • Form Creation
          • Form Settings
          • Widgets
          • Components
          • Versioning
          • Form Customisation in Theme Editor
          • Form Signature
          • How-to Guides
            • How to: Populate Forms with Data
            • How to Extract Data from Forms
            • How to Calculate Form Filling Percentage
            • How to Create a Form with Dynamical Answers into Questions
          • Multilingual Forms
          • FHIRPath Expressions with Visual Editor
          • Data Extraction
          • Population
        • Import Questionnaire
        • Form Sharing
        • Printing Forms
          • Template-based PDF Generation
        • FHIR Versions
        • Offline Forms
        • Embedding
          • Request Interception
        • Configuration
        • Forms Multitenancy
        • Building Reports Using SQL on FHIR
        • Integration with External Terminology Servers
        • External FHIR Servers as a Data Backend
        • Store Attachments in S3-like Storages
      • Access Control in Forms
      • Audit Logging in Forms
      • Aidbox Form Gallery
    • Aidbox Terminology Module
      • Concept
        • $translate-concepts
        • Handling Hierarchies Using Ancestors
      • ValueSet
        • ValueSet Expansion
        • ValueSet Code Validation
        • Create a ValueSet
      • CodeSystem
        • CodeSystem Concept Lookup
        • CodeSystem Subsumption Testing
        • CodeSystem Code Composition
      • Import External Terminologies
        • Import Flat File (/CSV)
        • $import operation
        • Ready-to-use Terminologies
      • $translate on ConceptMap
    • SQL on FHIR
      • $run operation
      • Defining Flat Views with View Definitions
      • Query Data from Flat Views
      • Reference
    • Integration Toolkit
      • C-CDA / FHIR Converter
        • List of Supported Templates
          • Admission Diagnosis Section (/V3)
          • Advance Directives Section (/Entries Optional) (/V3)
          • Advance Directives Section (/Entries Required) (/V3)
          • Allergies and Intolerances Section (/Entries Optional) (/V3)
          • Allergies and Intolerances Section (/Entries Required) (/V3)
          • Assessment Section
          • Chief Complaint Section
          • Chief Complaint and Reason for Visit Section
          • Complications Section (/V3)
          • Course of Care Section
          • DICOM Object Catalog Section - DCM 121181
          • Default Section Rules
          • Discharge Diagnosis Section (/V3)
          • Document Header
          • Encounters Section (/Entries Optional) (/V3)
          • Encounters Section (/Entries Required) (/V3)
          • Family History Section (/V3)
          • Functional Status Section (/V2)
          • General Status Section
          • Goals Section
          • Health Concerns Section (/V2)
          • History of Present Illness Section
          • Hospital Consultations Section
          • Hospital Course Section
          • Hospital Discharge Instructions Section
          • Hospital Discharge Physical Section
          • Hospital Discharge Studies Summary Section
          • Immunizations Section (/Entries Optional) (/V3)
          • Immunizations Section (/Entries Required) (/V3)
          • Medical (/General) History Section
          • Medical Equipment Section (/V2)
          • Medications Administered Section (/V2)
          • Medications Section (/Entries Optional) (/V2)
          • Medications Section (/Entries Required) (/V2)
          • Mental Status Section (/V2)
          • Notes
          • Nutrition Section
          • Objective Section
          • Operative Note Fluids Section
          • Operative Note Surgical Procedure Section
          • Past Medical History (/V3)
          • Payers Section (/V3)
          • Plan of Treatment Section (/V2)
          • Postprocedure Diagnosis Section (/V3)
          • Preoperative Diagnosis Section (/V3)
          • Problem Section (/Entries Optional) (/V3)
          • Problem Section (/Entries Required) (/V3)
          • Procedure Description Section
          • Procedure Disposition Section
          • Procedure Estimated Blood Loss Section
          • Procedure Implants Section
          • Procedure Specimens Taken Section
          • Procedures Section (/Entries Optional) (/V2)
          • Procedures Section (/Entries Required) (/V2)
          • Reason for Visit Section
          • Results Section (/Entries Optional) (/V3)
          • Results Section (/Entries Required) (/V3)
          • Review of Systems Section
          • Social History Section (/V3)
          • Vital Signs Section (/Entries Optional) (/V3)
          • Vital Signs Section (/Entries Required) (/V3)
        • How to Deploy the Service
        • Producing C-CDA Documents
        • How to Customize Conversion Rules
      • HL7 v2 Integration
        • HL7 v2 Integration with Aidbox Project
        • Mappings with lisp/mapping
      • X12 Message Converter
      • Analytics
        • Power BI
      • Mappings
      • Email Providers Integration
        • Setup SMTP Provider
    • SMARTbox | FHIR API for EHRs
      • Get Started
        • Set up Smartbox Locally
        • Deploy Smartbox with Kubernetes
      • (/G)(/10) Standardized API for Patient and Population Services
      • The B11 Decision Support Interventions
        • Source Attributes
        • Feedback Sections
      • How-to Guides
        • Pass Inferno Tests with Smartbox
        • Perform EHR Launch
        • Pass Inferno Visual Inspection and Attestation
        • Revoke Granted Access
        • Set up EHR-level Customization
        • Check Email Templates
        • Setup Email Provider
        • Register Users
        • Set up SSO with Auth0
        • Publish Terms of Use Link Onto the Documentation Page
        • Find Out What Resources Were Exported During the $export Operation
        • Find Documentation Endpoint
      • Background Information
        • Considerations for Testing with Inferno ONC
        • Adding Clients for Inferno Tests
        • Multitenancy Approach
        • What Is Tenant
        • Email Templating
    • ePrescription
      • Getting Started
      • Authentication with mTLS
      • Pharmacies Synchronization
      • Prescribing
        • NewRx Message
        • CancelRx Message
        • How to Test Callback
      • Directory
        • DirectoryDownload Message
        • GetProviderLocation Message
        • AddProviderLocation Message
        • UpdateProviderLocation Message
        • DisableProviderLocation Message
      • Medications
        • FDB
      • References
        • Environment Variables
        • List of Metrics
      • Frequently Asked Questions
    • Other Modules
      • MDM
        • Train Model
        • Configure MDM Module
        • Find Duplicates: $match
        • Mathematical Details
      • MCP
      • AidboxTrigger
      • HL7v2
        • Getting Started
        • FHIR Resources
        • Default Mappings
        • Module Limitations
        • Message Lifecycle
  • File storage
    • AWS S3
    • GCP Cloud Storage
    • Azure Blob Storage
    • Oracle Cloud Storage
  • Deployment and maintenance
    • Deploy Aidbox
      • Run Aidbox on Kubernetes
        • Deploy Production-ready Aidbox to Kubernetes
        • Deploy Aidbox with Helm Charts
        • Highly Available Aidbox
        • Self-signed SSL Certificates
      • Run Aidbox on Managed PostgreSQL
      • How to Inject Env Variables into Init Bundle
    • Backup and Restore
      • Crunchy Operator (/Pgbackrest)
      • pg_dump
      • pg_basebackup
      • WAL-G
    • Indexes
      • Get Suggested Indexes
      • Create Indexes Manually
  • App development
    • Use Aidbox with React
    • Aidbox SDK
      • Aidbox JavaScript SDK
      • Apps
      • NodeJs SDK
      • Python SDK
    • Examples
  • Reference
    • Settings Reference
      • General
      • FHIR
      • Security and Access Control
      • Modules
      • Database
      • Web Server
      • Observability
      • Zen Project
    • System Resources Reference
      • IAM Module Resources
      • SDC Module Resources
      • Base Module Resources
      • Bulk Module Resources
      • AWF Module Resources
      • Cloud Module Resources
      • HL7v2 Module Resources
      • SQL on FHIR Module Resources
    • Environment Variables
      • Aidbox Required Environment Variables
      • Optional Environment Variables
      • AidboxDB Environment Variables
    • FHIR Schema Reference
    • Email Providers Reference
      • Notification Resource Reference
      • Mailgun Environment Variables
      • Postmark Environment Variables
    • Aidbox Forms Reference
      • FHIR SDC API
      • Aidbox SDC API
      • Generating Questionnaire from PDF API
    • Aidbox SQL Functions
    • Matcho DSL Reference
  • Deprecated
    • Deprecated
      • Zen-related
        • RPC Reference
          • Aidbox
            • Mdm
              • aidbox.mdm/update-mdm-tables
              • aidbox.mdm/match
        • FTR
        • Aidbox Configuration Project
          • Run Aidbox Locally Using Aidbox Configuraiton Project
          • Aidbox Configuration Project Structure
          • Set up and Use Configuration Projects
          • Enable IGs
          • Repository
          • Seed Import
          • Manage Indexes in Zen Project
          • Seed v2
          • Migrate to Git Aidbox Configuration Projects
          • Aidbox Configuration Project Reference
            • Zen Configuration
            • Aidbox Project RPC Reference
            • aidbox.config/config
          • Custom Resources Using Aidbox Project
          • First-Class Extensions Using Zen
          • Zen Indexes
        • US Core IG
          • US Core IG Support Reference
        • Workflow Engine
          • Task
            • Aidbox Built-in Tasks
            • Task Executor API
            • Task User API
          • Workflow
            • Workflow User API
          • Services
          • Monitoring
        • FHIR Conformance Deprecated Guides
          • Touchstone FHIR 4.0.1 Basic Server
          • Touchstone FHIR USCore ClinData
          • How to Enable US Core IG
            • Start Aidbox Locally with US Core IG Enabled
            • Add US Core IG to a Running Aidbox Instance
          • HL7 FHIR Da Vinci PDex Plan Net IG
        • Terminology Deprecated Tutorials
          • Inferno Test-Suite US Core 3.1.1
        • API Constructor (/Beta)
        • Zen-Lang Validator
          • Write a Custom Zen Profile
          • Load Zen Profiles into Aidbox
        • FHIR Topic-Based Subscriptions
          • Set up SubscriptionTopic
          • Tutorial: Subscribe to Topic (/R4B)
          • R4B API Reference
            • Subscription API
        • FHIR Terminology Repository
          • FTR Specification
          • Create an FTR Instance
            • FTR from CSV
            • FTR from FHIR IG
            • FTR from FTR — Direct Dependency
            • FTR from FTR — Supplement
          • FTR Manifest
          • Load SNOMED CT into Aidbox
          • Load LOINC into Aidbox
          • Load ICD-10-CM into Aidbox
          • Load RxNorm into Aidbox
          • Load US VSAC Package to Aidbox
          • Import via FTR
        • Zen Search Parameters
        • Access Control Lists (/ACL)
      • Entity / Attribute
        • Entities and Attributes
        • First-Class Extensions Using Attribute
        • Custom Resources Using Entity
        • Working with Extensions
        • Aidbox Search Parameters
      • Forms
      • Other
        • Custom Search
        • SearchQuery
        • Subscribe to New Patient Resource
        • App Development Deprecated Tutorials
          • Receive Logs from Your App
            • X-Audit Header
          • Patient Encounter Notification Application
        • Other Deprecated Tutorials
          • Resource Generation with Map-to-Fhir-Bundle-Task and Subscription Triggers
          • APM Aidbox
          • Automatically Archive AuditEvent Resources in GCP Storage Guide
          • HL7 v2 Pipeline with Patient Mapping
          • How to Migrate to Apline Linux
          • How to Migrate Transaction Id to Bigint
          • How to Fix Broken Dates
          • Configure Multi-Tenancy
        • AidboxProfile
        • GCP Pub/Sub
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Modules
  2. ePrescription

Prescribing

NewRx MessageCancelRx MessageHow to Test Callback
PreviousPharmacies SynchronizationNextNewRx Message

Was this helpful?