Package org.hl7.fhir.dstu2016may.model

Class RelatedPerson

java.lang.Object

org.hl7.fhir.dstu2016may.model.Base

org.hl7.fhir.dstu2016may.model.BaseResource

org.hl7.fhir.dstu2016may.model.Resource

org.hl7.fhir.dstu2016may.model.DomainResource

org.hl7.fhir.dstu2016may.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.
static ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS	Fluent Client search parameter constant for address
static ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_CITY	Fluent Client search parameter constant for address-city
static ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_COUNTRY	Fluent Client search parameter constant for address-country
static ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_POSTALCODE	Fluent Client search parameter constant for address-postalcode
static ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_STATE	Fluent Client search parameter constant for address-state
static ca.uhn.fhir.rest.gclient.TokenClientParam	ADDRESS_USE	Fluent Client search parameter constant for address-use
protected DateType	birthDate	The date on which the related person was born.
static ca.uhn.fhir.rest.gclient.DateClientParam	BIRTHDATE	Fluent Client search parameter constant for birthdate
static ca.uhn.fhir.rest.gclient.TokenClientParam	EMAIL	Fluent Client search parameter constant for email
protected Enumeration<Enumerations.AdministrativeGender>	gender	Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
static ca.uhn.fhir.rest.gclient.TokenClientParam	GENDER	Fluent Client search parameter constant for gender
protected List<Identifier>	identifier	Identifier for a person within a particular scope.
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
protected HumanName	name	A name associated with the person.
static ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
protected Reference	patient	The patient this person is related to.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
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.
static ca.uhn.fhir.rest.gclient.TokenClientParam	PHONE	Fluent Client search parameter constant for phone
static ca.uhn.fhir.rest.gclient.StringClientParam	PHONETIC	Fluent Client search parameter constant for phonetic
protected List<Attachment>	photo	Image of the person.
protected CodeableConcept	relationship	The nature of the relationship between a patient and the related person.
static String	SP_ADDRESS	Search parameter: address
static String	SP_ADDRESS_CITY	Search parameter: address-city
static String	SP_ADDRESS_COUNTRY	Search parameter: address-country
static String	SP_ADDRESS_POSTALCODE	Search parameter: address-postalcode
static String	SP_ADDRESS_STATE	Search parameter: address-state
static String	SP_ADDRESS_USE	Search parameter: address-use
static String	SP_BIRTHDATE	Search parameter: birthdate
static String	SP_EMAIL	Search parameter: email
static String	SP_GENDER	Search parameter: gender
static String	SP_IDENTIFIER	Search parameter: identifier
static String	SP_NAME	Search parameter: name
static String	SP_PATIENT	Search parameter: patient
static String	SP_PHONE	Search parameter: phone
static String	SP_PHONETIC	Search parameter: phonetic
static String	SP_TELECOM	Search parameter: telecom
protected List<ContactPoint>	telecom	A contact detail for the person, e.g.
static ca.uhn.fhir.rest.gclient.TokenClientParam	TELECOM	Fluent Client search parameter constant for telecom

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
RelatedPerson()	Constructor
RelatedPerson(Reference patient)	Constructor

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()
Base[]	getProperty(int hash, String name, boolean checkValid)
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)
Base	makeProperty(int hash, String name)	make an instance of a property.
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(int hash, String name, Base value)
void	setProperty(String name, Base value)
RelatedPerson	setRelationship(CodeableConcept value)
protected RelatedPerson	typedCopy()

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

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

Methods inherited from class org.hl7.fhir.dstu2016may.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.dstu2016may.model.BaseResource

getStructureFhirVersionEnum, setId

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

castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, 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, setId

Field Detail

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_PHONE

public static final String SP_PHONE

Search parameter: phone

Description: A value in a phone contact
Type: token
Path: RelatedPerson.telecom(system=phone)

See Also:

Constant Field Values

PHONE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam PHONE

Fluent Client search parameter constant for phone

Description: A value in a phone contact
Type: token
Path: RelatedPerson.telecom(system=phone)

SP_PHONETIC

public static final String SP_PHONETIC

Search parameter: phonetic

Description: A portion of name using some kind of phonetic matching algorithm
Type: string
Path: RelatedPerson.name

See Also:

Constant Field Values

PHONETIC

public static final ca.uhn.fhir.rest.gclient.StringClientParam PHONETIC

Fluent Client search parameter constant for phonetic

Description: A portion of name using some kind of phonetic matching algorithm
Type: string
Path: RelatedPerson.name

SP_ADDRESS_COUNTRY

public static final String SP_ADDRESS_COUNTRY

Search parameter: address-country

