public class RelatedPerson extends BaseResource implements IResource
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
| Modifier and Type | Field and Description |
|---|---|
static StringClientParam |
ADDRESS
Fluent Client search parameter constant for address
|
static StringClientParam |
ADDRESS_CITY
Fluent Client search parameter constant for address-city
|
static StringClientParam |
ADDRESS_COUNTRY
Fluent Client search parameter constant for address-country
|
static StringClientParam |
ADDRESS_POSTALCODE
Fluent Client search parameter constant for address-postalcode
|
static StringClientParam |
ADDRESS_STATE
Fluent Client search parameter constant for address-state
|
static TokenClientParam |
ADDRESS_USE
Fluent Client search parameter constant for address-use
|
static DateClientParam |
BIRTHDATE
Fluent Client search parameter constant for birthdate
|
static TokenClientParam |
EMAIL
Fluent Client search parameter constant for email
|
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 TokenClientParam |
PHONE
Fluent Client search parameter constant for phone
|
static StringClientParam |
PHONETIC
Fluent Client search parameter constant for phonetic
|
static String |
SP_ADDRESS
Search parameter constant for address
|
static String |
SP_ADDRESS_CITY
Search parameter constant for address-city
|
static String |
SP_ADDRESS_COUNTRY
Search parameter constant for address-country
|
static String |
SP_ADDRESS_POSTALCODE
Search parameter constant for address-postalcode
|
static String |
SP_ADDRESS_STATE
Search parameter constant for address-state
|
static String |
SP_ADDRESS_USE
Search parameter constant for address-use
|
static String |
SP_BIRTHDATE
Search parameter constant for birthdate
|
static String |
SP_EMAIL
Search parameter constant for email
|
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_PHONE
Search parameter constant for phone
|
static String |
SP_PHONETIC
Search parameter constant for phonetic
|
static String |
SP_TELECOM
Search parameter constant for telecom
|
static TokenClientParam |
TELECOM
Fluent Client search parameter constant for telecom
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
RelatedPerson() |
| Modifier and Type | Method and Description |
|---|---|
AddressDt |
addAddress()
Adds and returns a new value for address ()
|
RelatedPerson |
addAddress(AddressDt theValue)
Adds a given new value for address ()
|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (id)
|
RelatedPerson |
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier (id)
|
AttachmentDt |
addPhoto()
Adds and returns a new value for photo ()
|
RelatedPerson |
addPhoto(AttachmentDt theValue)
Adds a given new value for photo ()
|
ContactPointDt |
addTelecom()
Adds and returns a new value for telecom ()
|
RelatedPerson |
addTelecom(ContactPointDt theValue)
Adds a given new value for telecom ()
|
List<AddressDt> |
getAddress()
Gets the value(s) for address ().
|
AddressDt |
getAddressFirstRep()
Gets the first repetition for address (),
creating it if it does not already exist.
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
Date |
getBirthDate()
Gets the value(s) for birthDate ().
|
DateDt |
getBirthDateElement()
Gets the value(s) for birthDate ().
|
String |
getGender()
Gets the value(s) for gender ().
|
BoundCodeDt<AdministrativeGenderEnum> |
getGenderElement()
Gets the value(s) for gender ().
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (id).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (id),
creating it if it does not already exist.
|
HumanNameDt |
getName()
Gets the value(s) for name ().
|
ResourceReferenceDt |
getPatient()
Gets the value(s) for patient ().
|
PeriodDt |
getPeriod()
Gets the value(s) for period (when.done).
|
List<AttachmentDt> |
getPhoto()
Gets the value(s) for photo ().
|
AttachmentDt |
getPhotoFirstRep()
Gets the first repetition for photo (),
creating it if it does not already exist.
|
CodeableConceptDt |
getRelationship()
Gets the value(s) for relationship (class).
|
String |
getResourceName() |
FhirVersionEnum |
getStructureFhirVersionEnum() |
List<ContactPointDt> |
getTelecom()
Gets the value(s) for telecom ().
|
ContactPointDt |
getTelecomFirstRep()
Gets the first repetition for telecom (),
creating it if it does not already exist.
|
boolean |
isEmpty() |
RelatedPerson |
setAddress(List<AddressDt> theValue)
Sets the value(s) for address ()
|
RelatedPerson |
setBirthDate(DateDt theValue)
Sets the value(s) for birthDate ()
|
RelatedPerson |
setBirthDate(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for birthDate ()
|
RelatedPerson |
setBirthDateWithDayPrecision(Date theDate)
Sets the value for birthDate ()
|
RelatedPerson |
setGender(AdministrativeGenderEnum theValue)
Sets the value(s) for gender ()
|
RelatedPerson |
setGender(BoundCodeDt<AdministrativeGenderEnum> theValue)
Sets the value(s) for gender ()
|
RelatedPerson |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (id)
|
RelatedPerson |
setName(HumanNameDt theValue)
Sets the value(s) for name ()
|
RelatedPerson |
setPatient(ResourceReferenceDt theValue)
Sets the value(s) for patient ()
|
RelatedPerson |
setPeriod(PeriodDt theValue)
Sets the value(s) for period (when.done)
|
RelatedPerson |
setPhoto(List<AttachmentDt> theValue)
Sets the value(s) for photo ()
|
RelatedPerson |
setRelationship(CodeableConceptDt theValue)
Sets the value(s) for relationship (class)
|
RelatedPerson |
setTelecom(List<ContactPointDt> theValue)
Sets the value(s) for telecom ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_IDENTIFIER
Description: A patient Identifier
Type: token
Path: RelatedPerson.identifier
public static final TokenClientParam IDENTIFIER
Description: A patient Identifier
Type: token
Path: RelatedPerson.identifier
public static final String SP_NAME
Description: A portion of name in any name part
Type: string
Path: RelatedPerson.name
public static final StringClientParam NAME
Description: A portion of name in any name part
Type: string
Path: RelatedPerson.name
public static final String SP_PHONETIC
Description: A portion of name using some kind of phonetic matching algorithm
Type: string
Path: RelatedPerson.name
public static final StringClientParam PHONETIC
Description: A portion of name using some kind of phonetic matching algorithm
Type: string
Path: RelatedPerson.name
public static final String SP_TELECOM
Description: The value in any kind of contact
Type: token
Path: RelatedPerson.telecom
public static final TokenClientParam TELECOM
Description: The value in any kind of contact
Type: token
Path: RelatedPerson.telecom
public static final String SP_PHONE
Description: A value in a phone contact
Type: token
Path: RelatedPerson.telecom(system=phone)
public static final TokenClientParam PHONE
Description: A value in a phone contact
Type: token
Path: RelatedPerson.telecom(system=phone)
public static final String SP_EMAIL
Description: A value in an email contact
Type: token
Path: RelatedPerson.telecom(system=email)
public static final TokenClientParam EMAIL
Description: A value in an email contact
Type: token
Path: RelatedPerson.telecom(system=email)
public static final String SP_ADDRESS
Description: An address in any kind of address/part
Type: string
Path: RelatedPerson.address
public static final StringClientParam ADDRESS
Description: An address in any kind of address/part
Type: string
Path: RelatedPerson.address
public static final String SP_ADDRESS_CITY
Description: A city specified in an address
Type: string
Path: RelatedPerson.address.city
public static final StringClientParam ADDRESS_CITY
Description: A city specified in an address
Type: string
Path: RelatedPerson.address.city
public static final String SP_ADDRESS_STATE
Description: A state specified in an address
Type: string
Path: RelatedPerson.address.state
public static final StringClientParam ADDRESS_STATE
Description: A state specified in an address
Type: string
Path: RelatedPerson.address.state
public static final String SP_ADDRESS_POSTALCODE
Description: A postal code specified in an address
Type: string
Path: RelatedPerson.address.postalCode
public static final StringClientParam ADDRESS_POSTALCODE
Description: A postal code specified in an address
Type: string
Path: RelatedPerson.address.postalCode
public static final String SP_ADDRESS_COUNTRY
Description: A country specified in an address
Type: string
Path: RelatedPerson.address.country
public static final StringClientParam ADDRESS_COUNTRY
Description: A country specified in an address
Type: string
Path: RelatedPerson.address.country
public static final String SP_ADDRESS_USE
Description: A use code specified in an address
Type: token
Path: RelatedPerson.address.use
public static final TokenClientParam ADDRESS_USE
Description: A use code specified in an address
Type: token
Path: RelatedPerson.address.use
public static final String SP_BIRTHDATE
Description: The Related Person's date of birth
Type: date
Path: RelatedPerson.birthDate
public static final DateClientParam BIRTHDATE
Description: The Related Person's date of birth
Type: date
Path: RelatedPerson.birthDate
public static final String SP_GENDER
Description: Gender of the person
Type: token
Path: RelatedPerson.gender
public static final TokenClientParam GENDER
Description: Gender of the person
Type: token
Path: RelatedPerson.gender
public static final String SP_PATIENT
Description: The patient this person is related to
Type: reference
Path: RelatedPerson.patient
public static final ReferenceClientParam PATIENT
Description: The patient this person is related to
Type: reference
Path: RelatedPerson.patient
public static final Include INCLUDE_PATIENT
public RelatedPerson()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic List<IdentifierDt> getIdentifier()
null.
Definition: Identifier for a person within a particular scope.
public RelatedPerson setIdentifier(List<IdentifierDt> theValue)
Definition: Identifier for a person within a particular scope.
public IdentifierDt addIdentifier()
Definition: Identifier for a person within a particular scope.
public RelatedPerson addIdentifier(IdentifierDt theValue)
Definition: Identifier for a person within a particular scope.
theValue - The identifier to add (must not be null)public IdentifierDt getIdentifierFirstRep()
Definition: Identifier for a person within a particular scope.
public ResourceReferenceDt getPatient()
null.
Definition: The patient this person is related to
public RelatedPerson setPatient(ResourceReferenceDt theValue)
Definition: The patient this person is related to
public CodeableConceptDt getRelationship()
null.
Definition: The nature of the relationship between a patient and the related person
public RelatedPerson setRelationship(CodeableConceptDt theValue)
Definition: The nature of the relationship between a patient and the related person
public HumanNameDt getName()
null.
Definition: A name associated with the person
public RelatedPerson setName(HumanNameDt theValue)
Definition: A name associated with the person
public List<ContactPointDt> getTelecom()
null.
Definition: A contact detail for the person, e.g. a telephone number or an email address.
public RelatedPerson setTelecom(List<ContactPointDt> theValue)
Definition: A contact detail for the person, e.g. a telephone number or an email address.
public ContactPointDt addTelecom()
Definition: A contact detail for the person, e.g. a telephone number or an email address.
public RelatedPerson addTelecom(ContactPointDt theValue)
Definition: A contact detail for the person, e.g. a telephone number or an email address.
theValue - The telecom to add (must not be null)public ContactPointDt getTelecomFirstRep()
Definition: A contact detail for the person, e.g. a telephone number or an email address.
public BoundCodeDt<AdministrativeGenderEnum> getGenderElement()
null.
Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
public String getGender()
null.
Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
public RelatedPerson setGender(BoundCodeDt<AdministrativeGenderEnum> theValue)
Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
public RelatedPerson setGender(AdministrativeGenderEnum theValue)
Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
public DateDt getBirthDateElement()
null.
Definition:
public Date getBirthDate()
null.
Definition:
public RelatedPerson setBirthDate(DateDt theValue)
Definition:
public RelatedPerson setBirthDate(Date theDate, TemporalPrecisionEnum thePrecision)
Definition:
public RelatedPerson setBirthDateWithDayPrecision(Date theDate)
Definition:
public List<AddressDt> getAddress()
null.
Definition: Address where the related person can be contacted or visited
public RelatedPerson setAddress(List<AddressDt> theValue)
Definition: Address where the related person can be contacted or visited
public AddressDt addAddress()
Definition: Address where the related person can be contacted or visited
public RelatedPerson addAddress(AddressDt theValue)
Definition: Address where the related person can be contacted or visited
theValue - The address to add (must not be null)public AddressDt getAddressFirstRep()
Definition: Address where the related person can be contacted or visited
public List<AttachmentDt> getPhoto()
null.
Definition: Image of the person
public RelatedPerson setPhoto(List<AttachmentDt> theValue)
Definition: Image of the person
public AttachmentDt addPhoto()
Definition: Image of the person
public RelatedPerson addPhoto(AttachmentDt theValue)
Definition: Image of the person
theValue - The photo to add (must not be null)public AttachmentDt getPhotoFirstRep()
Definition: Image of the person
public PeriodDt getPeriod()
null.
Definition: The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.
public RelatedPerson setPeriod(PeriodDt theValue)
Definition: The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.