Data Source
Kareo
Create a New Data Flow
-
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.
-
Select the Kareo connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Kareo instance, and click Next; or, create a new Kareo credential for use in this flow.
-
In Nexla, Kareo Clinical API data sources can be created using pre-built endpoint templates, which expedite source setup for common Kareo Clinical API endpoints. Each template is designed specifically for the corresponding Kareo Clinical API endpoint, making data source setup easy and efficient.
• To configure this source using a template, follow the instructions in Configure Using a Template.Kareo Clinical API sources can also be configured manually, allowing you to ingest data from Kareo Clinical API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
• To configure this source manually, follow the instructions in Configure Manually.
Configure Using a Template
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Kareo Clinical API endpoints. Each template is designed specifically for the corresponding Kareo Clinical API endpoint, making data source setup easy and efficient.
Endpoint Settings
-
Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.
Endpoint Testing
Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.
-
To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.
-
If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.
Configure Manually
Kareo Clinical API sources can also be configured manually, allowing you to ingest data from Kareo Clinical API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
First, select the method that will be used for calls to the Kareo API from the Method pulldown menu. The Kareo API primarily uses the following methods:
- GET: For retrieving data such as patients, providers, appointments, charges, and transactions.
- POST: For creating new records such as patients, encounters, and appointments.
- PUT: For updating existing records in Kareo.
API Endpoint URL
-
Enter the URL of the Kareo API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (
https://) and any required path parameters.Kareo's web services API base URL is
https://webservice.kareo.com/services/soap/2.1/KareoServices.svc. Common data retrieval endpoints include paths for patients, providers, appointments, charges, transactions, encounters, service locations, procedure codes, and practices.
Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. For a complete list of available Kareo API endpoints and their parameters, refer to the Tebra Help Center API documentation.
Date/Time Macros (API URL)
Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements.
Date/time macros are particularly useful when ingesting time-sensitive Kareo data, such as appointments scheduled within a specific date range or charges created after a certain date.
-
To add a macro, type
{at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.{now}– The current datetime{now-1}– The datetime one time unit before the current datetime{now+1}– The datetime one time unit after the current datetimecustom– Datetime macros can reference any number of time units before or after the current datetime—for example, enter(now-4)to indicate the datetime four time units before the current datetime
-
Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of
{now}in{now-1}. -
Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro
{now-1}, whenDayis selected,{now-1}will be converted to the datetime one day before the current datetime.
Lookup-Based Macros (API URL)
Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.
Lookup-based macros are useful when you need to create Kareo API endpoints that reference specific patient IDs, provider IDs, or other identifiers from data already available in your Nexla environment.
-
To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.
-
Type
{at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.
Path to Data
If only a subset of the data returned by the Kareo API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful because Kareo API responses often contain metadata, pagination information, or wrapper objects alongside the actual record data.
For example, when fetching a list of patients, the Kareo API typically returns an array of patient records nested within a response envelope. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as an individual record.
Path to Data is essential when working with Kareo API responses that have nested structures, such as responses that wrap records inside GetPatientsResp, GetAppointmentsResp, or similar envelope objects. Without specifying the correct path, Nexla might not be able to properly parse and organize the data into usable records.
-
To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.
-
For responses in JSON format, enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g.,
$.Patients.PatientData[*]to access an array of patient records within a Patients object). -
For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g.,
/GetPatientsResp/Patients/PatientDatato access patient records within the response).
Path to Data Example:If the Kareo API response is in JSON format and returns a top-level object named
Patientscontaining an array namedPatientData, the path to the response would be entered as$.Patients.PatientData[*]. -
Autogenerate Path Suggestions
Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.
-
To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.
-
Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.
Metadata
If metadata is included in the Kareo API response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but is not part of the main data array.
For example, when fetching a list of charges, the Kareo API response may include summary counts or request context metadata alongside the charge records themselves. By specifying a path to this metadata, you can include it with each record in the generated Nexset(s).
Metadata paths are particularly useful for preserving Kareo API response context such as total record counts, request timestamps, or practice-level information that applies to all records in the response.
-
To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.
- For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.
Request Headers
-
If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g.,
header1:value1,header2:value2). Additional headers may be required for API versioning or content type specifications when working with the Kareo API.You do not need to include any headers already present in the credentials. The Kareo Customer Key, Username, and Password authentication headers are handled automatically by Nexla based on your credential configuration.
Endpoint Testing
After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows you to verify that the source is configured correctly before saving.
-
To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.
-
If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.
Save & Activate the Source
- Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Kareo data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.