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

application/json

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/

HTTPcURLJavaScriptPython

POST /patients/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1172

{
  "id": "text",
  "firstName": "text",
  "lastName": "text",
  "middleName": "text",
  "birthDate": "2026-02-07",
  "timeZone": "text",
  "gender": "MALE",
  "email": "[email protected]",
  "mobileNumber": "text",
  "authenticationId": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "city": "text",
  "state": "text",
  "addresses": [
    {
      "id": 1,
      "title": "text",
      "line1": "text",
      "line2": "text",
      "country": "text",
      "state": "text",
      "district": "text",
      "city": "text",
      "addressType": "text",
      "zipCode": "text",
      "deleted": true
    }
  ],
  "zipCode": "text",
  "country": "text",
  "secondaryEmail": "[email protected]",
  "secondaryPhone": "text",
  "regionName": "text",
  "territory": "text",
  "mrn": "text",
  "department": "text",
  "cdts": [
    {
      "name": "text",
      "id": "text",
      "multiRecord": true,
      "records": [
        {
          "id": "text",
          "fields": [
            {
              "key": "text",
              "value": "text"
            }
          ]
        }
      ]
    }
  ],
  "isDependant": true,
  "isPrimary": true,
  "attributes": null,
  "lastLoginAt": "2026-02-07",
  "active": true,
  "profilePicCloudId": "text",
  "organizationId": 1,
  "guardian": {
    "guardianUuid": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "text",
    "lastName": "text",
    "mobileNumber": "text",
    "email": "[email protected]",
    "timeZone": "text",
    "organizationId": 1,
    "consumerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "isPrimary": true,
    "isPersonOfContact": true
  }
}

200Success

{
  "id": "1",
  "firstName": "John",
  "lastName": "Doe",
  "middleName": "Michael",
  "birthDate": "1990-01-01",
  "timeZone": "GMT",
  "gender": "MALE",
  "email": "[email protected]",
  "mobileNumber": "[phone]",
  "addressLine1": "123 Main St",
  "addressLine2": "Apt 4B",
  "city": "New York",
  "state": "NY",
  "zipCode": "10001",
  "country": "USA",
  "regionName": "Northeast",
  "consumerUuid": "uuid-1234",
  "territory": "Territory 1",
  "secondaryEmail": "[email protected]",
  "secondaryPhone": "+0987654321",
  "mrn": "MRN123456",
  "department": "Cardiology",
  "organizationId": 123,
  "isPatient": true,
  "isPrimary": true,
  "relationship": [
    "Parent",
    "Sibling"
  ],
  "cdts": [],
  "dependants": [],
  "guardians": [],
  "patientPrograms": [],
  "addresses": [],
  "attributes": {},
  "lastLoginAt": "2023-01-01T00:00:00Z",
  "profilePicFileId": 456,
  "profilePicture": "profile-pic-url",
  "profilePicFile": {
    "id": 1,
    "name": "text",
    "resource": null,
    "cloudId": "text",
    "cloudUrl": "text",
    "scanStatus": "text",
    "mimeType": "text",
    "createdAt": "2026-02-07",
    "updatedAt": "2026-02-07",
    "attributes": {},
    "archived": true,
    "healthRecordAttributeFile": [
      {
        "id": 1,
        "fileId": 1,
        "healthRecordAttributeId": 1
      }
    ],
    "labels": {},
    "relatedFiles": [
      {
        "id": 1,
        "name": "text",
        "resource": null,
        "cloudId": "text",
        "cloudUrl": "text",
        "scanStatus": "text",
        "mimeType": "text",
        "createdAt": "2026-02-07",
        "updatedAt": "2026-02-07",
        "attributes": {},
        "archived": true,
        "healthRecordAttributeFile": [
          {
            "id": 1,
            "fileId": 1,
            "healthRecordAttributeId": 1
          }
        ],
        "labels": {},
        "relatedFiles": [
          {
            "id": 1,
            "name": "text",
            "resource": null,
            "cloudId": "text",
            "cloudUrl": "text",
            "scanStatus": "text",
            "mimeType": "text",
            "createdAt": "2026-02-07",
            "updatedAt": "2026-02-07",
            "attributes": {},
            "archived": true,
            "healthRecordAttributeFile": [
              {
                "id": 1,
                "fileId": 1,
                "healthRecordAttributeId": 1
              }
            ],
            "labels": {},
            "relatedFiles": "[Circular Reference]",
            "isRelatedFile": true,
            "updatedBy": {}
          }
        ],
        "isRelatedFile": true,
        "updatedBy": {}
      }
    ],
    "isRelatedFile": true,
    "updatedBy": {}
  }
}

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

