For AI agents: the documentation index is at /docs/payerbox/llms.txt. A Markdown version of this page is available at /docs/payerbox/data-integration/uscdi/patient-demographics.md or by requesting it with the Accept: text/markdown header.
Payerbox Docs

Patient Demographics/Information

Datasets

US Core 6.1.0 maps each USCDI element to FHIR.

patients

One row per member. The sections below group its columns.

Identity

ColumnRequiredFormat / valuesExample
patient_identifierYesyour most stable patient key; must not change for a person or be reused for anotherMRN-4471903
patient_identifier_systemYesURI of the identifier system; a URL you control or an OIDhttp://acme.org/mrns
patient_identifier_typeRecommendedMR medical record, MB member number, MC Medicare, MA Medicaid v2-0203MR
patient_identifier_useRecommendedusual, official, temp, secondary identifier-useofficial
patient_identifier_assigner_org_npiRecommended10 digits1234567893

Additional identifiers

ColumnRequiredFormat / valuesExample
identifier_<n>_valueYesthe identifier as issuedHSX9930012
identifier_<n>_systemYesURI of the identifier system; a URL you control or an OIDhttp://acme.org/member-ids
identifier_<n>_typeRecommendedv2-0203 codeMB
identifier_<n>_useRecommendedusual, official, temp, secondary, old identifier-useofficial
identifier_<n>_period_startRecommendeddate2024-01-01
identifier_<n>_period_endRecommendeddate2025-12-31
identifier_<n>_assigner_org_npiRecommended10 digits1234567893
  • If you use a slot, fill both value and system. A value without a system is rejected. A slot left blank is ignored.
  • Number slots from 2 upward, contiguously. Never 2 and 4.

Name

ColumnRequiredFormat / valuesExample
last_nameYestextDoe
first_nameYestextJane
middle_nameRecommendedtextL
name_prefixNoMr. / Mrs. / Ms. / Dr.Ms.
name_suffixRecommendedJr. / Sr. / III
previous_nameRecommendedfamily, givenSmith, Jane

Demographics

ColumnRequiredFormat / valuesExample
genderYesmale, female, other, unknown AdministrativeGenderfemale
sexRecommended248152002 Female, 248153007 Male US Core Sex248152002
birth_dateRecommendedYYYY-MM-DD1957-03-11
deceased_dateIf applicabledatetime
race_omb_codeRecommended2106-3 White, 2054-5 Black or African American, 2028-9 Asian, 1002-5 American Indian or Alaska Native, 2076-8 Native Hawaiian or Other Pacific Islander; ;-separated OMB race categories2106-3
race_detailed_codeIf availableCDC race code(s), ;-separated detailed race2108-9
ethnicity_omb_codeRecommended2135-2 Hispanic or Latino, 2186-5 Not Hispanic or Latino OMB ethnicity categories2186-5
ethnicity_detailed_codeIf availableCDC ethnicity code(s) detailed ethnicity
tribal_affiliation_codeRecommendedtribal-entity code TribalEntityUS
preferred_languageRecommendedBCP 47 simple-languageen

Address and contact

ColumnRequiredFormat / valuesExample
address_line1Recommendedtext88 River Rd
address_line2NotextApt 3
cityRecommendedtextYonkers
stateRecommended2-letter USPS USPS statesNY
zipRecommended5 or 9 digits, as a string10701
countyIf availabletextWestchester
phoneRecommended10 digits5551234567
phone_typeRecommendedhome, work, mobile ContactPointUsemobile
emailRecommendedemail address
previous_addressRecommendedline, city, state, zip12 Elm St, Bronx, NY, 10453
previous_address_endIf availabledate2024-08-31

Contacts and non-clinician care-team members, such as a daughter, spouse, or guardian. One row per person per patient.

ColumnRequiredFormat / valuesExample
patient_identifierYespatient keyMRN-4471903
relationship_codeRecommendedDAU daughter, SPS spouse, NCH child v3-RoleCode, v2-0131DAU
last_nameRecommendedtextDoe
first_nameRecommendedtextMary
phoneIf available10 digits5559876543
preferred_languageIf availableBCP 47 simple-languageen

social_history

ColumnRequiredFormat / valuesExample
patient_identifierYespatient keyMRN-4471903
observation_typeYesoccupation for the demographics rows; smoking-status, pregnancy-status, pregnancy-intent are Health Status/Assessmentsoccupation
statusYesfinal, amended, corrected, entered-in-error observation-statusfinal
value_codeYesO*NET-SOC occupation code, with value_system Occupation ONETSOC Detail29-1141.00
industry_codeoccupation onlyNAICS industry code Industry NAICS Detail622110
effective_datetimeRecommendeddatetime2026-04-18

These resources are served by Patient Access, Provider Access, and Payer-to-Payer.

Last updated: