Create Patient

Python

import requests

url = 'https://api.miramace.com/v1/patient'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
payload = {
    'project_id': '123e4567-e89b-12d3-a456-426614174000',
    'phone_number': '+15555555555',
    'email': '[email protected]',
    'first_name': 'Jane',
    'last_name': 'Doe',
    'date_of_birth': '1990-01-15',
    'address': {
        'street_name': '123 Market Street',
        'city': 'San Francisco',
        'state': 'CA',
        'postal_code': '94105',
        'country_code': 'US'
    },
    'primary_care_provider': {
        'name': 'Dr. Sarah Smith',
        'practice': 'SF Medical Group'
    },
    'insurance': {
        'medical': [
            {
                'company_name': 'Blue Cross Blue Shield',
                'member_id': 'BCB123456789',
                'group_number': 'GRP987654',
                'plan_name': 'PPO Gold',
                'phone_number': '+18005551234',
                'relationship_to_subscriber': 'SELF',primary_subscriber: {
                    'first_name': 'Jane',
                    'last_name': 'Doe'
                }
            },
            {
                'company_name': 'Aetna',
                'member_id': 'AET987654321',
                'group_number': 'GRP456789',
                'plan_name': 'HMO Silver',
                'phone_number': '+18005559876',
                'relationship_to_subscriber': 'DEPENDENT',primary_subscriber: {
                    'first_name': 'John',
                    'last_name': 'Doe'
                }
            }
        ],
        'dental': [
            {
                'company_name': 'Delta Dental',
                'member_id': 'DDB123456789',
                'group_number': 'GRPD123',
                'plan_name': 'Premier Plan',
                'phone_number': '+18005553456',
                'relationship_to_subscriber': 'SELF'
            }
        ],
        'vision': [
            {
                'company_name': 'VSP',
                'member_id': 'VSP123456789',
                'group_number': 'GRPV123',
                'plan_name': 'Vision Care',
                'phone_number': '+18005554567',
                'relationship_to_subscriber': 'SELF'
            }
        ]
    }
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "123e4567-e89b-12d3-a456-426614174001"
}

POST

patient

Python

import requests

url = 'https://api.miramace.com/v1/patient'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}
payload = {
    'project_id': '123e4567-e89b-12d3-a456-426614174000',
    'phone_number': '+15555555555',
    'email': '[email protected]',
    'first_name': 'Jane',
    'last_name': 'Doe',
    'date_of_birth': '1990-01-15',
    'address': {
        'street_name': '123 Market Street',
        'city': 'San Francisco',
        'state': 'CA',
        'postal_code': '94105',
        'country_code': 'US'
    },
    'primary_care_provider': {
        'name': 'Dr. Sarah Smith',
        'practice': 'SF Medical Group'
    },
    'insurance': {
        'medical': [
            {
                'company_name': 'Blue Cross Blue Shield',
                'member_id': 'BCB123456789',
                'group_number': 'GRP987654',
                'plan_name': 'PPO Gold',
                'phone_number': '+18005551234',
                'relationship_to_subscriber': 'SELF',primary_subscriber: {
                    'first_name': 'Jane',
                    'last_name': 'Doe'
                }
            },
            {
                'company_name': 'Aetna',
                'member_id': 'AET987654321',
                'group_number': 'GRP456789',
                'plan_name': 'HMO Silver',
                'phone_number': '+18005559876',
                'relationship_to_subscriber': 'DEPENDENT',primary_subscriber: {
                    'first_name': 'John',
                    'last_name': 'Doe'
                }
            }
        ],
        'dental': [
            {
                'company_name': 'Delta Dental',
                'member_id': 'DDB123456789',
                'group_number': 'GRPD123',
                'plan_name': 'Premier Plan',
                'phone_number': '+18005553456',
                'relationship_to_subscriber': 'SELF'
            }
        ],
        'vision': [
            {
                'company_name': 'VSP',
                'member_id': 'VSP123456789',
                'group_number': 'GRPV123',
                'plan_name': 'Vision Care',
                'phone_number': '+18005554567',
                'relationship_to_subscriber': 'SELF'
            }
        ]
    }
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "123e4567-e89b-12d3-a456-426614174001"
}

Body

application/json

first_name

string

required

First name of the patient

Example:

"Jane"

last_name

string

required

Last name of the patient

Example:

