RelatedPerson (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.BaseResource
  - - org.hl7.fhir.r4.model.Resource
    - - org.hl7.fhir.r4.model.DomainResource
      - org.hl7.fhir.r4.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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RelatedPerson.RelatedPersonCommunicationComponent

Nested Classes
Modifier and Type	Class and Description
`static class`	`RelatedPerson.RelatedPersonCommunicationComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected BooleanType`	`active` Whether this related person record is in active use.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ACTIVE` Fluent Client search parameter constant for active
`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
`protected List<RelatedPerson.RelatedPersonCommunicationComponent>`	`communication` A language which may be used to communicate with about the patient's health.
`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 List<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 during which this relationship is or was active.
`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 List<CodeableConcept>`	`relationship` The nature of the relationship between a patient and the related person.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`RELATIONSHIP` Fluent Client search parameter constant for relationship
`static String`	`SP_ACTIVE` Search parameter: active
`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_RELATIONSHIP` Search parameter: relationship
`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.r4.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.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 and Description

RelatedPerson()
Constructor

RelatedPerson(Reference patient)
Constructor

Constructors
Constructor and Description
`RelatedPerson()` Constructor
`RelatedPerson(Reference patient)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Address`	`addAddress()`
`RelatedPerson`	`addAddress(Address t)`
`Base`	`addChild(String name)`
`RelatedPerson.RelatedPersonCommunicationComponent`	`addCommunication()`
`RelatedPerson`	`addCommunication(RelatedPerson.RelatedPersonCommunicationComponent t)`
`Identifier`	`addIdentifier()`
`RelatedPerson`	`addIdentifier(Identifier t)`
`HumanName`	`addName()`
`RelatedPerson`	`addName(HumanName t)`
`Attachment`	`addPhoto()`
`RelatedPerson`	`addPhoto(Attachment t)`
`CodeableConcept`	`addRelationship()`
`RelatedPerson`	`addRelationship(CodeableConcept t)`
`ContactPoint`	`addTelecom()`
`RelatedPerson`	`addTelecom(ContactPoint t)`
`RelatedPerson`	`copy()`
`void`	`copyValues(RelatedPerson dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`boolean`	`getActive()`
`BooleanType`	`getActiveElement()`
`List<Address>`	`getAddress()`
`Address`	`getAddressFirstRep()`
`Date`	`getBirthDate()`
`DateType`	`getBirthDateElement()`
`List<RelatedPerson.RelatedPersonCommunicationComponent>`	`getCommunication()`
`RelatedPerson.RelatedPersonCommunicationComponent`	`getCommunicationFirstRep()`
`Enumerations.AdministrativeGender`	`getGender()`
`Enumeration<Enumerations.AdministrativeGender>`	`getGenderElement()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`List<HumanName>`	`getName()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`HumanName`	`getNameFirstRep()`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`Period`	`getPeriod()`
`List<Attachment>`	`getPhoto()`
`Attachment`	`getPhotoFirstRep()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<CodeableConcept>`	`getRelationship()`
`CodeableConcept`	`getRelationshipFirstRep()`
`ResourceType`	`getResourceType()`
`List<ContactPoint>`	`getTelecom()`
`ContactPoint`	`getTelecomFirstRep()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasActive()`
`boolean`	`hasActiveElement()`
`boolean`	`hasAddress()`
`boolean`	`hasBirthDate()`
`boolean`	`hasBirthDateElement()`
`boolean`	`hasCommunication()`
`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> children)`
`Base`	`makeProperty(int hash, String name)`
`RelatedPerson`	`setActive(boolean value)`
`RelatedPerson`	`setActiveElement(BooleanType value)`
`RelatedPerson`	`setAddress(List<Address> theAddress)`
`RelatedPerson`	`setBirthDate(Date value)`
`RelatedPerson`	`setBirthDateElement(DateType value)`
`RelatedPerson`	`setCommunication(List<RelatedPerson.RelatedPersonCommunicationComponent> theCommunication)`
`RelatedPerson`	`setGender(Enumerations.AdministrativeGender value)`
`RelatedPerson`	`setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)`
`RelatedPerson`	`setIdentifier(List<Identifier> theIdentifier)`
`RelatedPerson`	`setName(List<HumanName> theName)`
`RelatedPerson`	`setPatient(Reference value)`
`RelatedPerson`	`setPatientTarget(Patient value)`
`RelatedPerson`	`setPeriod(Period value)`
`RelatedPerson`	`setPhoto(List<Attachment> thePhoto)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`RelatedPerson`	`setRelationship(List<CodeableConcept> theRelationship)`
`RelatedPerson`	`setTelecom(List<ContactPoint> theTelecom)`
`protected RelatedPerson`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    Identifier for a person within a particular scope.
  - active
