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

      • 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 (bool) or indicates the actual birth order (integer).
      • careProviderTarget

        protected List<Resource> careProviderTarget
        The actual objects that are the target of the reference (Patient's nominated care provider.)
      • managingOrganizationTarget

        protected Organization managingOrganizationTarget
        The actual object that is the target of the reference (Organization that is the custodian of the patient record.)
      • 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_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_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".
      • ANIMAL_SPECIES

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ANIMAL_SPECIES
        Fluent Client search parameter constant for animal-species

        Description: The species for animal patients
        Type: token
        Path: Patient.animal.species

      • SP_ORGANIZATION

        public static final String SP_ORGANIZATION
        Search parameter: organization

        Description: The organization at which this person is a patient
        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 at which this person is a patient
        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".
      • 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_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_CAREPROVIDER

        public static final String SP_CAREPROVIDER
        Search parameter: careprovider

        Description: Patient's nominated care provider, could be a care manager, not the organization that manages the record
        Type: reference
        Path: Patient.careProvider

        See Also:
        Constant Field Values
      • CAREPROVIDER

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

        Description: Patient's nominated care provider, could be a care manager, not the organization that manages the record
        Type: reference
        Path: Patient.careProvider

      • INCLUDE_CAREPROVIDER

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

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

        public static final String SP_NAME
        Search parameter: name

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

      • 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

      • 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

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

      • ANIMAL_BREED

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ANIMAL_BREED
        Fluent Client search parameter constant for animal-breed

        Description: The breed for animal patients
        Type: token
        Path: Patient.animal.breed

      • 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

      • 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

      • SP_ADDRESS

        public static final String SP_ADDRESS
        Search parameter: address

        Description: An address in any kind of address/part of the patient
        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: An address in any kind of address/part of the patient
        Type: string
        Path: Patient.address

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

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

      • 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

      • 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

    • Constructor Detail

      • Patient

        public Patient()
        Constructor