Package org.hl7.fhir.r4.model

Class Patient

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.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	Description
static class	Patient.ContactComponent
static enum	Patient.LinkType
static class	Patient.LinkTypeEnumFactory
static class	Patient.PatientCommunicationComponent
static class	Patient.PatientLinkComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	active	Whether this patient record is in active use.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ACTIVE	Fluent Client search parameter constant for active
protected List<Address>	address	An address for the individual.
static final ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS	Fluent Client search parameter constant for address
static final ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_CITY	Fluent Client search parameter constant for address-city
static final ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_COUNTRY	Fluent Client search parameter constant for address-country
static final ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_POSTALCODE	Fluent Client search parameter constant for address-postalcode
static final ca.uhn.fhir.rest.gclient.StringClientParam	ADDRESS_STATE	Fluent Client search parameter constant for address-state
static final ca.uhn.fhir.rest.gclient.TokenClientParam	ADDRESS_USE	Fluent Client search parameter constant for address-use
protected DateType	birthDate	The date of birth for the individual.
static final ca.uhn.fhir.rest.gclient.DateClientParam	BIRTHDATE	Fluent Client search parameter constant for birthdate
protected List<Patient.PatientCommunicationComponent>	communication	A language 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 final 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 final ca.uhn.fhir.rest.gclient.TokenClientParam	DECEASED	Fluent Client search parameter constant for deceased
static final ca.uhn.fhir.rest.gclient.TokenClientParam	EMAIL	Fluent Client search parameter constant for email
static final 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 final ca.uhn.fhir.rest.gclient.TokenClientParam	GENDER	Fluent Client search parameter constant for gender
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	GENERAL_PRACTITIONER	Fluent Client search parameter constant for general-practitioner
protected List<Reference>	generalPractitioner	Patient's nominated care provider.
protected List<Resource>	generalPractitionerTarget	The actual objects that are the target of the reference (Patient's nominated care provider.)
static final ca.uhn.fhir.rest.gclient.StringClientParam	GIVEN	Fluent Client search parameter constant for given
protected List<Identifier>	identifier	An identifier for this patient.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_GENERAL_PRACTITIONER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_LINK	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ORGANIZATION	Constant for fluent queries to be used to add include statements.
static final 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 final 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 (boolean) or indicates the actual birth order (integer).
protected List<HumanName>	name	A name associated with the individual.
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ORGANIZATION	Fluent Client search parameter constant for organization
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PHONE	Fluent Client search parameter constant for phone
static final ca.uhn.fhir.rest.gclient.StringClientParam	PHONETIC	Fluent Client search parameter constant for phonetic
protected List<Attachment>	photo	Image of the patient.
static final String	SP_ACTIVE	Search parameter: active
static final String	SP_ADDRESS	Search parameter: address
static final String	SP_ADDRESS_CITY	Search parameter: address-city
static final String	SP_ADDRESS_COUNTRY	Search parameter: address-country
static final String	SP_ADDRESS_POSTALCODE	Search parameter: address-postalcode
static final String	SP_ADDRESS_STATE	Search parameter: address-state
static final String	SP_ADDRESS_USE	Search parameter: address-use
static final String	SP_BIRTHDATE	Search parameter: birthdate
static final String	SP_DEATH_DATE	Search parameter: death-date
static final String	SP_DECEASED	Search parameter: deceased
static final String	SP_EMAIL	Search parameter: email
static final String	SP_FAMILY	Search parameter: family
static final String	SP_GENDER	Search parameter: gender
static final String	SP_GENERAL_PRACTITIONER	Search parameter: general-practitioner
static final String	SP_GIVEN	Search parameter: given
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_LANGUAGE	Search parameter: language
static final String	SP_LINK	Search parameter: link
static final String	SP_NAME	Search parameter: name
static final String	SP_ORGANIZATION	Search parameter: organization
static final String	SP_PHONE	Search parameter: phone
static final String	SP_PHONETIC	Search parameter: phonetic
static final String	SP_TELECOM	Search parameter: telecom
protected List<ContactPoint>	telecom	A contact detail (e.g.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TELECOM	Fluent Client search parameter constant for telecom

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Patient()	Constructor

Method Summary

Modifier and Type	Method	Description
Address	addAddress()
Patient	addAddress(Address t)
Base	addChild(String name)
Patient.PatientCommunicationComponent	addCommunication()
Patient	addCommunication(Patient.PatientCommunicationComponent t)
Patient.ContactComponent	addContact()
Patient	addContact(Patient.ContactComponent t)
Reference	addGeneralPractitioner()
Patient	addGeneralPractitioner(Reference 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()
void	copyValues(Patient dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getActive()
BooleanType	getActiveElement()
List<Address>	getAddress()
Address	getAddressFirstRep()
Date	getBirthDate()
DateType	getBirthDateElement()
List<Patient.PatientCommunicationComponent>	getCommunication()
Patient.PatientCommunicationComponent	getCommunicationFirstRep()
List<Patient.ContactComponent>	getContact()
Patient.ContactComponent	getContactFirstRep()
Type	getDeceased()
BooleanType	getDeceasedBooleanType()
DateTimeType	getDeceasedDateTimeType()
Enumerations.AdministrativeGender	getGender()
Enumeration<Enumerations.AdministrativeGender>	getGenderElement()
List<Reference>	getGeneralPractitioner()
Reference	getGeneralPractitionerFirstRep()
List<Resource>	getGeneralPractitionerTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Patient.PatientLinkComponent>	getLink()
Patient.PatientLinkComponent	getLinkFirstRep()
Reference	getManagingOrganization()
Organization	getManagingOrganizationTarget()
CodeableConcept	getMaritalStatus()
Type	getMultipleBirth()
BooleanType	getMultipleBirthBooleanType()
IntegerType	getMultipleBirthIntegerType()
List<HumanName>	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
HumanName	getNameFirstRep()
List<Attachment>	getPhoto()
Attachment	getPhotoFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
List<ContactPoint>	getTelecom()
ContactPoint	getTelecomFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasActive()
boolean	hasActiveElement()
boolean	hasAddress()
boolean	hasBirthDate()
boolean	hasBirthDateElement()
boolean	hasCommunication()
boolean	hasContact()
boolean	hasDeceased()
boolean	hasDeceasedBooleanType()
boolean	hasDeceasedDateTimeType()
boolean	hasGender()
boolean	hasGenderElement()
boolean	hasGeneralPractitioner()
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> children)
Base	makeProperty(int hash, String name)
Patient	setActive(boolean value)
Patient	setActiveElement(BooleanType value)
Patient	setAddress(List<Address> theAddress)
Patient	setBirthDate(Date value)
Patient	setBirthDateElement(DateType value)
Patient	setCommunication(List<Patient.PatientCommunicationComponent> theCommunication)
Patient	setContact(List<Patient.ContactComponent> theContact)
Patient	setDeceased(Type value)
Patient	setGender(Enumerations.AdministrativeGender value)
Patient	setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)
Patient	setGeneralPractitioner(List<Reference> theGeneralPractitioner)
Patient	setIdentifier(List<Identifier> theIdentifier)
Patient	setLink(List<Patient.PatientLinkComponent> theLink)
Patient	setManagingOrganization(Reference value)
Patient	setManagingOrganizationTarget(Organization value)
Patient	setMaritalStatus(CodeableConcept value)
Patient	setMultipleBirth(Type value)
Patient	setName(List<HumanName> theName)
Patient	setPhoto(List<Attachment> thePhoto)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Patient	setTelecom(List<ContactPoint> theTelecom)
protected Patient	typedCopy()

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

An identifier for this patient.

active

protected BooleanType active

Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

name

protected List<HumanName> name

A name associated with the individual.

telecom

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

An address 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 (boolean) 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.

communication

protected List<Patient.PatientCommunicationComponent> communication

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

generalPractitioner

protected List<Reference> generalPractitioner

Patient's nominated care provider.

generalPractitionerTarget

protected List<Resource> generalPractitionerTarget

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_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

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

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

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

SP_GIVEN

public static final String SP_GIVEN

Search parameter: given

Description: A portion of the given name of the patient
Type: string
Path: Patient.name.given

See Also:

• Constant Field Values

GIVEN

public static final ca.uhn.fhir.rest.gclient.StringClientParam GIVEN

Fluent Client search parameter constant for given

Description: A portion of the given name of the patient
Type: string
Path: Patient.name.given

SP_ADDRESS

public static final String SP_ADDRESS

Search parameter: address

Description: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
Type: string
Path: Patient.address

See Also:

• Constant Field Values

ADDRESS

public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS

Fluent Client search parameter constant for address

Description: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
Type: string
Path: Patient.address

SP_BIRTHDATE

public static final String SP_BIRTHDATE

Search parameter: birthdate

Description: The patient's date of birth
Type: date
Path: Patient.birthDate

See Also:

• Constant Field Values

BIRTHDATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam BIRTHDATE

Fluent Client search parameter constant for birthdate

Description: The patient's date of birth
Type: date
Path: Patient.birthDate

SP_DECEASED

public static final String SP_DECEASED

Search parameter: deceased

Description: This patient has been marked as deceased, or as a death date entered
Type: token
Path: Patient.deceased[x]

See Also:

• Constant Field Values

DECEASED

public static final ca.uhn.fhir.rest.gclient.TokenClientParam DECEASED

Fluent Client search parameter constant for deceased

Description: This patient has been marked as deceased, or as a death date entered
Type: token
Path: Patient.deceased[x]

SP_ADDRESS_STATE

public static final String SP_ADDRESS_STATE

Search parameter: address-state

Description: A state specified in an address
Type: string
Path: Patient.address.state

See Also:

• Constant Field Values

ADDRESS_STATE

public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_STATE

Fluent Client search parameter constant for address-state

Description: A state specified in an address
Type: string
Path: Patient.address.state

SP_GENDER

public static final String SP_GENDER

Search parameter: gender

Description: Gender of the patient
Type: token
Path: Patient.gender

See Also:

• Constant Field Values

GENDER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam GENDER

Fluent Client search parameter constant for gender

Description: Gender of the patient
Type: token
Path: Patient.gender

SP_GENERAL_PRACTITIONER

public static final String SP_GENERAL_PRACTITIONER

Search parameter: general-practitioner

Description: Patient's nominated general practitioner, not the organization that manages the record
Type: reference
Path: Patient.generalPractitioner

See Also:

• Constant Field Values

GENERAL_PRACTITIONER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam GENERAL_PRACTITIONER

Fluent Client search parameter constant for general-practitioner

Description: Patient's nominated general practitioner, not the organization that manages the record
Type: reference
Path: Patient.generalPractitioner

INCLUDE_GENERAL_PRACTITIONER

public static final ca.uhn.fhir.model.api.Include INCLUDE_GENERAL_PRACTITIONER

Constant for fluent queries to be used to add include statements. Specifies the path value of "Patient:general-practitioner".

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

public static final String SP_ADDRESS_POSTALCODE

Search parameter: address-postalcode

Description: A postalCode specified in an address
Type: string
Path: Patient.address.postalCode

See Also:

• Constant Field Values

ADDRESS_POSTALCODE

public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_POSTALCODE

Fluent Client search parameter constant for address-postalcode

Description: A postalCode specified in an address
Type: string
Path: Patient.address.postalCode

SP_ADDRESS_COUNTRY

public static final String SP_ADDRESS_COUNTRY

Search parameter: address-country

Description: A country specified in an address
Type: string
Path: Patient.address.country

See Also:

• Constant Field Values

ADDRESS_COUNTRY

public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_COUNTRY

Fluent Client search parameter constant for address-country

Description: A country specified in an address
Type: string
Path: Patient.address.country

SP_DEATH_DATE

public static final String SP_DEATH_DATE

Search parameter: death-date

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

See Also:

• Constant Field Values

DEATH_DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam DEATH_DATE

Fluent Client search parameter constant for death-date

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

SP_PHONETIC

public static final String SP_PHONETIC

Search parameter: phonetic

Description: A portion of either family or given name using some kind of phonetic matching algorithm
Type: string
Path: Patient.name

See Also:

• Constant Field Values

PHONETIC

public static final ca.uhn.fhir.rest.gclient.StringClientParam PHONETIC

Fluent Client search parameter constant for phonetic

Description: A portion of either family or given name using some kind of phonetic matching algorithm
Type: string
Path: Patient.name

SP_PHONE

public static final String SP_PHONE

Search parameter: phone

Description: A value in a phone contact
Type: token
Path: Patient.telecom(system=phone)

See Also:

• Constant Field Values

PHONE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam PHONE

Fluent Client search parameter constant for phone

Description: A value in a phone contact
Type: token
Path: Patient.telecom(system=phone)

SP_ORGANIZATION

public static final String SP_ORGANIZATION

Search parameter: organization

Description: The organization that is the custodian of the patient record
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 that is the custodian of the patient record
Type: reference
Path: Patient.managingOrganization

INCLUDE_ORGANIZATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "Patient:organization".

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
Type: string
Path: Patient.name

See Also:

• Constant Field Values

NAME

public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME

Fluent Client search parameter constant for name

Description: A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
Type: string
Path: Patient.name

SP_ADDRESS_USE

public static final String SP_ADDRESS_USE

Search parameter: address-use

Description: A use code specified in an address
Type: token
Path: Patient.address.use

See Also:

• Constant Field Values

ADDRESS_USE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADDRESS_USE

Fluent Client search parameter constant for address-use

Description: A use code specified in an address
Type: token
Path: Patient.address.use

SP_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_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_ADDRESS_CITY

public static final String SP_ADDRESS_CITY

Search parameter: address-city

Description: A city specified in an address
Type: string
Path: Patient.address.city

See Also:

• Constant Field Values

ADDRESS_CITY

public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS_CITY

Fluent Client search parameter constant for address-city

Description: A city specified in an address
Type: string
Path: Patient.address.city

SP_EMAIL

public static final String SP_EMAIL

Search parameter: email

Description: A value in an email contact
Type: token
Path: Patient.telecom(system=email)

See Also:

• Constant Field Values

EMAIL

public static final ca.uhn.fhir.rest.gclient.TokenClientParam EMAIL

Fluent Client search parameter constant for email

Description: A value in an email contact
Type: token
Path: Patient.telecom(system=email)

Constructor Details

Patient

public Patient()

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (An identifier for this patient.)

setIdentifier

public Patient setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public Patient addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getActiveElement

public BooleanType getActiveElement()

Returns:

active (Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.). 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. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.). 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. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

setActive

public Patient setActive(boolean value)

Parameters:

value - Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

getName

public List<HumanName> getName()

Returns:

name (A name associated with the individual.)

setName

public Patient setName(List<HumanName> theName)

Returns:

Returns a reference to this for easy method chaining

hasName

public boolean hasName()

addName

public HumanName addName()

addName

public Patient addName(HumanName t)

getNameFirstRep

public HumanName getNameFirstRep()

Returns:

The first repetition of repeating field name, creating it if it does not already exist

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

setTelecom

public Patient setTelecom(List<ContactPoint> theTelecom)

Returns:

Returns a reference to this for easy method chaining

hasTelecom

public boolean hasTelecom()

addTelecom

public ContactPoint addTelecom()

addTelecom

public Patient addTelecom(ContactPoint t)

getTelecomFirstRep

public ContactPoint getTelecomFirstRep()

Returns:

The first repetition of repeating field telecom, creating it if it does not already exist

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 (An address for the individual.)

setAddress

public Patient setAddress(List<Address> theAddress)

Returns:

Returns a reference to this for easy method chaining

hasAddress

public boolean hasAddress()

addAddress

public Address addAddress()

addAddress

public Patient addAddress(Address t)

getAddressFirstRep

public Address getAddressFirstRep()

Returns:

The first repetition of repeating field address, creating it if it does not already exist

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 (boolean) 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 (boolean) 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 (boolean) 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 (boolean) or indicates the actual birth order (integer).)

