Artera Extended Data API

A Marketplace-vendor API that attaches custom partner content to a patient's upcoming or past appointment or encounter, including post-discharge content. Vendors call Artera with Appointment and/or Encounter IDs that must match the EMR records already stored in Artera, together with the corresponding Location ID, and the supplied content is rendered into Artera messages through named Smart Phrase tokens — {eventPartnerPreCheckIn}, {eventPartnerPostApptRx}, {eventPartnerRescheduling}, {eventPartnerTelehealth}, {eventPartnerCheckIn} for appointments and {dischargePartnerRx} for encounters. The tokens can be used in manual messages, Quick Responses, Triggers, Conversation Flows and Broadcasts; missing data renders blank and the message still sends. Specification access requires developer-portal registration.

API entry from apis.yml

apis.yml Raw ↑
name: Artera Extended Data API
description: A Marketplace-vendor API that attaches custom partner content to a patient's upcoming or
  past appointment or encounter, including post-discharge content. Vendors call Artera with Appointment
  and/or Encounter IDs that must match the EMR records already stored in Artera, together with the corresponding
  Location ID, and the supplied content is rendered into Artera messages through named Smart Phrase tokens
  — {eventPartnerPreCheckIn}, {eventPartnerPostApptRx}, {eventPartnerRescheduling}, {eventPartnerTelehealth},
  {eventPartnerCheckIn} for appointments and {dischargePartnerRx} for encounters. The tokens can be used
  in manual messages, Quick Responses, Triggers, Conversation Flows and Broadcasts; missing data renders
  blank and the message still sends. Specification access requires developer-portal registration.
humanURL: https://knowledge.artera.io/en_US/marketplace/extended-data-api-appointments-and-encounters
baseURL: https://api.artera.io
tags:
- Appointments
- Encounters
- Healthcare
- Marketplace
- Patient Engagement
properties:
- type: Documentation
  url: https://knowledge.artera.io/en_US/marketplace/extended-data-api-appointments-and-encounters
- type: DeveloperPortal
  url: https://apidocs.artera.io/login
- type: Authentication
  url: authentication/artera-authentication.yml