SendMessage API
- Get Started
- Automations
- Patient Channel
- Patient Facesheet
- Collaborative Inbox
- Lines & Resources Requests
- Lines, Events, Resources
- Analytics
- Platform Settings and Configuration
- Users and Groups
- Campaigns
- SMS Basics
- Troubleshooting and FAQ
- Conversation Builder
- Add-Ons
- Release Notes
- Technical Specifications
- Referrals
- Self-Rescheduling
- Recalls
- Marketplace
Table of Contents
What is Artera SendMessage API (SMAPI)? How will SMAPI Deliver Messages? What is the Benefit of SMAPI?How is SMAPI set up?Artera SMAPI with EpicArtera SMAPI with other EMRsFAQsWhat is Artera SendMessage API (SMAPI)?
Artera SendMessage API (SMAPI) provides Artera with the ability to deliver text messages to patients that are generated from a customer’s EMR. By using the customer’s EMR to generate the message, customers will leverage their EMR to determine which patients qualify for messages, when messages will be sent, which triggers will qualify to send messages, and what information those messages will contain.
How will SMAPI Deliver Messages?
Artera will deliver the message to the destination phone number sent on the API call from the customer’s EMR even if the phone number does or does not belong to a known patient in Artera. Delivered messages appear in a Verified Patient Channel when the patient is known and in an Unverified Patient Channel when the patient is not known. Click here to learn more about Verified vs Unverified Patients.
What is the Benefit of SMAPI?
SMAPI inserts messages into conversations used by staff and patients to coordinate care on Lines already familiar to patients, unifying touch points across the patient journey in a single thread. This allows organizations to deliver messages with high redundancy and reliability, driving increases in patient engagement.
How is SMAPI set up?
Please connect with your Customer Success Representative. Artera will work with you to understand your desired use cases, scope out the necessary workflows, set up a technical scoping conversation, and walk you through how to authorize your organization’s EMR to send messages through Artera.
At a high-level, you will provide your IP addresses, procure various API Keys, create a new Artera SendMessage API Practice(s), and configure new Line(s). All API calls will be made to a single Artera Practice. You will then connect to Artera’s API Demo and Production endpoints. These endpoints will be provided to you by Artera during implementation.
Artera SMAPI with Epic
Customers are able to leverage SMS integration points with MyChart and OpTime Epic applications with SMAPI by sending E0A records. Review the table below to see which Use Cases other Artera customers have successfully implemented with SMAPI:
NOTE: The exact message content and timing will be determined by your organization’s operational workflow and Epic configuration.
Artera SMAPI with other EMRs
FAQs
Is a separate Artera Practice always required for SMAPI?
Not always–this will be determined by the information a customer’s EMR is able to send to Artera. For example, not all EMRs support sending Location IDs through the API, which means a separate Practice is needed. This will be reviewed during technical scoping.
Does SendMessage API support Secure Messaging?
No, Artera’s Secure Message feature is not available with SendMessage API. Your organization is responsible for ensuring outbound messages meet all HIPAA requirements.
Can users respond back to Inbound Messages from patients who respond to a message sent to them through the API?
No, your SendMessage API Practice will work like a One-Way Messaging Practice. This means that your team should update the Practice’s Settings so all 7 days are included in its Practice Hours and the open and close times are set from 1:00 AM-1:01 AM. Click here to learn more about Practice Settings.
You should also build an Inbound Message Automation to automatically close Patient Channels upon a patient sending in a message. Click here to learn more about Inbound Message Automations.
Are languages other than English supported?
As you are responsible for crafting the outbound message, you are therefore responsible for forming the message content in the correct language(s) and with any variable replacements you want presented to the patient.
Does this API work for voice or email?
No, SendMessage API is specifically for SMS messages. Please use standard Artera Automations when voice or email outreach is required.
How are TCPA hours and Holiday Hours supported with SendMessage API?
Messages sent through SendMessage API are sent nearly immediately. There are no adjustments to move your messages into TCPA (8:00am - 9:00pm) hours or to accommodate your Holiday Hours set in Artera.
If you need these features, we recommend using standard Artera Automations or embedding this logic within your application that is calling the API.
Can URLs be included in our messages?
Yes, URLs are permitted in posts to the API. They will be shortened according to the rules configured for the Enterprise.
Is Merged Messaging available with SendMessage API?
No, Merged Messaging is not available with Send Message API. This Artera feature requires messages to be known about in advance in order to manage their delivery behavior. As SendMessage API is a real-time messaging service, merging is not possible.