```
protected BooleanType active
```
    Whether this related person record is in active use.
  - 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 List<CodeableConcept> relationship
```
    The nature of the relationship between a patient and the related person.
  - 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 - 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 during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
  - communication
```
protected List<RelatedPerson.RelatedPersonCommunicationComponent> communication
```
    A language which may be used to communicate with about the patient's health.
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: An Identifier of the RelatedPerson
    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: An Identifier of the RelatedPerson
    Type: token
    Path: RelatedPerson.identifier
  - SP_ADDRESS
```
public static final String SP_ADDRESS
```
    Search parameter: address
    Description: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
    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: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
    Type: string
    Path: RelatedPerson.address
  - 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_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_GENDER
```
public static final String SP_GENDER
```
    Search parameter: gender
    Description: Gender of the related 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 related person
    Type: token
    Path: RelatedPerson.gender
  - SP_ACTIVE
```
public static final String SP_ACTIVE
```
    Search parameter: active
    Description: Indicates if the related person record is active
    Type: token
    Path: RelatedPerson.active
    
    See Also:
    
    Constant Field Values
  - ACTIVE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTIVE
```
    Fluent Client search parameter constant for active
    Description: Indicates if the related person record is active
    Type: token
    Path: RelatedPerson.active
  - 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
  - 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_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_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_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: The patient this related 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 related 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_NAME
```
public static final String SP_NAME
```
    Search parameter: name
    Description: A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
    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 server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
    Type: string
    Path: RelatedPerson.name
  - 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_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_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_RELATIONSHIP
