Package org.hl7.fhir.r5.model

Class RelatedPerson

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.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:

  • Field Details

    • identifier

      protected List<Identifier> identifier
      Identifier for a person within a particular scope.

    • active

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

    • patient

      protected Reference patient
      The patient this person is related to.

    • relationship

      protected List<CodeableConcept> relationship
      The nature of the relationship between a patient and the related person.

    • name

      protected List<HumanName> name
      A name associated with the person.

    • telecom

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

    • gender

      protected Enumeration<Enumerations.AdministrativeGender> gender
      Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

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

    • photo

      protected List<Attachment> photo
      Image of the person.

    • period

      protected Period 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

      protected List<RelatedPerson.RelatedPersonCommunicationComponent> communication
      A language which may be used to communicate with about the patient's health.

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

    • 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_FAMILY

      public static final String SP_FAMILY
      Search parameter: family

      Description: A portion of the family name of the related person
      Type: string
      Path: RelatedPerson.name.family

      See Also:

    • FAMILY

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

      Description: A portion of the family name of the related person
      Type: string
      Path: RelatedPerson.name.family

    • SP_GIVEN

      public static final String SP_GIVEN
      Search parameter: given

      Description: A portion of the given name of the related person
      Type: string
      Path: RelatedPerson.name.given

      See Also:

    • GIVEN

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

      Description: A portion of the given name of the related person
      Type: string
      Path: RelatedPerson.name.given

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: An Identifier of the RelatedPerson
      Type: token
      Path: RelatedPerson.identifier

      See Also:

    • 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_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:

    • 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_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:

    • 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_RELATIONSHIP

      public static final String SP_RELATIONSHIP
      Search parameter: relationship

      Description: The relationship between the patient and the relatedperson
      Type: token
      Path: RelatedPerson.relationship

      See Also:

    • RELATIONSHIP

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

      Description: The relationship between the patient and the relatedperson
      Type: token
      Path: RelatedPerson.relationship

    • SP_ADDRESS_CITY

      public static final String SP_ADDRESS_CITY
      Search parameter: address-city

      Description: Multiple Resources: [Patient](patient.html): A city specified in an address [Person](person.html): A city specified in an address [Practitioner](practitioner.html): A city specified in an address [RelatedPerson](relatedperson.html): A city specified in an address
      Type: string
      Path: Patient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.address.city

      See Also:

    • ADDRESS_CITY

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

      Description: Multiple Resources: [Patient](patient.html): A city specified in an address [Person](person.html): A city specified in an address [Practitioner](practitioner.html): A city specified in an address [RelatedPerson](relatedperson.html): A city specified in an address
      Type: string
      Path: Patient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.address.city

    • SP_ADDRESS_COUNTRY

      public static final String SP_ADDRESS_COUNTRY
      Search parameter: address-country

      Description: Multiple Resources: [Patient](patient.html): A country specified in an address [Person](person.html): A country specified in an address [Practitioner](practitioner.html): A country specified in an address [RelatedPerson](relatedperson.html): A country specified in an address
      Type: string
      Path: Patient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.address.country

      See Also:

    • ADDRESS_COUNTRY

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

      Description: Multiple Resources: [Patient](patient.html): A country specified in an address [Person](person.html): A country specified in an address [Practitioner](practitioner.html): A country specified in an address [RelatedPerson](relatedperson.html): A country specified in an address
      Type: string
      Path: Patient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.address.country

    • SP_ADDRESS_POSTALCODE

      public static final String SP_ADDRESS_POSTALCODE
      Search parameter: address-postalcode

      Description: Multiple Resources: [Patient](patient.html): A postalCode specified in an address [Person](person.html): A postal code specified in an address [Practitioner](practitioner.html): A postalCode specified in an address [RelatedPerson](relatedperson.html): A postal code specified in an address
      Type: string
      Path: Patient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.address.postalCode

      See Also:

    • ADDRESS_POSTALCODE

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

      Description: Multiple Resources: [Patient](patient.html): A postalCode specified in an address [Person](person.html): A postal code specified in an address [Practitioner](practitioner.html): A postalCode specified in an address [RelatedPerson](relatedperson.html): A postal code specified in an address
      Type: string
      Path: Patient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.address.postalCode

    • SP_ADDRESS_STATE

      public static final String SP_ADDRESS_STATE
      Search parameter: address-state

      Description: Multiple Resources: [Patient](patient.html): A state specified in an address [Person](person.html): A state specified in an address [Practitioner](practitioner.html): A state specified in an address [RelatedPerson](relatedperson.html): A state specified in an address
      Type: string
      Path: Patient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.address.state

      See Also:

    • ADDRESS_STATE

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

      Description: Multiple Resources: [Patient](patient.html): A state specified in an address [Person](person.html): A state specified in an address [Practitioner](practitioner.html): A state specified in an address [RelatedPerson](relatedperson.html): A state specified in an address
      Type: string
      Path: Patient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.address.state

    • SP_ADDRESS_USE

      public static final String SP_ADDRESS_USE
      Search parameter: address-use

      Description: Multiple Resources: [Patient](patient.html): A use code specified in an address [Person](person.html): A use code specified in an address [Practitioner](practitioner.html): A use code specified in an address [RelatedPerson](relatedperson.html): A use code specified in an address
      Type: token
      Path: Patient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.address.use

      See Also:

    • ADDRESS_USE

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

      Description: Multiple Resources: [Patient](patient.html): A use code specified in an address [Person](person.html): A use code specified in an address [Practitioner](practitioner.html): A use code specified in an address [RelatedPerson](relatedperson.html): A use code specified in an address
      Type: token
      Path: Patient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.address.use

    • SP_ADDRESS

      public static final String SP_ADDRESS
      Search parameter: address

      Description: Multiple Resources: [Patient](patient.html): 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 [Person](person.html): 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 [Practitioner](practitioner.html): 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 [RelatedPerson](relatedperson.html): 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: Patient.address | Person.address | Practitioner.address | RelatedPerson.address

      See Also:

    • ADDRESS

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

      Description: Multiple Resources: [Patient](patient.html): 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 [Person](person.html): 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 [Practitioner](practitioner.html): 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 [RelatedPerson](relatedperson.html): 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: Patient.address | Person.address | Practitioner.address | RelatedPerson.address

    • SP_BIRTHDATE

      public static final String SP_BIRTHDATE
      Search parameter: birthdate

      Description: Multiple Resources: [Patient](patient.html): The patient's date of birth [Person](person.html): The person's date of birth [RelatedPerson](relatedperson.html): The Related Person's date of birth
      Type: date
      Path: Patient.birthDate | Person.birthDate | RelatedPerson.birthDate

      See Also:

    • BIRTHDATE

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

      Description: Multiple Resources: [Patient](patient.html): The patient's date of birth [Person](person.html): The person's date of birth [RelatedPerson](relatedperson.html): The Related Person's date of birth
      Type: date
      Path: Patient.birthDate | Person.birthDate | RelatedPerson.birthDate

    • SP_EMAIL

      public static final String SP_EMAIL
      Search parameter: email

      Description: Multiple Resources: [Patient](patient.html): A value in an email contact [Person](person.html): A value in an email contact [Practitioner](practitioner.html): A value in an email contact [PractitionerRole](practitionerrole.html): A value in an email contact [RelatedPerson](relatedperson.html): A value in an email contact
      Type: token
      Path: Patient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.telecom.where(system='email') | RelatedPerson.telecom.where(system='email')

      See Also:

    • EMAIL

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

      Description: Multiple Resources: [Patient](patient.html): A value in an email contact [Person](person.html): A value in an email contact [Practitioner](practitioner.html): A value in an email contact [PractitionerRole](practitionerrole.html): A value in an email contact [RelatedPerson](relatedperson.html): A value in an email contact
      Type: token
      Path: Patient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.telecom.where(system='email') | RelatedPerson.telecom.where(system='email')

    • SP_GENDER

      public static final String SP_GENDER
      Search parameter: gender

      Description: Multiple Resources: [Patient](patient.html): Gender of the patient [Person](person.html): The gender of the person [Practitioner](practitioner.html): Gender of the practitioner [RelatedPerson](relatedperson.html): Gender of the related person
      Type: token
      Path: Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender

      See Also:

    • GENDER

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

      Description: Multiple Resources: [Patient](patient.html): Gender of the patient [Person](person.html): The gender of the person [Practitioner](practitioner.html): Gender of the practitioner [RelatedPerson](relatedperson.html): Gender of the related person
      Type: token
      Path: Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender

    • SP_PHONE

      public static final String SP_PHONE
      Search parameter: phone

      Description: Multiple Resources: [Patient](patient.html): A value in a phone contact [Person](person.html): A value in a phone contact [Practitioner](practitioner.html): A value in a phone contact [PractitionerRole](practitionerrole.html): A value in a phone contact [RelatedPerson](relatedperson.html): A value in a phone contact
      Type: token
      Path: Patient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone')

      See Also:

    • PHONE

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

      Description: Multiple Resources: [Patient](patient.html): A value in a phone contact [Person](person.html): A value in a phone contact [Practitioner](practitioner.html): A value in a phone contact [PractitionerRole](practitionerrole.html): A value in a phone contact [RelatedPerson](relatedperson.html): A value in a phone contact
      Type: token
      Path: Patient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone')

    • SP_PHONETIC

      public static final String SP_PHONETIC
      Search parameter: phonetic

      Description: Multiple Resources: [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm [Person](person.html): A portion of name using some kind of phonetic matching algorithm [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm
      Type: string
      Path: Patient.name | Person.name | Practitioner.name | RelatedPerson.name

      See Also:

    • PHONETIC

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

      Description: Multiple Resources: [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm [Person](person.html): A portion of name using some kind of phonetic matching algorithm [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm
      Type: string
      Path: Patient.name | Person.name | Practitioner.name | RelatedPerson.name

    • SP_TELECOM

      public static final String SP_TELECOM
      Search parameter: telecom

      Description: Multiple Resources: [Patient](patient.html): The value in any kind of telecom details of the patient [Person](person.html): The value in any kind of contact [Practitioner](practitioner.html): The value in any kind of contact [PractitionerRole](practitionerrole.html): The value in any kind of contact [RelatedPerson](relatedperson.html): The value in any kind of contact
      Type: token
      Path: Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.telecom | RelatedPerson.telecom

      See Also:

    • TELECOM

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

      Description: Multiple Resources: [Patient](patient.html): The value in any kind of telecom details of the patient [Person](person.html): The value in any kind of contact [Practitioner](practitioner.html): The value in any kind of contact [PractitionerRole](practitionerrole.html): The value in any kind of contact [RelatedPerson](relatedperson.html): The value in any kind of contact
      Type: token
      Path: Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.telecom | RelatedPerson.telecom

  • Constructor Details

  • Method Details