Class Person

  • 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 Person
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR Person Resource (administrative.entity)

    Definition: Demographics and administrative information about a person independent of a specific health-related context.

    Requirements: Need to track persons potentially across multiple roles

    Profile Definition: http://hl7.org/fhir/profiles/Person

    See Also:
    Serialized Form
    • Field Detail

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

        public static final String SP_NAME
        Search parameter constant for name

        Description: A portion of name in any name part
        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 portion of name in any name part
        Type: string
        Path: Person.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: Person.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: Person.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: Person.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: Person.telecom

      • SP_PHONE

        public static final String SP_PHONE
        Search parameter constant for phone

        Description: A value in a phone contact
        Type: token
        Path: Person.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: Person.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: Person.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: Person.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: Person.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: Person.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: Person.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: Person.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: Person.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: Person.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: Person.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: Person.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: Person.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: Person.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: Person.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: Person.address.use

      • SP_GENDER

        public static final String SP_GENDER
        Search parameter constant for gender

        Description: The gender of the person
        Type: token
        Path: Person.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: The gender of the person
        Type: token
        Path: Person.gender

      • SP_BIRTHDATE

        public static final String SP_BIRTHDATE
        Search parameter constant for birthdate

        Description: The person's date of birth
        Type: date
        Path: Person.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 person's date of birth
        Type: date
        Path: Person.birthDate

      • SP_ORGANIZATION

        public static final String SP_ORGANIZATION
        Search parameter constant for 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

      • SP_LINK

        public static final String SP_LINK
        Search parameter constant for 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

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter constant for patient

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

        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

      • SP_PRACTITIONER

        public static final String SP_PRACTITIONER
        Search parameter constant for practitioner

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

        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

      • SP_RELATEDPERSON

        public static final String SP_RELATEDPERSON
        Search parameter constant for relatedperson

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

        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

      • 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".
      • 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".
      • 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".
      • 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".
      • 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".
    • Constructor Detail

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

      • setIdentifier

        public Person setIdentifier​(List<IdentifierDt> theValue)
        Sets the value(s) for identifier (id)

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

      • getName

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

        Definition: A name associated with the person

      • setName

        public Person setName​(List<HumanNameDt> theValue)
        Sets the value(s) for name ()

        Definition: A name associated with the person

      • addName

        public HumanNameDt addName()
        Adds and returns a new value for name ()

        Definition: A name associated with the person

      • addName

        public Person addName​(HumanNameDt theValue)
        Adds a given new value for name ()

        Definition: A name associated with the person

        Parameters:
        theValue - The name to add (must not be null)
      • getNameFirstRep

        public HumanNameDt getNameFirstRep()
        Gets the first repetition for name (), creating it if it does not already exist.

        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.

      • setTelecom

        public Person setTelecom​(List<ContactPointDt> theValue)
        Sets the value(s) for telecom ()

        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 Person 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

      • 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

      • 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: The birth date for the person.

      • getBirthDate

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

        Definition: The birth date for the person.

      • setBirthDate

        public Person setBirthDate​(ca.uhn.fhir.model.primitive.DateDt theValue)
        Sets the value(s) for birthDate ()

        Definition: The birth date for the person.

      • setBirthDate

        public Person setBirthDate​(Date theDate,
                                   ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for birthDate ()

        Definition: The birth date for the person.

      • getAddress

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

        Definition: One or more addresses for the person

      • setAddress

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

        Definition: One or more addresses for the person

      • addAddress

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

        Definition: One or more addresses for the person

      • addAddress

        public Person addAddress​(AddressDt theValue)
        Adds a given new value for address ()

        Definition: One or more addresses for the person

        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: One or more addresses for the person

      • getPhoto

        public AttachmentDt getPhoto()
        Gets the value(s) for photo (). creating it if it does not exist. Will not return null.

        Definition: An image that can be displayed as a thumbnail of the person to enhance the identification of the individual

      • setPhoto

        public Person setPhoto​(AttachmentDt theValue)
        Sets the value(s) for photo ()

        Definition: An image that can be displayed as a thumbnail of the person to enhance the identification of the individual

      • getManagingOrganization

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

        Definition: The organization that is the custodian of the person record

      • getActiveElement

        public ca.uhn.fhir.model.primitive.BooleanDt getActiveElement()
        Gets the value(s) for active (status). creating it if it does not exist. Will not return null.

        Definition: Whether this person's record is in active use

      • getActive

        public Boolean getActive()
        Gets the value(s) for active (status). creating it if it does not exist. This method may return null.

        Definition: Whether this person's record is in active use

      • setActive

        public Person setActive​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for active (status)

        Definition: Whether this person's record is in active use

      • setActive

        public Person setActive​(boolean theBoolean)
        Sets the value for active (status)

        Definition: Whether this person's record is in active use

      • getLink

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

        Definition:

      • addLink

        public Person.Link addLink()
        Adds and returns a new value for link ()

        Definition:

      • addLink

        public Person addLink​(Person.Link theValue)
        Adds a given new value for link ()

        Definition:

        Parameters:
        theValue - The link to add (must not be null)
      • getLinkFirstRep

        public Person.Link getLinkFirstRep()
        Gets the first repetition for link (), creating it if it does not already exist.

        Definition:

      • 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