Skip to content
Last updated

Verato API Reference

Purpose

This page defines how Verato APIs are structured across Entities and Domains, and how consumers should interpret domain-specific data models when integrating with the platform.

The goal is to provide a clear, consistent mental model for customers, partners, and internal teams – while allowing Verato to support multiple real‑world contexts without fragmenting the API surface.

Core Concepts

  1. Entity
    An Entity represents a real‑world object whose identity Verato resolves and manages. Verato currently supports the following entities:
  • Person
  • Provider
  • Organization
  1. Domain
    Represents a contextual view of an entity. Domains represent what some might define as the ‘role’ or ‘persona’ within the entity. Domains define:
  • Which attributes are applicable.
  • Which workflows and APIs apply.

Domains allow Verato to model the same real‑world entity differently based on how it is used, while preserving a single underlying identity.

Entity & Domain Model

Person Entity

The Person entity represents an individual human being. Verato supports multiple domains to reflect different usage contexts. Verato’s out-of-the-box configuration covers these pre-built Person domains:

DomainDescription
Core PersonCanonical representation of a person with general demographic attributes
PatientTeHealthcare‑specific view of a person used in clinical and care delivery context

Verato MDM Cloud can also be configured to add custom domains in addition to the pre-built domains. Examples of custom Person domains might include Member, Citizen, Consumer, or Prospect.

Key Notes

  • Patient domain extends Core Person
  • Some attributes (encounter identifiers, health insurance, etc…) exist only in Patient.

Provider Entity.

The Provider entity represents parties involved in delivering healthcare. This can include both individual human beings and organizations. In the case of individual human beings, the data attributes typically revolve around the practitioner’s professional life (work address, work-related identifiers) rather than their personal life (home address, personal identifier such as an SSN). In the case of organizations, the data attributes typically revolve around healthcare-specific details about an organization (specialty and NPI number for example). Verato’s out-of-the-box configuration covers these pre-built Provider domains:

DomainDescription
PractitionerIndividual clinicians or care providers
Health FacilityOrganizations or locations where care is delivered

Verato MDM Cloud can also be configured to add custom domains in addition to the pre-built domains. Examples of custom Provider domains might include Nurses or Community Service Organizations.

Organization Entity

The Organization entity represents non‑clinical organizations. Verato’s out-of-the-box configuration covers this pre-built Organization domain:

DomainDescription
Core OrganizationCanonical organizational identity

Verato MDM Cloud can also be configured to add custom domains in addition to the pre-built domains. Examples of custom Organization domains might include Institutional Clients or Vendors.

API Model

Verato APIs are organized using an Entity‑first structure:

  • Entities represent what is being identified.
  • Domains represent how that entity is used. Domains do not fragment identity—they contextualize it
Verato APIs
Person APIs
• Core Person Domain
• Patient Domain
Provider APIs
• Practitioner (Type-1) Domain
• Health Facility (Type-2) Domain
Organization APIs
• Core Organization Domain