Package com.ibm.fhir.model.resource

Class RelatedPerson

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.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)

    • Method Detail

      • getIdentifier

        public 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 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 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 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 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 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.

      • accept

        public void accept​(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 interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object