External Communications Ingestion Extract Specifications
- Get Started
- Release Notes
- Automations
- Patient Channel
- Troubleshooting and FAQ
- Patient Facesheet
- Technical Specifications
- Insights & Analytics
- Collaborative Inbox
- Conversation Flows
- Campaigns
- Lines & Resources Requests
- Lines, Events, Resources
- SMS Basics
- Triggers
- Referrals
- Add-Ons
- Users and Groups
- Platform Settings and Configuration
- Self-Rescheduling
- Recalls
- Marketplace
- Pulse Outreach
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.