NameDescriptionTypeAdditional information
PatientID

Patient ID

string

Required

Max length: 255
MRN

Medical Record Number

string

Max length: 255
ExtID

External Patient ID

string

Max length: 255
AltID

Alternate Patient ID

string

Max length: 255
MedicareNumber

Medicare Number

string

Max length: 255
LastName

Last Name

string

Required

Max length: 255
FirstName

First Name

string

Required

Max length: 255
MiddleName

Middle Name

string

Max length: 255
Suffix

Suffix (e.g. Jr.)

string

Max length: 255
DateOfBirth

Date of Birth

string

Required

Max length: 25
Gender

Gender

string

Max length: 25
SSN

Social Security Number

string

Max length: 11
Race

    Code [Description]
  • A [Asian]
  • B [Black or African-American]
  • N [American Indian or Alaskan Native]
  • O [Other]
  • P [Pacific Islander/Native Hawaiian]
  • U [Unknown]
  • W [Caucasian/White]

 string

Max length: 25
Ethnicity

    Code [Description]
  • H [Hispanic or Latino]
  • N [Not Hispanic or Latino]
  • U [Unknown]

 string

Max length: 50
GenderIdentityCode

    Code [Description]
  • M [Male]
  • F [Female]
  • FTM [Female-to-Male (FTM)/Transgender Male/Trans Man]
  • MTF [Male-to-Female (MTF)/Transgender Female/Trans Woman]
  • X [Genderqueer, neither exclusively male nor female]
  • TNOS [<other description provided>]
  • D [Choose not to disclose]
  • <no code> [Not Provided]

 string

Max length: 25
GenderIdentityDescription

    Description [Code]
  • Male [M]
  • Female [F]
  • Female-to-Male (FTM)/Transgender Male/Trans Man [FTM]
  • Male-to-Female (MTF)/Transgender Female/Trans Woman [MTF]
  • Genderqueer, neither exclusively male nor female [X]
  • <other description provided> [TNOS]
  • Choose not to disclose [D]
  • Not Provided [<no code>]

string

Max length: 50
SexualOrientationCode

    Code [Description]
  • HOM [Lesbian, Gay, or Homosexual]
  • HET [Straight or Heterosexual]
  • BI Bisexual]
  • SE [<other description provided>]
  • DK [Don't know]
  • D [Choose not to disclose]
  • <no code> [Not Provided]

 string

Max length: 25
SexualOrientationDescription

    Description [Code]
  • Lesbian, Gay, or Homosexual [HOM]
  • Straight or Heterosexual [HET]
  • Bisexual [BI]
  • <other description provided> [SE]
  • Don't know [DK]
  • Choose not to disclose [D]
  • Not Provided [<no code>]

 string

Max length: 50
Address1

Address line 1

string

Required

Max length: 255
Address2

Address line 2

string

Max length: 255
City

City

string

Max length: 255
State

State or Province

string

Max length: 255
Country

Country

string

Max length: 255
ZipCode

Zip or postal code

string

Required

Max length: 10
Phone

Main Phone

string

Max length: 25
WorkPhone

Work Phone

string

Max length: 25
CellPhone

Cell Phone

string

Max length: 25
Email

Email Address

string

Max length: 255
MaritalStatus

Marital Status

string

Max length: 25
Unit

Unit (if in long term care facility)

string

Max length: 255
Room

Room (if in long term care facility)

string

Max length: 25
Bed

Bed (if in long term care facility)

string

Max length: 25
CareStatus

The care status of the patient.
Can be "O" for Outpatient or "I" for Inpatient

string

Max length: 25