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 Details

    • identifier

      An identifier for this patient.
    • active

      protected BooleanType active
      Whether this patient record is in active use.
    • name

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

      A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
    • gender

      Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
    • birthDate

      protected DateType birthDate
      The date of birth for the individual.
    • deceased

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

      protected List<Address> address
      Addresses for the individual.
    • maritalStatus

      This field contains a patient's most recent marital (civil) status.
    • multipleBirth

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

      protected List<Attachment> photo
      Image of the patient.
    • contact

      A contact party (e.g. guardian, partner, friend) for the patient.
    • animal

      This patient is known to be an animal.
    • communication

      Languages which may be used to communicate with the patient about his or her health.
    • generalPractitioner

      Patient's nominated care provider.
    • generalPractitionerTarget

      The actual objects that are the target of the reference (Patient's nominated care provider.)
    • managingOrganization

      Organization that is the custodian of the patient record.
    • managingOrganizationTarget

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

      public static final String SP_BIRTHDATE
      Search parameter: birthdate

      Description: The patient's date of birth
      Type: date
      Path: Patient.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 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]

    • SP_ADDRESS_STATE

      public static final String SP_ADDRESS_STATE
      Search parameter: address-state

      Description: A state specified in an address
      Type: string
      Path: Patient.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: Patient.address.state

    • SP_GENDER

      public static final String SP_GENDER
      Search parameter: gender

      Description: Gender of the patient
      Type: token
      Path: Patient.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: Gender of the patient
      Type: token
      Path: Patient.gender

    • SP_ANIMAL_SPECIES

      public static final String SP_ANIMAL_SPECIES
      Search parameter: animal-species

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

      See Also:
      Constant Field Values
    • 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_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

    • SP_ANIMAL_BREED

      public static final String SP_ANIMAL_BREED
      Search parameter: animal-breed

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

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

    • SP_ADDRESS_COUNTRY

      public static final String SP_ADDRESS_COUNTRY
      Search parameter: address-country

      Description: A country specified in an address
      Type: string
      Path: Patient.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: 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_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_ADDRESS_CITY

      public static final String SP_ADDRESS_CITY
      Search parameter: address-city

      Description: A city specified in an address
      Type: string
      Path: Patient.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: 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)

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

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

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

      public static final String SP_ADDRESS_POSTALCODE
      Search parameter: address-postalcode

      Description: A postalCode specified in an address
      Type: string
      Path: Patient.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 postalCode specified in an address
      Type: string
      Path: Patient.address.postalCode

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

  • Constructor Details

    • Patient

      public Patient()
      Constructor
  • Method Details