"Doe"

phone_number

string

required

The phone number in E.164 format (e.g., +15555555555)

Example:

"+15555555555"

address

object

required

Show child attributes

address.street_name

string

required

Street address

Example:

"123 Main St"

address.city

string

required

City

Example:

"San Francisco"

address.state

string

required

State/province

Example:

"CA"

address.postal_code

string

required

Postal/ZIP code

Example:

"94105"

address.country_code

string

required

Two-letter country code

Example:

"US"

project_id

string<uuid>

required

UUID of the project this patient belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

string<email>

Email address of the patient

date_of_birth

string<date>

Date in ISO 8601 format (YYYY-MM-DD)

Example:

"1990-01-01"

primary_care_provider

object

Show child attributes

primary_care_provider.name

string

Name of the patient's primary care provider

primary_care_provider.practice

string

Practice name of the patient's primary care provider

insurance

object

Show child attributes

insurance.medical

object[]

Show child attributes

insurance.medical.company_name

string

The name of the insurance company

Example:

"Blue Cross Blue Shield"

insurance.medical.member_id

string

The member ID

Example:

"XYZ1234567"

insurance.medical.group_number

string

The group number

Example:

"GRP123456"

insurance.medical.plan_name

string

The plan name

Example:

"PPO Gold"

insurance.medical.phone_number

string | null

The phone number in E.164 format (e.g., +15555555555)

Example:

"+15555555555"

insurance.medical.relationship_to_subscriber

enum<string>

The relationship of the member to the primary subscriber

Available options:

RELATIONSHIP_TO_SUBSCRIBER_UNSPECIFIED,

SELF,

SPOUSE,

DEPENDENT

Example:

"SELF"

insurance.medical.primary_subscriber

object

Show child attributes

insurance.medical.primary_subscriber.first_name

string

The first name of the primary subscriber

Example:

"John"

insurance.medical.primary_subscriber.last_name

string

The last name of the primary subscriber

Example:

"Doe"

insurance.dental

object[]

Show child attributes

insurance.dental.company_name

string

The name of the insurance company

Example:

"Blue Cross Blue Shield"

insurance.dental.member_id

string

The member ID

Example:

"XYZ1234567"

insurance.dental.group_number

string

The group number

Example:

"GRP123456"

insurance.dental.plan_name

string

The plan name

Example:

"PPO Gold"

insurance.dental.phone_number

string | null

The phone number in E.164 format (e.g., +15555555555)

Example:

"+15555555555"

insurance.dental.relationship_to_subscriber

enum<string>

The relationship of the member to the primary subscriber

Available options:

RELATIONSHIP_TO_SUBSCRIBER_UNSPECIFIED,

SELF,

SPOUSE,

DEPENDENT

Example:

"SELF"

insurance.dental.primary_subscriber

object

Show child attributes

insurance.dental.primary_subscriber.first_name

string

The first name of the primary subscriber

Example:

"John"

insurance.dental.primary_subscriber.last_name

string

The last name of the primary subscriber

Example:

"Doe"

insurance.vision

object[]

Show child attributes

insurance.vision.company_name

string

The name of the insurance company

Example:

"Blue Cross Blue Shield"

insurance.vision.member_id

string

The member ID

Example:

"XYZ1234567"

insurance.vision.group_number

string

The group number

Example:

"GRP123456"

insurance.vision.plan_name

string

The plan name

Example:

"PPO Gold"

insurance.vision.phone_number

string | null

The phone number in E.164 format (e.g., +15555555555)

Example:

"+15555555555"

insurance.vision.relationship_to_subscriber

enum<string>

The relationship of the member to the primary subscriber

Available options:

RELATIONSHIP_TO_SUBSCRIBER_UNSPECIFIED,

SELF,

SPOUSE,

DEPENDENT

Example:

"SELF"

insurance.vision.primary_subscriber

object

Show child attributes

insurance.vision.primary_subscriber.first_name

string

The first name of the primary subscriber

Example:

"John"

insurance.vision.primary_subscriber.last_name

string

The last name of the primary subscriber

Example:

"Doe"

Response

Patient created successfully

string<uuid>

UUID of the created patient

Example:

"123e4567-e89b-12d3-a456-426614174001"

Advanced Capabilities Get Patient Details

⌘I

API Documentation

Patients

Tasks

Body

Response