Skip to main content

Alleva Custom Field Mapping Using the V2 Data Facet API (CRM)

Overview

Alleva custom fields — such as those created inside named forms in the Admission Screening section of the Alleva EMR — cannot be mapped through the standard Alleva field mapping UI in Dazos CRM. Instead, these fields are exposed through Alleva's V2 Data Facet API, which allows Dazos to discover and pull custom field data into the CRM.

This capability is available on eligible Dazos instances and is configured by the Dazos Support or Implementation team. It is a read-only (GET) operation — data can be pulled from Alleva into the CRM, but values cannot be posted back to Alleva custom forms through this method.

Key Concepts

  • Data Facet API: Alleva's V2 API architecture used to discover and retrieve custom form fields. The integration queries GET v2/data-facet to identify each custom field's uuid and datakind.

  • Custom Forms in Admission Screening: Before any custom field can be pulled via the API, it must be set up as part of a named form within Alleva's Admission Screening section. Fields that exist outside of a named form cannot be retrieved.

  • Read-Only Sync: This integration reads data from Alleva and writes it to the CRM. Changes made in Dazos CRM are not posted back to Alleva custom forms.

  • Field Type Mapping: Different Alleva custom field types correspond to different value types in the API payload. Mapping must account for the correct value type for each field.

  • Alleva Swagger Documentation: Alleva's full API reference is available at https://api.allevasoft.com/swagger/index.html. This is the authoritative source for identifying available endpoints and field structures.

How It Works

When the Dazos integration is configured to use the V2 Data Facet API, it follows this workflow:

  1. Metadata Discovery: The integration queries GET v2/data-facet to retrieve the list of available custom fields from Alleva. Each field is identified by its uuid and datakind.

  2. Field Type Identification: Based on the field's type in Alleva, the integration maps to the correct value type in the API response:

  3. Data Pull: The integration retrieves the field values for each patient record and writes them to the corresponding CRM fields on the Intake Opportunity or Contact record.

  4. CRM Field Mapping: Each Alleva custom field is mapped to a matching CRM field. The CRM field must already exist before the mapping can be configured.

Examples of fields commonly mapped using this method include:

  • Intake / Clinical: Intake Conditions, Substance of Choice (and Notes), Current Medications, Mental Health / Medical Issues, MAT

  • Demographics: Race, Ethnicity, Gender Identity, Sexual Orientation, Preferred Pronouns, Preferred Language, Religion

  • Logistics: Preferred Method of Contact, Living Situation, Resident Type, Employment Status, Medicaid Type, Drivers License details

Important Notes

Custom forms must be created in Alleva first. Before Dazos can pull any custom field data, the fields must be added to a named form within Alleva's Admission Screening section. If a field is not part of a form, it will not be discoverable via the Data Facet API. Coordinate with your Alleva administrator or the Alleva support team to confirm forms are in place before requesting mapping.

This is a GET-only operation. Data flows from Alleva into Dazos CRM only. You cannot use this method to write values back to Alleva custom forms from the CRM.

This feature requires setup by Dazos Support. Custom field mapping via the V2 Data Facet API is not configurable through the standard CRM mapping UI. Contact Dazos Support to request configuration on your instance.

Alleva Swagger documentation is required. To identify the correct endpoint names, uuid values, and field types for your specific Alleva instance, request the Swagger documentation from Alleva or access it directly at https://api.allevasoft.com/swagger/index.html.

Eligibility: This capability was built as a new feature (reference: SUPPORT-4092) and is available on eligible Dazos instances. Contact Dazos Support to confirm availability for your instance.

If you need assistance setting up Alleva custom field mapping via the V2 Data Facet API, contact Dazos Support and include the names of the Alleva form(s) and the specific fields you would like mapped.

Did this answer your question?