Class Patient

  • 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 Patient
    extends DomainResource
    Demographics and other administrative information about an individual or animal receiving care or other health-related services.
    See Also:
    Serialized Form
    • Field Detail

      • active

        protected BooleanType active
        Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
      • telecom

        protected List<ContactPoint> telecom
        A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
      • deceased

        protected Type deceased
        Indicates if the individual is deceased or not.
      • multipleBirth

        protected Type multipleBirth
        Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).
      • managingOrganizationTarget

        protected Organization managingOrganizationTarget
        The actual object that is the target of the reference (Organization that is the custodian of the patient record.)
      • IDENTIFIER

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

        Description: A patient identifier
        Type: token
        Path: Patient.identifier

      • SP_GIVEN

        public static final String SP_GIVEN
        Search parameter: given

        Description: A portion of the given name of the patient
        Type: string
        Path: Patient.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 patient
        Type: string
        Path: Patient.name.given

      • 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, district, state, country, postalCode, and/or text
        Type: string
        Path: Patient.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, district, state, country, postalCode, and/or text
        Type: string
        Path: Patient.address

      • BIRTHDATE

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

        Description: The patient's date of birth
        Type: date
        Path: Patient.birthDate

      • SP_DECEASED

        public static final String SP_DECEASED
        Search parameter: deceased

        Description: This patient has been marked as deceased, or as a death date entered
        Type: token
        Path: Patient.deceased[x]

        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 patient has been marked as deceased, or as a death date entered
        Type: token
        Path: Patient.deceased[x]

      • 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: Patient.address.state

      • GENDER

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

        Description: Gender of the patient
        Type: token
        Path: Patient.gender

      • SP_GENERAL_PRACTITIONER

        public static final String SP_GENERAL_PRACTITIONER
        Search parameter: general-practitioner

        Description: Patient's nominated general practitioner, not the organization that manages the record
        Type: reference
        Path: Patient.generalPractitioner

        See Also:
        Constant Field Values
      • GENERAL_PRACTITIONER

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

        Description: Patient's nominated general practitioner, not the organization that manages the record
        Type: reference
        Path: Patient.generalPractitioner

      • INCLUDE_GENERAL_PRACTITIONER

        public static final ca.uhn.fhir.model.api.Include INCLUDE_GENERAL_PRACTITIONER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Patient:general-practitioner".
      • SP_LINK

        public static final String SP_LINK
        Search parameter: link

        Description: All patients linked to the given patient
        Type: reference
        Path: Patient.link.other

        See Also:
        Constant Field Values
      • LINK

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

        Description: All patients linked to the given patient
        Type: reference
        Path: Patient.link.other

      • 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 "Patient:link".
      • SP_ACTIVE

        public static final String SP_ACTIVE
        Search parameter: active

        Description: Whether the patient record is active
        Type: token
        Path: Patient.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: Whether the patient record is active
        Type: token
        Path: Patient.active

      • SP_LANGUAGE

        public static final String SP_LANGUAGE
        Search parameter: language

        Description: Language code (irrespective of use value)
        Type: token
        Path: Patient.communication.language

        See Also:
        Constant Field Values
      • LANGUAGE

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

        Description: Language code (irrespective of use value)
        Type: token
        Path: Patient.communication.language

      • ADDRESS_POSTALCODE

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

        Description: A postalCode specified in an address
        Type: string
        Path: Patient.address.postalCode

      • 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: Patient.address.country

      • 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: Patient.deceasedDateTime

        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: Patient.deceasedDateTime

      • SP_PHONETIC

        public static final String SP_PHONETIC
        Search parameter: phonetic

        Description: A portion of either family or given name using some kind of phonetic matching algorithm
        Type: string
        Path: Patient.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 either family or given name using some kind of phonetic matching algorithm
        Type: string
        Path: Patient.name

      • SP_PHONE

        public static final String SP_PHONE
        Search parameter: phone

        Description: A value in a phone contact
        Type: token
        Path: Patient.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: Patient.telecom(system=phone)

      • SP_ORGANIZATION

        public static final String SP_ORGANIZATION
        Search parameter: organization

        Description: The organization that is the custodian of the patient record
        Type: reference
        Path: Patient.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 that is the custodian of the patient record
        Type: reference
        Path: Patient.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 "Patient: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: Patient.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: Patient.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: Patient.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: Patient.address.use

      • SP_TELECOM

        public static final String SP_TELECOM
        Search parameter: telecom

        Description: The value in any kind of telecom details of the patient
        Type: token
        Path: Patient.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 telecom details of the patient
        Type: token
        Path: Patient.telecom

      • SP_FAMILY

        public static final String SP_FAMILY
        Search parameter: family

        Description: A portion of the family name of the patient
        Type: string
        Path: Patient.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 patient
        Type: string
        Path: Patient.name.family

      • 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: Patient.address.city

      • SP_EMAIL

        public static final String SP_EMAIL
        Search parameter: email

        Description: A value in an email contact
        Type: token
        Path: Patient.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: Patient.telecom(system=email)

    • Constructor Detail

      • Patient

        public Patient()
        Constructor