getPhoto

public List<Attachment> getPhoto()

Returns:

photo (Image of the patient.)

setPhoto

public Patient setPhoto(List<Attachment> thePhoto)

Returns:

Returns a reference to this for easy method chaining

hasPhoto

public boolean hasPhoto()

addPhoto

public Attachment addPhoto()

addPhoto

public Patient addPhoto(Attachment t)

getPhotoFirstRep

public Attachment getPhotoFirstRep()

Returns:

The first repetition of repeating field photo, creating it if it does not already exist

getContact

public List<Patient.ContactComponent> getContact()

Returns:

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

setContact

public Patient setContact(List<Patient.ContactComponent> theContact)

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

addContact

public Patient.ContactComponent addContact()

addContact

public Patient addContact(Patient.ContactComponent t)

getContactFirstRep

public Patient.ContactComponent getContactFirstRep()

Returns:

The first repetition of repeating field contact, creating it if it does not already exist

getCommunication

public List<Patient.PatientCommunicationComponent> getCommunication()

Returns:

communication (A language which may be used to communicate with the patient about his or her health.)

setCommunication

public Patient setCommunication(List<Patient.PatientCommunicationComponent> theCommunication)

Returns:

Returns a reference to this for easy method chaining

hasCommunication

public boolean hasCommunication()

