Patient (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.model.Patient

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class Patient
extends DomainResource
```
Demographics and other administrative information about an individual or animal receiving care or other health-related services.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Patient.AnimalComponent`
`static class`	`Patient.ContactComponent`
`static class`	`Patient.LinkType`
`static class`	`Patient.LinkTypeEnumFactory`
`static class`	`Patient.PatientCommunicationComponent`
`static class`	`Patient.PatientLinkComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`protected BooleanType`	`active` Whether this patient record is in active use.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ACTIVE` Fluent Client search parameter constant for active
`protected List<Address>`	`address` Addresses for the individual.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`ADDRESS` Fluent Client search parameter constant for address
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`ADDRESS_CITY` Fluent Client search parameter constant for address-city
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`ADDRESS_COUNTRY` Fluent Client search parameter constant for address-country
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`ADDRESS_POSTALCODE` Fluent Client search parameter constant for address-postalcode
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`ADDRESS_STATE` Fluent Client search parameter constant for address-state
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ADDRESS_USE` Fluent Client search parameter constant for address-use
`protected Patient.AnimalComponent`	`animal` This patient is known to be an animal.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ANIMAL_BREED` Fluent Client search parameter constant for animal-breed
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`ANIMAL_SPECIES` Fluent Client search parameter constant for animal-species
`protected DateType`	`birthDate` The date of birth for the individual.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`BIRTHDATE` Fluent Client search parameter constant for birthdate
`protected List<Reference>`	`careProvider` Patient's nominated care provider.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`CAREPROVIDER` Fluent Client search parameter constant for careprovider
`protected List<Resource>`	`careProviderTarget` The actual objects that are the target of the reference (Patient's nominated care provider.)
`protected List<Patient.PatientCommunicationComponent>`	`communication` Languages which may be used to communicate with the patient about his or her health.
`protected List<Patient.ContactComponent>`	`contact` A contact party (e.g.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DEATH_DATE` Fluent Client search parameter constant for death-date
`protected Type`	`deceased` Indicates if the individual is deceased or not.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`DECEASED` Fluent Client search parameter constant for deceased
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`EMAIL` Fluent Client search parameter constant for email
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`FAMILY` Fluent Client search parameter constant for family
`protected Enumeration<Enumerations.AdministrativeGender>`	`gender` Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`GENDER` Fluent Client search parameter constant for gender
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`GIVEN` Fluent Client search parameter constant for given
`protected List<Identifier>`	`identifier` An identifier for this patient.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_CAREPROVIDER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_LINK` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ORGANIZATION` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`LANGUAGE` Fluent Client search parameter constant for language
`protected List<Patient.PatientLinkComponent>`	`link` Link to another patient resource that concerns the same actual patient.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`LINK` Fluent Client search parameter constant for link
`protected Reference`	`managingOrganization` Organization that is the custodian of the patient record.
`protected Organization`	`managingOrganizationTarget` The actual object that is the target of the reference (Organization that is the custodian of the patient record.)
`protected CodeableConcept`	`maritalStatus` This field contains a patient's most recent marital (civil) status.
`protected Type`	`multipleBirth` Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
`protected List<HumanName>`	`name` A name associated with the individual.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ORGANIZATION` Fluent Client search parameter constant for organization
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`PHONE` Fluent Client search parameter constant for phone
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`PHONETIC` Fluent Client search parameter constant for phonetic
`protected List<Attachment>`	`photo` Image of the patient.
`static String`	`SP_ACTIVE` Search parameter: active
`static String`	`SP_ADDRESS` Search parameter: address
`static String`	`SP_ADDRESS_CITY` Search parameter: address-city
`static String`	`SP_ADDRESS_COUNTRY` Search parameter: address-country
`static String`	`SP_ADDRESS_POSTALCODE` Search parameter: address-postalcode
`static String`	`SP_ADDRESS_STATE` Search parameter: address-state
`static String`	`SP_ADDRESS_USE` Search parameter: address-use
`static String`	`SP_ANIMAL_BREED` Search parameter: animal-breed
`static String`	`SP_ANIMAL_SPECIES` Search parameter: animal-species
`static String`	`SP_BIRTHDATE` Search parameter: birthdate
`static String`	`SP_CAREPROVIDER` Search parameter: careprovider
`static String`	`SP_DEATH_DATE` Search parameter: death-date
`static String`	`SP_DECEASED` Search parameter: deceased
`static String`	`SP_EMAIL` Search parameter: email
`static String`	`SP_FAMILY` Search parameter: family
`static String`	`SP_GENDER` Search parameter: gender
`static String`	`SP_GIVEN` Search parameter: given
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_LANGUAGE` Search parameter: language
`static String`	`SP_LINK` Search parameter: link
`static String`	`SP_NAME` Search parameter: name
`static String`	`SP_ORGANIZATION` Search parameter: organization
`static String`	`SP_PHONE` Search parameter: phone
`static String`	`SP_PHONETIC` Search parameter: phonetic
`static String`	`SP_TELECOM` Search parameter: telecom
`protected List<ContactPoint>`	`telecom` A contact detail (e.g.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TELECOM` Fluent Client search parameter constant for telecom

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
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()
Constructor

Constructors
Constructor and Description
`Patient()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Address`	`addAddress()`
`Patient`	`addAddress(Address t)`
`Reference`	`addCareProvider()`
`Patient`	`addCareProvider(Reference t)`
`Base`	`addChild(String name)`
`Patient.PatientCommunicationComponent`	`addCommunication()`
`Patient`	`addCommunication(Patient.PatientCommunicationComponent t)`
`Patient.ContactComponent`	`addContact()`
`Patient`	`addContact(Patient.ContactComponent t)`
`Identifier`	`addIdentifier()`
`Patient`	`addIdentifier(Identifier t)`
`Patient.PatientLinkComponent`	`addLink()`
`Patient`	`addLink(Patient.PatientLinkComponent t)`
`HumanName`	`addName()`
`Patient`	`addName(HumanName t)`
`Attachment`	`addPhoto()`
`Patient`	`addPhoto(Attachment t)`
`ContactPoint`	`addTelecom()`
`Patient`	`addTelecom(ContactPoint t)`
`Patient`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`boolean`	`getActive()`
`BooleanType`	`getActiveElement()`
`List<Address>`	`getAddress()`
`Patient.AnimalComponent`	`getAnimal()`
`Date`	`getBirthDate()`
`DateType`	`getBirthDateElement()`
`List<Reference>`	`getCareProvider()`
`List<Resource>`	`getCareProviderTarget()`
`List<Patient.PatientCommunicationComponent>`	`getCommunication()`
`List<Patient.ContactComponent>`	`getContact()`
`Type`	`getDeceased()`
`BooleanType`	`getDeceasedBooleanType()`
`DateTimeType`	`getDeceasedDateTimeType()`
`Enumerations.AdministrativeGender`	`getGender()`
`Enumeration<Enumerations.AdministrativeGender>`	`getGenderElement()`
`List<Identifier>`	`getIdentifier()`
`List<Patient.PatientLinkComponent>`	`getLink()`
`Reference`	`getManagingOrganization()`
`Organization`	`getManagingOrganizationTarget()`
`CodeableConcept`	`getMaritalStatus()`
`Type`	`getMultipleBirth()`
`BooleanType`	`getMultipleBirthBooleanType()`
`IntegerType`	`getMultipleBirthIntegerType()`
`List<HumanName>`	`getName()`
`List<Attachment>`	`getPhoto()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`ResourceType`	`getResourceType()`
`List<ContactPoint>`	`getTelecom()`
`boolean`	`hasActive()`
`boolean`	`hasActiveElement()`
`boolean`	`hasAddress()`
`boolean`	`hasAnimal()`
`boolean`	`hasBirthDate()`
`boolean`	`hasBirthDateElement()`
`boolean`	`hasCareProvider()`
`boolean`	`hasCommunication()`
`boolean`	`hasContact()`
`boolean`	`hasDeceased()`
`boolean`	`hasDeceasedBooleanType()`
`boolean`	`hasDeceasedDateTimeType()`
`boolean`	`hasGender()`
`boolean`	`hasGenderElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasLink()`
`boolean`	`hasManagingOrganization()`
`boolean`	`hasMaritalStatus()`
`boolean`	`hasMultipleBirth()`
`boolean`	`hasMultipleBirthBooleanType()`
`boolean`	`hasMultipleBirthIntegerType()`
`boolean`	`hasName()`
`boolean`	`hasPhoto()`
`boolean`	`hasTelecom()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Patient`	`setActive(boolean value)`
`Patient`	`setActiveElement(BooleanType value)`
`Patient`	`setAnimal(Patient.AnimalComponent value)`
`Patient`	`setBirthDate(Date value)`
`Patient`	`setBirthDateElement(DateType value)`
`Patient`	`setDeceased(Type value)`
`Patient`	`setGender(Enumerations.AdministrativeGender value)`
`Patient`	`setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)`
`Patient`	`setManagingOrganization(Reference value)`
`Patient`	`setManagingOrganizationTarget(Organization value)`
`Patient`	`setMaritalStatus(CodeableConcept value)`
`Patient`	`setMultipleBirth(Type value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`protected Patient`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    An identifier for this patient.
  - active
```
protected BooleanType active
```
    Whether this patient record is in active use.
  - name
```
protected List<HumanName> name
```
    A name associated with the individual.
  - telecom
```
protected List<ContactPoint> telecom
```
    A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
  - gender
```
protected Enumeration<Enumerations.AdministrativeGender> gender
```
    Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
  - birthDate
```
protected DateType birthDate
```
    The date of birth for the individual.
  - deceased
```
protected Type deceased
```
    Indicates if the individual is deceased or not.
  - address
```
protected List<Address> address
```
    Addresses for the individual.
  - maritalStatus
```
protected CodeableConcept maritalStatus
```
    This field contains a patient's most recent marital (civil) status.
  - multipleBirth
```
protected Type multipleBirth
```
    Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
  - photo
```
protected List<Attachment> photo
```
    Image of the patient.
  - contact
```
protected List<Patient.ContactComponent> contact
```
    A contact party (e.g. guardian, partner, friend) for the patient.
  - animal
```
protected Patient.AnimalComponent animal
```
    This patient is known to be an animal.
  - communication
```
protected List<Patient.PatientCommunicationComponent> communication
```
    Languages which may be used to communicate with the patient about his or her health.
  - careProvider
```
protected List<Reference> careProvider
```
    Patient's nominated care provider.
  - careProviderTarget
```
protected List<Resource> careProviderTarget
```
    The actual objects that are the target of the reference (Patient's nominated care provider.)
  - managingOrganization
```
protected Reference managingOrganization
```
    Organization that is the custodian of the patient record.
  - managingOrganizationTarget
```
protected Organization managingOrganizationTarget
```
    The actual object that is the target of the reference (Organization that is the custodian of the patient record.)
  - link
```
protected List<Patient.PatientLinkComponent> link
```
    Link to another patient resource that concerns the same actual patient.
  - SP_PHONE
```
public static final String SP_PHONE
```
    Search parameter: phone
    Description: A value in a phone contact
    Type: token
    Path: Patient.telecom(system=phone)
    
    See Also:
    
    Constant Field Values
  - PHONE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PHONE
```
    Fluent Client search parameter constant for phone
    Description: A value in a phone contact
    Type: token
    Path: Patient.telecom(system=phone)
  - SP_PHONETIC
```
public static final String SP_PHONETIC
```
    Search parameter: phonetic
    Description: A portion of either family or given name using some kind of phonetic matching algorithm
    Type: string
    Path: Patient.name
    
    See Also:
    
    Constant Field Values
  - PHONETIC
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam PHONETIC
```
    Fluent Client search parameter constant for phonetic
    Description: A portion of either family or given name using some kind of phonetic matching algorithm
    Type: string
    Path: Patient.name
  - SP_LINK
```
public static final String SP_LINK
```
    Search parameter: link
    Description: All patients linked to the given patient
    Type: reference
    Path: Patient.link.other
    
    See Also:
    
    Constant Field Values
  - LINK
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LINK
```
    Fluent Client search parameter constant for link
    Description: All patients linked to the given patient
    Type: reference
    Path: Patient.link.other
  - INCLUDE_LINK
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_LINK
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Patient:link".
  - SP_ANIMAL_SPECIES
```
public static final String SP_ANIMAL_SPECIES
```
    Search parameter: animal-species
    Description: The species for animal patients
    Type: token
    Path: Patient.animal.species
    
    See Also:
    
    Constant Field Values
  - ANIMAL_SPECIES
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ANIMAL_SPECIES
```
    Fluent Client search parameter constant for animal-species
    Description: The species for animal patients
    Type: token
    Path: Patient.animal.species
  - SP_ORGANIZATION
```
public static final String SP_ORGANIZATION
```
    Search parameter: organization
    Description: The organization at which this person is a patient
    Type: reference
    Path: Patient.managingOrganization
    
    See Also:
    
    Constant Field Values
  - ORGANIZATION
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION
```
    Fluent Client search parameter constant for organization
    Description: The organization at which this person is a patient
    Type: reference
    Path: Patient.managingOrganization
  - INCLUDE_ORGANIZATION
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Patient:organization".
  - SP_ADDRESS_CITY
```
public static final String SP_ADDRESS_CITY
```
    Search parameter: address-city
    Description: A city specified in an address
    Type: string
    Path: Patient.address.city
    
    See Also:
    
    Constant Field Values
  - ADDRESS_CITY
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_CITY
```
    Fluent Client search parameter constant for address-city
    Description: A city specified in an address
    Type: string
    Path: Patient.address.city
  - SP_GIVEN
```
public static final String SP_GIVEN
```
    Search parameter: given
    Description: A portion of the given name of the patient
    Type: string
    Path: Patient.name.given
    
    See Also:
    
    Constant Field Values
  - GIVEN
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam GIVEN
```
    Fluent Client search parameter constant for given
    Description: A portion of the given name of the patient
    Type: string
    Path: Patient.name.given
  - SP_CAREPROVIDER
```
public static final String SP_CAREPROVIDER
```
    Search parameter: careprovider
    Description: Patient's nominated care provider, could be a care manager, not the organization that manages the record
    Type: reference
    Path: Patient.careProvider
    
    See Also:
    
    Constant Field Values
  - CAREPROVIDER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CAREPROVIDER
```
    Fluent Client search parameter constant for careprovider
    Description: Patient's nominated care provider, could be a care manager, not the organization that manages the record
    Type: reference
    Path: Patient.careProvider
  - INCLUDE_CAREPROVIDER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_CAREPROVIDER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Patient:careprovider".
  - SP_FAMILY
```
public static final String SP_FAMILY
```
    Search parameter: family
    Description: A portion of the family name of the patient
    Type: string
    Path: Patient.name.family
    
    See Also:
    
    Constant Field Values
  - FAMILY
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam FAMILY
```
    Fluent Client search parameter constant for family
    Description: A portion of the family name of the patient
    Type: string
    Path: Patient.name.family
  - SP_DEATH_DATE
```
public static final String SP_DEATH_DATE
```
    Search parameter: death-date
    Description: The date of death has been provided and satisfies this search value
    Type: date
    Path: Patient.deceasedDateTime
    
    See Also:
    
    Constant Field Values
  - DEATH_DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam DEATH_DATE
```
    Fluent Client search parameter constant for death-date
    Description: The date of death has been provided and satisfies this search value
    Type: date
    Path: Patient.deceasedDateTime
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter: name
    Description: A portion of either family or given name of the patient
    Type: string
    Path: Patient.name
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
```
    Fluent Client search parameter constant for name
    Description: A portion of either family or given name of the patient
    Type: string
    Path: Patient.name
  - SP_TELECOM
```
public static final String SP_TELECOM
```
    Search parameter: telecom
    Description: The value in any kind of telecom details of the patient
    Type: token
    Path: Patient.telecom
    
    See Also:
    
    Constant Field Values
  - TELECOM
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TELECOM
```
    Fluent Client search parameter constant for telecom
    Description: The value in any kind of telecom details of the patient
    Type: token
    Path: Patient.telecom
  - SP_BIRTHDATE
```
public static final String SP_BIRTHDATE
```
    Search parameter: birthdate
    Description: The patient's date of birth
    Type: date
    Path: Patient.birthDate
    
    See Also:
    
    Constant Field Values
  - BIRTHDATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam BIRTHDATE
```
    Fluent Client search parameter constant for birthdate
    Description: The patient's date of birth
    Type: date
    Path: Patient.birthDate
  - SP_GENDER
```
public static final String SP_GENDER
```
    Search parameter: gender
    Description: Gender of the patient
    Type: token
    Path: Patient.gender
    
    See Also:
    
    Constant Field Values
  - GENDER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam GENDER
```
    Fluent Client search parameter constant for gender
    Description: Gender of the patient
    Type: token
    Path: Patient.gender
  - SP_DECEASED
```
public static final String SP_DECEASED
```
    Search parameter: deceased
    Description: This patient has been marked as deceased, or as a death date entered
    Type: token
    Path: Patient.deceased[x]
    
    See Also:
    
    Constant Field Values
  - DECEASED
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam DECEASED
```
    Fluent Client search parameter constant for deceased
    Description: This patient has been marked as deceased, or as a death date entered
    Type: token
    Path: Patient.deceased[x]
  - SP_ANIMAL_BREED
```
public static final String SP_ANIMAL_BREED
```
    Search parameter: animal-breed
    Description: The breed for animal patients
    Type: token
    Path: Patient.animal.breed
    
    See Also:
    
    Constant Field Values
  - ANIMAL_BREED
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ANIMAL_BREED
```
    Fluent Client search parameter constant for animal-breed
    Description: The breed for animal patients
    Type: token
    Path: Patient.animal.breed
  - SP_ADDRESS_COUNTRY
```
public static final String SP_ADDRESS_COUNTRY
```
    Search parameter: address-country
    Description: A country specified in an address
    Type: string
    Path: Patient.address.country
    
    See Also:
    
    Constant Field Values
  - ADDRESS_COUNTRY
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_COUNTRY
```
    Fluent Client search parameter constant for address-country
    Description: A country specified in an address
    Type: string
    Path: Patient.address.country
  - SP_ADDRESS_STATE
```
public static final String SP_ADDRESS_STATE
```
    Search parameter: address-state
    Description: A state specified in an address
    Type: string
    Path: Patient.address.state
    
    See Also:
    
    Constant Field Values
  - ADDRESS_STATE
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_STATE
```
    Fluent Client search parameter constant for address-state
    Description: A state specified in an address
    Type: string
    Path: Patient.address.state
  - SP_ADDRESS
```
public static final String SP_ADDRESS
```
    Search parameter: address
    Description: An address in any kind of address/part of the patient
    Type: string
    Path: Patient.address
    
    See Also:
    
    Constant Field Values
  - ADDRESS
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS
```
    Fluent Client search parameter constant for address
    Description: An address in any kind of address/part of the patient
    Type: string
    Path: Patient.address
  - SP_EMAIL
```
public static final String SP_EMAIL
```
    Search parameter: email
    Description: A value in an email contact
    Type: token
    Path: Patient.telecom(system=email)
    
    See Also:
    
    Constant Field Values
  - EMAIL
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EMAIL
```
    Fluent Client search parameter constant for email
    Description: A value in an email contact
    Type: token
    Path: Patient.telecom(system=email)
  - SP_ADDRESS_USE
```
public static final String SP_ADDRESS_USE
```
    Search parameter: address-use
    Description: A use code specified in an address
    Type: token
    Path: Patient.address.use
    
    See Also:
    
    Constant Field Values
  - ADDRESS_USE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADDRESS_USE
```
    Fluent Client search parameter constant for address-use
    Description: A use code specified in an address
    Type: token
    Path: Patient.address.use
  - SP_ACTIVE
```
public static final String SP_ACTIVE
```
    Search parameter: active
    Description: Whether the patient record is active
    Type: token
    Path: Patient.active
    
    See Also:
    
    Constant Field Values
  - ACTIVE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTIVE
```
    Fluent Client search parameter constant for active
    Description: Whether the patient record is active
    Type: token
    Path: Patient.active
  - SP_LANGUAGE
```
public static final String SP_LANGUAGE
```
    Search parameter: language
    Description: Language code (irrespective of use value)
    Type: token
    Path: Patient.communication.language
    
    See Also:
    
    Constant Field Values
  - LANGUAGE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam LANGUAGE
```
    Fluent Client search parameter constant for language
    Description: Language code (irrespective of use value)
    Type: token
    Path: Patient.communication.language
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: A patient identifier
    Type: token
    Path: Patient.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: A patient identifier
    Type: token
    Path: Patient.identifier
  - SP_ADDRESS_POSTALCODE
```
public static final String SP_ADDRESS_POSTALCODE
```
    Search parameter: address-postalcode
    Description: A postalCode specified in an address
    Type: string
    Path: Patient.address.postalCode
    
    See Also:
    
    Constant Field Values
  - ADDRESS_POSTALCODE
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_POSTALCODE
```
    Fluent Client search parameter constant for address-postalcode
    Description: A postalCode specified in an address
    Type: string
    Path: Patient.address.postalCode
- Constructor Detail
  - Patient
```
public Patient()
```
    Constructor
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (An identifier for this patient.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (An identifier for this patient.)
  - addIdentifier
```
public Patient addIdentifier(Identifier t)
```
  - getActiveElement
```
public BooleanType getActiveElement()
```
    Returns:
    
    active (Whether this patient record is in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value
  - hasActiveElement
```
public boolean hasActiveElement()
```
  - hasActive
```
public boolean hasActive()
```
  - setActiveElement
```
public Patient setActiveElement(BooleanType value)
```
    Parameters:
    
    value - active (Whether this patient record is in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value
  - getActive
```
public boolean getActive()
```
    Returns:
    
    Whether this patient record is in active use.
  - setActive
```
public Patient setActive(boolean value)
```
    Parameters:
    
    value - Whether this patient record is in active use.
  - getName
```
public List<HumanName> getName()
```
    Returns:
    
    name (A name associated with the individual.)
  - hasName
```
public boolean hasName()
```
  - addName
```
public HumanName addName()
```
    Returns:
    
    name (A name associated with the individual.)
  - addName
```
public Patient addName(HumanName t)
```
  - getTelecom
```
public List<ContactPoint> getTelecom()
```
    Returns:
    
    telecom (A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.)
  - hasTelecom
```
public boolean hasTelecom()
```
  - addTelecom
```
public ContactPoint addTelecom()
```
    Returns:
    
    telecom (A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.)
  - addTelecom
```
public Patient addTelecom(ContactPoint t)
```
  - getGenderElement
```
public Enumeration<Enumerations.AdministrativeGender> getGenderElement()
```
    Returns:
    
    gender (Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.). This is the underlying object with id, value and extensions. The accessor "getGender" gives direct access to the value
  - hasGenderElement
```
public boolean hasGenderElement()
```
  - hasGender
```
public boolean hasGender()
```
  - setGenderElement
```
public Patient setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)
```
    Parameters:
    
    value - gender (Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.). This is the underlying object with id, value and extensions. The accessor "getGender" gives direct access to the value
  - getGender
```
public Enumerations.AdministrativeGender getGender()
```
    Returns:
    
    Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
  - setGender
```
public Patient setGender(Enumerations.AdministrativeGender value)
```
    Parameters:
    
    value - Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
  - getBirthDateElement
```
public DateType getBirthDateElement()
```
    Returns:
    
    birthDate (The date of birth for the individual.). This is the underlying object with id, value and extensions. The accessor "getBirthDate" gives direct access to the value
  - hasBirthDateElement
```
public boolean hasBirthDateElement()
```
  - hasBirthDate
```
public boolean hasBirthDate()
```
  - setBirthDateElement
```
public Patient setBirthDateElement(DateType value)
```
    Parameters:
    
    value - birthDate (The date of birth for the individual.). This is the underlying object with id, value and extensions. The accessor "getBirthDate" gives direct access to the value
  - getBirthDate
```
public Date getBirthDate()
```
    Returns:
    
    The date of birth for the individual.
  - setBirthDate
```
public Patient setBirthDate(Date value)
```
    Parameters:
    
    value - The date of birth for the individual.
  - getDeceased
```
public Type getDeceased()
```
    Returns:
    
    deceased (Indicates if the individual is deceased or not.)
  - getDeceasedBooleanType
```
public BooleanType getDeceasedBooleanType()
                                   throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    deceased (Indicates if the individual is deceased or not.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasDeceasedBooleanType
```
public boolean hasDeceasedBooleanType()
```
  - getDeceasedDateTimeType
```
public DateTimeType getDeceasedDateTimeType()
                                     throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    deceased (Indicates if the individual is deceased or not.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasDeceasedDateTimeType
```
public boolean hasDeceasedDateTimeType()
```
  - hasDeceased
```
public boolean hasDeceased()
```
  - setDeceased
```
public Patient setDeceased(Type value)
```
    Parameters:
    
    value - deceased (Indicates if the individual is deceased or not.)
  - getAddress
```
public List<Address> getAddress()
```
    Returns:
    
    address (Addresses for the individual.)
  - hasAddress
```
public boolean hasAddress()
```
  - addAddress
```
public Address addAddress()
```
    Returns:
    
    address (Addresses for the individual.)
  - addAddress
```
public Patient addAddress(Address t)
```
  - getMaritalStatus
```
public CodeableConcept getMaritalStatus()
```
    Returns:
    
    maritalStatus (This field contains a patient's most recent marital (civil) status.)
  - hasMaritalStatus
```
public boolean hasMaritalStatus()
```
  - setMaritalStatus
```
public Patient setMaritalStatus(CodeableConcept value)
```
    Parameters:
    
    value - maritalStatus (This field contains a patient's most recent marital (civil) status.)
  - getMultipleBirth
```
public Type getMultipleBirth()
```
    Returns:
    
    multipleBirth (Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).)
  - getMultipleBirthBooleanType
```
public BooleanType getMultipleBirthBooleanType()
                                        throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    multipleBirth (Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasMultipleBirthBooleanType
```
public boolean hasMultipleBirthBooleanType()
```
  - getMultipleBirthIntegerType
```
public IntegerType getMultipleBirthIntegerType()
                                        throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    multipleBirth (Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasMultipleBirthIntegerType
```
public boolean hasMultipleBirthIntegerType()
```
  - hasMultipleBirth
```
public boolean hasMultipleBirth()
```
  - setMultipleBirth
```
public Patient setMultipleBirth(Type value)
```
    Parameters:
    
    value - multipleBirth (Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).)
  - getPhoto
```
public List<Attachment> getPhoto()
```
    Returns:
    
    photo (Image of the patient.)
  - hasPhoto
```
public boolean hasPhoto()
```
  - addPhoto
```
public Attachment addPhoto()
```
    Returns:
    
    photo (Image of the patient.)
  - addPhoto
```
public Patient addPhoto(Attachment t)
```
  - getContact
```
public List<Patient.ContactComponent> getContact()
```
    Returns:
    
    contact (A contact party (e.g. guardian, partner, friend) for the patient.)
  - hasContact
```
public boolean hasContact()
```
  - addContact
```
public Patient.ContactComponent addContact()
```
    Returns:
    
    contact (A contact party (e.g. guardian, partner, friend) for the patient.)
  - addContact
```
public Patient addContact(Patient.ContactComponent t)
```
  - getAnimal
```
public Patient.AnimalComponent getAnimal()
```
    Returns:
    
    animal (This patient is known to be an animal.)
  - hasAnimal
```
public boolean hasAnimal()
```
  - setAnimal
```
public Patient setAnimal(Patient.AnimalComponent value)
```
    Parameters:
    
    value - animal (This patient is known to be an animal.)
  - getCommunication
```
public List<Patient.PatientCommunicationComponent> getCommunication()
```
    Returns:
    
    communication (Languages which may be used to communicate with the patient about his or her health.)
  - hasCommunication
```
public boolean hasCommunication()
```
  - addCommunication
```
public Patient.PatientCommunicationComponent addCommunication()
```
    Returns:
    
    communication (Languages which may be used to communicate with the patient about his or her health.)
  - addCommunication
```
public Patient addCommunication(Patient.PatientCommunicationComponent t)
```
  - getCareProvider
```
public List<Reference> getCareProvider()
```
    Returns:
    
    careProvider (Patient's nominated care provider.)
  - hasCareProvider
```
public boolean hasCareProvider()
```
  - addCareProvider
```
public Reference addCareProvider()
```
    Returns:
    
    careProvider (Patient's nominated care provider.)
  - addCareProvider
```
public Patient addCareProvider(Reference t)
```
  - getCareProviderTarget
```
public List<Resource> getCareProviderTarget()
```
    Returns:
    
    careProvider (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Patient's nominated care provider.)
  - getManagingOrganization
```
public Reference getManagingOrganization()
```
    Returns:
    
    managingOrganization (Organization that is the custodian of the patient record.)
  - hasManagingOrganization
```
public boolean hasManagingOrganization()
```
  - setManagingOrganization
```
public Patient setManagingOrganization(Reference value)
```
    Parameters:
    
    value - managingOrganization (Organization that is the custodian of the patient record.)
  - getManagingOrganizationTarget
```
public Organization getManagingOrganizationTarget()
```
    Returns:
    
    managingOrganization The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Organization that is the custodian of the patient record.)
  - setManagingOrganizationTarget
```
public Patient setManagingOrganizationTarget(Organization value)
```
    Parameters:
    
    value - managingOrganization The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Organization that is the custodian of the patient record.)
  - getLink
```
public List<Patient.PatientLinkComponent> getLink()
```
    Returns:
    
    link (Link to another patient resource that concerns the same actual patient.)
  - hasLink
```
public boolean hasLink()
```
  - addLink
```
public Patient.PatientLinkComponent addLink()
```
    Returns:
    
    link (Link to another patient resource that concerns the same actual patient.)
  - addLink
```
public Patient addLink(Patient.PatientLinkComponent t)
```
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class DomainResource
  - copy
```
public Patient copy()
```
    Specified by:
    
    copy in class DomainResource
  - typedCopy
```
protected Patient typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Patient

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

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

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

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

Methods inherited from class java.lang.Object

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

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

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

Field Detail

identifier

active

name

telecom

gender

birthDate

deceased

address

maritalStatus

multipleBirth

photo

contact

animal

communication

careProvider

careProviderTarget

managingOrganization

managingOrganizationTarget

link

SP_PHONE

PHONE

SP_PHONETIC

PHONETIC

SP_LINK

LINK

INCLUDE_LINK

SP_ANIMAL_SPECIES

ANIMAL_SPECIES

SP_ORGANIZATION

ORGANIZATION

INCLUDE_ORGANIZATION

SP_ADDRESS_CITY

ADDRESS_CITY

SP_GIVEN

GIVEN

SP_CAREPROVIDER

CAREPROVIDER

INCLUDE_CAREPROVIDER

SP_FAMILY

FAMILY

SP_DEATH_DATE

DEATH_DATE

SP_NAME

NAME

SP_TELECOM

TELECOM

SP_BIRTHDATE

BIRTHDATE

SP_GENDER

GENDER

SP_DECEASED

DECEASED

SP_ANIMAL_BREED

ANIMAL_BREED

SP_ADDRESS_COUNTRY

ADDRESS_COUNTRY

SP_ADDRESS_STATE

ADDRESS_STATE

SP_ADDRESS

ADDRESS

SP_EMAIL

EMAIL