Class Person

  • 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 Person
    extends DomainResource
    Demographics and administrative information about a person independent of a specific health-related context.
    See Also:
    Serialized Form
    • Field Detail

      • active

        protected BooleanType active
        Whether this person's record is in active use.
      • telecom

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

        protected DataType deceased
        Indicates if the individual is deceased or not.
      • photo

        protected List<Attachment> photo
        An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
      • SP_DEATH_DATE

        public static final String SP_DEATH_DATE
        Search parameter: death-date

        Description: The date of death has been provided and satisfies this search value
        Type: date
        Path: (Person.deceased as dateTime)

        See Also:
        Constant Field Values
      • DEATH_DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DEATH_DATE
        Fluent Client search parameter constant for death-date

        Description: The date of death has been provided and satisfies this search value
        Type: date
        Path: (Person.deceased as dateTime)

      • SP_DECEASED

        public static final String SP_DECEASED
        Search parameter: deceased

        Description: This person has been marked as deceased, or has a death date entered
        Type: token
        Path: Person.deceased.exists() and Person.deceased != false

        See Also:
        Constant Field Values
      • DECEASED

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

        Description: This person has been marked as deceased, or has a death date entered
        Type: token
        Path: Person.deceased.exists() and Person.deceased != false

      • SP_FAMILY

        public static final String SP_FAMILY
        Search parameter: family

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

        See Also:
        Constant Field Values
      • 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 person
        Type: string
        Path: Person.name.family

      • SP_GIVEN

        public static final String SP_GIVEN
        Search parameter: given

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

        See Also:
        Constant Field Values
      • 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 person
        Type: string
        Path: Person.name.given

      • IDENTIFIER

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

        Description: A person Identifier
        Type: token
        Path: Person.identifier

      • SP_LINK

        public static final String SP_LINK
        Search parameter: link

        Description: Any link has this Patient, Person, RelatedPerson or Practitioner reference
        Type: reference
        Path: Person.link.target

        See Also:
        Constant Field Values
      • LINK

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

        Description: Any link has this Patient, Person, RelatedPerson or Practitioner reference
        Type: reference
        Path: Person.link.target

      • INCLUDE_LINK

        public static final ca.uhn.fhir.model.api.Include INCLUDE_LINK
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:link".
      • 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: Person.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: Person.name

      • SP_ORGANIZATION

        public static final String SP_ORGANIZATION
        Search parameter: organization

        Description: The organization at which this person record is being managed
        Type: reference
        Path: Person.managingOrganization

        See Also:
        Constant Field Values
      • ORGANIZATION

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

        Description: The organization at which this person record is being managed
        Type: reference
        Path: Person.managingOrganization

      • INCLUDE_ORGANIZATION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:organization".
      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: The Person links to this Patient
        Type: reference
        Path: Person.link.target.where(resolve() is 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 Person links to this Patient
        Type: reference
        Path: Person.link.target.where(resolve() is 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 "Person:patient".
      • SP_PRACTITIONER

        public static final String SP_PRACTITIONER
        Search parameter: practitioner

        Description: The Person links to this Practitioner
        Type: reference
        Path: Person.link.target.where(resolve() is Practitioner)

        See Also:
        Constant Field Values
      • PRACTITIONER

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

        Description: The Person links to this Practitioner
        Type: reference
        Path: Person.link.target.where(resolve() is Practitioner)

      • INCLUDE_PRACTITIONER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:practitioner".
      • SP_RELATEDPERSON

        public static final String SP_RELATEDPERSON
        Search parameter: relatedperson

        Description: The Person links to this RelatedPerson
        Type: reference
        Path: Person.link.target.where(resolve() is RelatedPerson)

        See Also:
        Constant Field Values
      • RELATEDPERSON

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

        Description: The Person links to this RelatedPerson
        Type: reference
        Path: Person.link.target.where(resolve() is RelatedPerson)

      • INCLUDE_RELATEDPERSON

        public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATEDPERSON
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:relatedperson".
      • 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:
        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: 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:
        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: 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:
        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: 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:
        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: 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:
        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: 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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 Detail

      • Person

        public Person()
        Constructor