Elation Health · Schema

Patient

Elation Health patient profile object

EHRElectronic Health RecordsPrimary CareHealthcareFHIRClinicalPatientsPrescriptionsMessaging

Properties

Name Type Description
id integer Unique patient identifier
first_name string Patient's given name
middle_name string Patient's middle name
last_name string Patient's family name
actual_name string Preferred name variation
suffix string Name suffix
dob string Date of birth (YYYY-MM-DD)
sex string Biological sex classification
gender_identity string Personal sense of gender
legal_gender_marker string Document gender marker
pronouns string Personal pronouns
sexual_orientation string Patient's sexual orientation
primary_physician integer ID of physician providing care within practice
caregiver_practice integer Practice providing patient care
ssn string Social Security Number
race string Racial category
ethnicity string Hispanic/Latino status
preferred_language string Patient's preferred communication language
preferred_contact string Preferred contact method
notes string Additional notes about patient
vip boolean VIP status flag
sms_opt_in_status boolean SMS consent status
verified boolean Patient verification status
address object Street address
phones array
emails array
emergency_contact object Emergency contact information
guarantor object Financial guarantor details
insurances array Active insurance policies
deleted_insurances array Historical insurance records
tags array Patient labels/classifications
patient_status object Status tracking
preference object Pharmacy preferences
primary_care_provider integer Internal ID of collaborator representing patient's external PCP
primary_care_provider_npi string NPI identifier for patient's primary care provider
previous_name object Prior name information
master_patient integernull Linked master patient record
employer object Employment information (Enterprise-only)
consents array Healthcare information sharing consents
metadata object Custom metadata
created_date string Record creation timestamp
deleted_date stringnull Record deletion timestamp
merged_into_chart integernull Target patient ID if merged
View JSON Schema on GitHub

JSON Schema

