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
    HAPI/FHIR RelatedPerson Resource (administrative.individual)

    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 Detail

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

        Description: A patient Identifier
        Type: token
        Path: RelatedPerson.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: A patient Identifier
        Type: token
        Path: RelatedPerson.identifier

      • SP_NAME

        public static final String SP_NAME
        Search parameter constant for name

        Description: A portion of name in any name part
        Type: string
        Path: RelatedPerson.name

        See Also:
        Constant Field Values
      • NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
        Fluent Client search parameter constant for name

        Description: A portion of name in any name part
        Type: string
        Path: RelatedPerson.name

      • SP_PHONETIC

        public static final String SP_PHONETIC
        Search parameter constant for phonetic

        Description: A portion of name using some kind of phonetic matching algorithm
        Type: string
        Path: RelatedPerson.name

        See Also:
        Constant Field Values
      • PHONETIC

        public static final ca.uhn.fhir.rest.gclient.StringClientParam PHONETIC
        Fluent Client search parameter constant for phonetic

        Description: A portion of name using some kind of phonetic matching algorithm
        Type: string
        Path: RelatedPerson.name

      • SP_TELECOM

        public static final String SP_TELECOM
        Search parameter constant for telecom

        Description: The value in any kind of contact
        Type: token
        Path: RelatedPerson.telecom

        See Also:
        Constant Field Values
      • TELECOM

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TELECOM
        Fluent Client search parameter constant for telecom

        Description: The value in any kind of contact
        Type: token
        Path: RelatedPerson.telecom

      • SP_PHONE

        public static final String SP_PHONE
        Search parameter constant for phone

        Description: A value in a phone contact
        Type: token
        Path: RelatedPerson.telecom(system=phone)

        See Also:
        Constant Field Values
      • PHONE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam PHONE
        Fluent Client search parameter constant for phone

        Description: A value in a phone contact
        Type: token
        Path: RelatedPerson.telecom(system=phone)

      • SP_EMAIL

        public static final String SP_EMAIL
        Search parameter constant for email

        Description: A value in an email contact
        Type: token
        Path: RelatedPerson.telecom(system=email)

        See Also:
        Constant Field Values
      • EMAIL

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam EMAIL
        Fluent Client search parameter constant for email

        Description: A value in an email contact
        Type: token
        Path: RelatedPerson.telecom(system=email)

      • SP_ADDRESS

        public static final String SP_ADDRESS
        Search parameter constant for address

        Description: An address in any kind of address/part
        Type: string
        Path: RelatedPerson.address

        See Also:
        Constant Field Values
      • ADDRESS

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS
        Fluent Client search parameter constant for address

        Description: An address in any kind of address/part
        Type: string
        Path: RelatedPerson.address

      • SP_ADDRESS_CITY

        public static final String SP_ADDRESS_CITY
        Search parameter constant for address-city

        Description: A city specified in an address
        Type: string
        Path: RelatedPerson.address.city

        See Also:
        Constant Field Values
      • ADDRESS_CITY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_CITY
        Fluent Client search parameter constant for address-city

        Description: A city specified in an address
        Type: string
        Path: RelatedPerson.address.city

      • SP_ADDRESS_STATE

        public static final String SP_ADDRESS_STATE
        Search parameter constant for address-state

        Description: A state specified in an address
        Type: string
        Path: RelatedPerson.address.state

        See Also:
        Constant Field Values
      • ADDRESS_STATE

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_STATE
        Fluent Client search parameter constant for address-state

        Description: A state specified in an address
        Type: string
        Path: RelatedPerson.address.state

      • SP_ADDRESS_POSTALCODE

        public static final String SP_ADDRESS_POSTALCODE
        Search parameter constant for address-postalcode

        Description: A postal code specified in an address
        Type: string
        Path: RelatedPerson.address.postalCode

        See Also:
        Constant Field Values
      • ADDRESS_POSTALCODE

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_POSTALCODE
        Fluent Client search parameter constant for address-postalcode

        Description: A postal code specified in an address
        Type: string
        Path: RelatedPerson.address.postalCode

      • SP_ADDRESS_COUNTRY

        public static final String SP_ADDRESS_COUNTRY
        Search parameter constant for address-country

        Description: A country specified in an address
        Type: string
        Path: RelatedPerson.address.country

        See Also:
        Constant Field Values
      • ADDRESS_COUNTRY

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_COUNTRY
        Fluent Client search parameter constant for address-country

        Description: A country specified in an address
        Type: string
        Path: RelatedPerson.address.country

      • SP_ADDRESS_USE

        public static final String SP_ADDRESS_USE
        Search parameter constant for address-use

        Description: A use code specified in an address
        Type: token
        Path: RelatedPerson.address.use

        See Also:
        Constant Field Values
      • ADDRESS_USE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADDRESS_USE
        Fluent Client search parameter constant for address-use

        Description: A use code specified in an address
        Type: token
        Path: RelatedPerson.address.use

      • SP_BIRTHDATE

        public static final String SP_BIRTHDATE
        Search parameter constant for birthdate

        Description: The Related Person's date of birth
        Type: date
        Path: RelatedPerson.birthDate

        See Also:
        Constant Field Values
      • BIRTHDATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam BIRTHDATE
        Fluent Client search parameter constant for birthdate

        Description: The Related Person's date of birth
        Type: date
        Path: RelatedPerson.birthDate

      • SP_GENDER

        public static final String SP_GENDER
        Search parameter constant for gender

        Description: Gender of the person
        Type: token
        Path: RelatedPerson.gender

        See Also:
        Constant Field Values
      • GENDER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam GENDER
        Fluent Client search parameter constant for gender

        Description: Gender of the person
        Type: token
        Path: RelatedPerson.gender

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter constant for patient

        Description: The patient this person is related to
        Type: reference
        Path: RelatedPerson.patient

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: The patient this person is related to
        Type: reference
        Path: RelatedPerson.patient

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "RelatedPerson:patient".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.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 interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.

        Definition: Identifier for a person within a particular scope.

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: Identifier for a person within a particular scope.

      • addIdentifier

        public RelatedPerson addIdentifier​(IdentifierDt theValue)
        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 be null)
      • getIdentifierFirstRep

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

        public ResourceReferenceDt getPatient()
        Gets the value(s) for patient (). creating it if it does not exist. Will not return null.

        Definition: The patient this person is related to

      • getRelationship

        public CodeableConceptDt getRelationship()
        Gets the value(s) for relationship (class). creating it if it does not exist. Will not return null.

        Definition: The nature of the relationship between a patient and the related person

      • getName

        public HumanNameDt getName()
        Gets the value(s) for name (). creating it if it does not exist. Will not return null.

        Definition: A name associated with the person

      • getTelecom

        public List<ContactPointDtgetTelecom()
        Gets the value(s) for telecom (). creating it if it does not exist. Will not return null.

        Definition: A contact detail for the person, e.g. a telephone number or an email address.

      • addTelecom

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

        public RelatedPerson addTelecom​(ContactPointDt theValue)
        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 be null)
      • getTelecomFirstRep

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

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AdministrativeGenderEnumgetGenderElement()
        Gets the value(s) for gender (). creating it if it does not exist. Will not return null.

        Definition: Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

      • getGender

        public String getGender()
        Gets the value(s) for gender (). creating it if it does not exist. This method may return null.

        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

        public RelatedPerson setGender​(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.

      • getBirthDateElement

        public ca.uhn.fhir.model.primitive.DateDt getBirthDateElement()
        Gets the value(s) for birthDate (). creating it if it does not exist. Will not return null.

        Definition:

      • getBirthDate

        public Date getBirthDate()
        Gets the value(s) for birthDate (). creating it if it does not exist. This method may return null.

        Definition:

      • setBirthDate

        public RelatedPerson setBirthDate​(ca.uhn.fhir.model.primitive.DateDt theValue)
        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:

      • getAddress

        public List<AddressDtgetAddress()
        Gets the value(s) for address (). creating it if it does not exist. Will not return null.

        Definition: Address where the related person can be contacted or visited

      • setAddress

        public RelatedPerson setAddress​(List<AddressDt> theValue)
        Sets the value(s) for address ()

        Definition: Address where the related person can be contacted or visited

      • addAddress

        public AddressDt addAddress()
        Adds and returns a new value for address ()

        Definition: Address where the related person can be contacted or visited

      • addAddress

        public RelatedPerson addAddress​(AddressDt theValue)
        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 be null)
      • getAddressFirstRep

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

        public List<AttachmentDtgetPhoto()
        Gets the value(s) for photo (). creating it if it does not exist. Will not return null.

        Definition: Image of the person

      • addPhoto

        public AttachmentDt addPhoto()
        Adds and returns a new value for photo ()

        Definition: Image of the person

      • addPhoto

        public RelatedPerson addPhoto​(AttachmentDt theValue)
        Adds a given new value for photo ()

        Definition: Image of the person

        Parameters:
        theValue - The photo to add (must not be null)
      • getPhotoFirstRep

        public AttachmentDt getPhotoFirstRep()
        Gets the first repetition for photo (), creating it if it does not already exist.

        Definition: Image of the person

      • getPeriod

        public PeriodDt getPeriod()
        Gets the value(s) for period (when.done). creating it if it does not exist. Will not return 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.

      • setPeriod

        public RelatedPerson setPeriod​(PeriodDt theValue)
        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

        public String getResourceName()
        Specified by:
        getResourceName in interface ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource