Patient (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.Patient

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class Patient
extends BaseResource
implements 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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Patient.Animal` Block class for child element: Patient.animal ()
`static class`	`Patient.Communication` Block class for child element: Patient.communication ()
`static class`	`Patient.Contact` Block class for child element: Patient.contact ()
`static class`	`Patient.Link` Block class for child element: Patient.link ()

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`ACTIVE` Fluent Client search parameter constant for active
`static StringClientParam`	`ADDRESS` Fluent Client search parameter constant for address
`static StringClientParam`	`ADDRESS_CITY` Fluent Client search parameter constant for address-city
`static StringClientParam`	`ADDRESS_COUNTRY` Fluent Client search parameter constant for address-country
`static StringClientParam`	`ADDRESS_POSTALCODE` Fluent Client search parameter constant for address-postalcode
`static StringClientParam`	`ADDRESS_STATE` Fluent Client search parameter constant for address-state
`static TokenClientParam`	`ADDRESS_USE` Fluent Client search parameter constant for address-use
`static TokenClientParam`	`ANIMAL_BREED` Fluent Client search parameter constant for animal-breed
`static TokenClientParam`	`ANIMAL_SPECIES` Fluent Client search parameter constant for animal-species
`static DateClientParam`	`BIRTHDATE` Fluent Client search parameter constant for birthdate
`static ReferenceClientParam`	`CAREPROVIDER` Fluent Client search parameter constant for careprovider
`static DateClientParam`	`DEATHDATE` Fluent Client search parameter constant for deathdate
`static TokenClientParam`	`DECEASED` Fluent Client search parameter constant for deceased
`static TokenClientParam`	`EMAIL` Fluent Client search parameter constant for email
`static StringClientParam`	`FAMILY` Fluent Client search parameter constant for family
`static TokenClientParam`	`GENDER` Fluent Client search parameter constant for gender
`static StringClientParam`	`GIVEN` Fluent Client search parameter constant for given
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_CAREPROVIDER` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_LINK` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_ORGANIZATION` Constant for fluent queries to be used to add include statements.
`static TokenClientParam`	`LANGUAGE` Fluent Client search parameter constant for language
`static ReferenceClientParam`	`LINK` Fluent Client search parameter constant for link
`static StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static ReferenceClientParam`	`ORGANIZATION` Fluent Client search parameter constant for organization
`static TokenClientParam`	`PHONE` Fluent Client search parameter constant for phone
`static StringClientParam`	`PHONETIC` Fluent Client search parameter constant for phonetic
`static String`	`SP_ACTIVE` Search parameter constant for active
`static String`	`SP_ADDRESS` Search parameter constant for address
`static String`	`SP_ADDRESS_CITY` Search parameter constant for address-city
`static String`	`SP_ADDRESS_COUNTRY` Search parameter constant for address-country
`static String`	`SP_ADDRESS_POSTALCODE` Search parameter constant for address-postalcode
`static String`	`SP_ADDRESS_STATE` Search parameter constant for address-state
`static String`	`SP_ADDRESS_USE` Search parameter constant for address-use
`static String`	`SP_ANIMAL_BREED` Search parameter constant for animal-breed
`static String`	`SP_ANIMAL_SPECIES` Search parameter constant for animal-species
`static String`	`SP_BIRTHDATE` Search parameter constant for birthdate
`static String`	`SP_CAREPROVIDER` Search parameter constant for careprovider
`static String`	`SP_DEATHDATE` Search parameter constant for deathdate
`static String`	`SP_DECEASED` Search parameter constant for deceased
`static String`	`SP_EMAIL` Search parameter constant for email
`static String`	`SP_FAMILY` Search parameter constant for family
`static String`	`SP_GENDER` Search parameter constant for gender
`static String`	`SP_GIVEN` Search parameter constant for given
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_LANGUAGE` Search parameter constant for language
`static String`	`SP_LINK` Search parameter constant for link
`static String`	`SP_NAME` Search parameter constant for name
`static String`	`SP_ORGANIZATION` Search parameter constant for organization
`static String`	`SP_PHONE` Search parameter constant for phone
`static String`	`SP_PHONETIC` Search parameter constant for phonetic
`static String`	`SP_TELECOM` Search parameter constant for telecom
`static TokenClientParam`	`TELECOM` Fluent Client search parameter constant for telecom

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

Patient()

Constructors
Constructor and Description
`Patient()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddressDt`	`addAddress()` Adds and returns a new value for address ()
`Patient`	`addAddress(AddressDt theValue)` Adds a given new value for address ()
`ResourceReferenceDt`	`addCareProvider()` Adds and returns a new value for careProvider ()
`Patient.Communication`	`addCommunication()` Adds and returns a new value for communication ()
`Patient`	`addCommunication(Patient.Communication theValue)` Adds a given new value for communication ()
`Patient.Contact`	`addContact()` Adds and returns a new value for contact ()
`Patient`	`addContact(Patient.Contact theValue)` Adds a given new value for contact ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`Patient`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier (id)
`Patient.Link`	`addLink()` Adds and returns a new value for link ()
`Patient`	`addLink(Patient.Link theValue)` Adds a given new value for link ()
`HumanNameDt`	`addName()` Adds and returns a new value for name ()
`Patient`	`addName(HumanNameDt theValue)` Adds a given new value for name ()
`AttachmentDt`	`addPhoto()` Adds and returns a new value for photo ()
`Patient`	`addPhoto(AttachmentDt theValue)` Adds a given new value for photo ()
`ContactPointDt`	`addTelecom()` Adds and returns a new value for telecom ()
`Patient`	`addTelecom(ContactPointDt theValue)` Adds a given new value for telecom ()
`Boolean`	`getActive()` Gets the value(s) for active (status).
`BooleanDt`	`getActiveElement()` Gets the value(s) for active (status).
`List<AddressDt>`	`getAddress()` Gets the value(s) for address ().
`AddressDt`	`getAddressFirstRep()` Gets the first repetition for address (), creating it if it does not already exist.
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`Patient.Animal`	`getAnimal()` Gets the value(s) for animal ().
`Date`	`getBirthDate()` Gets the value(s) for birthDate ().
`DateDt`	`getBirthDateElement()` Gets the value(s) for birthDate ().
`List<ResourceReferenceDt>`	`getCareProvider()` Gets the value(s) for careProvider ().
`List<Patient.Communication>`	`getCommunication()` Gets the value(s) for communication ().
`Patient.Communication`	`getCommunicationFirstRep()` Gets the first repetition for communication (), creating it if it does not already exist.
`List<Patient.Contact>`	`getContact()` Gets the value(s) for contact ().
`Patient.Contact`	`getContactFirstRep()` Gets the first repetition for contact (), creating it if it does not already exist.
`IDatatype`	`getDeceased()` Gets the value(s) for deceased[x] ().
`String`	`getGender()` Gets the value(s) for gender ().
`BoundCodeDt<AdministrativeGenderEnum>`	`getGenderElement()` Gets the value(s) for gender ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (id).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (id), creating it if it does not already exist.
`List<Patient.Link>`	`getLink()` Gets the value(s) for link ().
`Patient.Link`	`getLinkFirstRep()` Gets the first repetition for link (), creating it if it does not already exist.
`ResourceReferenceDt`	`getManagingOrganization()` Gets the value(s) for managingOrganization ().
`BoundCodeableConceptDt<MaritalStatusCodesEnum>`	`getMaritalStatus()` Gets the value(s) for maritalStatus ().
`IDatatype`	`getMultipleBirth()` Gets the value(s) for multipleBirth[x] ().
`List<HumanNameDt>`	`getName()` Gets the value(s) for name ().
`HumanNameDt`	`getNameFirstRep()` Gets the first repetition for name (), creating it if it does not already exist.
`List<AttachmentDt>`	`getPhoto()` Gets the value(s) for photo ().
`AttachmentDt`	`getPhotoFirstRep()` Gets the first repetition for photo (), creating it if it does not already exist.
`String`	`getResourceName()`
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`List<ContactPointDt>`	`getTelecom()` Gets the value(s) for telecom ().
`ContactPointDt`	`getTelecomFirstRep()` Gets the first repetition for telecom (), creating it if it does not already exist.
`boolean`	`isEmpty()`
`Patient`	`setActive(boolean theBoolean)` Sets the value for active (status)
`Patient`	`setActive(BooleanDt theValue)` Sets the value(s) for active (status)
`Patient`	`setAddress(List<AddressDt> theValue)` Sets the value(s) for address ()
`Patient`	`setAnimal(Patient.Animal theValue)` Sets the value(s) for animal ()
`Patient`	`setBirthDate(DateDt theValue)` Sets the value(s) for birthDate ()
`Patient`	`setBirthDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for birthDate ()
`Patient`	`setBirthDateWithDayPrecision(Date theDate)` Sets the value for birthDate ()
`Patient`	`setCareProvider(List<ResourceReferenceDt> theValue)` Sets the value(s) for careProvider ()
`Patient`	`setCommunication(List<Patient.Communication> theValue)` Sets the value(s) for communication ()
`Patient`	`setContact(List<Patient.Contact> theValue)` Sets the value(s) for contact ()
`Patient`	`setDeceased(IDatatype theValue)` Sets the value(s) for deceased[x] ()
`Patient`	`setGender(AdministrativeGenderEnum theValue)` Sets the value(s) for gender ()
`Patient`	`setGender(BoundCodeDt<AdministrativeGenderEnum> theValue)` Sets the value(s) for gender ()
`Patient`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`Patient`	`setLink(List<Patient.Link> theValue)` Sets the value(s) for link ()
`Patient`	`setManagingOrganization(ResourceReferenceDt theValue)` Sets the value(s) for managingOrganization ()
`Patient`	`setMaritalStatus(BoundCodeableConceptDt<MaritalStatusCodesEnum> theValue)` Sets the value(s) for maritalStatus ()
`Patient`	`setMaritalStatus(MaritalStatusCodesEnum theValue)` Sets the value(s) for maritalStatus ()
`Patient`	`setMultipleBirth(IDatatype theValue)` Sets the value(s) for multipleBirth[x] ()
`Patient`	`setName(List<HumanNameDt> theValue)` Sets the value(s) for name ()
`Patient`	`setPhoto(List<AttachmentDt> theValue)` Sets the value(s) for photo ()
`Patient`	`setTelecom(List<ContactPointDt> theValue)` Sets the value(s) for telecom ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId

- 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 Include INCLUDE_ORGANIZATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Patient:organization".
- Constructor Detail
  - Patient
```
public Patient()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.
    Definition: An identifier for this patient
  - setIdentifier
```
public Patient setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (id)
    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 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. Will not return null.
    Definition: Whether this patient record is in active use
  - setActive
```
public Patient setActive(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<HumanNameDt> getName()
```
    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<ContactPointDt> getTelecom()
```
    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 BoundCodeDt<AdministrativeGenderEnum> getGenderElement()
```
    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. Will not return null.
    Definition: Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
  - setGender
```
public Patient setGender(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 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. Will not return null.
    Definition: The date of birth for the individual
  - setBirthDate
```
public Patient setBirthDate(DateDt theValue)
```
    Sets the value(s) for birthDate ()
    Definition: The date of birth for the individual
  - setBirthDate
```
public Patient setBirthDate(Date theDate,
                            TemporalPrecisionEnum thePrecision)
```
    Sets the value for birthDate ()
    Definition: The date of birth for the individual
  - setBirthDateWithDayPrecision
```
public Patient setBirthDateWithDayPrecision(Date theDate)
```
    Sets the value for birthDate ()
    Definition: The date of birth for the individual
  - getDeceased
```
public 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(IDatatype theValue)
```
    Sets the value(s) for deceased[x] ()
    Definition: Indicates if the individual is deceased or not
  - getAddress
```
public List<AddressDt> getAddress()
```
    Gets the value(s) for address (). creating it if it does not exist. Will not return null.
    Definition: Addresses for the individual
  - setAddress
```
public Patient setAddress(List<AddressDt> theValue)
```
    Sets the value(s) for address ()
    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
  - getMaritalStatus
```
public BoundCodeableConceptDt<MaritalStatusCodesEnum> getMaritalStatus()
```
    Gets the value(s) for maritalStatus (). creating it if it does not exist. Will not return null.
    Definition: This field contains a patient's most recent marital (civil) status.
  - setMaritalStatus
```
public Patient setMaritalStatus(BoundCodeableConceptDt<MaritalStatusCodesEnum> theValue)
```
    Sets the value(s) for maritalStatus ()
    Definition: This field contains a patient's most recent marital (civil) status.
  - setMaritalStatus
```
public Patient setMaritalStatus(MaritalStatusCodesEnum theValue)
```
    Sets the value(s) for maritalStatus ()
    Definition: This field contains a patient's most recent marital (civil) status.
  - getMultipleBirth
```
public 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(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<AttachmentDt> getPhoto()
```
    Gets the value(s) for photo (). creating it if it does not exist. Will not return null.
    Definition: Image of the patient
  - setPhoto
```
public Patient setPhoto(List<AttachmentDt> theValue)
```
    Sets the value(s) for photo ()
    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.Contact> getContact()
```
    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
  - setAnimal
```
public Patient setAnimal(Patient.Animal theValue)
```
    Sets the value(s) for animal ()
    Definition: This patient is known to be an animal
  - getCommunication
```
public List<Patient.Communication> getCommunication()
```
    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
  - setCommunication
```
public Patient setCommunication(List<Patient.Communication> theValue)
```
    Sets the value(s) for communication ()
    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<ResourceReferenceDt> getCareProvider()
```
    Gets the value(s) for careProvider (). creating it if it does not exist. Will not return null.
    Definition: Patient's nominated care provider
  - setCareProvider
```
public Patient setCareProvider(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for careProvider ()
    Definition: Patient's nominated care provider
  - addCareProvider
```
public ResourceReferenceDt addCareProvider()
```
    Adds and returns a new value for careProvider ()
    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
  - setManagingOrganization
```
public Patient setManagingOrganization(ResourceReferenceDt theValue)
```
    Sets the value(s) for managingOrganization ()
    Definition: Organization that is the custodian of the patient record
  - getLink
```
public List<Patient.Link> getLink()
```
    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 IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class Patient

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

SP_IDENTIFIER

IDENTIFIER

SP_NAME

NAME

SP_FAMILY

FAMILY

SP_GIVEN

GIVEN

SP_PHONETIC

PHONETIC

SP_TELECOM

TELECOM

SP_PHONE

PHONE

SP_EMAIL

EMAIL

SP_ADDRESS

ADDRESS

SP_ADDRESS_CITY

ADDRESS_CITY

SP_ADDRESS_STATE

ADDRESS_STATE

SP_ADDRESS_POSTALCODE

ADDRESS_POSTALCODE

SP_ADDRESS_COUNTRY

ADDRESS_COUNTRY

SP_ADDRESS_USE

ADDRESS_USE

SP_GENDER

GENDER

SP_LANGUAGE

LANGUAGE

SP_BIRTHDATE

BIRTHDATE

SP_ORGANIZATION

ORGANIZATION

SP_CAREPROVIDER

CAREPROVIDER

SP_ACTIVE

ACTIVE

SP_ANIMAL_SPECIES

ANIMAL_SPECIES

SP_ANIMAL_BREED

ANIMAL_BREED

SP_LINK

LINK

SP_DECEASED

DECEASED

SP_DEATHDATE

DEATHDATE

INCLUDE_CAREPROVIDER

INCLUDE_LINK

INCLUDE_ORGANIZATION

Constructor Detail

Patient

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getActiveElement

getActive

setActive

setActive