Class 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
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionprotected BooleanType
Whether this related person record is in active use.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for activeAddress where the related person can be contacted or visited.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for addressstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-citystatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-countrystatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-postalcodestatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-statestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for address-useprotected DateType
The date on which the related person was born.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for birthdateA language which may be used to communicate with about the patient's health.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for emailprotected Enumeration
<Enumerations.AdministrativeGender> Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for genderprotected List
<Identifier> Identifier for a person within a particular scope.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.A name associated with the person.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for nameprotected Reference
The patient this person is related to.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected Patient
The actual object that is the target of the reference (The patient this person is related to.)protected Period
The period of time during which this relationship is or was active.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for phonestatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for phoneticprotected List
<Attachment> Image of the person.protected List
<CodeableConcept> The nature of the relationship between a patient and the related person.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for relationshipstatic final String
Search parameter: activestatic final String
Search parameter: addressstatic final String
Search parameter: address-citystatic final String
Search parameter: address-countrystatic final String
Search parameter: address-postalcodestatic final String
Search parameter: address-statestatic final String
Search parameter: address-usestatic final String
Search parameter: birthdatestatic final String
Search parameter: emailstatic final String
Search parameter: genderstatic final String
Search parameter: identifierstatic final String
Search parameter: namestatic final String
Search parameter: patientstatic final String
Search parameter: phonestatic final String
Search parameter: phoneticstatic final String
Search parameter: relationshipstatic final String
Search parameter: telecomprotected List
<ContactPoint> A contact detail for the person, e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for telecomFields 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, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddName()
addPhoto()
copy()
void
copyValues
(RelatedPerson dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
boolean
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getPhoto()
Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
hasPhoto()
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setActive
(boolean value) setActiveElement
(BooleanType value) setAddress
(List<Address> theAddress) setBirthDate
(Date value) setBirthDateElement
(DateType value) setCommunication
(List<RelatedPerson.RelatedPersonCommunicationComponent> theCommunication) setIdentifier
(List<Identifier> theIdentifier) setPatient
(Reference value) setPatientTarget
(Patient value) setPhoto
(List<Attachment> thePhoto) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setRelationship
(List<CodeableConcept> theRelationship) setTelecom
(List<ContactPoint> theTelecom) protected RelatedPerson
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, 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, getIdPart, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Identifier for a person within a particular scope. -
active
Whether this related person record is in active use. -
patient
The patient this person is related to. -
patientTarget
The actual object that is the target of the reference (The patient this person is related to.) -
relationship
The nature of the relationship between a patient and the related person. -
name
A name associated with the person. -
telecom
A contact detail for the person, e.g. a telephone number or an email address. -
gender
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. -
birthDate
The date on which the related person was born. -
address
Address where the related person can be contacted or visited. -
photo
Image of the person. -
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
A language which may be used to communicate with about the patient's health. -
SP_IDENTIFIER
Search parameter: identifierDescription: An Identifier of the RelatedPerson
Type: token
Path: RelatedPerson.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: An Identifier of the RelatedPerson
Type: token
Path: RelatedPerson.identifier
-
SP_ADDRESS
Search parameter: addressDescription: 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:
-
ADDRESS
Fluent Client search parameter constant for addressDescription: 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
Search parameter: birthdateDescription: The Related Person's date of birth
Type: date
Path: RelatedPerson.birthDate
- See Also:
-
BIRTHDATE
Fluent Client search parameter constant for birthdateDescription: The Related Person's date of birth
Type: date
Path: RelatedPerson.birthDate
-
SP_ADDRESS_STATE
Search parameter: address-stateDescription: A state specified in an address
Type: string
Path: RelatedPerson.address.state
- See Also:
-
ADDRESS_STATE
Fluent Client search parameter constant for address-stateDescription: A state specified in an address
Type: string
Path: RelatedPerson.address.state
-
SP_GENDER
Search parameter: genderDescription: Gender of the related person
Type: token
Path: RelatedPerson.gender
- See Also:
-
GENDER
Fluent Client search parameter constant for genderDescription: Gender of the related person
Type: token
Path: RelatedPerson.gender
-
SP_ACTIVE
Search parameter: activeDescription: Indicates if the related person record is active
Type: token
Path: RelatedPerson.active
- See Also:
-
ACTIVE
Fluent Client search parameter constant for activeDescription: Indicates if the related person record is active
Type: token
Path: RelatedPerson.active
-
SP_ADDRESS_POSTALCODE
Search parameter: address-postalcodeDescription: A postal code specified in an address
Type: string
Path: RelatedPerson.address.postalCode
- See Also:
-
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: address-countryDescription: A country specified in an address
Type: string
Path: RelatedPerson.address.country
- See Also:
-
ADDRESS_COUNTRY
Fluent Client search parameter constant for address-countryDescription: A country specified in an address
Type: string
Path: RelatedPerson.address.country
-
SP_PHONETIC
Search parameter: phoneticDescription: A portion of name using some kind of phonetic matching algorithm
Type: string
Path: RelatedPerson.name
- See Also:
-
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_PHONE
Search parameter: phoneDescription: A value in a phone contact
Type: token
Path: RelatedPerson.telecom(system=phone)
- See Also:
-
PHONE
Fluent Client search parameter constant for phoneDescription: A value in a phone contact
Type: token
Path: RelatedPerson.telecom(system=phone)
-
SP_PATIENT
Search parameter: patientDescription: The patient this related person is related to
Type: reference
Path: RelatedPerson.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The patient this related 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". -
SP_NAME
Search parameter: nameDescription: 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:
-
NAME
Fluent Client search parameter constant for nameDescription: 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
Search parameter: address-useDescription: A use code specified in an address
Type: token
Path: RelatedPerson.address.use
- See Also:
-
ADDRESS_USE
Fluent Client search parameter constant for address-useDescription: A use code specified in an address
Type: token
Path: RelatedPerson.address.use
-
SP_TELECOM
Search parameter: telecomDescription: The value in any kind of contact
Type: token
Path: RelatedPerson.telecom
- See Also:
-
TELECOM
Fluent Client search parameter constant for telecomDescription: The value in any kind of contact
Type: token
Path: RelatedPerson.telecom
-
SP_ADDRESS_CITY
Search parameter: address-cityDescription: A city specified in an address
Type: string
Path: RelatedPerson.address.city
- See Also:
-
ADDRESS_CITY
Fluent Client search parameter constant for address-cityDescription: A city specified in an address
Type: string
Path: RelatedPerson.address.city
-
SP_RELATIONSHIP
Search parameter: relationshipDescription: The relationship between the patient and the relatedperson
Type: token
Path: RelatedPerson.relationship
- See Also:
-
RELATIONSHIP
Fluent Client search parameter constant for relationshipDescription: The relationship between the patient and the relatedperson
Type: token
Path: RelatedPerson.relationship
-
SP_EMAIL
Search parameter: emailDescription: A value in an email contact
Type: token
Path: RelatedPerson.telecom(system=email)
- See Also:
-
EMAIL
Fluent Client search parameter constant for emailDescription: A value in an email contact
Type: token
Path: RelatedPerson.telecom(system=email)
-
-
Constructor Details
-
RelatedPerson
public RelatedPerson()Constructor -
RelatedPerson
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Identifier for a person within a particular scope.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
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
-
hasActive
-
setActiveElement
- 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
- Returns:
- Whether this related person record is in active use.
-
setActive
- Parameters:
value
- Whether this related person record is in active use.
-
getPatient
- Returns:
patient
(The patient this person is related to.)
-
hasPatient
-
setPatient
- Parameters:
value
-patient
(The patient this person is related to.)
-
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
- 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
- Returns:
relationship
(The nature of the relationship between a patient and the related person.)
-
setRelationship
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelationship
-
addRelationship
-
addRelationship
-
getRelationshipFirstRep
- Returns:
- The first repetition of repeating field
relationship
, creating it if it does not already exist
-
getName
- Returns:
name
(A name associated with the person.)
-
setName
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasName
-
addName
-
addName
-
getNameFirstRep
- Returns:
- The first repetition of repeating field
name
, creating it if it does not already exist
-
getTelecom
- Returns:
telecom
(A contact detail for the person, e.g. a telephone number or an email address.)
-
setTelecom
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTelecom
-
addTelecom
-
addTelecom
-
getTelecomFirstRep
- Returns:
- The first repetition of repeating field
telecom
, creating it if it does not already exist
-
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
-
hasGender
-
setGenderElement
- 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
- Returns:
- Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
setGender
- Parameters:
value
- Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
-
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
-
hasBirthDate
-
setBirthDateElement
- 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
- Returns:
- The date on which the related person was born.
-
setBirthDate
- Parameters:
value
- The date on which the related person was born.
-
getAddress
- Returns:
address
(Address where the related person can be contacted or visited.)
-
setAddress
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAddress
-
addAddress
-
addAddress
-
getAddressFirstRep
- Returns:
- The first repetition of repeating field
address
, creating it if it does not already exist
-
getPhoto
- Returns:
photo
(Image of the person.)
-
setPhoto
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPhoto
-
addPhoto
-
addPhoto
-
getPhotoFirstRep
- Returns:
- The first repetition of repeating field
photo
, creating it if it does not already exist
-
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
-
setPeriod
- 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
- 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
-
addCommunication
-
addCommunication
-
getCommunicationFirstRep
- Returns:
- The first repetition of repeating field
communication
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-