Description: A country specified in an address
Type: string
Path: RelatedPerson.address.country

See Also:

Constant Field Values

ADDRESS_COUNTRY

public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_COUNTRY

Fluent Client search parameter constant for address-country

Description: A country specified in an address
Type: string
Path: RelatedPerson.address.country

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: The patient this person is related to
Type: reference
Path: RelatedPerson.patient

See Also:

Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: The patient this person is related to
Type: reference
Path: RelatedPerson.patient

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "RelatedPerson:patient".

SP_ADDRESS_CITY

public static final String SP_ADDRESS_CITY

Search parameter: address-city

Description: A city specified in an address
Type: string
Path: RelatedPerson.address.city

See Also:

Constant Field Values

ADDRESS_CITY

public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_CITY

Fluent Client search parameter constant for address-city

Description: A city specified in an address
Type: string
Path: RelatedPerson.address.city

SP_ADDRESS_STATE

public static final String SP_ADDRESS_STATE

Search parameter: address-state

Description: A state specified in an address
Type: string
Path: RelatedPerson.address.state

See Also:

Constant Field Values

ADDRESS_STATE

public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_STATE

Fluent Client search parameter constant for address-state

Description: A state specified in an address
Type: string
Path: RelatedPerson.address.state

SP_EMAIL

public static final String SP_EMAIL

Search parameter: email

Description: A value in an email contact
Type: token
Path: RelatedPerson.telecom(system=email)

See Also:

Constant Field Values

EMAIL

public static final ca.uhn.fhir.rest.gclient.TokenClientParam EMAIL

Fluent Client search parameter constant for email

Description: A value in an email contact
Type: token
Path: RelatedPerson.telecom(system=email)

SP_ADDRESS

public static final String SP_ADDRESS

Search parameter: address

Description: An address in any kind of address/part
Type: string
Path: RelatedPerson.address

See Also:

Constant Field Values

ADDRESS

public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS

Fluent Client search parameter constant for address

Description: An address in any kind of address/part
Type: string
Path: RelatedPerson.address

SP_ADDRESS_USE

public static final String SP_ADDRESS_USE

Search parameter: address-use

Description: A use code specified in an address
Type: token
Path: RelatedPerson.address.use

See Also:

Constant Field Values

ADDRESS_USE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADDRESS_USE

Fluent Client search parameter constant for address-use

Description: A use code specified in an address
Type: token
Path: RelatedPerson.address.use

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: A portion of name in any name part
Type: string
Path: RelatedPerson.name

See Also:

Constant Field Values

NAME

public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME

Fluent Client search parameter constant for name

Description: A portion of name in any name part
Type: string
Path: RelatedPerson.name

SP_BIRTHDATE

public static final String SP_BIRTHDATE

Search parameter: birthdate

Description: The Related Person's date of birth
Type: date
Path: RelatedPerson.birthDate

See Also:

Constant Field Values

BIRTHDATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam BIRTHDATE

Fluent Client search parameter constant for birthdate

Description: The Related Person's date of birth
Type: date
Path: RelatedPerson.birthDate

SP_TELECOM

public static final String SP_TELECOM

Search parameter: telecom

Description: The value in any kind of contact
Type: token
Path: RelatedPerson.telecom

See Also:

Constant Field Values

TELECOM

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TELECOM

Fluent Client search parameter constant for telecom

Description: The value in any kind of contact
Type: token
Path: RelatedPerson.telecom

SP_GENDER

public static final String SP_GENDER

Search parameter: gender

Description: Gender of the person
Type: token
Path: RelatedPerson.gender

See Also:

Constant Field Values

GENDER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam GENDER

Fluent Client search parameter constant for gender

Description: Gender of the person
Type: token
Path: RelatedPerson.gender

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: A patient Identifier
Type: token
Path: RelatedPerson.identifier

See Also:

Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: A patient Identifier
Type: token
Path: RelatedPerson.identifier

SP_ADDRESS_POSTALCODE

public static final String SP_ADDRESS_POSTALCODE

Search parameter: address-postalcode

Description: A postal code specified in an address
Type: string
Path: RelatedPerson.address.postalCode

See Also:

Constant Field Values

ADDRESS_POSTALCODE

public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_POSTALCODE

Fluent Client search parameter constant for address-postalcode

Description: A postal code specified in an address
Type: string
Path: RelatedPerson.address.postalCode

Constructor Detail

RelatedPerson

public RelatedPerson()

Constructor

RelatedPerson

public RelatedPerson(Reference patient)

Constructor

Method Detail

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

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

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

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Description copied from class: Base

make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property

Overrides:

makeProperty in class DomainResource

Returns:

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