Package org.hl7.fhir.dstu2.model

Class Person

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.BaseResource

org.hl7.fhir.dstu2.model.Resource

org.hl7.fhir.dstu2.model.DomainResource

org.hl7.fhir.dstu2.model.Person

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Person
extends DomainResource

Demographics and administrative information about a person independent of a specific health-related context.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Person.IdentityAssuranceLevel
static class	Person.IdentityAssuranceLevelEnumFactory
static class	Person.PersonLinkComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	active	Whether this person's record is in active use.
protected List<Address>	address	One or more addresses for the person.
protected DateType	birthDate	The birth date for the person.
protected Enumeration<Enumerations.AdministrativeGender>	gender	Administrative Gender.
protected List<Identifier>	identifier	Identifier for a person within a particular scope.
protected List<Person.PersonLinkComponent>	link	Link to a resource that concerns the same actual person.
protected Reference	managingOrganization	The organization that is the custodian of the person record.
protected Organization	managingOrganizationTarget	The actual object that is the target of the reference (The organization that is the custodian of the person record.)
protected List<HumanName>	name	A name associated with the person.
protected Attachment	photo	An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
static final String	SP_ADDRESS
static final String	SP_ADDRESSCITY
static final String	SP_ADDRESSCOUNTRY
static final String	SP_ADDRESSPOSTALCODE
static final String	SP_ADDRESSSTATE
static final String	SP_ADDRESSUSE
static final String	SP_BIRTHDATE
static final String	SP_EMAIL
static final String	SP_GENDER
static final String	SP_IDENTIFIER
static final String	SP_LINK
static final String	SP_NAME
static final String	SP_ORGANIZATION
static final String	SP_PATIENT
static final String	SP_PHONE
static final String	SP_PHONETIC
static final String	SP_PRACTITIONER
static final String	SP_RELATEDPERSON
static final String	SP_TELECOM
protected List<ContactPoint>	telecom	A contact detail for the person, e.g. a telephone number or an email address.

Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Person()

Method Summary

Modifier and Type	Method	Description
Address	addAddress()
Person	addAddress(Address t)
Base	addChild(String name)
Identifier	addIdentifier()
Person	addIdentifier(Identifier t)
Person.PersonLinkComponent	addLink()
Person	addLink(Person.PersonLinkComponent t)
HumanName	addName()
Person	addName(HumanName t)
ContactPoint	addTelecom()
Person	addTelecom(ContactPoint t)
Person	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
boolean	getActive()
BooleanType	getActiveElement()
List<Address>	getAddress()
Date	getBirthDate()
DateType	getBirthDateElement()
Enumerations.AdministrativeGender	getGender()
Enumeration<Enumerations.AdministrativeGender>	getGenderElement()
List<Identifier>	getIdentifier()
List<Person.PersonLinkComponent>	getLink()
Reference	getManagingOrganization()
Organization	getManagingOrganizationTarget()
List<HumanName>	getName()
Attachment	getPhoto()
ResourceType	getResourceType()
List<ContactPoint>	getTelecom()
boolean	hasActive()
boolean	hasActiveElement()
boolean	hasAddress()
boolean	hasBirthDate()
boolean	hasBirthDateElement()
boolean	hasGender()
boolean	hasGenderElement()
boolean	hasIdentifier()
boolean	hasLink()
boolean	hasManagingOrganization()
boolean	hasName()
boolean	hasPhoto()
boolean	hasTelecom()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Person	setActive(boolean value)
Person	setActiveElement(BooleanType value)
Person	setBirthDate(Date value)
Person	setBirthDateElement(DateType value)
Person	setGender(Enumerations.AdministrativeGender value)
Person	setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)
Person	setManagingOrganization(Reference value)
Person	setManagingOrganizationTarget(Organization value)
Person	setPhoto(Attachment value)
void	setProperty(String name, Base value)
protected Person	typedCopy()

Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2.model.Resource

copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource

getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Identifier for a person within a particular scope.

name

protected List<HumanName> name

A name associated with the person.

telecom

protected List<ContactPoint> telecom

A contact detail for the person, e.g. a telephone number or an email address.

gender

protected Enumeration<Enumerations.AdministrativeGender> gender

Administrative Gender.

birthDate

protected DateType birthDate

The birth date for the person.

address

protected List<Address> address

One or more addresses for the person.

photo

protected Attachment photo

An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.

managingOrganization

protected Reference managingOrganization

The organization that is the custodian of the person record.

managingOrganizationTarget

protected Organization managingOrganizationTarget

The actual object that is the target of the reference (The organization that is the custodian of the person record.)

active

protected BooleanType active

Whether this person's record is in active use.

link

protected List<Person.PersonLinkComponent> link

Link to a resource that concerns the same actual person.

SP_IDENTIFIER

public static final String SP_IDENTIFIER

See Also:

• Constant Field Values

SP_ADDRESS

public static final String SP_ADDRESS

See Also:

• Constant Field Values

SP_BIRTHDATE

public static final String SP_BIRTHDATE

See Also:

• Constant Field Values

SP_ADDRESSSTATE

public static final String SP_ADDRESSSTATE

See Also:

• Constant Field Values

SP_GENDER

public static final String SP_GENDER

See Also:

• Constant Field Values

SP_PRACTITIONER

public static final String SP_PRACTITIONER

See Also:

• Constant Field Values

SP_LINK

public static final String SP_LINK

See Also:

• Constant Field Values

SP_RELATEDPERSON

