Class RelatedPerson
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.RelatedPerson
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") 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.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RelatedPerson.Builder
static class
RelatedPerson.Communication
A language which may be used to communicate with about the patient's health.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static RelatedPerson.Builder
builder()
boolean
equals(java.lang.Object obj)
Boolean
getActive()
Whether this related person record is in active use.java.util.List<Address>
getAddress()
Address where the related person can be contacted or visited.Date
getBirthDate()
The date on which the related person was born.java.util.List<RelatedPerson.Communication>
getCommunication()
A language which may be used to communicate with about the patient's health.AdministrativeGender
getGender()
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.java.util.List<Identifier>
getIdentifier()
Identifier for a person within a particular scope.java.util.List<HumanName>
getName()
A name associated with the person.Reference
getPatient()
The patient this person is related to.Period
getPeriod()
The period of time during which this relationship is or was active.java.util.List<Attachment>
getPhoto()
Image of the person.java.util.List<CodeableConcept>
getRelationship()
The nature of the relationship between a patient and the related person.java.util.List<ContactPoint>
getTelecom()
A contact detail for the person, e.g.boolean
hasChildren()
int
hashCode()
RelatedPerson.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Identifier for a person within a particular scope.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getActive
public Boolean getActive()
Whether this related person record is in active use.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getPatient
public Reference getPatient()
The patient this person is related to.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getRelationship
public java.util.List<CodeableConcept> getRelationship()
The nature of the relationship between a patient and the related person.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getName
public java.util.List<HumanName> getName()
A name associated with the person.- Returns:
- An unmodifiable list containing immutable objects of type
HumanName
that may be empty.
-
getTelecom
public java.util.List<ContactPoint> getTelecom()
A contact detail for the person, e.g. a telephone number or an email address.- Returns:
- An unmodifiable list containing immutable objects of type
ContactPoint
that may be empty.
-
getGender
public AdministrativeGender getGender()
Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.- Returns:
- An immutable object of type
AdministrativeGender
that may be null.
-
getBirthDate
public Date getBirthDate()
The date on which the related person was born.- Returns:
- An immutable object of type
Date
that may be null.
-
getAddress
public java.util.List<Address> getAddress()
Address where the related person can be contacted or visited.- Returns:
- An unmodifiable list containing immutable objects of type
Address
that may be empty.
-
getPhoto
public java.util.List<Attachment> getPhoto()
Image of the person.- Returns:
- An unmodifiable list containing immutable objects of type
Attachment
that may be empty.
-
getPeriod
public Period getPeriod()
The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.- Returns:
- An immutable object of type
Period
that may be null.
-
getCommunication
public java.util.List<RelatedPerson.Communication> getCommunication()
A language which may be used to communicate with about the patient's health.- Returns:
- An unmodifiable list containing immutable objects of type
RelatedPerson.Communication
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public RelatedPerson.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static RelatedPerson.Builder builder()
-
-