Extended Data API: Appointments and Encounters

+ More

What is Extended Data API: Appointments and Encounters? Marketplace Vendor Smart Phrases How is Extended Data API: Appointments and Encounters API set up?FAQs

What is Extended Data API: Appointments and Encounters?

Artera’s Extended Data API allows customers and vendors to send custom content related to a patient’s upcoming or past appointment or encounter, such as post-discharge.

The custom content provided by the vendor is utilized through the use of Marketplace Vendor Smart Phrases, which can be placed in Outbound Messages from Artera.

Marketplace Vendor Smart Phrases can be inserted into Manual Messages, Quick Responses, Triggers, Conversation Flows, and Broadcasts. This allows Artera to control the timing, cadence, and message content associated with the Smart Phrase.

Patient Messaging Example

As these messages are delivered to patients through Manual Messaging, Quick Responses, Triggers, Conversation Flows, and Broadcasts, users can view these Outbound Messages in a Patient’s Channel.

Marketplace Vendor Smart Phrases

The following Smart Phrases can be inserted into messages to deliver customized content to patients.

Each Smart Phrase supports a different Marketplace category. For example, {eventPartnerPreCheckIn} is reserved for pre-check in workflows.

Extended Data API Appointment Smart Phrases	Extended Data API Encounter Smart Phrases
{eventPartnerPreCheckIn}	{dischargePartnerRx}
{eventPartnerPreQuestionnaire}
{eventPartnerPostApptSurvey}
{eventPartnerPostApptPayment}
{eventPartnerPostApptEdu}
{eventPartnerPostApptRx}
{eventPartnerRescheduling}

How is Extended Data API: Appointments and Encounters API 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, and set up a technical scoping conversation.

At a high-level, the Marketplace Vendor must provide the Appointment ID and/or Encounter ID. It is a requirement that the Appointment ID and/or Encounter ID we receive from your EMR and have stored in Artera matches the ID that the Marketplace Vendor provides in the Extended Data API call.

Your Artera Project Manager will confirm with the Marketplace Vendor that the Appointment and/or Encounter IDs they send matches Artera’s.

Operational Decisions

Your Artera Representative will work with you to determine which Artera Practice(s) will support the utilization of Marketplace Vendor Smart Phrases. This will inform which Triggers, Quick Responses, and other Artera Settings may need to be updated.

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.

FAQs

Where are the Extended Data API specifications located?

Extended Data API specifications can be accessed through Artera’s Developer Portal. To access the Developer Portal, you must first register for an account.

Can a separate Artera Shell Practice send Extended Data API messages?

No. Messages will be determined by the Appointment or Encounter ID and corresponding Location ID, meaning an existing Artera Practice is needed to support this functionality.

Does Extended Data API support Secure Messaging?

Yes, Artera’s Secure Message feature is available with Extended Data API. Customers are responsible for ensuring Outbound Messages to patients meet all HIPAA requirements.

Are languages besides English supported?

Yes. 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.

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

Yes, users can respond to Inbound Messages. However, if you are only supporting One-Way Messaging in your 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 Trigger to automatically close Patient Channels upon a patient sending in a message. Click here to learn more about Inbound Message Triggers.

Does Extended Data API work for email outreach to patients?

Yes. Extended Data API powers any Smart Phrases that would call it and that includes a Smart Phrase used to create an email. Please use standard Artera Triggers when voice outreach is required.

Can URLs be included in Outbound Messages to patients?

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

What if there is no value found for the Smart Phrase included in a message to the patient?

If there is no data available to fill the Smart Phrase, the message to the patient will still be sent. However, there will be no content in place of the Smart Phrase and it will display as a blank value to the patient.

Is Merged Messaging available with Extended Data API?

No. Event Smart Phrases populate with the first scheduled appointment’s details. In Merged Messaging, Smart Phrases will only reference one appointment. If you want to refer to multiple or all appointments in a text, you should not use Merged Messages for that Trigger.

interactions scheduler

Contact Us