application/json

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/

HTTPcURLJavaScriptPython

POST /service-provider-patients/ HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 1172

{
  "id": "text",
  "firstName": "text",
  "lastName": "text",
  "middleName": "text",
  "birthDate": "2026-02-07",
  "timeZone": "text",
  "gender": "MALE",
  "email": "[email protected]",
  "mobileNumber": "text",
  "authenticationId": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "city": "text",
  "state": "text",
  "addresses": [
    {
      "id": 1,
      "title": "text",
      "line1": "text",
      "line2": "text",
      "country": "text",
      "state": "text",
      "district": "text",
      "city": "text",
      "addressType": "text",
      "zipCode": "text",
      "deleted": true
    }
  ],
  "zipCode": "text",
  "country": "text",
  "secondaryEmail": "[email protected]",
  "secondaryPhone": "text",
  "regionName": "text",
  "territory": "text",
  "mrn": "text",
  "department": "text",
  "cdts": [
    {
      "name": "text",
      "id": "text",
      "multiRecord": true,
      "records": [
        {
          "id": "text",
          "fields": [
            {
              "key": "text",
              "value": "text"
            }
          ]
        }
      ]
    }
  ],
  "isDependant": true,
  "isPrimary": true,
  "attributes": null,
  "lastLoginAt": "2026-02-07",
  "active": true,
  "profilePicCloudId": "text",
  "organizationId": 1,
  "guardian": {
    "guardianUuid": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "text",
    "lastName": "text",
    "mobileNumber": "text",
    "email": "[email protected]",
    "timeZone": "text",
    "organizationId": 1,
    "consumerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "isPrimary": true,
    "isPersonOfContact": true
  }
}

200Success

{
  "id": "1",
  "firstName": "John",
  "lastName": "Doe",
  "middleName": "Michael",
  "birthDate": "1990-01-01",
  "timeZone": "GMT",
  "gender": "MALE",
  "email": "[email protected]",
  "mobileNumber": "[phone]",
  "addressLine1": "123 Main St",
  "addressLine2": "Apt 4B",
  "city": "New York",
  "state": "NY",
  "zipCode": "10001",
  "country": "USA",
  "regionName": "Northeast",
  "consumerUuid": "uuid-1234",
  "territory": "Territory 1",
  "secondaryEmail": "[email protected]",
  "secondaryPhone": "+0987654321",
  "mrn": "MRN123456",
  "department": "Cardiology",
  "organizationId": 123,
  "isPatient": true,
  "isPrimary": true,
  "relationship": [
    "Parent",
    "Sibling"
  ],
  "cdts": [],
  "dependants": [],
  "guardians": [],
  "patientPrograms": [],
  "addresses": [],
  "attributes": {},
  "lastLoginAt": "2023-01-01T00:00:00Z",
  "profilePicFileId": 456,
  "profilePicture": "profile-pic-url",
  "profilePicFile": {
    "id": 1,
    "name": "text",
    "resource": null,
    "cloudId": "text",
    "cloudUrl": "text",
    "scanStatus": "text",
    "mimeType": "text",
    "createdAt": "2026-02-07",
    "updatedAt": "2026-02-07",
    "attributes": {},
    "archived": true,
    "healthRecordAttributeFile": [
      {
        "id": 1,
        "fileId": 1,
        "healthRecordAttributeId": 1
      }
    ],
    "labels": {},
    "relatedFiles": [
      {
        "id": 1,
        "name": "text",
        "resource": null,
        "cloudId": "text",
        "cloudUrl": "text",
        "scanStatus": "text",
        "mimeType": "text",
        "createdAt": "2026-02-07",
        "updatedAt": "2026-02-07",
        "attributes": {},
        "archived": true,
        "healthRecordAttributeFile": [
          {
            "id": 1,
            "fileId": 1,
            "healthRecordAttributeId": 1
          }
        ],
        "labels": {},
        "relatedFiles": [
          {
            "id": 1,
            "name": "text",
            "resource": null,
            "cloudId": "text",
            "cloudUrl": "text",
            "scanStatus": "text",
            "mimeType": "text",
            "createdAt": "2026-02-07",
            "updatedAt": "2026-02-07",
            "attributes": {},
            "archived": true,
            "healthRecordAttributeFile": [
              {
                "id": 1,
                "fileId": 1,
                "healthRecordAttributeId": 1
              }
            ],
            "labels": {},
            "relatedFiles": "[Circular Reference]",
            "isRelatedFile": true,
            "updatedBy": {}
          }
        ],
        "isRelatedFile": true,
        "updatedBy": {}
      }
    ],
    "isRelatedFile": true,
    "updatedBy": {}
  }
}

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.