addCommunication

public Patient.PatientCommunicationComponent addCommunication()

addCommunication

public Patient addCommunication(Patient.PatientCommunicationComponent t)

getCommunicationFirstRep

public Patient.PatientCommunicationComponent getCommunicationFirstRep()

Returns:

The first repetition of repeating field communication, creating it if it does not already exist

getGeneralPractitioner

public List<Reference> getGeneralPractitioner()

Returns:

generalPractitioner (Patient's nominated care provider.)

setGeneralPractitioner

public Patient setGeneralPractitioner(List<Reference> theGeneralPractitioner)

Returns:

Returns a reference to this for easy method chaining

hasGeneralPractitioner

public boolean hasGeneralPractitioner()

addGeneralPractitioner

public Reference addGeneralPractitioner()

addGeneralPractitioner

public Patient addGeneralPractitioner(Reference t)

getGeneralPractitionerFirstRep

public Reference getGeneralPractitionerFirstRep()

Returns:

The first repetition of repeating field generalPractitioner, creating it if it does not already exist

getGeneralPractitionerTarget

@Deprecated
public List<Resource> getGeneralPractitionerTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

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

setLink

public Patient setLink(List<Patient.PatientLinkComponent> theLink)

Returns:

Returns a reference to this for easy method chaining

hasLink

public boolean hasLink()

addLink

public Patient.PatientLinkComponent addLink()

addLink

public Patient addLink(Patient.PatientLinkComponent t)

getLinkFirstRep

public Patient.PatientLinkComponent getLinkFirstRep()

Returns:

The first repetition of repeating field link, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

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 Base 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 Base 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

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public Patient copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(Patient dst)

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