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

    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.
    See Also:
    Serialized Form
    • Field Detail

      • active

        protected BooleanType active
        Whether this related person record is in active use.
      • patientTarget

        protected Patient patientTarget
        The actual object that is the target of the reference (The patient this person is related to.)
      • telecom

        protected List<ContactPoint> telecom
        A contact detail for the person, e.g. a telephone number or an email address.
      • birthDate

        protected DateType birthDate
        The date on which the related person was born.
      • address

        protected List<Address> address
        Address where the related person can be contacted or visited.
      • period

        protected Period period
        The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.
      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: An Identifier of the RelatedPerson
        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: An Identifier of the RelatedPerson
        Type: token
        Path: RelatedPerson.identifier

      • SP_ADDRESS

        public static final String SP_ADDRESS
        Search parameter: address

        Description: A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
        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: A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
        Type: string
        Path: RelatedPerson.address

      • SP_BIRTHDATE

        public static final String SP_BIRTHDATE
        Search parameter: 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_ADDRESS_STATE

        public static final String SP_ADDRESS_STATE
        Search parameter: 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_GENDER

        public static final String SP_GENDER
        Search parameter: gender

        Description: Gender of the related 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 related person
        Type: token
        Path: RelatedPerson.gender

      • SP_ACTIVE

        public static final String SP_ACTIVE
        Search parameter: active

        Description: Indicates if the related person record is active
        Type: token
        Path: RelatedPerson.active

        See Also:
        Constant Field Values
      • ACTIVE

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

        Description: Indicates if the related person record is active
        Type: token
        Path: RelatedPerson.active

      • SP_ADDRESS_POSTALCODE

        public static final String SP_ADDRESS_POSTALCODE
        Search parameter: 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: 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_PHONETIC

        public static final String SP_PHONETIC
        Search parameter: 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_PHONE

        public static final String SP_PHONE
        Search parameter: 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_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: The patient this related 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 related 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".
      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: 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:
        Constant Field Values
      • NAME

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

        Description: 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

        public static final String SP_ADDRESS_USE
        Search parameter: 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_TELECOM

        public static final String SP_TELECOM
        Search parameter: 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_ADDRESS_CITY

        public static final String SP_ADDRESS_CITY
        Search parameter: 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_EMAIL

        public static final String SP_EMAIL
        Search parameter: 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)