PersonName

Type : PersonNameType

Elements
AlternateScriptPersonName
FamilyNameContains a non-given name. This is an inherited name or one representing a family relationship or in some cultural contexts a "Place Name" (where someone is from). In some cultural contexts, a single family name is typical, while in others there may be multiple family names. A "primary" attribute may be used in the case where there are multiple last names. A family name can have a "prefix," such as Von, De, Van, Al, etc. These can be represented using the FamilyName "prefix" attribute. Not all implementers may find it necessary to separate prefixes from the family name itself. Capturing the prefix and FamilyName as discrete fields can become important when formatting or appearance may vary based on context. For example, in some cultural contexts it may be common to use a blank space as the delimiter between the prefix and the family name, while in others a hyphen might be used. Separating the prefix from FamilyName allows such formatting requirements to be handled flexibly. This contains the name or names that generally would be inherited or indicative of a person's family. In Western contexts, this is what is commonly referred to as a "last name." If a person has multiple family names, the order in which the names appear is deemed significant. Generally, that order should correspond to the order in which the names would appear in a typical formatted representation. The order may be specifically identified by the sequence. A "primary" family name may be indicated using the attribute supplied for this purpose. Where multiple family names are presented, only a single name may be designated as primary = "true" Note that the attribute "prefix" may optionally contain a part of the person’s name that precedes the family name. For example: Van den, Von, Al, de, etc. Some implementers may choose not to represent a prefix separately from a Family Name. However, it may be desirable to do so for a number of reasons: 1. name sorting. For example, to support sorting on first letter of prefix and then by first letter of the family name. 2. formatting. For example, depending on the cultural context in which the name is presented, the type of delimiter (e.g., a space or a hyphen) between the prefix and the family name (or whether a delimiter appears at) all may depend on the "alphabet" and/or cultural context in which the name is presented.
FormattedNameThis is a formatted presentation of a name (for example, a person name) that might alternatively presented as discretely fielded components or it could otherwise be a name that has alternative formatted representations. The formatCode is an optional attribute available to specify the applicable "mask" or type of format presentation to which the contents conforms. For example, in the case of the FormattedName of person formatCodes could be items such as: "Family Name, Given Name" "Given Name, Middle Initial, Family Name" "First Initial, Family Name" "Given Name, Last Initial" "Nick Name, Family Name" This is a formatted presentation of a name (for example, a person name) that might alternatively presented as discretely fielded components or it could otherwise be a name that has alternative formatted representations. The formatCode is an optional attribute available to specify the applicable "mask" or type of format presentation to which the contents conforms. For example, in the case of the FormattedName of person formatCodes could be items such as: "Family Name, Given Name" "Given Name, Middle Initial, Family Name" "First Initial, Family Name" "Given Name, Last Initial" "Nick Name, Family Name"
FormerFamilyNameA previous family name, such as a "maiden name," which is a family name prior to marriage and assuming a spouse's name. This contains the name or names that generally would be inherited or indicative of a person's family. In Western contexts, this is what is commonly referred to as a "last name." If a person has multiple family names, the order in which the names appear is deemed significant. Generally, that order should correspond to the order in which the names would appear in a typical formatted representation. The order may be specifically identified by the sequence. A "primary" family name may be indicated using the attribute supplied for this purpose. Where multiple family names are presented, only a single name may be designated as primary = "true" Note that the attribute "prefix" may optionally contain a part of the person’s name that precedes the family name. For example: Van den, Von, Al, de, etc. Some implementers may choose not to represent a prefix separately from a Family Name. However, it may be desirable to do so for a number of reasons: 1. name sorting. For example, to support sorting on first letter of prefix and then by first letter of the family name. 2. formatting. For example, depending on the cultural context in which the name is presented, the type of delimiter (e.g., a space or a hyphen) between the prefix and the family name (or whether a delimiter appears at) all may depend on the "alphabet" and/or cultural context in which the name is presented.
GenerationAffixCodeA portion of a name indicating generation Sr., Jr., III (the third), etc.
GivenNameIs the Persons given name or first name.
LegalNameThis is a formatted presentation of a name (for example, a person name) that might alternatively presented as discretely fielded components or it could otherwise be a name that has alternative formatted representations. The formatCode is an optional attribute available to specify the applicable "mask" or type of format presentation to which the contents conforms. For example, in the case of the FormattedName of person formatCodes could be items such as: "Family Name, Given Name" "Given Name, Middle Initial, Family Name" "First Initial, Family Name" "Given Name, Last Initial" "Nick Name, Family Name" This is a formatted presentation of a name (for example, a person name) that might alternatively presented as discretely fielded components or it could otherwise be a name that has alternative formatted representations. The formatCode is an optional attribute available to specify the applicable "mask" or type of format presentation to which the contents conforms. For example, in the case of the FormattedName of person formatCodes could be items such as: "Family Name, Given Name" "Given Name, Middle Initial, Family Name" "First Initial, Family Name" "Given Name, Last Initial" "Nick Name, Family Name"
MiddleName This is a second "given name" or sometimes depending on cultural context, representative of family relationships. A middle name can have a prefix. For example, in Saudi names the word "Bin" means "son of" and would be a common prefix to a middle name usually representing the first name of the person's father. Some implementers may choose not to represent a prefix separately from a middle name. However, it may be desirable to do so for a number of reasons: 1. name sorting. For example, to support sorting on first letter of prefix and then by first letter of the middle name. 2. formatting. For example, depending on the cultural context in which the name is presented, the type of delimiter (e.g., a space or a hyphen) between the prefix and the family name (or whether a delimiter appears at) all may depend on the "alphabet" and/or cultural context in which the name is presented. This is a second "given name" or sometimes depending on cultural context, representative of family relationships. A middle name can have a prefix. For example, in Saudi names the word "Bin" means "son of" and would be a common prefix to a middle name usually representing the first name of the person's father. Some implementers may choose not to represent a prefix separately from a middle name. However, it may be desirable to do so for a number of reasons: 1. name sorting. For example, to support sorting on first letter of prefix and then by first letter of the middle name. 2. formatting. For example, depending on the cultural context in which the name is presented, the type of delimiter (e.g., a space or a hyphen) between the prefix and the family name (or whether a delimiter appears at) all may depend on the "alphabet" and/or cultural context in which the name is presented.
PersonNameInitialsA letter or series of letters representing the first letter in each name part.
PreferredNameA "nick name" or the name by which the person prefers to be called.
PreferredSalutationCodeContains a preferred form of address or salutation. For, example, Mr., Mrs., Hon., Dr., Major, Monsignor, Senora, Senor, Madam.etc.
QualificationAffixCodeUsually an abreviation representing a qualification (a degree or certification, for example) held by a person. For example, MD, RN, CPA, Phd., Esq., Ing., Lic., etc.
TitleAffixCodeThis is intended to accomodate a special category of affixes to person names, such as aristocratic titles (For example, "Baron" or "Lord"), political or legal titles (Senator, Judge), academic titles (Professor), or Military rank or title (Major, Capt., etc.). Within some systems and implementation contexts, such titles may be handled simply as a PreferredSalutationCode. However, there are also implementations where it is necessary to present the two concepts separately. Senator. Ms. Sara Jones; Professor. Mr. Sam Smith; Major. Ms. Jane Doe. Such titles would not always be from an enumerated value domain, but they could be within systems implemented within specialized settings such as education, government, military, etc. Note that this is not intended to capture information such as a Position Title.
UserAreaAllows the implementer to extend the base HR-XML specification. This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document throught the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document. Allows the implementer to extend the base HR-XML specification. This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document throught the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.

