Creating a Consumer

Consumers are the primary end-users of the platform, including patients, healthcare providers (HCPs), guardians, and dependents. These users interact with the platform to manage their health data, communicate with service providers, and access care services. Each consumer has a role aligned with their relationship to the platform, whether as a patient receiving care or as a guardian managing dependents.

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

Ways to Create a Consumer

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

Adds a new patient to the system

Body
idstringOptional
firstNamestringOptional
lastNamestringOptional
middleNamestringOptional
birthDateone ofOptional
string · dateOptional
or
string · date-timeOptional
timeZonestringOptional
genderstring · enumOptionalPossible values:
emailstring · emailOptional
mobileNumberstringOptional
authenticationIdstringOptional
addressLine1stringOptional
addressLine2stringOptional
citystringOptional
statestringOptional
zipCodestringOptional
countrystringOptional
secondaryEmailstring · emailOptional
secondaryPhonestringOptional
regionNamestringOptional
territorystringOptional
mrnstringOptional
departmentstringOptional
isDependantbooleanOptional
isPrimarybooleanOptional
attributesanyOptional
lastLoginAtone ofOptional
string · dateOptional
or
string · date-timeOptional
activebooleanOptional
profilePicCloudIdstringOptional
organizationIdnumberOptional
Responses
200Success
application/json
post
/patients/
200Success

  1. Service Provider-Generated Consumer: Enables healthcare providers and staff to create consumer accounts directly, particularly useful during initial onboarding or intake processes.

Create patient

post

Creates a new patient record

Body
idstringOptional
firstNamestringOptional
lastNamestringOptional
middleNamestringOptional
birthDateone ofOptional
string · dateOptional
or
string · date-timeOptional
timeZonestringOptional
genderstring · enumOptionalPossible values:
emailstring · emailOptional
mobileNumberstringOptional
authenticationIdstringOptional
addressLine1stringOptional
addressLine2stringOptional
citystringOptional
statestringOptional
zipCodestringOptional
countrystringOptional
secondaryEmailstring · emailOptional
secondaryPhonestringOptional
regionNamestringOptional
territorystringOptional
mrnstringOptional
departmentstringOptional
isDependantbooleanOptional
isPrimarybooleanOptional
attributesanyOptional
lastLoginAtone ofOptional
string · dateOptional
or
string · date-timeOptional
activebooleanOptional
profilePicCloudIdstringOptional
organizationIdnumberOptional
Responses
200Success
application/json
post
/service-provider-patients/
200Success

Configuration and Authentication

Consumers are authenticated using OAuth2 to ensure secure access to the platform. Each primary consumer (patients or guardians) must have a unique identifier, such as an email or phone number, for smooth authentication. Non-primary consumers, like dependents, can share credentials with their guardians to facilitate easier management.

Last updated