Messaging API (MAPI)

+ More

What is Messaging API (MAPI)? How will MAPI Deliver Messages?Can MAPI Deliver Secure Messages? What is the Benefit of MAPI?How is MAPI set up?Artera MAPI with Epic Artera MAPI with other EMRs FAQs

What is Messaging API (MAPI)?

Artera’s Messaging API (MAPI) provides Artera with the ability to deliver text messages to patients that are generated from your organization's EMR or one of Artera’s Marketplace Vendors. By using your EMR to generate the message, the EMR is leveraged 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 MAPI Deliver Messages?

Artera will deliver the message to the destination phone number sent on the API call from your organization'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.

Can MAPI Deliver Secure Messages?

Yes, MAPI supports Secure Messaging only for Verified Patients. When sending Secure Messages through MAPI, patient response webhooks are sent when the patient responds to the message via the Secure Messaging Portal.

Note: Your organization is responsible for ensuring outbound messages meet all HIPAA requirements for Unverified Patients.

What is the Benefit of MAPI?

MAPI inserts messages into conversations used by staff and patients to coordinate care on phone numbers (Lines) that are 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 MAPI 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, and make the operational decisions necessary to support your workflow. You will then connect to Artera’s API Demo and Production endpoints. These endpoints will be provided to you by Artera during implementation.

Operational Decisions

Your Artera Representative will work with you to determine which Artera Practice(s), whether existing or new, will drive patient messaging. This is an operational decision that must be made and will vary from organization-to-organization based on what best supports your patient communication strategy and technical capabilities.

This table will help guide your implementation decisions:

	New Shell Practice	Existing Practices
Benefits	All messages are viewable in a single Practice If a patient opts-out of messaging, they would only opt out of that individual Line rather than opting out of the Line that also sends their Appointment Reminders Potential for higher-level of control and may be better suited for Enterprises that drive messaging through a Contact Center	Messages are delivered from a recognizable phone number that is also used to deliver Appointment Automations Staff Users can view all messages and directly address patient questions This provides the most streamlined patient experience
Considerations	Messages are delivered from a different Line than Appointment Automations, reducing recognizability from patients Staff Users in other Practices will not be able to view these messages when communicating with patients. This is less seamless and does not allow users to address questions directly	If a patient opts-out of messaging, they would be opting out of all messaging from that Line, which would include their Appointment Reminders This may not be best suited for Enterprises that use a Call Center to support this type of messaging

Settings Configuration

The Artera Settings, if any, that need to be updated will depend on the operational decisions your Enterprise made to support your MAPI workflows. Your Artera Representative will help guide you through this process.

During Implementation

Evening before Go-Live

Create Users

Note: Staff and Manager Users will immediately receive email notifications about their User Account after their User Profile is created in Artera.

Disable or Enable Channel Closure Inbound Messaging Automations
Update Practice or Line Hours
Update After-Hours-Auto Response
Update Permissions

Artera MAPI with Epic

Customers are able to leverage SMS integration points with MyChart and OpTime Epic applications with MAPI by sending E0A records. Your Artera team will provide you with the necessary documentation on how to configure these E0A records within Epic.

Review the table below to see which Use Cases other Artera customers have successfully implemented with MAPI:

Use Case	Description
OpTime Family Notifications	Uses Epic’s Surgical Module to send texts to family members of the patient while the patient is in surgery to indicate when the patient enters surgery, their progress, when the patient is moved to the recovery room, ready for visitors, etc.
MyChart Notifications	Rather than sending email ticklers or push notifications to patients, send MyChart notifications to patients as text messages regarding new lab results, 2FA, important messages from physician, new prescription refill, etc.
MyChart Instant Activation	Send patients MyChart Activation links from Epic to their phone number in order to facilitate efficient, easy MyChart enrollment.

Delete

NOTE: The exact message content and timing will be determined by your organization’s operational workflow and Epic configuration.

Artera MAPI with other EMRs

Use Case	Description
Portal Notifications	Rather than sending email ticklers or push notifications to patients, send portal notifications to patients as text messages regarding new lab results, important messages from physician, new prescription refill, etc.
Patient Surveys	Gather survey feedback from your patients.

FAQs

Our organization is familiar with SendMessage API (SMAPI). How does this differ from Messaging API (MAPI)?

MAPI leverages Auth 2.0 and includes an option to send back a Deliverability Webhook, whereas SMAPI does not. Delivery statuses help to indicate whether an outbound message to the patient sent through the MAPI was received, sent, delivered, undelivered, or failed.

How do we configure MAPI?

For technical specifications and documentation, visit Artera’s Developer Portal. To access the Developer Portal, you must first register for an account.

Is a separate Artera Practice always required for MAPI?

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.

Can users respond back to Inbound Messages from patients who respond to a message sent to them through the MAPI?

Yes, users can respond to Inbound Messages. However, if you are only supporting One-Way Messaging in your MAPI Practice, then your team should update the Practice’s Settings so that 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, MAPI 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 MAPI?

Messages sent through MAPI 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 MAPI.

Can URLs be included in our messages?

Yes, URLs are permitted in posts to the MAPI. They will be shortened according to the rules configured for the Enterprise.

Is Merged Messaging available with MAPI?

No, Merged Messaging is not available with MAPI. This Artera feature requires messages to be known about in advance in order to manage their delivery behavior. As MAPI is a real-time messaging service, merging is not possible.

api smapi sendmessage api optime family messaging surgery updates mapi

Contact Us