Get Patient Details

Python

import requests

url = 'https://api.miramace.com/v1/patient/d7038030-aa24-4b89-a076-23c3fd29df34'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "first_name": "Jane",
  "last_name": "Doe",
  "date_of_birth": "1990-01-15",
  "phone_number": "+14155555555",
  "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"
      }
    ],
    "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"
      }
    ]
  },
  "created_at": "2024-03-20T08:00:00Z",
  "updated_at": "2024-03-20T08:00:00Z"
}

GET

patient

{patient_id}

Python

import requests

url = 'https://api.miramace.com/v1/patient/d7038030-aa24-4b89-a076-23c3fd29df34'
headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[email protected]",
  "first_name": "Jane",
  "last_name": "Doe",
  "date_of_birth": "1990-01-15",
  "phone_number": "+14155555555",
  "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"
      }
    ],
    "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"
      }
    ]
  },
  "created_at": "2024-03-20T08:00:00Z",
  "updated_at": "2024-03-20T08:00:00Z"
}

Path Parameters

patient_id

string<uuid>

required

The ID of the patient to retrieve UUID of the patient to retrieve

Example:

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

Response

Patient details retrieved successfully

string<email>

Email address of the patient

first_name

string

First name of the patient

Example:

"Jane"

last_name

string

Last name of the patient

Example:

"Doe"

date_of_birth

string<date>

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

Example:

"1990-01-01"

phone_number

string

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

Example:

"+15555555555"

address

object

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"

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"

string<uuid>

UUID of the patient

Example:

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

project_id

string<uuid>

UUID of the project this patient belongs to

Example:

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

created_at

string<date-time>

Timestamp when the patient was created

updated_at

string<date-time>

Timestamp when the patient was last updated

Create Patient Create Task

⌘I

API Documentation

Patients

Tasks

Path Parameters

Response