v2
latestOpenAPI 3.0.02026-07-2632977728.5 KBCreate messages in doctor's message center
Query parameters
Response
Created
Type Description
Patient Middle Name
ID of /api/users who owns the message, who may be the doctor themselves or one of their staff members
Responsible User First Name
Doctor Last Name
Owner First Name
If true, indicates that the message has been soft-deleted
Owner Last Name
Patient First Name
Files are passed using multipart/form-data encoding, but returned as URLs.
Outgoing fax recipient fax number
Responsible User Last Name
| Value | Description |
|---|---|
| "GP" | Generated PDF |
| "GC" | Generated CSV |
| "GZ" | Generated ZIP |
| "IF" | Incoming Fax |
| "OF" | Outgoing Fax |
| "IL" | Incoming Labs |
| "IR" | Inbound Referrals |
| "OR" | Outbound Referrals |
| "IE" | Incoming eRx |
| "OA" | Online Appointments |
| "PO" | Patient Onboarding |
| "PI" | Patient Incoming Message |
| "PM" | Patient Outgoing Message |
| "OO" | Demo Meeting Message |
| "OD" | Outbound Direct Message |
| "ID" | Inbound Direct Message |
Patient Last Name
ID of patient that the message concerns, if applicable
Doctor First Name
ID of /api/users who has been assigned to process the message, who may be the doctor themselves or one of their staff members
Used by doctors and their staff to keep track of what step of processing the message is in
Outgoing fax recipient name
Doctor Middle Name