elation-patient-schema.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/elation/main/json-schema/elation-patient-schema.json",
  "title": "Patient",
  "description": "Elation Health patient profile object",
  "type": "object",
  "required": ["first_name", "last_name", "dob", "primary_physician", "caregiver_practice", "sex"],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "Unique patient identifier",
      "readOnly": true
    },
    "first_name": {
      "type": "string",
      "maxLength": 70,
      "description": "Patient's given name"
    },
    "middle_name": {
      "type": "string",
      "maxLength": 50,
      "description": "Patient's middle name"
    },
    "last_name": {
      "type": "string",
      "maxLength": 70,
      "description": "Patient's family name"
    },
    "actual_name": {
      "type": "string",
      "maxLength": 150,
      "description": "Preferred name variation"
    },
    "suffix": {
      "type": "string",
      "maxLength": 20,
      "description": "Name suffix"
    },
    "dob": {
      "type": "string",
      "format": "date",
      "description": "Date of birth (YYYY-MM-DD)"
    },
    "sex": {
      "type": "string",
      "enum": ["Female", "Male", "Other", "Unknown"],
      "description": "Biological sex classification"
    },
    "gender_identity": {
      "type": "string",
      "enum": ["man", "woman", "nonbinary", "transgender_man", "transgender_woman", "prefer_not_to_say"],
      "description": "Personal sense of gender"
    },
    "legal_gender_marker": {
      "type": "string",
      "enum": ["M", "F", "X", "U"],
      "description": "Document gender marker"
    },
    "pronouns": {
      "type": "string",
      "enum": ["he_him_his", "she_her_hers", "they_them_theirs", "not_listed"],
      "description": "Personal pronouns"
    },
    "sexual_orientation": {
      "type": "string",
      "enum": ["straight", "gay", "lesbian", "bisexual", "queer", "asexual", "unknown"],
      "description": "Patient's sexual orientation"
    },
    "primary_physician": {
      "type": "integer",
      "description": "ID of physician providing care within practice"
    },
    "caregiver_practice": {
      "type": "integer",
      "description": "Practice providing patient care"
    },
    "ssn": {
      "type": "string",
      "maxLength": 37,
      "description": "Social Security Number"
    },
    "race": {
      "type": "string",
      "description": "Racial category"
    },
    "ethnicity": {
      "type": "string",
      "description": "Hispanic/Latino status"
    },
    "preferred_language": {
      "type": "string",
      "description": "Patient's preferred communication language"
    },
    "preferred_contact": {
      "type": "string",
      "enum": ["sms", "email", "phone", "passport"],
      "description": "Preferred contact method"
    },
    "notes": {
      "type": "string",
      "maxLength": 500,
      "description": "Additional notes about patient"
    },
    "vip": {
      "type": "boolean",
      "description": "VIP status flag"
    },
    "sms_opt_in_status": {
      "type": "boolean",
      "description": "SMS consent status",
      "readOnly": true
    },
    "verified": {
      "type": "boolean",
      "description": "Patient verification status"
    },
    "address": {
      "type": "object",
      "description": "Street address",
      "properties": {
        "address_line1": {"type": "string"},
        "address_line2": {"type": "string"},
        "city": {"type": "string"},
        "state": {"type": "string", "maxLength": 2},
        "zip": {"type": "string"}
      }
    },
    "phones": {
      "type": "array",
      "maxItems": 2,
      "items": {
        "type": "object",
        "properties": {
          "phone": {"type": "string"},
          "phone_type": {"type": "string", "enum": ["Home", "Work", "Cell", "Fax"]}
        }
      }
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {"type": "string", "format": "email"}
        }
      }
    },
    "emergency_contact": {
      "type": "object",
      "description": "Emergency contact information"
    },
    "guarantor": {
      "type": "object",
      "description": "Financial guarantor details"
    },
    "insurances": {
      "type": "array",
      "maxItems": 2,
      "description": "Active insurance policies",
      "items": {"type": "object"}
    },
    "deleted_insurances": {
      "type": "array",
      "maxItems": 5,
      "description": "Historical insurance records",
      "readOnly": true,
      "items": {"type": "object"}
    },
    "tags": {
      "type": "array",
      "maxItems": 10,
      "items": {"type": "string"},
      "description": "Patient labels/classifications"
    },
    "patient_status": {
      "type": "object",
      "description": "Status tracking",
      "properties": {
        "status": {"type": "string", "enum": ["Active", "Inactive", "Prospect", "Deceased"]},
        "reason": {"type": "string"},
        "deleted_date": {"type": "string", "format": "date-time"}
      }
    },
    "preference": {
      "type": "object",
      "description": "Pharmacy preferences"
    },
    "primary_care_provider": {
      "type": "integer",
      "description": "Internal ID of collaborator representing patient's external PCP",
      "readOnly": true
    },
    "primary_care_provider_npi": {
      "type": "string",
      "maxLength": 10,
      "description": "NPI identifier for patient's primary care provider"
    },
    "previous_name": {
      "type": "object",
      "description": "Prior name information"
    },
    "master_patient": {
      "type": ["integer", "null"],
      "description": "Linked master patient record"
    },
    "employer": {
      "type": "object",
      "description": "Employment information (Enterprise-only)"
    },
    "consents": {
      "type": "array",
      "description": "Healthcare information sharing consents",
      "readOnly": true,
      "items": {"type": "object"}
    },
    "metadata": {
      "type": "object",
      "description": "Custom metadata"
    },
    "created_date": {
      "type": "string",
      "format": "date-time",
      "description": "Record creation timestamp",
      "readOnly": true
    },
    "deleted_date": {
      "type": ["string", "null"],
      "format": "date-time",
      "description": "Record deletion timestamp",
      "readOnly": true
    },
    "merged_into_chart": {
      "type": ["integer", "null"],
      "format": "int64",
      "description": "Target patient ID if merged",
      "readOnly": true
    }
  }
}