EntityBioDemographics

Name EntityBioDemographics
Usage IdentityService
addBioDemographicsToEntity updateBioDemographics
Entity
Type Complex

Description

Copyright 2005-2012 The Kuali Foundation

Licensed under the Educational Community License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.opensource.org/licenses/ecl2.php

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
entityId Entity Id String Gets this {@link EntityBioDemographicsContract}'s identity id.     One No  
deceasedDate Deceased Date String Gets this {@link EntityBioDemographicsContract}'s deceased date.     One No  
birthDate Birth Date String Gets this {@link EntityBioDemographicsContract}'s birth date.     One No  
age Age Integer Gets this {@link EntityBioDemographicsContract}'s current age based on birth date if present. Age calculation uses
deceased date if present.
Required   One No  
genderCode Gender Code String Gets this {@link EntityBioDemographicsContract}'s gender code.     One No  
genderChangeCode Gender Change Code String Get the {@link EntityBioDemographicsContract}'s gender change code
Corresponds to PESC GenderChangeCode
    One No  
maritalStatusCode Marital Status Code String Gets this {@link EntityBioDemographicsContract}'s marital status code.     One No  
primaryLanguageCode Primary Language Code String Gets this {@link EntityBioDemographicsContract}'s primary language code.     One No  
secondaryLanguageCode Secondary Language Code String Gets this {@link EntityBioDemographicsContract}'s secondary language code.     One No  
birthCountry Birth Country String Gets this {@link EntityBioDemographicsContract}'s country of birth code.
Corresponds to PESC BirthCountry.
    One No  
birthStateProvinceCode Birth State Province Code String Gets this {@link EntityBioDemographicsContract}'s birth state or extra-state jurisdiction code. Corresponds to PESC BirthStateProvinceCode.     One No  
birthCity Birth City String Gets this {@link EntityBioDemographicsContract}'s city of birth. Corresponds to PESC BirthCity.     One No  
geographicOrigin Geographic Origin String Gets this {@link EntityBioDemographicsContract}'s geographic origin.     One No  
birthDateUnmasked Birth Date Unmasked String Gets this {@link EntityBioDemographicsContract}'s unmasked birth date.     One No  
genderCodeUnmasked Gender Code Unmasked String Gets this {@link EntityBioDemographicsContract}'s unmasked gender code.     One No  
genderChangeCodeUnmasked Gender Change Code Unmasked String Get the {@link EntityBioDemographicsContract}'s gender change code
Corresponds to PESC GenderChangeCode
    One No  
maritalStatusCodeUnmasked Marital Status Code Unmasked String Gets this {@link EntityBioDemographicsContract}'s unmasked martial status code.     One No  
primaryLanguageCodeUnmasked Primary Language Code Unmasked String Gets this {@link EntityBioDemographicsContract}'s unmasked primary language code.     One No  
secondaryLanguageCodeUnmasked Secondary Language Code Unmasked String Gets this {@link EntityBioDemographicsContract}'s unmasked secondary language code.     One No  
birthCountryUnmasked Birth Country Unmasked String Gets this {@link EntityBioDemographicsContract}'s unmasked country of birth code.     One No  
birthStateProvinceCodeUnmasked Birth State Province Code Unmasked String Gets this {@link EntityBioDemographicsContract}'s unmasked birth state or extra-state jurisdiction code. Corresponds to PESC BirthStateProvinceCode.     One No  
birthCityUnmasked Birth City Unmasked String Gets this {@link EntityBioDemographicsContract}'s unmasked city of birth. Corresponds to PESC BirthCity.     One No  
geographicOriginUnmasked Geographic Origin Unmasked String Gets this {@link EntityBioDemographicsContract}'s unmasked geographic origin.     One No  
noteMessage Note Message String Get the note associated with this {@link EntityBioDemographicsContract}
Corresponds to PESC NoteMessage
    One No  
suppressPersonal Suppress Personal boolean Returns a boolean value that determines if personal fields should be suppressed.     One No  
versionNumber Version Number Long Returns the version number for this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.
This version number is generally used for the purposes of optimistic locking.
    One No  
objectId Object Id String Return the globally unique object id of this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.
    One No