The Patient Object

AttributeTypeDescription
idstringA stable, unique, Railway-provided identifier. Always prefixed with pt_.
first_namestringThe patient’s first name.
last_namestringThe patient’s last name.
middle_namestringThe patient’s middle name.
preferred_namestringThe patient's preferred first name.
dobstringThe patient’s official date of birth.
gender_identitystringThe patient’s identification of their gender. Valid options: Male, Female, Non Binary, Other, Transgender Male, Transgender Female, and Undisclosed.
administrative_genderstringThe patient’s gender as defined in government-issued documents for administrative purposes. Valid options: Male and Female.
emailstringThe patient’s personal email address.
mobile_phone_numberstringThe patient's mobile phone number formatted in E.164 format.
home_phone_numberstringThe patient's home phone number formatted in E.164 format.
timezonestringThe IANA time zone identifier of the patient.
addressobjectThe patient's home address.
address.street_line1stringStreet address or PO box.
address.street_line2stringApartment, suite, unit, or building.
address.citystringCity, district, suburb, town, or village.
address.statestringTwo-letter state code.
address.postal_codestringThe postal code or zip code.
insuranceobjectThe patient's insurance.
insurance.idstringThe Railway id for the patient's insurance. The list of ids can be found here.
insurance.member_idstringThe patient's insurance member id, usually found on their insurance card.
insurance.subscriber_idstringThe patient's insurance subscriber id, usually found on their insurance card.
insurance.group_numberstringThe patient's insurance group number, usually found on their insurance card.
created_atdatetimeISO 8601 timestamp of when the patient was created.
updated_atdatetimeISO 8601 timestamp of when the patient was last updated.