
Class RelatedPerson
- All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement
,ca.uhn.fhir.model.api.IElement
,ca.uhn.fhir.model.api.IResource
,ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseResource
public class RelatedPerson extends BaseResource implements ca.uhn.fhir.model.api.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
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.StringClientParam
ADDRESS
Fluent Client search parameter constant for addressstatic ca.uhn.fhir.rest.gclient.StringClientParam
ADDRESS_CITY
Fluent Client search parameter constant for address-citystatic ca.uhn.fhir.rest.gclient.StringClientParam
ADDRESS_COUNTRY
Fluent Client search parameter constant for address-countrystatic ca.uhn.fhir.rest.gclient.StringClientParam
ADDRESS_POSTALCODE
Fluent Client search parameter constant for address-postalcodestatic ca.uhn.fhir.rest.gclient.StringClientParam
ADDRESS_STATE
Fluent Client search parameter constant for address-statestatic ca.uhn.fhir.rest.gclient.TokenClientParam
ADDRESS_USE
Fluent Client search parameter constant for address-usestatic ca.uhn.fhir.rest.gclient.DateClientParam
BIRTHDATE
Fluent Client search parameter constant for birthdatestatic ca.uhn.fhir.rest.gclient.TokenClientParam
EMAIL
Fluent Client search parameter constant for emailstatic ca.uhn.fhir.rest.gclient.TokenClientParam
GENDER
Fluent Client search parameter constant for genderstatic ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.StringClientParam
NAME
Fluent Client search parameter constant for namestatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientstatic ca.uhn.fhir.rest.gclient.TokenClientParam
PHONE
Fluent Client search parameter constant for phonestatic ca.uhn.fhir.rest.gclient.StringClientParam
PHONETIC
Fluent Client search parameter constant for phoneticstatic String
SP_ADDRESS
Search parameter constant for addressstatic String
SP_ADDRESS_CITY
Search parameter constant for address-citystatic String
SP_ADDRESS_COUNTRY
Search parameter constant for address-countrystatic String
SP_ADDRESS_POSTALCODE
Search parameter constant for address-postalcodestatic String
SP_ADDRESS_STATE
Search parameter constant for address-statestatic String
SP_ADDRESS_USE
Search parameter constant for address-usestatic String
SP_BIRTHDATE
Search parameter constant for birthdatestatic String
SP_EMAIL
Search parameter constant for emailstatic String
SP_GENDER
Search parameter constant for genderstatic String
SP_IDENTIFIER
Search parameter constant for identifierstatic String
SP_NAME
Search parameter constant for namestatic String
SP_PATIENT
Search parameter constant for patientstatic String
SP_PHONE
Search parameter constant for phonestatic String
SP_PHONETIC
Search parameter constant for phoneticstatic String
SP_TELECOM
Search parameter constant for telecomstatic ca.uhn.fhir.rest.gclient.TokenClientParam
TELECOM
Fluent Client search parameter constant for telecomFields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
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()
-
Method Summary
Modifier and Type Method 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 ca.uhn.fhir.model.api.IElement>
List<T>getAllPopulatedChildElementsOfType(Class<T> theType)
Date
getBirthDate()
Gets the value(s) for birthDate ().ca.uhn.fhir.model.primitive.DateDt
getBirthDateElement()
Gets the value(s) for birthDate ().String
getGender()
Gets the value(s) for gender ().ca.uhn.fhir.model.primitive.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()
ca.uhn.fhir.context.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(ca.uhn.fhir.model.primitive.DateDt theValue)
Sets the value(s) for birthDate ()RelatedPerson
setBirthDate(Date theDate, ca.uhn.fhir.model.api.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(ca.uhn.fhir.model.primitive.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 ()Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString
Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId
Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata
-
Field Details
-
SP_IDENTIFIER
Search parameter constant for identifierDescription: A patient Identifier
Type: token
Path: RelatedPerson.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: A patient Identifier
Type: token
Path: RelatedPerson.identifier
-
SP_NAME
Search parameter constant for nameDescription: A portion of name in any name part
Type: string
Path: RelatedPerson.name
- See Also:
- Constant Field Values
-
NAME
Fluent Client search parameter constant for nameDescription: A portion of name in any name part
Type: string
Path: RelatedPerson.name
-
SP_PHONETIC
Search parameter constant for phoneticDescription: A portion of name using some kind of phonetic matching algorithm
Type: string
Path: RelatedPerson.name
- See Also:
- Constant Field Values
-
PHONETIC
Fluent Client search parameter constant for phoneticDescription: A portion of name using some kind of phonetic matching algorithm
Type: string
Path: RelatedPerson.name
-
SP_TELECOM
Search parameter constant for telecomDescription: The value in any kind of contact
Type: token
Path: RelatedPerson.telecom
- See Also:
- Constant Field Values
-
TELECOM
Fluent Client search parameter constant for telecomDescription: The value in any kind of contact
Type: token
Path: RelatedPerson.telecom
-
SP_PHONE
Search parameter constant for phoneDescription: A value in a phone contact
Type: token
Path: RelatedPerson.telecom(system=phone)
- See Also:
- Constant Field Values
-
PHONE
Fluent Client search parameter constant for phoneDescription: A value in a phone contact
Type: token
Path: RelatedPerson.telecom(system=phone)
-
SP_EMAIL
Search parameter constant for emailDescription: A value in an email contact
Type: token
Path: RelatedPerson.telecom(system=email)
- See Also:
- Constant Field Values
-
EMAIL
Fluent Client search parameter constant for emailDescription: A value in an email contact
Type: token
Path: RelatedPerson.telecom(system=email)
-
SP_ADDRESS
Search parameter constant for addressDescription: An address in any kind of address/part
Type: string
Path: RelatedPerson.address
- See Also:
- Constant Field Values
-
ADDRESS
Fluent Client search parameter constant for addressDescription: An address in any kind of address/part
Type: string
Path: RelatedPerson.address
-
SP_ADDRESS_CITY
Search parameter constant for address-cityDescription: A city specified in an address
Type: string
Path: RelatedPerson.address.city
- See Also:
- Constant Field Values
-
ADDRESS_CITY
Fluent Client search parameter constant for address-cityDescription: A city specified in an address
Type: string
Path: RelatedPerson.address.city
-
SP_ADDRESS_STATE
Search parameter constant for address-stateDescription: A state specified in an address
Type: string
Path: RelatedPerson.address.state
- See Also:
- Constant Field Values
-
ADDRESS_STATE
Fluent Client search parameter constant for address-stateDescription: A state specified in an address
Type: string
Path: RelatedPerson.address.state
-
SP_ADDRESS_POSTALCODE
Search parameter constant for address-postalcodeDescription: A postal code specified in an address
Type: string
Path: RelatedPerson.address.postalCode
- See Also:
- Constant Field Values
-
ADDRESS_POSTALCODE
Fluent Client search parameter constant for address-postalcodeDescription: A postal code specified in an address
Type: string
Path: RelatedPerson.address.postalCode
-
SP_ADDRESS_COUNTRY
Search parameter constant for address-countryDescription: A country specified in an address
Type: string
Path: RelatedPerson.address.country
- See Also:
- Constant Field Values
-
ADDRESS_COUNTRY
Fluent Client search parameter constant for address-countryDescription: A country specified in an address
Type: string
Path: RelatedPerson.address.country
-
SP_ADDRESS_USE
Search parameter constant for address-useDescription: A use code specified in an address
Type: token
Path: RelatedPerson.address.use
- See Also:
- Constant Field Values
-
ADDRESS_USE
Fluent Client search parameter constant for address-useDescription: A use code specified in an address
Type: token
Path: RelatedPerson.address.use
-
SP_BIRTHDATE
Search parameter constant for birthdateDescription: The Related Person's date of birth
Type: date
Path: RelatedPerson.birthDate
- See Also:
- Constant Field Values
-
BIRTHDATE
Fluent Client search parameter constant for birthdateDescription: The Related Person's date of birth
Type: date
Path: RelatedPerson.birthDate
-
SP_GENDER
Search parameter constant for genderDescription: Gender of the person
Type: token
Path: RelatedPerson.gender
- See Also:
- Constant Field Values
-
GENDER
Fluent Client search parameter constant for genderDescription: Gender of the person
Type: token
Path: RelatedPerson.gender
-
SP_PATIENT
Search parameter constant for patientDescription: The patient this person is related to
Type: reference
Path: RelatedPerson.patient
- See Also:
- Constant Field Values
-
PATIENT
Fluent Client search parameter constant for patientDescription: The patient this person is related to
Type: reference
Path: RelatedPerson.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "RelatedPerson:patient".
-
-
Constructor Details
-
RelatedPerson
public RelatedPerson()
-
-
Method Details
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
-
getAllPopulatedChildElementsOfType
public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)- Specified by:
getAllPopulatedChildElementsOfType
in interfaceca.uhn.fhir.model.api.ICompositeElement
-
getIdentifier
Gets the value(s) for identifier (id). creating it if it does not exist. Will not returnnull
.Definition: Identifier for a person within a particular scope.
-
setIdentifier
Sets the value(s) for identifier (id)Definition: Identifier for a person within a particular scope.
-
addIdentifier
Adds and returns a new value for identifier (id)Definition: Identifier for a person within a particular scope.
-
addIdentifier
Adds a given new value for identifier (id)Definition: Identifier for a person within a particular scope.
- Parameters:
theValue
- The identifier to add (must not benull
)
-
getIdentifierFirstRep
Gets the first repetition for identifier (id), creating it if it does not already exist.Definition: Identifier for a person within a particular scope.
-
getPatient
Gets the value(s) for patient (). creating it if it does not exist. Will not returnnull
.Definition: The patient this person is related to
-
setPatient
Sets the value(s) for patient ()Definition: The patient this person is related to
-
getRelationship
Gets the value(s) for relationship (class). creating it if it does not exist. Will not returnnull
.Definition: The nature of the relationship between a patient and the related person
-
setRelationship
Sets the value(s) for relationship (class)Definition: The nature of the relationship between a patient and the related person
-
getName
Gets the value(s) for name (). creating it if it does not exist. Will not returnnull
.Definition: A name associated with the person
-
setName
Sets the value(s) for name ()Definition: A name associated with the person
-
getTelecom
Gets the value(s) for telecom (). creating it if it does not exist. Will not returnnull
.Definition: A contact detail for the person, e.g. a telephone number or an email address.
-
setTelecom
Sets the value(s) for telecom ()Definition: A contact detail for the person, e.g. a telephone number or an email address.
-
addTelecom
Adds and returns a new value for telecom ()Definition: A contact detail for the person, e.g. a telephone number or an email address.
-
addTelecom
Adds a given new value for telecom ()Definition: A contact detail for the person, e.g. a telephone number or an email address.
- Parameters:
theValue
- The telecom to add (must not benull
)
-
getTelecomFirstRep
Gets the first repetition for telecom (), creating it if it does not already exist.Definition: A contact detail for the person, e.g. a telephone number or an email address.
-
getGenderElement
Gets the value(s) for gender (). creating it if it does not exist. Will not returnnull
.Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
getGender
Gets the value(s) for gender (). creating it if it does not exist. This method may returnnull
.Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
setGender
public RelatedPerson setGender(ca.uhn.fhir.model.primitive.BoundCodeDt<AdministrativeGenderEnum> theValue)Sets the value(s) for gender ()Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
setGender
Sets the value(s) for gender ()Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
getBirthDateElement
Gets the value(s) for birthDate (). creating it if it does not exist. Will not returnnull
.Definition:
-
getBirthDate
Gets the value(s) for birthDate (). creating it if it does not exist. This method may returnnull
.Definition:
-
setBirthDate
Sets the value(s) for birthDate ()Definition:
-
setBirthDate
public RelatedPerson setBirthDate(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)Sets the value for birthDate ()Definition:
-
setBirthDateWithDayPrecision
Sets the value for birthDate ()Definition:
-
getAddress
Gets the value(s) for address (). creating it if it does not exist. Will not returnnull
.Definition: Address where the related person can be contacted or visited
-
setAddress
Sets the value(s) for address ()Definition: Address where the related person can be contacted or visited
-
addAddress
Adds and returns a new value for address ()Definition: Address where the related person can be contacted or visited
-
addAddress
Adds a given new value for address ()Definition: Address where the related person can be contacted or visited
- Parameters:
theValue
- The address to add (must not benull
)
-
getAddressFirstRep
Gets the first repetition for address (), creating it if it does not already exist.Definition: Address where the related person can be contacted or visited
-
getPhoto
Gets the value(s) for photo (). creating it if it does not exist. Will not returnnull
.Definition: Image of the person
-
setPhoto
Sets the value(s) for photo ()Definition: Image of the person
-
addPhoto
Adds and returns a new value for photo ()Definition: Image of the person
-
addPhoto
Adds a given new value for photo ()Definition: Image of the person
- Parameters:
theValue
- The photo to add (must not benull
)
-
getPhotoFirstRep
Gets the first repetition for photo (), creating it if it does not already exist.Definition: Image of the person
-
getPeriod
Gets the value(s) for period (when.done). creating it if it does not exist. Will not returnnull
.Definition: The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.
-
setPeriod
Sets the value(s) for period (when.done)Definition: The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.
-
getResourceName
- Specified by:
getResourceName
in interfaceca.uhn.fhir.model.api.IResource
-
getStructureFhirVersionEnum
- Specified by:
getStructureFhirVersionEnum
in interfaceorg.hl7.fhir.instance.model.api.IBaseResource
- Specified by:
getStructureFhirVersionEnum
in interfaceca.uhn.fhir.model.api.IResource
-