RelatedPerson (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.RelatedPerson

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class RelatedPerson
extends BaseResource
implements IResource
```
HAPI/FHIR RelatedPerson Resource (An person that is related to a patient, but who is not a direct target of care)
Definition: 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

Requirements: Need to track persons related to the patient or the healthcare process.

Profile Definition: http://hl7.org/fhir/profiles/RelatedPerson

Field Summary

Fields
Modifier and Type	Field and Description
`static StringClientParam`	`ADDRESS` Fluent Client search parameter constant for address
`static TokenClientParam`	`GENDER` Fluent Client search parameter constant for gender
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static StringClientParam`	`PHONETIC` Fluent Client search parameter constant for phonetic
`static String`	`SP_ADDRESS` Search parameter constant for address
`static String`	`SP_GENDER` Search parameter constant for gender
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_NAME` Search parameter constant for name
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_PHONETIC` Search parameter constant for phonetic
`static String`	`SP_TELECOM` Search parameter constant for telecom
`static StringClientParam`	`TELECOM` Fluent Client search parameter constant for telecom

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

RelatedPerson()

Constructors
Constructor and Description
`RelatedPerson()`

Method Summary

Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (A Human identifier for this person)
`RelatedPerson`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (A Human identifier for this person)
`RelatedPerson`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (A Human identifier for this person)
`AttachmentDt`	`addPhoto()` Adds and returns a new value for photo (Image of the person)
`ContactDt`	`addTelecom()` Adds and returns a new value for telecom (A contact detail for the person)
`RelatedPerson`	`addTelecom(ContactUseEnum theContactUse, String theValue)` Adds a new value for telecom (A contact detail for the person)
`RelatedPerson`	`addTelecom(String theValue)` Adds a new value for telecom (A contact detail for the person)
`AddressDt`	`getAddress()` Gets the value(s) for address (Address where the related person can be contacted or visited).
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`BoundCodeableConceptDt<AdministrativeGenderCodesEnum>`	`getGender()` Gets the value(s) for gender (Gender for administrative purposes).
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (A Human identifier for this person).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (A Human identifier for this person), creating it if it does not already exist.
`HumanNameDt`	`getName()` Gets the value(s) for name (A name associated with the person).
`ResourceReferenceDt`	`getPatient()` Gets the value(s) for patient (The patient this person is related to).
`List<AttachmentDt>`	`getPhoto()` Gets the value(s) for photo (Image of the person).
`AttachmentDt`	`getPhotoFirstRep()` Gets the first repetition for photo (Image of the person), creating it if it does not already exist.
`BoundCodeableConceptDt<PatientRelationshipTypeEnum>`	`getRelationship()` Gets the value(s) for relationship (The nature of the relationship).
`List<ContactDt>`	`getTelecom()` Gets the value(s) for telecom (A contact detail for the person).
`ContactDt`	`getTelecomFirstRep()` Gets the first repetition for telecom (A contact detail for the person), creating it if it does not already exist.
`boolean`	`isEmpty()`
`RelatedPerson`	`setAddress(AddressDt theValue)` Sets the value(s) for address (Address where the related person can be contacted or visited)
`RelatedPerson`	`setGender(AdministrativeGenderCodesEnum theValue)` Sets the value(s) for gender (Gender for administrative purposes)
`RelatedPerson`	`setGender(BoundCodeableConceptDt<AdministrativeGenderCodesEnum> theValue)` Sets the value(s) for gender (Gender for administrative purposes)
`RelatedPerson`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (A Human identifier for this person)
`RelatedPerson`	`setName(HumanNameDt theValue)` Sets the value(s) for name (A name associated with the person)
`RelatedPerson`	`setPatient(ResourceReferenceDt theValue)` Sets the value(s) for patient (The patient this person is related to)
`RelatedPerson`	`setPhoto(List<AttachmentDt> theValue)` Sets the value(s) for photo (Image of the person)
`RelatedPerson`	`setRelationship(BoundCodeableConceptDt<PatientRelationshipTypeEnum> theValue)` Sets the value(s) for relationship (The nature of the relationship)
`RelatedPerson`	`setRelationship(PatientRelationshipTypeEnum theValue)` Sets the value(s) for relationship (The nature of the relationship)
`RelatedPerson`	`setTelecom(List<ContactDt> theValue)` Sets the value(s) for telecom (A contact detail for the person)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: A patient Identifier
    Type: token
    Path: RelatedPerson.identifier
    
    See Also:
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: A patient Identifier
    Type: token
    Path: RelatedPerson.identifier
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter constant for name
    Description: A portion of name in any name part
    Type: string
    Path: RelatedPerson.name
    
    See Also:
    Constant Field Values
  - NAME
```
public static final StringClientParam NAME
```
    Fluent Client search parameter constant for name
    Description: A portion of name in any name part
    Type: string
    Path: RelatedPerson.name
  - SP_PHONETIC
```
public static final String SP_PHONETIC
```
    Search parameter constant for phonetic
    Description: A portion of name using some kind of phonetic matching algorithm
    Type: string
    Path:
    
    See Also:
    Constant Field Values
  - PHONETIC
```
public static final StringClientParam PHONETIC
```
    Fluent Client search parameter constant for phonetic
    Description: A portion of name using some kind of phonetic matching algorithm
    Type: string
    Path:
  - SP_TELECOM
```
public static final String SP_TELECOM
```
    Search parameter constant for telecom
    Description: The value in any kind of contact
    Type: string
    Path: RelatedPerson.telecom
    
    See Also:
    Constant Field Values
  - TELECOM
```
public static final StringClientParam TELECOM
```
    Fluent Client search parameter constant for telecom
    Description: The value in any kind of contact
    Type: string
    Path: RelatedPerson.telecom
  - SP_ADDRESS
```
public static final String SP_ADDRESS
```
    Search parameter constant for address
    Description: An address in any kind of address/part
    Type: string
    Path: RelatedPerson.address
    
    See Also:
    Constant Field Values
  - ADDRESS
```
public static final StringClientParam ADDRESS
```
    Fluent Client search parameter constant for address
    Description: An address in any kind of address/part
    Type: string
    Path: RelatedPerson.address
  - SP_GENDER
```
public static final String SP_GENDER
```
    Search parameter constant for gender
    Description: Gender of the person
    Type: token
    Path: RelatedPerson.gender
    
    See Also:
    Constant Field Values
  - GENDER
```
public static final TokenClientParam GENDER
```
    Fluent Client search parameter constant for gender
    Description: Gender of the person
    Type: token
    Path: RelatedPerson.gender
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description: The patient this person is related to
    Type: reference
    Path: RelatedPerson.patient
    
    See Also:
    Constant Field Values
  - PATIENT
```
public static final 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 Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "RelatedPerson.patient".
- Constructor Detail
  - RelatedPerson
```
public RelatedPerson()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (A Human identifier for this person). creating it if it does not exist. Will not return null.
    Definition: Identifier for a person within a particular scope.
  - setIdentifier
```
public RelatedPerson setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (A Human identifier for this person)
    Definition: Identifier for a person within a particular scope.
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (A Human identifier for this person)
    Definition: Identifier for a person within a particular scope.
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (A Human identifier for this person), creating it if it does not already exist.
    Definition: Identifier for a person within a particular scope.
  - addIdentifier
```
public RelatedPerson addIdentifier(IdentifierUseEnum theUse,
                          String theSystem,
                          String theValue,
                          String theLabel)
```
    Adds a new value for identifier (A Human identifier for this person)
    Definition: Identifier for a person within a particular scope.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public RelatedPerson addIdentifier(String theSystem,
                          String theValue)
```
    Adds a new value for identifier (A Human identifier for this person)
    Definition: Identifier for a person within a particular scope.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getPatient
```
public ResourceReferenceDt getPatient()
```
    Gets the value(s) for patient (The patient this person is related to). creating it if it does not exist. Will not return null.
    Definition: The patient this person is related to
  - setPatient
```
public RelatedPerson setPatient(ResourceReferenceDt theValue)
```
    Sets the value(s) for patient (The patient this person is related to)
    Definition: The patient this person is related to
  - getRelationship
```
public BoundCodeableConceptDt<PatientRelationshipTypeEnum> getRelationship()
```
    Gets the value(s) for relationship (The nature of the relationship). creating it if it does not exist. Will not return null.
    Definition: The nature of the relationship between a patient and the related person
  - setRelationship
```
public RelatedPerson setRelationship(BoundCodeableConceptDt<PatientRelationshipTypeEnum> theValue)
```
    Sets the value(s) for relationship (The nature of the relationship)
    Definition: The nature of the relationship between a patient and the related person
  - setRelationship
```
public RelatedPerson setRelationship(PatientRelationshipTypeEnum theValue)
```
    Sets the value(s) for relationship (The nature of the relationship)
    Definition: The nature of the relationship between a patient and the related person
  - getName
```
public HumanNameDt getName()
```
    Gets the value(s) for name (A name associated with the person). creating it if it does not exist. Will not return null.
    Definition: A name associated with the person
  - setName
```
public RelatedPerson setName(HumanNameDt theValue)
```
    Sets the value(s) for name (A name associated with the person)
    Definition: A name associated with the person
  - getTelecom
```
public List<ContactDt> getTelecom()
```
    Gets the value(s) for telecom (A contact detail for the person). creating it if it does not exist. Will not return null.
    Definition: A contact detail for the person, e.g. a telephone number or an email address.
  - setTelecom
```
public RelatedPerson setTelecom(List<ContactDt> theValue)
```
    Sets the value(s) for telecom (A contact detail for the person)
    Definition: A contact detail for the person, e.g. a telephone number or an email address.
  - addTelecom
```
public ContactDt addTelecom()
```
    Adds and returns a new value for telecom (A contact detail for the person)
    Definition: A contact detail for the person, e.g. a telephone number or an email address.
  - getTelecomFirstRep
```
public ContactDt getTelecomFirstRep()
```
    Gets the first repetition for telecom (A contact detail for the person), creating it if it does not already exist.
    Definition: A contact detail for the person, e.g. a telephone number or an email address.
  - addTelecom
```
public RelatedPerson addTelecom(ContactUseEnum theContactUse,
                       String theValue)
```
    Adds a new value for telecom (A contact detail for the person)
    Definition: A contact detail for the person, e.g. a telephone number or an email address.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addTelecom
```
public RelatedPerson addTelecom(String theValue)
```
    Adds a new value for telecom (A contact detail for the person)
    Definition: A contact detail for the person, e.g. a telephone number or an email address.
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getGender
```
public BoundCodeableConceptDt<AdministrativeGenderCodesEnum> getGender()
```
    Gets the value(s) for gender (Gender for administrative purposes). creating it if it does not exist. Will not return null.
    Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
  - setGender
```
public RelatedPerson setGender(BoundCodeableConceptDt<AdministrativeGenderCodesEnum> theValue)
```
    Sets the value(s) for gender (Gender for administrative purposes)
    Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
  - setGender
```
public RelatedPerson setGender(AdministrativeGenderCodesEnum theValue)
```
    Sets the value(s) for gender (Gender for administrative purposes)
    Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
  - getAddress
```
public AddressDt getAddress()
```
    Gets the value(s) for address (Address where the related person can be contacted or visited). creating it if it does not exist. Will not return null.
    Definition: Address where the related person can be contacted or visited
  - setAddress
```
public RelatedPerson setAddress(AddressDt theValue)
```
    Sets the value(s) for address (Address where the related person can be contacted or visited)
    Definition: Address where the related person can be contacted or visited
  - getPhoto
```
public List<AttachmentDt> getPhoto()
```
    Gets the value(s) for photo (Image of the person). creating it if it does not exist. Will not return null.
    Definition: Image of the person
  - setPhoto
```
public RelatedPerson setPhoto(List<AttachmentDt> theValue)
```
    Sets the value(s) for photo (Image of the person)
    Definition: Image of the person
  - addPhoto
```
public AttachmentDt addPhoto()
```
    Adds and returns a new value for photo (Image of the person)
    Definition: Image of the person
  - getPhotoFirstRep
```
public AttachmentDt getPhotoFirstRep()
```
    Gets the first repetition for photo (Image of the person), creating it if it does not already exist.
    Definition: Image of the person

Class RelatedPerson

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_IDENTIFIER

IDENTIFIER

SP_NAME

NAME

SP_PHONETIC

PHONETIC

SP_TELECOM

TELECOM

SP_ADDRESS

ADDRESS

SP_GENDER

GENDER

SP_PATIENT

PATIENT

INCLUDE_PATIENT

Constructor Detail

RelatedPerson

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getPatient

setPatient

getRelationship

setRelationship

setRelationship

getName

setName

getTelecom

setTelecom

addTelecom

getTelecomFirstRep

addTelecom

addTelecom

getGender

setGender

setGender

getAddress

setAddress

getPhoto

setPhoto

addPhoto

getPhotoFirstRep