```
public static final String SP_RELATIONSHIP
```
    Search parameter: relationship
    Description: The relationship between the patient and the relatedperson
    Type: token
    Path: RelatedPerson.relationship
    
    See Also:
    
    Constant Field Values
  - RELATIONSHIP
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATIONSHIP
```
    Fluent Client search parameter constant for relationship
    Description: The relationship between the patient and the relatedperson
    Type: token
    Path: RelatedPerson.relationship
  - 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)
- 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.)
  - setIdentifier
```
public RelatedPerson setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public RelatedPerson addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getActiveElement
```
public BooleanType getActiveElement()
```
    Returns:
    
    active (Whether this related person 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 RelatedPerson setActiveElement(BooleanType value)
```
    Parameters:
    
    value - active (Whether this related person 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 related person record is in active use.
  - setActive
```
public RelatedPerson setActive(boolean value)
```
    Parameters:
    
    value - Whether this related person record is in active use.
  - 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 List<CodeableConcept> getRelationship()
```
    Returns:
    
    relationship (The nature of the relationship between a patient and the related person.)
  - setRelationship
```
public RelatedPerson setRelationship(List<CodeableConcept> theRelationship)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasRelationship
```
public boolean hasRelationship()
```
  - addRelationship
```
public CodeableConcept addRelationship()
```
  - addRelationship
```
public RelatedPerson addRelationship(CodeableConcept t)
```
  - getRelationshipFirstRep
```
public CodeableConcept getRelationshipFirstRep()
```
    Returns:
    
    The first repetition of repeating field relationship, creating it if it does not already exist
  - getName
```
public List<HumanName> getName()
```
    Returns:
    
    name (A name associated with the person.)
  - setName
```
public RelatedPerson setName(List<HumanName> theName)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasName
```
public boolean hasName()
```
  - addName
```
public HumanName addName()
```
  - addName
```
public RelatedPerson addName(HumanName t)
```
  - getNameFirstRep
```
public HumanName getNameFirstRep()
```
    Returns:
    
    The first repetition of repeating field name, creating it if it does not already exist
  - getTelecom
```
public List<ContactPoint> getTelecom()
```
    Returns:
    
    telecom (A contact detail for the person, e.g. a telephone number or an email address.)
  - setTelecom
```
public RelatedPerson setTelecom(List<ContactPoint> theTelecom)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasTelecom
```
public boolean hasTelecom()
```
  - addTelecom
```
public ContactPoint addTelecom()
```
  - addTelecom
```
public RelatedPerson addTelecom(ContactPoint t)
```
  - getTelecomFirstRep
```
public ContactPoint getTelecomFirstRep()
```
    Returns:
    
    The first repetition of repeating field telecom, creating it if it does not already exist
  - 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.)
  - setAddress
```
public RelatedPerson setAddress(List<Address> theAddress)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAddress
```
public boolean hasAddress()
```
  - addAddress
```
public Address addAddress()
```
  - addAddress
```
public RelatedPerson addAddress(Address t)
```
  - getAddressFirstRep
```
public Address getAddressFirstRep()
```
    Returns:
    
    The first repetition of repeating field address, creating it if it does not already exist
  - getPhoto
```
public List<Attachment> getPhoto()
```
    Returns:
    
    photo (Image of the person.)
  - setPhoto
```
public RelatedPerson setPhoto(List<Attachment> thePhoto)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasPhoto
```
public boolean hasPhoto()
```
  - addPhoto
```
public Attachment addPhoto()
```
  - addPhoto
```
public RelatedPerson addPhoto(Attachment t)
```
  - getPhotoFirstRep
```
public Attachment getPhotoFirstRep()
```
    Returns:
    
    The first repetition of repeating field photo, creating it if it does not already exist
  - getPeriod
```
public Period getPeriod()
```
    Returns:
    
    period (The period of time during which this relationship is or was active. 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 during which this relationship is or was active. If there are no dates defined, then the interval is unknown.)
  - getCommunication
```
public List<RelatedPerson.RelatedPersonCommunicationComponent> getCommunication()
```
    Returns:
    
    communication (A language which may be used to communicate with about the patient's health.)
  - setCommunication
```
public RelatedPerson setCommunication(List<RelatedPerson.RelatedPersonCommunicationComponent> theCommunication)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasCommunication
```
public boolean hasCommunication()
```
  - addCommunication
```
public RelatedPerson.RelatedPersonCommunicationComponent addCommunication()
```
  - addCommunication
```
public RelatedPerson addCommunication(RelatedPerson.RelatedPersonCommunicationComponent t)
```
  - getCommunicationFirstRep
```
public RelatedPerson.RelatedPersonCommunicationComponent getCommunicationFirstRep()
```
    Returns:
    
    The first repetition of repeating field communication, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - 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 Base 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 Base 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
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty 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
  - copyValues
```
public void copyValues(RelatedPerson dst)
```
  - 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

Class RelatedPerson

Nested Class Summary

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

identifier

active

patient

patientTarget

relationship

name

telecom

gender

birthDate

address

photo

period

communication

SP_IDENTIFIER

IDENTIFIER

SP_ADDRESS

ADDRESS

SP_BIRTHDATE

BIRTHDATE

SP_ADDRESS_STATE

ADDRESS_STATE

SP_GENDER

GENDER

SP_ACTIVE

ACTIVE

SP_ADDRESS_POSTALCODE

ADDRESS_POSTALCODE

SP_ADDRESS_COUNTRY

ADDRESS_COUNTRY

SP_PHONETIC

PHONETIC

SP_PHONE

PHONE

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_NAME

NAME

SP_ADDRESS_USE

ADDRESS_USE

SP_TELECOM

TELECOM

SP_ADDRESS_CITY

ADDRESS_CITY

SP_RELATIONSHIP

RELATIONSHIP

SP_EMAIL

EMAIL

Constructor Detail

RelatedPerson

RelatedPerson

Method Detail

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getActiveElement

hasActiveElement

hasActive

setActiveElement