Attributes
legalNameIndicatorIndicates whether or not the PersonName represents a "legal" or "official" name. Note that in some business contexts, a legal name is a formatted name. For example, the exact way that a person's name is represented within contracts and legal documents. Note that for this second use, LegalName is optionally available within PersonName. The legalNameIndicator is used when there is the need to distinquish the entire collection of information as a legalName. This second use case may be less common the first, but both are supported.
nameTypeCodeA code classifying the type of name - Current, Former, Alias. This is an HR-XML open list so other values are permitted.
scriptCode
Attribute Group : EffectiveDateAttributeGroup
validFromThis is formatted representation of a date, which may be specified as a date, date/time, year, or year/month.
validToThis is formatted representation of a date, which may be specified as a date, date/time, year, or year/month.

Parents
\AcknowledgeAssessmentOrder\DataArea\AssessmentOrder\AssessmentSubject
\AcknowledgeEmploymentEligibilityI-9\DataArea\EmploymentEligibilityI-9\AuditTrail\AuditTrailPerson
\AcknowledgeSavingsPlanEnrollment\DataArea\SavingsPlanEnrollment\AccountHolder\Beneficiary\BeneficiaryPerson
\AcknowledgeCandidate\DataArea\Candidate\CandidatePerson
\AcknowledgeUSEnrollment\DataArea\USEnrollment\SubscriberDetails\SubscriberDependent\CustodialParent
\AcknowledgeScreeningOrder\DataArea\ScreeningOrder\ScreeningPackage\Screening\SearchAlcohol\ScreeningCustomer\DesignatedEmployerRepresentative
\AcknowledgeHRMasterData\DataArea\HRMasterData\MasterPersonDossier\MasterPerson\EmergencyContact
\AcknowledgeEPMParticipant\DataArea\EPMParticipant\EPMParticipantDossier\EPMPerson
\AcknowledgeHRMasterData\DataArea\HRMasterData\MasterPersonDossier\MasterPerson
\AcknowledgeAssessmentCatalog\DataArea\AssessmentCatalog\SupplierParty\PersonContact
\AcknowledgeOrganizationChart\DataArea\OrganizationChart\OrganizationUnit\MemberPosition\PositionIncumbent
\AcknowledgeDevelopmentPlan\DataArea\DevelopmentPlan\Preparer
\AcknowledgeCandidate\DataArea\Candidate\CandidateProfile\PublicationHistory\Publication\Article\PublicationContributor
\AcknowledgeEPMRaterPanel\DataArea\EPMRaterPanel\RaterPanel\Rater
\AcknowledgeCandidate\DataArea\Candidate\CandidateProfile\EmploymentReferences\Referee
\AcknowledgeStaffingAssignment\DataArea\StaffingAssignment\StaffingContract\ReplacedPerson
\AcknowledgeEPMParticipant\DataArea\EPMParticipant\EPMParticipantDossier\EPMDeployment\EPMPosition\ReportsToPerson
\AcknowledgeStaffingOrder\DataArea\StaffingOrder\StaffingRequisition\RequestedPerson
\AcknowledgeCreditResult\DataArea\CreditResult\CreditFile\CreditFilePerson\SubjectIdentification\ScreeningSubjectName\ScreeningPersonName
\AcknowledgeScreeningVendorOrder\DataArea\ScreeningVendorOrder\ScreeningVendorCourtOrder\CourtSearchParameters\ScreeningSubjectFilters
\AcknowledgeScreeningVendorOrder\DataArea\ScreeningVendorOrder\ScreeningVendorSubject\ScreeningVendorPerson\ScreeningVendorPersonName
\AcknowledgeUSEnrollment\DataArea\USEnrollment\SubscriberDetails\USHealthCoverage\SelectedHealthcareProvider
\AcknowledgeScreeningReport\DataArea\ScreeningReport\ScreeningPackageResult\ScreeningResult\AlcoholScreeningReport\Specimen\SpecimenCollector
\AcknowledgeScreeningReport\DataArea\ScreeningReport\ScreeningPackageResult\ScreeningResult\AlcoholScreeningReport\SpecimenDonor
\AcknowledgeUserAccount\DataArea\UserAccount
\AcknowledgeHRMasterData\DataArea\HRMasterData\MasterPersonDossier\WorkEligibility\Verification