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

    • identifier

      An identifier for this patient.
    • 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.
    • 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 DataType deceased
      Indicates if the individual is deceased or not.
    • address

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

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

      Indicates whether the patient is part of a multiple (boolean) 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.
    • communication

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

      Patient's nominated care provider.
    • managingOrganization

      Organization that is the custodian of the patient record.
    • 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:
    • 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_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.deceased as dateTime)

      See Also:
    • 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.deceased as dateTime)

    • SP_DECEASED

      public static final String SP_DECEASED
      Search parameter: deceased

      Description: This patient has been marked as deceased, or has a death date entered
      Type: token
      Path: Patient.deceased.exists() and Patient.deceased != false

      See Also:
    • 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 has a death date entered
      Type: token
      Path: Patient.deceased.exists() and Patient.deceased != false

    • 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:
    • 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_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

      See Also:
    • 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_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:
    • 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_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, given, prefix, suffix, and/or text
      Type: string
      Path: Patient.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, given, prefix, suffix, and/or text
      Type: string
      Path: Patient.name

    • 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:
    • 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_PART_AGREE

      public static final String SP_PART_AGREE
      Search parameter: part-agree

      Description: Search by url for a participation agreement, which is stored in a DocumentReference
      Type: reference
      Path: DocumentReference.extension('http://example.org/fhir/StructureDefinition/participation-agreement')

      See Also:
    • PART_AGREE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_AGREE
      Fluent Client search parameter constant for part-agree

      Description: Search by url for a participation agreement, which is stored in a DocumentReference
      Type: reference
      Path: DocumentReference.extension('http://example.org/fhir/StructureDefinition/participation-agreement')

    • INCLUDE_PART_AGREE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_AGREE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Patient:part-agree".
    • SP_ADDRESS_CITY

      public static final String SP_ADDRESS_CITY
      Search parameter: address-city

      Description: Multiple Resources: [Patient](patient.html): A city specified in an address [Person](person.html): A city specified in an address [Practitioner](practitioner.html): A city specified in an address [RelatedPerson](relatedperson.html): A city specified in an address
      Type: string
      Path: Patient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.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: Multiple Resources: [Patient](patient.html): A city specified in an address [Person](person.html): A city specified in an address [Practitioner](practitioner.html): A city specified in an address [RelatedPerson](relatedperson.html): A city specified in an address
      Type: string
      Path: Patient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.address.city

    • SP_ADDRESS_COUNTRY

      public static final String SP_ADDRESS_COUNTRY
      Search parameter: address-country

      Description: Multiple Resources: [Patient](patient.html): A country specified in an address [Person](person.html): A country specified in an address [Practitioner](practitioner.html): A country specified in an address [RelatedPerson](relatedperson.html): A country specified in an address
      Type: string
      Path: Patient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.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: Multiple Resources: [Patient](patient.html): A country specified in an address [Person](person.html): A country specified in an address [Practitioner](practitioner.html): A country specified in an address [RelatedPerson](relatedperson.html): A country specified in an address
      Type: string
      Path: Patient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.address.country

    • SP_ADDRESS_POSTALCODE

      public static final String SP_ADDRESS_POSTALCODE
      Search parameter: address-postalcode

      Description: Multiple Resources: [Patient](patient.html): A postalCode specified in an address [Person](person.html): A postal code specified in an address [Practitioner](practitioner.html): A postalCode specified in an address [RelatedPerson](relatedperson.html): A postal code specified in an address
      Type: string
      Path: Patient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.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: Multiple Resources: [Patient](patient.html): A postalCode specified in an address [Person](person.html): A postal code specified in an address [Practitioner](practitioner.html): A postalCode specified in an address [RelatedPerson](relatedperson.html): A postal code specified in an address
      Type: string
      Path: Patient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.address.postalCode

    • SP_ADDRESS_STATE

      public static final String SP_ADDRESS_STATE
      Search parameter: address-state

      Description: Multiple Resources: [Patient](patient.html): A state specified in an address [Person](person.html): A state specified in an address [Practitioner](practitioner.html): A state specified in an address [RelatedPerson](relatedperson.html): A state specified in an address
      Type: string
      Path: Patient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.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: Multiple Resources: [Patient](patient.html): A state specified in an address [Person](person.html): A state specified in an address [Practitioner](practitioner.html): A state specified in an address [RelatedPerson](relatedperson.html): A state specified in an address
      Type: string
      Path: Patient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.address.state

    • SP_ADDRESS_USE

      public static final String SP_ADDRESS_USE
      Search parameter: address-use

      Description: Multiple Resources: [Patient](patient.html): A use code specified in an address [Person](person.html): A use code specified in an address [Practitioner](practitioner.html): A use code specified in an address [RelatedPerson](relatedperson.html): A use code specified in an address
      Type: token
      Path: Patient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.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: Multiple Resources: [Patient](patient.html): A use code specified in an address [Person](person.html): A use code specified in an address [Practitioner](practitioner.html): A use code specified in an address [RelatedPerson](relatedperson.html): A use code specified in an address
      Type: token
      Path: Patient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.address.use

    • SP_ADDRESS

      public static final String SP_ADDRESS
      Search parameter: address

      Description: Multiple Resources: [Patient](patient.html): 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 [Person](person.html): 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 [Practitioner](practitioner.html): 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 [RelatedPerson](relatedperson.html): 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 | Person.address | Practitioner.address | RelatedPerson.address

      See Also:
    • ADDRESS

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

      Description: Multiple Resources: [Patient](patient.html): 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 [Person](person.html): 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 [Practitioner](practitioner.html): 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 [RelatedPerson](relatedperson.html): 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 | Person.address | Practitioner.address | RelatedPerson.address

    • SP_BIRTHDATE

      public static final String SP_BIRTHDATE
      Search parameter: birthdate

      Description: Multiple Resources: [Patient](patient.html): The patient's date of birth [Person](person.html): The person's date of birth [RelatedPerson](relatedperson.html): The Related Person's date of birth
      Type: date
      Path: Patient.birthDate | Person.birthDate | RelatedPerson.birthDate

      See Also:
    • BIRTHDATE

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

      Description: Multiple Resources: [Patient](patient.html): The patient's date of birth [Person](person.html): The person's date of birth [RelatedPerson](relatedperson.html): The Related Person's date of birth
      Type: date
      Path: Patient.birthDate | Person.birthDate | RelatedPerson.birthDate

    • SP_EMAIL

      public static final String SP_EMAIL
      Search parameter: email

      Description: Multiple Resources: [Patient](patient.html): A value in an email contact [Person](person.html): A value in an email contact [Practitioner](practitioner.html): A value in an email contact [PractitionerRole](practitionerrole.html): A value in an email contact [RelatedPerson](relatedperson.html): A value in an email contact
      Type: token
      Path: Patient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.telecom.where(system='email') | RelatedPerson.telecom.where(system='email')

      See Also:
    • EMAIL

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

      Description: Multiple Resources: [Patient](patient.html): A value in an email contact [Person](person.html): A value in an email contact [Practitioner](practitioner.html): A value in an email contact [PractitionerRole](practitionerrole.html): A value in an email contact [RelatedPerson](relatedperson.html): A value in an email contact
      Type: token
      Path: Patient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.telecom.where(system='email') | RelatedPerson.telecom.where(system='email')

    • SP_FAMILY

      public static final String SP_FAMILY
      Search parameter: family

      Description: Multiple Resources: [Patient](patient.html): A portion of the family name of the patient [Practitioner](practitioner.html): A portion of the family name
      Type: string
      Path: Patient.name.family | Practitioner.name.family

      See Also:
    • FAMILY

      public static final ca.uhn.fhir.rest.gclient.StringClientParam FAMILY
      Fluent Client search parameter constant for family

      Description: Multiple Resources: [Patient](patient.html): A portion of the family name of the patient [Practitioner](practitioner.html): A portion of the family name
      Type: string
      Path: Patient.name.family | Practitioner.name.family

    • SP_GENDER

      public static final String SP_GENDER
      Search parameter: gender

      Description: Multiple Resources: [Patient](patient.html): Gender of the patient [Person](person.html): The gender of the person [Practitioner](practitioner.html): Gender of the practitioner [RelatedPerson](relatedperson.html): Gender of the related person
      Type: token
      Path: Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender

      See Also:
    • GENDER

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

      Description: Multiple Resources: [Patient](patient.html): Gender of the patient [Person](person.html): The gender of the person [Practitioner](practitioner.html): Gender of the practitioner [RelatedPerson](relatedperson.html): Gender of the related person
      Type: token
      Path: Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender

    • SP_GIVEN

      public static final String SP_GIVEN
      Search parameter: given

      Description: Multiple Resources: [Patient](patient.html): A portion of the given name of the patient [Practitioner](practitioner.html): A portion of the given name
      Type: string
      Path: Patient.name.given | Practitioner.name.given

      See Also:
    • GIVEN

      public static final ca.uhn.fhir.rest.gclient.StringClientParam GIVEN
      Fluent Client search parameter constant for given

      Description: Multiple Resources: [Patient](patient.html): A portion of the given name of the patient [Practitioner](practitioner.html): A portion of the given name
      Type: string
      Path: Patient.name.given | Practitioner.name.given

    • SP_PHONE

      public static final String SP_PHONE
      Search parameter: phone

      Description: Multiple Resources: [Patient](patient.html): A value in a phone contact [Person](person.html): A value in a phone contact [Practitioner](practitioner.html): A value in a phone contact [PractitionerRole](practitionerrole.html): A value in a phone contact [RelatedPerson](relatedperson.html): A value in a phone contact
      Type: token
      Path: Patient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone')

      See Also:
    • PHONE

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

      Description: Multiple Resources: [Patient](patient.html): A value in a phone contact [Person](person.html): A value in a phone contact [Practitioner](practitioner.html): A value in a phone contact [PractitionerRole](practitionerrole.html): A value in a phone contact [RelatedPerson](relatedperson.html): A value in a phone contact
      Type: token
      Path: Patient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone')

    • SP_PHONETIC

      public static final String SP_PHONETIC
      Search parameter: phonetic

      Description: Multiple Resources: [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm [Person](person.html): A portion of name using some kind of phonetic matching algorithm [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm
      Type: string
      Path: Patient.name | Person.name | Practitioner.name | RelatedPerson.name

      See Also:
    • PHONETIC

      public static final ca.uhn.fhir.rest.gclient.StringClientParam PHONETIC
      Fluent Client search parameter constant for phonetic

      Description: Multiple Resources: [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm [Person](person.html): A portion of name using some kind of phonetic matching algorithm [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm
      Type: string
      Path: Patient.name | Person.name | Practitioner.name | RelatedPerson.name

    • SP_TELECOM

      public static final String SP_TELECOM
      Search parameter: telecom

      Description: Multiple Resources: [Patient](patient.html): The value in any kind of telecom details of the patient [Person](person.html): The value in any kind of contact [Practitioner](practitioner.html): The value in any kind of contact [PractitionerRole](practitionerrole.html): The value in any kind of contact [RelatedPerson](relatedperson.html): The value in any kind of contact
      Type: token
      Path: Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.telecom | RelatedPerson.telecom

      See Also:
    • TELECOM

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

      Description: Multiple Resources: [Patient](patient.html): The value in any kind of telecom details of the patient [Person](person.html): The value in any kind of contact [Practitioner](practitioner.html): The value in any kind of contact [PractitionerRole](practitionerrole.html): The value in any kind of contact [RelatedPerson](relatedperson.html): The value in any kind of contact
      Type: token
      Path: Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.telecom | RelatedPerson.telecom

    • SP_AGE

      public static final String SP_AGE
      Search parameter: age

      Description: Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search.
      Type: number
      Path: null

      See Also:
    • AGE

      public static final ca.uhn.fhir.rest.gclient.NumberClientParam AGE
      Fluent Client search parameter constant for age

      Description: Searches for patients based on age as calculated based on current date and date of birth. Deceased patients are excluded from the search.
      Type: number
      Path: null

    • SP_BIRTHORDERBOOLEAN

      public static final String SP_BIRTHORDERBOOLEAN
      Search parameter: birthOrderBoolean

      Description: Search based on whether a patient was part of a multiple birth or not.
      Type: token
      Path: null

      See Also:
    • BIRTHORDERBOOLEAN

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

      Description: Search based on whether a patient was part of a multiple birth or not.
      Type: token
      Path: null

    • SP_MOTHERSMAIDENNAME

      public static final String SP_MOTHERSMAIDENNAME
      Search parameter: mothersMaidenName

      Description: Search based on patient's mother's maiden name
      Type: string
      Path: Patient.extension('http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName')

      See Also:
    • MOTHERSMAIDENNAME

      public static final ca.uhn.fhir.rest.gclient.StringClientParam MOTHERSMAIDENNAME
      Fluent Client search parameter constant for mothersMaidenName

      Description: Search based on patient's mother's maiden name
      Type: string
      Path: Patient.extension('http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName')

  • Constructor Details

    • Patient

      public Patient()
      Constructor
  • Method Details