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 classPatient.ContactComponentstatic classPatient.LinkTypestatic classPatient.LinkTypeEnumFactorystatic classPatient.PatientCommunicationComponentstatic classPatient.PatientLinkComponent
-
Field Summary
Fields Modifier and Type Field Description protected BooleanTypeactiveWhether this patient record is in active use.static ca.uhn.fhir.rest.gclient.TokenClientParamACTIVEFluent Client search parameter constant for activeprotected List<Address>addressAn address for the individual.static ca.uhn.fhir.rest.gclient.StringClientParamADDRESSFluent Client search parameter constant for addressstatic ca.uhn.fhir.rest.gclient.StringClientParamADDRESS_CITYFluent Client search parameter constant for address-citystatic ca.uhn.fhir.rest.gclient.StringClientParamADDRESS_COUNTRYFluent Client search parameter constant for address-countrystatic ca.uhn.fhir.rest.gclient.StringClientParamADDRESS_POSTALCODEFluent Client search parameter constant for address-postalcodestatic ca.uhn.fhir.rest.gclient.StringClientParamADDRESS_STATEFluent Client search parameter constant for address-statestatic ca.uhn.fhir.rest.gclient.TokenClientParamADDRESS_USEFluent Client search parameter constant for address-useprotected DateTypebirthDateThe date of birth for the individual.static ca.uhn.fhir.rest.gclient.DateClientParamBIRTHDATEFluent Client search parameter constant for birthdateprotected List<Patient.PatientCommunicationComponent>communicationA language which may be used to communicate with the patient about his or her health.protected List<Patient.ContactComponent>contactA contact party (e.g.static ca.uhn.fhir.rest.gclient.DateClientParamDEATH_DATEFluent Client search parameter constant for death-dateprotected TypedeceasedIndicates if the individual is deceased or not.static ca.uhn.fhir.rest.gclient.TokenClientParamDECEASEDFluent Client search parameter constant for deceasedstatic ca.uhn.fhir.rest.gclient.TokenClientParamEMAILFluent Client search parameter constant for emailstatic ca.uhn.fhir.rest.gclient.StringClientParamFAMILYFluent Client search parameter constant for familyprotected Enumeration<Enumerations.AdministrativeGender>genderAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.static ca.uhn.fhir.rest.gclient.TokenClientParamGENDERFluent Client search parameter constant for genderstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamGENERAL_PRACTITIONERFluent Client search parameter constant for general-practitionerprotected List<Reference>generalPractitionerPatient's nominated care provider.protected List<Resource>generalPractitionerTargetThe actual objects that are the target of the reference (Patient's nominated care provider.)static ca.uhn.fhir.rest.gclient.StringClientParamGIVENFluent Client search parameter constant for givenprotected List<Identifier>identifierAn identifier for this patient.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_GENERAL_PRACTITIONERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_LINKConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_ORGANIZATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.TokenClientParamLANGUAGEFluent Client search parameter constant for languageprotected List<Patient.PatientLinkComponent>linkLink to another patient resource that concerns the same actual patient.static ca.uhn.fhir.rest.gclient.ReferenceClientParamLINKFluent Client search parameter constant for linkprotected ReferencemanagingOrganizationOrganization that is the custodian of the patient record.protected OrganizationmanagingOrganizationTargetThe actual object that is the target of the reference (Organization that is the custodian of the patient record.)protected CodeableConceptmaritalStatusThis field contains a patient's most recent marital (civil) status.protected TypemultipleBirthIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).protected List<HumanName>nameA name associated with the individual.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for namestatic ca.uhn.fhir.rest.gclient.ReferenceClientParamORGANIZATIONFluent Client search parameter constant for organizationstatic ca.uhn.fhir.rest.gclient.TokenClientParamPHONEFluent Client search parameter constant for phonestatic ca.uhn.fhir.rest.gclient.StringClientParamPHONETICFluent Client search parameter constant for phoneticprotected List<Attachment>photoImage of the patient.static StringSP_ACTIVESearch parameter: activestatic StringSP_ADDRESSSearch parameter: addressstatic StringSP_ADDRESS_CITYSearch parameter: address-citystatic StringSP_ADDRESS_COUNTRYSearch parameter: address-countrystatic StringSP_ADDRESS_POSTALCODESearch parameter: address-postalcodestatic StringSP_ADDRESS_STATESearch parameter: address-statestatic StringSP_ADDRESS_USESearch parameter: address-usestatic StringSP_BIRTHDATESearch parameter: birthdatestatic StringSP_DEATH_DATESearch parameter: death-datestatic StringSP_DECEASEDSearch parameter: deceasedstatic StringSP_EMAILSearch parameter: emailstatic StringSP_FAMILYSearch parameter: familystatic StringSP_GENDERSearch parameter: genderstatic StringSP_GENERAL_PRACTITIONERSearch parameter: general-practitionerstatic StringSP_GIVENSearch parameter: givenstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_LANGUAGESearch parameter: languagestatic StringSP_LINKSearch parameter: linkstatic StringSP_NAMESearch parameter: namestatic StringSP_ORGANIZATIONSearch parameter: organizationstatic StringSP_PHONESearch parameter: phonestatic StringSP_PHONETICSearch parameter: phoneticstatic StringSP_TELECOMSearch parameter: telecomprotected List<ContactPoint>telecomA contact detail (e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamTELECOMFluent 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
-
-
Constructor Summary
Constructors Constructor Description Patient()Constructor
-
Method Summary
-
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, 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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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
-
-
-
-
Field Detail
-
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.
-
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.
-
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: identifierDescription: 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 identifierDescription: A patient identifier
Type: token
Path: Patient.identifier
-
SP_GIVEN
public static final String SP_GIVEN
Search parameter: givenDescription: 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 givenDescription: 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: addressDescription: 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 addressDescription: 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: birthdateDescription: 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 birthdateDescription: The patient's date of birth
Type: date
Path: Patient.birthDate
-
SP_DECEASED
public static final String SP_DECEASED
Search parameter: deceasedDescription: 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 deceasedDescription: 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-stateDescription: 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-stateDescription: A state specified in an address
Type: string
Path: Patient.address.state
-
SP_GENDER
public static final String SP_GENDER
Search parameter: genderDescription: 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 genderDescription: Gender of the patient
Type: token
Path: Patient.gender
-
SP_GENERAL_PRACTITIONER
public static final String SP_GENERAL_PRACTITIONER
Search parameter: general-practitionerDescription: 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-practitionerDescription: 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: linkDescription: 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 linkDescription: 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: activeDescription: 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 activeDescription: Whether the patient record is active
Type: token
Path: Patient.active
-
SP_LANGUAGE
public static final String SP_LANGUAGE
Search parameter: languageDescription: 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 languageDescription: 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-postalcodeDescription: 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-postalcodeDescription: 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-countryDescription: 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-countryDescription: 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-dateDescription: 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-dateDescription: 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: phoneticDescription: 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 phoneticDescription: 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: phoneDescription: 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 phoneDescription: A value in a phone contact
Type: token
Path: Patient.telecom(system=phone)
-
SP_ORGANIZATION
public static final String SP_ORGANIZATION
Search parameter: organizationDescription: 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 organizationDescription: 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: nameDescription: 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 nameDescription: 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-useDescription: 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-useDescription: A use code specified in an address
Type: token
Path: Patient.address.use
-
SP_TELECOM
public static final String SP_TELECOM
Search parameter: telecomDescription: 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 telecomDescription: 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: familyDescription: 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 familyDescription: 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-cityDescription: 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-cityDescription: A city specified in an address
Type: string
Path: Patient.address.city
-
SP_EMAIL
public static final String SP_EMAIL
Search parameter: emailDescription: 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 emailDescription: A value in an email contact
Type: token
Path: Patient.telecom(system=email)
-
-
Constructor Detail
-
Patient
public Patient()
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(An identifier for this patient.)
-
setIdentifier
public Patient setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor 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.
-
setName
public Patient setName(List<HumanName> theName)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasName
public boolean hasName()
-
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
thisfor 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
thisfor 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
thisfor 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
thisfor 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
thisfor 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
thisfor 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:
managingOrganizationThe 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-managingOrganizationThe 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
thisfor 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:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Patient copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Patient dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-