Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • WEBINARS
  • ARTERA ACADEMY
  • SUPPORT
  • RELEASES
  • STATUS PAGE
  • Home
  • Technical Specifications

External Communications Ingestion Extract Specifications

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Get Started
    Getting Help Post-Implementation
  • Release Notes
  • Triggers
  • Patient Channel
    Managing Appointments
  • Troubleshooting and FAQ
  • Patient Facesheet
  • Technical Specifications
    Artera Foundation Artera-Specific Features EMR Specifications
  • Insights & Analytics
    Insights Analytics Plus Self Service Analytics
  • Collaborative Inbox
  • Conversation Flows
  • Campaigns
  • Lines & Resources Requests
  • Lines, Events, Resources
  • SMS Basics
  • Automations
    Appointment Automations Inbound Message Automations Recall Automations Referral Automations
  • Referrals
  • Add-Ons
    Call-To-Text/Abandoned Calls Community Outreach
  • Users and Groups
  • Platform Settings and Configuration
    Settings Forms
  • Self-Rescheduling
  • Recalls
  • Marketplace
+ More

Table of Contents

ID Matching and Patient Information File Format Data Elements

ID Matching and Patient Information

Artera must be provided with a single, unique identifier for each patient and External Communication between all External Communication flat files. The IDs for Location, Provider and, Appointment, if sending these values in the file, must match values sent for other Artera integrations (API, HL7, etc). For example, if the provider's internal EPM ID is sent on an HL7 feed, the EPM ID should also be sent in the extract (rather than, say, the NPI).

Artera uses the Patient ID to associate the External Communication data to an existing patient in Artera. Therefore, the Patient ID in the file needs to match the ID type for patients we are receiving through other integrations. If a patient ID already exists in Artera, the patient demographic information will not be updated by the External Communication extract.

If a Patient ID does not exist yet in Artera, a new patient record will be created. If you intend to use the External Communication extract to create new patients in Artera, please provide as much information for the patient in the extract as possible in the respective fields (contact information, language preference, preferred name, etc)

Artera uses these IDs for matching in order to update the associated information with that ID, such as a patient’s name. If different IDs are provided for the same Resource value (i.e. a provider), duplicate Resources will appear in Artera. If IDs are shared between any two values, information will be overwritten with the latest received for that ID.

If an External Communication ID already exists in Artera, any new file with that External Communication ID will overwrite any existing information in Artera for that External Communication with the information contained in the CSV.

File Format

The file sent to Artera should be in .CSV format to avoid formatting issues. Each row of the file should represent one External Communication. A column must be present for each and every data element listed in the below table, even if you are not sending data in that field. 

Be sure to leave a blank column in order to prevent formatting issues. 

Data Elements

The table below contains all of the data elements that can be included in the External Communication extract. The first column of the table contains the name of each field and the second contains a description of that field. The actual CSV does not need to contain a header row. The third column indicates whether the field is required.


Field

Description

Required?

externalPatientId

Patient unique identifier

Required

patientFirstName

Patient first name

Optional

patientLastName

Patient last name

Optional

patientPreferredName

Patient's preferred first name

Optional

patientNumber

Patient/guarantor phone number that a message or phone call was sent to

Recommended

patientEmail

Patient/guarantor email address that a message was sent to

Optional

preferredLanguage

The preferred language of the patient

Optional

zipcode

Patient zipcode

Optional

communicationId

Communication unique identifier

Required

communicationDate

The date and time that the sms, email or phone call was delivered to the patient

Required

communicationType

The type of communication that was sent to the patient/guarantor

Optional

communicationCategory

The category of the message that was sent to the patient/guarantor

Optional

communicationSubject

Subject line of communication if applicable (likely mainly for email comm's)

Optional

communicationBody

The body of the communication

Optional

communicationTo

Name of communication recipient

Optional

communicationSentFrom

Internal system or staff user the communication was sent from

Optional

communicationContext

Additional context about why or where the communication was sent

Optional

communicationSource

Name of vendor who sent the message to the patient

Optional

externalPhoneNumber

The outgoing phone number the message was sent from

Optional

locationId

External location ID the communication was affiliated with

Optional

locationName

Location name the communication was affiliated with

Optional

locationType

Location type the communication was affiliated with

Optional

providerID

External provider ID the communication was affiliated with

Optional

providerName

Provider name the communication was affiliated with

Optional

appointmentID

Patient unique appointment identifier

Optional

appointmentDate

Date of the appointment that triggered the communication

Optional

specialtyId

Patient's address, city

Optional

specialtyName

Patient's address, state

Optional

specifications ingestion

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Automation Filters
  • Link Shortening and Third-Party Shorteners
  • {eventInstructions} Smart Phrase
© 2024 Artera. All Rights Reserved.
Privacy Policy | Terms of Service | Cookie Policy | Do Not Sell My Personal Information

Knowledge Base Software powered by Helpjuice

Expand