public static final String SP_RELATEDPERSON

See Also:

• Constant Field Values

SP_ADDRESSPOSTALCODE

public static final String SP_ADDRESSPOSTALCODE

See Also:

• Constant Field Values

SP_ADDRESSCOUNTRY

public static final String SP_ADDRESSCOUNTRY

See Also:

• Constant Field Values

SP_PHONETIC

public static final String SP_PHONETIC

See Also:

• Constant Field Values

SP_PHONE

public static final String SP_PHONE

See Also:

• Constant Field Values

SP_PATIENT

public static final String SP_PATIENT

See Also:

• Constant Field Values

SP_ORGANIZATION

public static final String SP_ORGANIZATION

See Also:

• Constant Field Values

SP_NAME

public static final String SP_NAME

See Also:

• Constant Field Values

SP_ADDRESSUSE

public static final String SP_ADDRESSUSE

See Also:

• Constant Field Values

SP_TELECOM

public static final String SP_TELECOM

See Also:

• Constant Field Values

SP_ADDRESSCITY

public static final String SP_ADDRESSCITY

See Also:

• Constant Field Values

SP_EMAIL

public static final String SP_EMAIL

See Also:

• Constant Field Values

Constructor Details

Person

public Person()

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifier for a person within a particular scope.)

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

Returns:

identifier (Identifier for a person within a particular scope.)

addIdentifier

public Person addIdentifier(Identifier t)

getName

public List<HumanName> getName()

Returns:

name (A name associated with the person.)

hasName

public boolean hasName()

addName

public HumanName addName()

Returns:

name (A name associated with the person.)

addName

public Person addName(HumanName t)

getTelecom

public List<ContactPoint> getTelecom()

Returns:

telecom (A contact detail for the person, e.g. a telephone number or an email address.)

hasTelecom

public boolean hasTelecom()

addTelecom

public ContactPoint addTelecom()

Returns:

telecom (A contact detail for the person, e.g. a telephone number or an email address.)

addTelecom

public Person addTelecom(ContactPoint t)

getGenderElement

public Enumeration<Enumerations.AdministrativeGender> getGenderElement()

Returns:

gender (Administrative Gender.). This is the underlying object with id, value and extensions. The accessor "getGender" gives direct access to the value

hasGenderElement

public boolean hasGenderElement()

hasGender

public boolean hasGender()

setGenderElement

public Person setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)

Parameters:

value - gender (Administrative Gender.). This is the underlying object with id, value and extensions. The accessor "getGender" gives direct access to the value

getGender

public Enumerations.AdministrativeGender getGender()

Returns:

Administrative Gender.

setGender

public Person setGender(Enumerations.AdministrativeGender value)

Parameters:

value - Administrative Gender.

getBirthDateElement

public DateType getBirthDateElement()

Returns:

birthDate (The birth date for the person.). This is the underlying object with id, value and extensions. The accessor "getBirthDate" gives direct access to the value

hasBirthDateElement

public boolean hasBirthDateElement()

hasBirthDate

public boolean hasBirthDate()

setBirthDateElement

public Person setBirthDateElement(DateType value)

Parameters:

value - birthDate (The birth date for the person.). This is the underlying object with id, value and extensions. The accessor "getBirthDate" gives direct access to the value

getBirthDate

public Date getBirthDate()

Returns:

The birth date for the person.

setBirthDate

public Person setBirthDate(Date value)

Parameters:

value - The birth date for the person.

getAddress

public List<Address> getAddress()

Returns:

address (One or more addresses for the person.)

hasAddress

public boolean hasAddress()

addAddress

public Address addAddress()

Returns:

address (One or more addresses for the person.)

addAddress

public Person addAddress(Address t)

getPhoto

public Attachment getPhoto()

Returns:

photo (An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.)

hasPhoto

public boolean hasPhoto()

setPhoto

public Person setPhoto(Attachment value)

Parameters:

value - photo (An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.)

getManagingOrganization

public Reference getManagingOrganization()

Returns:

managingOrganization (The organization that is the custodian of the person record.)

hasManagingOrganization

public boolean hasManagingOrganization()

setManagingOrganization

public Person setManagingOrganization(Reference value)

Parameters:

value - managingOrganization (The organization that is the custodian of the person record.)

getManagingOrganizationTarget

public Organization getManagingOrganizationTarget()

Returns:

managingOrganization The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The organization that is the custodian of the person record.)

setManagingOrganizationTarget

public Person setManagingOrganizationTarget(Organization value)

Parameters:

value - managingOrganization The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The organization that is the custodian of the person record.)

getActiveElement

public BooleanType getActiveElement()

Returns:

active (Whether this person's record is in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value

hasActiveElement

public boolean hasActiveElement()

hasActive

public boolean hasActive()

setActiveElement

public Person setActiveElement(BooleanType value)

Parameters:

value - active (Whether this person's record is in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value

getActive

public boolean getActive()

Returns:

Whether this person's record is in active use.

setActive

public Person setActive(boolean value)

Parameters:

value - Whether this person's record is in active use.

getLink

public List<Person.PersonLinkComponent> getLink()

Returns:

link (Link to a resource that concerns the same actual person.)

hasLink

public boolean hasLink()

addLink

public Person.PersonLinkComponent addLink()

Returns:

link (Link to a resource that concerns the same actual person.)

addLink

public Person addLink(Person.PersonLinkComponent t)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

setProperty

public void setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public Person copy()

Specified by:

copy in class DomainResource

typedCopy

protected Person typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource