Package org.hl7.fhir.dstu2.model

Class RelatedPerson

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.RelatedPerson

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 RelatedPerson
extends DomainResource

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Address>	address	Address where the related person can be contacted or visited.
protected DateType	birthDate	The date on which the related person was born.
protected Enumeration<Enumerations.AdministrativeGender>	gender	Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
protected List<Identifier>	identifier	Identifier for a person within a particular scope.
protected HumanName	name	A name associated with the person.
protected Reference	patient	The patient this person is related to.
protected Patient	patientTarget	The actual object that is the target of the reference (The patient this person is related to.)
protected Period	period	The period of time that this relationship is considered to be valid.
protected List<Attachment>	photo	Image of the person.
protected CodeableConcept	relationship	The nature of the relationship between a patient and the related person.
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_NAME
static final String	SP_PATIENT
static final String	SP_PHONE
static final String	SP_PHONETIC
static final String	SP_TELECOM
protected List<ContactPoint>	telecom	A contact detail for the person, e.g.

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
RelatedPerson()
RelatedPerson(Reference patient)

Method Summary

Modifier and Type	Method	Description
Address	addAddress()
RelatedPerson	addAddress(Address t)
Base	addChild(String name)
Identifier	addIdentifier()
RelatedPerson	addIdentifier(Identifier t)
Attachment	addPhoto()
RelatedPerson	addPhoto(Attachment t)
ContactPoint	addTelecom()
RelatedPerson	addTelecom(ContactPoint t)
RelatedPerson	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
List<Address>	getAddress()
Date	getBirthDate()
DateType	getBirthDateElement()
Enumerations.AdministrativeGender	getGender()
Enumeration<Enumerations.AdministrativeGender>	getGenderElement()
List<Identifier>	getIdentifier()
HumanName	getName()
Reference	getPatient()
Patient	getPatientTarget()
Period	getPeriod()
List<Attachment>	getPhoto()
CodeableConcept	getRelationship()
ResourceType	getResourceType()
List<ContactPoint>	getTelecom()
boolean	hasAddress()
boolean	hasBirthDate()
boolean	hasBirthDateElement()
boolean	hasGender()
boolean	hasGenderElement()
boolean	hasIdentifier()
boolean	hasName()
boolean	hasPatient()
boolean	hasPeriod()
boolean	hasPhoto()
boolean	hasRelationship()
boolean	hasTelecom()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
RelatedPerson	setBirthDate(Date value)
RelatedPerson	setBirthDateElement(DateType value)
RelatedPerson	setGender(Enumerations.AdministrativeGender value)
RelatedPerson	setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)
RelatedPerson	setName(HumanName value)
RelatedPerson	setPatient(Reference value)
RelatedPerson	setPatientTarget(Patient value)
RelatedPerson	setPeriod(Period value)
void	setProperty(String name, Base value)
RelatedPerson	setRelationship(CodeableConcept value)
protected RelatedPerson	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.

patient

protected Reference patient

The patient this person is related to.

patientTarget

protected Patient patientTarget

The actual object that is the target of the reference (The patient this person is related to.)

relationship

protected CodeableConcept relationship

The nature of the relationship between a patient and the related person.

name

protected 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 - the gender that the person is considered to have for administration and record keeping purposes.

birthDate

protected DateType birthDate

The date on which the related person was born.

address

protected List<Address> address

Address where the related person can be contacted or visited.

photo

protected List<Attachment> photo

Image of the person.

period

protected Period period

The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.

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_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_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

RelatedPerson

public RelatedPerson()

RelatedPerson

public RelatedPerson(Reference patient)

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 RelatedPerson addIdentifier(Identifier t)

getPatient

public Reference getPatient()

Returns:

patient (The patient this person is related to.)

hasPatient

public boolean hasPatient()

setPatient

public RelatedPerson setPatient(Reference value)

Parameters:

value - patient (The patient this person is related to.)

getPatientTarget

public Patient getPatientTarget()

Returns:

patient 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 patient this person is related to.)

setPatientTarget

public RelatedPerson setPatientTarget(Patient value)

Parameters:

value - patient 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 patient this person is related to.)

getRelationship

public CodeableConcept getRelationship()

Returns:

relationship (The nature of the relationship between a patient and the related person.)

hasRelationship

public boolean hasRelationship()

setRelationship

public RelatedPerson setRelationship(CodeableConcept value)

Parameters:

value - relationship (The nature of the relationship between a patient and the related person.)

getName

public HumanName getName()

Returns:

name (A name associated with the person.)

hasName

public boolean hasName()

setName

public RelatedPerson setName(HumanName value)

Parameters:

value - name (A name associated with the person.)

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 RelatedPerson addTelecom(ContactPoint t)

getGenderElement

public Enumeration<Enumerations.AdministrativeGender> getGenderElement()

Returns:

gender (Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.). 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 RelatedPerson setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)

Parameters:

value - gender (Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.). 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 - the gender that the person is considered to have for administration and record keeping purposes.

setGender

public RelatedPerson setGender(Enumerations.AdministrativeGender value)

Parameters:

value - Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

getBirthDateElement

public DateType getBirthDateElement()

Returns:

birthDate (The date on which the related person was born.). 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 RelatedPerson setBirthDateElement(DateType value)

Parameters:

value - birthDate (The date on which the related person was born.). 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 date on which the related person was born.

setBirthDate

public RelatedPerson setBirthDate(Date value)

Parameters:

value - The date on which the related person was born.

getAddress

public List<Address> getAddress()

Returns:

address (Address where the related person can be contacted or visited.)

hasAddress

public boolean hasAddress()

addAddress

public Address addAddress()

Returns:

address (Address where the related person can be contacted or visited.)

addAddress

public RelatedPerson addAddress(Address t)

getPhoto

public List<Attachment> getPhoto()

Returns:

photo (Image of the person.)

hasPhoto

public boolean hasPhoto()

addPhoto

public Attachment addPhoto()

Returns:

photo (Image of the person.)

addPhoto

public RelatedPerson addPhoto(Attachment t)

getPeriod

public Period getPeriod()

Returns:

period (The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.)

hasPeriod

public boolean hasPeriod()

setPeriod

public RelatedPerson setPeriod(Period value)

Parameters:

value - period (The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.)

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 RelatedPerson copy()

Specified by:

copy in class DomainResource

typedCopy

protected RelatedPerson 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