Consumer Configuration Guide
Overview
This document provides standardized guidance for configuring consumers using Azodha's APIs. Consumers are the primary end-users of the platform, including patients, healthcare providers (HCPs), guardians, and dependents. Each consumer has a specific role aligned with their relationship to the platform.
Consumer Types
Patients: Individuals receiving healthcare services
Healthcare Proxies (HCPs): Individuals authorized to make healthcare decisions for others
Guardians: Individuals managing care for dependents
Dependents: Individuals whose healthcare is managed by guardians
Creation Methods
There are two standard methods for creating consumers in the system:
1. Self Sign-Up
Enables consumers to register themselves using OAuth2 credentials configured in the platform. This method provides user autonomy and self-service capabilities.
Implementation Requirements
Unique identifier (email or phone number) for authentication
OAuth2 integration for secure authentication
Proper validation of required fields
Consent and privacy policy acceptance tracking
Create a New Patient
POST /api/v1/patients/
This endpoint is used to create a new Patient
Headers
Content-Type
application/json
Authorization
Bearer <token>
organization_code
Organization Code
Body
At least one contact method (email or mobile number) must be provided
firstName
string
Consumer's first name
Yes
lastName
string
Consumer's last name
Yes
email
string
Valid email address
Yes*
mobileNumber
string
Valid phone number
Yes*
birthDate
date
Date of birth (YYYY-MM-DD)
Yes
gender
enum
MALE, FEMALE, OTHERS, UNKNOWN
Yes
middleName
string
Consumer's middle name
timeZone
string
Consumer's time zone
addressLine1
string
Primary address line
addressLine2
string
Secondary address line
city
string
City of residence
state
string
State/province of residence
zipCode
string
Postal/ZIP code
country
string
Country of residence
secondaryEmail
string
Backup email address
secondaryPhone
string
Backup phone number
regionName
string
Geographic region
territory
string
Specific territory
mrn
string
Medical Record Number
department
string
Related department
isDependant
boolean
Whether consumer is a dependent
isPrimary
boolean
Whether consumer is primary account holder
organizationId
number
Associated organization ID
profilePicCloudId
string
Cloud ID for profile picture
Response
2. Service Provider-Generated
It enables healthcare providers and staff to create consumer accounts directly, which is particularly useful during initial onboarding or intake processes.
Implementation Requirements
Service provider authentication and authorization
Mandatory fields validation
System-generated notification to the consumer
Temporary access credentials generation
Create a New Patient as a Service Provider
POST/api/v1/service-providers/patients/
This endpoint is used to create a new Patient
Headers
Content-Type
application/json
Authorization
Bearer <token>
organization_code
Organization Code
Body
At least one contact method (email or mobile number) must be provided
firstName
string
Consumer's first name
Yes
lastName
string
Consumer's last name
Yes
email
string
Valid email address
Yes*
mobileNumber
string
Valid phone number
Yes*
birthDate
date
Date of birth (YYYY-MM-DD)
Yes
gender
enum
MALE, FEMALE, OTHERS, UNKNOWN
Yes
middleName
string
Consumer's middle name
timeZone
string
Consumer's time zone
addressLine1
string
Primary address line
addressLine2
string
Secondary address line
city
string
City of residence
state
string
State/province of residence
zipCode
string
Postal/ZIP code
country
string
Country of residence
secondaryEmail
string
Backup email address
secondaryPhone
string
Backup phone number
regionName
string
Geographic region
territory
string
Specific territory
mrn
string
Medical Record Number
department
string
Related department
isDependant
boolean
Whether consumer is a dependent
isPrimary
boolean
Whether consumer is primary account holder
organizationId
number
Associated organization ID
profilePicCloudId
string
Cloud ID for profile picture
Response
Configuration Components
Guardian-Dependent Relationships
Guardians can manage healthcare for dependents who cannot do so themselves. Each dependent must be linked to at least one guardian through the guardian object. The relationship establishes access controls and permissions for healthcare management. Primary guardians receive all notifications and can make decisions, while secondary guardians have limited access based on configured permissions.
Custom Data Templates (CDTs)
The platform supports Custom Data Templates (CDTs) for organization-specific data requirements. CDTs provide a flexible framework for storing specialized information that doesn't fit into the standard consumer model. Each CDT has a unique identifier, can be configured for single or multiple records, and supports custom field definitions for capturing domain-specific information.
Multiple Address Management
Consumers can maintain multiple addresses (home, work, billing, etc.) through the structured address object. Each address can be categorized by type, marked as primary or secondary, and includes standard location information. The system allows efficient address management with search capabilities by type, region, or purpose.
Last updated