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

    • identifier

      Identifier for a person within a particular scope.
    • name

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

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

      Administrative Gender.
    • birthDate

      protected DateType birthDate
      The birth date for the person.
    • address

      protected List<Address> address
      One or more addresses for the person.
    • photo

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

      The organization that is the custodian of the person record.
    • managingOrganizationTarget

      The actual object that is the target of the reference (The organization that is the custodian of the person record.)
    • active

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

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

      See Also:
    • 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_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: Person.address

      See Also:
    • 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: Person.address

    • SP_BIRTHDATE

      public static final String SP_BIRTHDATE
      Search parameter: birthdate

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

      See Also:
    • BIRTHDATE

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

      Description: The person's date of birth
      Type: date
      Path: Person.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: Person.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: A state specified in an address
      Type: string
      Path: Person.address.state

    • SP_GENDER

      public static final String SP_GENDER
      Search parameter: gender

      Description: The gender of the person
      Type: token
      Path: Person.gender

      See Also:
    • GENDER

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

      Description: The gender of the person
      Type: token
      Path: Person.gender

    • SP_PRACTITIONER

      public static final String SP_PRACTITIONER
      Search parameter: practitioner

      Description: The Person links to this Practitioner
      Type: reference
      Path: Person.link.target

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

    • 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

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

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

      public static final String SP_ADDRESS_POSTALCODE
      Search parameter: address-postalcode

      Description: A postal code specified in an address
      Type: string
      Path: Person.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: A postal code specified in an address
      Type: string
      Path: Person.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: Person.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: A country specified in an address
      Type: string
      Path: Person.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: Person.name

      See Also:
    • 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: Person.name

    • SP_PHONE

      public static final String SP_PHONE
      Search parameter: phone

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

      See Also:
    • 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: Person.telecom(system=phone)

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: The Person links to this Patient
      Type: reference
      Path: Person.link.target

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

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

      public static final String SP_ADDRESS_USE
      Search parameter: address-use

      Description: A use code specified in an address
      Type: token
      Path: Person.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: A use code specified in an address
      Type: token
      Path: Person.address.use

    • SP_TELECOM

      public static final String SP_TELECOM
      Search parameter: telecom

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

      See Also:
    • 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: Person.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: Person.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: A city specified in an address
      Type: string
      Path: Person.address.city

    • SP_EMAIL

      public static final String SP_EMAIL
      Search parameter: email

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

      See Also:
    • 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: Person.telecom(system=email)

  • Constructor Details

    • Person

      public Person()
      Constructor
  • Method Details