addressA physical address at which the person is located or can be reached. The datatype for this property is Address which contains a type code to indicate what kind of address is being referenced. Note that this property can contain more than one entry."Contains the address of the patient. Multiple addresses for the same person may be sent." - HL7 Version 2.8, PID-11."One or more addresses for the person." - HL7 FHIR, Person.address."Addresses for the individual." - HL7 FHIR, Patient.address."Address for the contact person." - HL7 FHIR, Patient.contact.address"Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent." - HL7 FHIR, Practitioner.address
administrativeGender"Gender is used to refer to administrative sex rather than biological sex and therefore should easily be classified into female and male. It is included in the exchange for purposes of linking to insurance information and other patient identification linkages and the value chosen by the patient should reflect the information under which any insurance or financial information will be filed, as well as the same information given to other healthcare providers, institutions or health data exchange networks" - HITSP C154"The gender (i.e., the behavioral, cultural, or psychological traits typically associated with one sex) of a living subject as defined for administrative purposes. This attribute does not include terms related to clinical gender. Gender is a complex physiological, genetic, and sociological concept that requires multiple observations in order to be comprehensively described. The purpose of this attribute is to provide a high-level classification that can also be used for the appropriate allocation of inpatient bed assignment. - HL7 Version 3 RIM.Note that the this concept is restricted to those societal roles as perceived in the United States and other Western cultures."The patient's sex." - HL7 Version 2.8, PID-8."The next of kin/associated party's sex." - HL7 Version 2.8, NK1-15.HL7 Version 2 has the following suggested values (table 1): Female; Male; Other; Unknown; Ambiguous; Not applicable."Administrative Gender." - HL7 FHIR, Person.gender."Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes." - HL7 FHIR, Patient.gender."Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes." - HL7 FHIR, Patient.contact.gender"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes." - HL7 FHIR, Practitioner.gender"Code identifying the gender of the individual [clinician]." - NCPDP Telecommunication (Field 721-MD, Data Dictionary 201104)."Code identifying the gender of the individual [patient]." - NCPDP Telecommunication (Field 305-C5, Data Dictionary 201104)."The Gender of the purchaser of the product/service." - NCPDP Telecommunication (Field 595-YY, Data Dictionary 201104).Note that NCPDP Telecom uses: blank=unknown (721-MD), 0=not specified (305-C5) or unknown (595-YY), 1=male, 2=female"Gender of the patient" - NCPDP Script (Field 9703, Data Dictionary 201104). Note that Script uses M=Male, F=Female, U=Unknown"Code indicating the sex of the individual" - ASC X12 1068 (Gender Code). Note that X12 uses the following values: A=Not Provided, B=Not Applicable, F=Female, M=Male, N=Non-sexed, U=Unknown, X=Unsexable"A gender or sex of a person." NIEM PersonSexCode"A gender or sex of a person." - NIEM, PersonSexText"Code indicating the sex of the patient" - ASAP Standard for PDMP, PAT19: Gender Code. Possible values include: Male, Female, Unknown.
advanceDirectiveA pointer to a set of instructions provided in advance by the person specifying what actions may be taken on their behalf.
asCitizenPointer to a person's role as a "native or naturalized member of a state or nation who owes allegiance to its government and is entitled to its protection" - Dictionary.com."Information related to a person's country citizenship. For country citizenship HL7 recommends using ISO table 3166.... This field repeats since persons can be citizens of more than one country." - HL7 Version 2.8, PID-26."Identif(ies) the next of kin/associated party's citizenship." - HL7 Version 2.8, NK1-19.
asProviderPointer to the role information of a person who is authorized to provide health care services. The role of practitioner includes all functions performed for a health care provider organization in order to provide patient care and treatment.
asStudentPointer to the Role that a Person plays or played as a Student at some School.
asUniformedServicePersonPointer to the Role that a Person plays or played as a past or present member of a uniformed service.
asVeteranPointer to the Role that a Person plays as a past member of a military service.
asWorkerPointer to the Role a Person plays as an Employee of some Organization.
birthAddressThe city, state (or other designation such as province or region) and country where a person was born. Used for both identification and statistical purposes."Indicates the location of the patient's birth" - HL7 Version 2.8, PID-23."A location where a person was born." NIEM PersonBirthLocation
birthCertificate birthNameA name that a person had shortly after being born. Usually for family names but may be used to mark given names at birth that may have changed later. In western cultures, this name can be used for "maiden name." Note that the data type for this property is a PersonName, which includes the various parts that make up a person's name such as family name, prefixes, suffixes, etc. "This field contains one or more of the names of the patient." - HL7 Version 2.8, PID-5 Note that in HL7, the PersonName data type contains a type code to indicate what kind of name is being referenced. The FHIM explicitly models the name type, so in this case the attribute name is "Birth Name", and the type code would be set to "birth name" when targeting an HL7 implementation.
contactPartyPointer to the (Role of the) Person who should be contacted on the patients behalf under specified situations."A contact party (e.g. guardian, partner, friend) for the patient." - HL7 FHIR, Patient.contact.
deathCertificate employmentStatus ethnicityA group of people whose members identify with each other, through a common heritage, often consisting of a common language, a common culture (often including a shared religion) and an ideology that stresses common ancestry or endogamy. In addition, an ethnic group often shares an interest in a homeland connected with a specific geographical area and common traditions, including food preferences (Wikipedia). Note that unlike race, which concentrates on a person s physical heritage, ethnicity is concerned with the cultural heritage with which a person identifies themselves. Examples of ethnicity include: German, Scandinavian, Italian, Irish, etc. These ethnic groups are of the same race (Caucasian, or white ). Note also that the set of ethnicity values used may vary based on the purpose for collecting this information. The U.S. Office of Management and Budget (OMB) issues a set to be used for census purposes. See OMB publication 15. This property may contain more than one ethnicity for a given person, identified in no particular order."This field further defines the patient's ancestry." - HL7 Version 2.8, PID-22."The next of kin/associated party's ethnic group." - HL7 Version 2.8, NK1-28.HL7 Version 2 has the following suggested values (table 189): Hispanic or Latino; Not Hispanic or Latino; Unknown."A person of Cuban, Mexican, Puerto Rican, South or Central American, or other Spanish culture or origin, regardless of race." - PCORnet Common Data Model, Demographic.Hispanic. Possible values include: Yes; No; Refuse to answer; No information; Unknown; Other."A cultural lineage of a person." NIEM PersonEthnicityCode
fathersNameThe name of the father of the person. Used primarily for identification purposes. Added for VRM, but other use cases are anticipated.
genderIdentityA person's perception of having a particular gender, which may or may not correspond with their birth sex."The client's gender identity, otherwise known as core gender identity, and refers to how the client self-identifies. It is not based on the person’s anatomy." - HL7 Behavioral Health Record DAM R2, Client.genderIdentity"Current gender identity." - PCORnet Common Data Model, Demographic.Sex. Possible values include: Man; Woman; Transgender male/Trans man/Female-to-male; Transgender female/Trans woman/Male-to-female; Genderqueer; Something else; Multiple gender categories; Decline to answer; No information; Unknown; Other
handicap"Indicates the nature of the patient's permanent handicapped condition (e.g., deaf, blind). A handicapped condition is defined as a physical or mental disability that is permanent." - HL7 Version 2.8, PD1-6.Note that this property is included in the FHIM for compatibility to HL7 V2, although we have not yet identified a particular need for it by partner agencies. It is therefore modeled as an optional element. In addition, the potential values for this field are currently unknown. Therefore we have modeled it as a String rather than a Code, because we currently do not have a use case which requires a particular set of values. Note also that HL7 identifies a Code Table (Table 295) for this property, but does not provide any suggested values.
householdMbrOccHistoryObsPointer to an observation of the occupational history of a family member or other household member of the Person. This is used to determine if occupational hazards might affect other persons in the household of the person employed in that occupation.
identityReliabilityCode"Contains a coded value used to communicate information regarding the reliability of patient/person identifying data transmitted via a transaction. Values could indicate that certain fields on a PID segment for a given patient/person are known to be false (e.g., use of default or system-generated values for Date of Birth or Social Security Number)." - HL7 Version 2.8, PID-32. HL7 Version 2 has the following suggested values (table 445): Unknown/Default Social Security Number; Unknown/Default Date of Birth; Unknown/Default Address; Patient/Person Name is an Alias. Suggest that the FHIM use something like: Unreliable Social Security Number, Unreliable Date of Birth, Unreliable Address; Unreliable Name.Note that this property is included in the FHIM for compatibility to HL7 V2, although we have not yet identified a particular need for it by partner agencies. It is therefore modeled as an optional element. In addition, the potential values for this field are currently unknown. Therefore we have modeled it as a String rather than a Code, because we currently do not have a use case which requires a particular set of values. Note also that HL7 identifies a Code Table (Table 445) for this property, but does not provide any suggested values.
isActiveThis optional property can be used to indicate whether the Person's record is active. It is included for compatibility to FHIR."Whether this person's record is in active use." - HL7 FHIR, Person.active.
isIdentityUnknown"Indicates whether or not the patient's/person's identity is known." - HL7 Version 2.8, PID-31.
isTranslatorNeededIndicates whether this person needs translation services due to an inability to speak English. Added for Public Health Reporting 6/14/2012.
languageCapabilityA pointer to information regarding the language communication capabilities for a Person."The patient's primary language. HL7 recommends using ISO table 639" - HL7 Version 2.8, PID-15."The next of kin/associated party's primary speaking language." - HL7 Version 2.8, NK1-20."Languages which may be used to communicate with the patient about his or her health" - HL7 FHIR, Patient.communication."A language the practitioner can use in patient communication." - HL7 FHIR, Practitioner.communication
lastUpdateDateTime"Contains the last update date and time for the patient's/person's identifying and demographic data, as defined in the PID segment...." - HL7 Version 2.8, PID-33.
lastUpdateFacility"Identifies the facility of the last update to a patient's/person's identifying and demographic data, as defined in the PID segment...." - HL7 Version 2.8, PID-34.
linkPointer to a record that links this Person record with another Person record referring to the same real-world person."Link to another patient resource that concerns the same actual patient." - HL7 FHIR, Patient.link
livingArrangement"The housing situation of a person. This attribute is used for discharge planning, social service assessment, and psychosocial evaluation." - HL7 Version 3 RIM."The situation in which the patient lives at his residential address. Examples might include Alone, Family, Relatives, Institution, etc." - HL7 Version 2.8, PD1-2."The situation that the associated party lives in at his/her residential address." - HL7 Version 2.8, NK1-21.Possible values include (from HL7 Table 220): Alone; Family; Institution; Relative; Unknown; Spouse Only.
livingDependency"Identifies specific living conditions (e.g., spouse dependent on patient, walk-up) that are relevant to an evaluation of the patient's healthcare needs. This information can be used for discharge planning. This field repeats because, for example, "spouse dependent" and "medical supervision required" can apply at the same time." - HL7 Version 2.8, PD1-1."Identifies specific living conditions (e.g., spouse dependent on patient, walk-up) that are relevant to an evaluation of the patient's healthcare needs. This information can be used for discharge planning. Examples might include Spouse Dependent, Medical Supervision Required, Small Children Dependent." - HL7 Version 2.8, NK1-17.Possible values include (from HL7 V2 Table 223): Spouse Dependent; Medical Supervision Required; Small Children Dependent; Other; Unknown.
managingOrganizationThis optional property can be used to identify the organization or organizational component that owns or manages the record of the Person. This property has been included for compatibility with FHIR."The Organization that is the custodian of the person record." - HL7 FHIR, Person.managingOrganization."Organization that is the custodian of the patient record." - HL7 FHIR, Patient.managingOrganization.
maritalStatus"Contains the patient's marital (civil) status." - HL7 Version 2.8, PID-16."Contains the next of kin/associated party's marital status." - HL7 Version 2.8, NK1-14.HL7 Version 2 has the following suggested values (table 2): Separated; Divorced; Married; Single; Widowed; Common law; Living together; Domestic partner; Registered domestic partner; Legally Separated; Annulled; Interlocutory; Unmarried; Unknown; Other; Unreported."The domestic partnership status of a person." - HL7 Version 3 RIM."This field contains a patient's most recent marital (civil) status." - HL7 FHIR, Patient.maritalStatus.
mothersMaidenName"The family name under which the [person's] mother was born (i.e., before marriage). It is used to distinguish between patients with the same last name." - HL7 Version 2.8, PID-6."The maiden name of the next of kin/associated party's mother." - HL7 Version 2.8, NK1-26.This property is typically used for identity management purposes, especially to distinguish between persons who may have similar or identical names.
nameThe name by which a person is known or legally identified such as the name on a driver's license or passport. Note that the data type for this property is a PersonName, which includes the various parts that make up a person's name such as family name, prefixes, suffixes, etc. Note that in HL7, the PersonName data type contains a type code to indicate what kind of name is being referenced. The FHIM explicitly models the name type, so in this case the attribute name is "Legal Name", and the type code would be set to "Legal Name" when targeting an HL7 implementation."Contains one or more of the names of the patient...." - HL7 Version 2.8, PID-5"A name associated with the person." - HL7 FHIR, Person.name"A name associated with the individual." - HL7 FHIR, Patient.name"A name associated with the contact person." - HL7 FHIR, Patient.contact.name"The name(s) associated with the practitioner." - HL7 FHIR, Practitioner.name"A name associated with the person." - HL7 FHIR, RelatedPerson.name"Last name of the person dropping off or picking up Rx." - ASAP Standard for PDMP, AIR07: Last Name of Person Dropping Off or Picking Up Rx"First name of the person dropping off or picking up Rx" - ASAP Standard for PDMP, AIR08: First Name of Person Dropping Off or Picking Up Rx"Last name or initials of the pharmacist dispensing the medication" - ASAP Standard for PDMP, AIR09: Last Name or Initials of Pharmacist"First name of the pharmacist dispensing the medication" - ASAP Standard for PDMP, AIR10: First Name of Pharmacist"Freeform name of the pharmacy. Note: If a dispensing prescriber, the prescriber’s name and professional degree should be entered,such as John Doe MD." - ASAP Standard for PDMP, PHA04: Pharmacy or Dispensing Prescriber Name"Prescriber's last name." - ASAP Standard for PDMP, PRE05: Last Name"Prescriber's first name." - ASAP Standard for PDMP, PRE06: First Name"Prescriber's middle name or initial." - ASAP Standard for PDMP, PRE07: Middle Name"A combination of names and/or titles by which a person is known." - NIEM Core, PersonName
occupationalHistoryPointer to a set of observations regarding the usual occupation of a person, and what industries the person has worked in.
organizationalRepresentative"The name of the organization that serves as a next of kin/associated party or as the next of kin of the patient. This field may also be used to communicate the name of the organization at which the associated party works." - HL7 Version 2.8, NK1-13."Organization on behalf of which the contact is acting or for which the contact is working." - HL7 FHIR, Patient.contact.organization.
photo"An image that can be displayed as a thumbnail of the person to enhance the identification of the individual." - HL7 FHIR, Person.photo."Image of the patient." - HL7 FHIR, Patient.photo."Image of the person." - HL7 FHIR, Practitioner.photo
preferredContactMethodThe preferred method by which this person should be contacted. Possible values include: primaryHomePhone, temporaryEmail, etc. Added for MyHealtheVet.
raceA classification of humans into large and distinct populations or groups by factors such as heritable phenotypic characteristics or geographic ancestry, but also often influenced by and correlated with traits such as appearance, culture, ethnicity, and socio-economic status. (Wikipedia). This property may contain more than one race for a given person, identified in no particular order."This field refers to the patient's race." - HL7 Version 2.8, PID-10."The race of the next of kin/associated party." - HL7 Version 2.8, NK1-35.HL7 Version 2 has the following suggested values (table 5): American Indian or Alaska Native; Asian; Black or African American; Native Hawaiian or Other Pacific Islander; White; Other Race."" - PCORnet Common Data Model, Demographic.Race. Possible values include: American Indian or Alaska Native; Asian; Black or African American; Native Hawaiian or Other Pacific Islander; White; Multiple race; Refuse to answer; No information; Unknown; Other."A classification of a person based on factors such as geographical locations and genetics." NIEM PersonRaceCode
relatedPersonPointer to the (Role of the) Person to whom the originating Person is related in some way."A contact party (e.g. guardian, partner, friend) for the patient." - HL7 FHIR, Patient.contact.
religiousAffiliationIdentifies a set of spiritual beliefs to which the person adheres. This property is used primarily to accommodate the person's religious preferences in clinical settings."The ... religious preference of a person (e.g. Hinduism, Islam, Roman Catholic). - HL7 Version 3 RIM."Contains the patient's religion." - HL7 Version 2.8, PID-17."The type of religion practiced by the next of kin/associated party." - HL7 Version 2.8, NK1-25.Note that HL7 Version 2 table 6 lists 85 suggested values for this field.
sexualOrientation"An enduring pattern, or lack thereof, of a romantic, sexual, and/or emotional attraction to men, women, or all genders." - HL7 Behavioral Health Record DAM R2, Client.sexualOrientation"Sexual orientation." - PCORnet Common Data Model, Demographic.Sexual_Orientation. Possible values include: Bisexual; Gay; Lesbian; Queer; Questioning; Straight; Something else; Multiple sexual orientations; Decline to answer; No information; Unknown; Other.
ssnA nine digit identification number assigned to a person by the US Social Security Administration. Used primarily for identification purposes. Note that HIPAA forbids the use of SSN as a primary identifier. Maps to HL7 Version 2.8, PID-18. Note that while Social Security Number is a type of Id, and could be modeled as simply one of the possible instances of the "id" property, it is explicitly modeled because it is a particular kind of identifier that is needed for various business processes."Identifier for a person within a particular scope." - HL7 FHIR, Person.identifier.
telecomIndicates how and at what address that the person can be reached via electronic communications. The datatype for this property is ContactPoint, which can be used for telephone numbers as well as email, etc. The ContactPoint data type contains a type code to indicate what kind of telecommunications address that is being referenced. Note that this property can contain more than one entry."Contains the patient's personal telecommunication contact information." - HL7 Version 2.8, PID-40."A contact detail for the person, e.g. a telephone number or an email address." - HL7 FHIR, Person.telecom."A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted." - HL7 FHIR, Patient.telecom."A contact detail for the person, e.g. a telephone number or an email address." - HL7 FHIR, Patient.contact.telecom"Complete phone number including area code" - ASAP Standard for PDMP, PAT17: Phone Number
