Class Patient

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

    Definition: Demographics and other administrative information about an individual or animal receiving care or other health-related services.

    Requirements: Tracking patient is the center of the healthcare process

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

    See Also:
    Serialized Form
    • Field Detail

      • SP_IDENTIFIER

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

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

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

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

        public static final String SP_PHONETIC
        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

        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 constant for 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_PHONE

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

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

        public static final String SP_ADDRESS
        Search parameter constant for 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_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: 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_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: 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_ADDRESS_POSTALCODE

        public static final String SP_ADDRESS_POSTALCODE
        Search parameter constant for 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_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: 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_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: 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_GENDER

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

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

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

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

      • SP_CAREPROVIDER

        public static final String SP_CAREPROVIDER
        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

        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

      • SP_ACTIVE

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

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

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

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

      • SP_DECEASED

        public static final String SP_DECEASED
        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]

        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_DEATHDATE

        public static final String SP_DEATHDATE
        Search parameter constant for deathdate

        Description: The date of death has been provided and satisfies this search value
        Type: date
        Path: Patient.deceasedDateTime

        See Also:
        Constant Field Values
      • DEATHDATE

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

        Description: The date of death has been provided and satisfies this search value
        Type: date
        Path: Patient.deceasedDateTime

      • 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".
      • 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".
      • 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".
    • 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: An identifier for this patient

      • addIdentifier

        public IdentifierDt addIdentifier()
        Adds and returns a new value for identifier (id)

        Definition: An identifier for this patient

      • addIdentifier

        public Patient addIdentifier​(IdentifierDt theValue)
        Adds a given new value for identifier (id)

        Definition: An identifier for this patient

        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: An identifier for this patient

      • 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 patient 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 patient record is in active use

      • setActive

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

        Definition: Whether this patient record is in active use

      • setActive

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

        Definition: Whether this patient record is in active use

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

      • setName

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

        Definition: A name associated with the individual.

      • addName

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

        Definition: A name associated with the individual.

      • addName

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

        Definition: A name associated with the individual.

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

      • 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 (e.g. a telephone number or an email address) by which the individual may be contacted.

      • setTelecom

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

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

      • addTelecom

        public ContactPointDt addTelecom()
        Adds and returns a new value for telecom ()

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

      • addTelecom

        public Patient addTelecom​(ContactPointDt theValue)
        Adds a given new value for telecom ()

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

        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 (e.g. a telephone number or an email address) by which the individual may be contacted.

      • 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 - the gender that the patient is considered to have for administration and record keeping purposes.

      • 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 - the gender that the patient is considered to have for administration and record keeping purposes.

      • setGender

        public Patient setGender​(ca.uhn.fhir.model.primitive.BoundCodeDt<AdministrativeGenderEnum> theValue)
        Sets the value(s) for gender ()

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

      • setGender

        public Patient setGender​(AdministrativeGenderEnum theValue)
        Sets the value(s) for gender ()

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

      • 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 date of birth for the individual

      • getBirthDate

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

        Definition: The date of birth for the individual

      • setBirthDate

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

        Definition: The date of birth for the individual

      • setBirthDate

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

        Definition: The date of birth for the individual

      • getDeceased

        public ca.uhn.fhir.model.api.IDatatype getDeceased()
        Gets the value(s) for deceased[x] (). creating it if it does not exist. Will not return null.

        Definition: Indicates if the individual is deceased or not

      • setDeceased

        public Patient setDeceased​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for deceased[x] ()

        Definition: Indicates if the individual is deceased or not

      • getAddress

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

        Definition: Addresses for the individual

      • addAddress

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

        Definition: Addresses for the individual

      • addAddress

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

        Definition: Addresses for the individual

        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: Addresses for the individual

      • getMultipleBirth

        public ca.uhn.fhir.model.api.IDatatype getMultipleBirth()
        Gets the value(s) for multipleBirth[x] (). creating it if it does not exist. Will not return null.

        Definition: Indicates whether the patient is part of a multiple or indicates the actual birth order.

      • setMultipleBirth

        public Patient setMultipleBirth​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for multipleBirth[x] ()

        Definition: Indicates whether the patient is part of a multiple or indicates the actual birth order.

      • getPhoto

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

        Definition: Image of the patient

      • addPhoto

        public AttachmentDt addPhoto()
        Adds and returns a new value for photo ()

        Definition: Image of the patient

      • addPhoto

        public Patient addPhoto​(AttachmentDt theValue)
        Adds a given new value for photo ()

        Definition: Image of the patient

        Parameters:
        theValue - The photo to add (must not be null)
      • getPhotoFirstRep

        public AttachmentDt getPhotoFirstRep()
        Gets the first repetition for photo (), creating it if it does not already exist.

        Definition: Image of the patient

      • getContact

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

        Definition: A contact party (e.g. guardian, partner, friend) for the patient

      • setContact

        public Patient setContact​(List<Patient.Contact> theValue)
        Sets the value(s) for contact ()

        Definition: A contact party (e.g. guardian, partner, friend) for the patient

      • addContact

        public Patient.Contact addContact()
        Adds and returns a new value for contact ()

        Definition: A contact party (e.g. guardian, partner, friend) for the patient

      • addContact

        public Patient addContact​(Patient.Contact theValue)
        Adds a given new value for contact ()

        Definition: A contact party (e.g. guardian, partner, friend) for the patient

        Parameters:
        theValue - The contact to add (must not be null)
      • getContactFirstRep

        public Patient.Contact getContactFirstRep()
        Gets the first repetition for contact (), creating it if it does not already exist.

        Definition: A contact party (e.g. guardian, partner, friend) for the patient

      • getAnimal

        public Patient.Animal getAnimal()
        Gets the value(s) for animal (). creating it if it does not exist. Will not return null.

        Definition: This patient is known to be an animal

      • getCommunication

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

        Definition: Languages which may be used to communicate with the patient about his or her health

      • addCommunication

        public Patient.Communication addCommunication()
        Adds and returns a new value for communication ()

        Definition: Languages which may be used to communicate with the patient about his or her health

      • addCommunication

        public Patient addCommunication​(Patient.Communication theValue)
        Adds a given new value for communication ()

        Definition: Languages which may be used to communicate with the patient about his or her health

        Parameters:
        theValue - The communication to add (must not be null)
      • getCommunicationFirstRep

        public Patient.Communication getCommunicationFirstRep()
        Gets the first repetition for communication (), creating it if it does not already exist.

        Definition: Languages which may be used to communicate with the patient about his or her health

      • getCareProvider

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

        Definition: Patient's nominated care provider

      • getManagingOrganization

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

        Definition: Organization that is the custodian of the patient record

      • getLink

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

        Definition: Link to another patient resource that concerns the same actual patient

      • setLink

        public Patient setLink​(List<Patient.Link> theValue)
        Sets the value(s) for link ()

        Definition: Link to another patient resource that concerns the same actual patient

      • addLink

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

        Definition: Link to another patient resource that concerns the same actual patient

      • addLink

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

        Definition: Link to another patient resource that concerns the same actual patient

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

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

        Definition: Link to another patient resource that concerns the same actual patient

      • 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