![](/hapi-fhir/images/logos/raccoon-forwards.png)
Class Person
- 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
static class
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected BooleanType
Whether this person's record is in active use.One or more addresses for the person.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for addressstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-citystatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-countrystatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-postalcodestatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for address-statestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for address-useprotected DateType
The birth date for the person.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for birthdatestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for emailprotected Enumeration
<Enumerations.AdministrativeGender> Administrative Gender.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for genderprotected List
<Identifier> Identifier for a person within a particular scope.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected List
<Person.PersonLinkComponent> Link to a resource that concerns the same actual person.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for linkprotected Reference
The organization that is the custodian of the person record.protected Organization
The actual object that is the target of the reference (The organization that is the custodian of the person record.)A name associated with the person.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for namestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for organizationstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for phonestatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for phoneticprotected Attachment
An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for practitionerstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for relatedpersonstatic final String
Search parameter: addressstatic final String
Search parameter: address-citystatic final String
Search parameter: address-countrystatic final String
Search parameter: address-postalcodestatic final String
Search parameter: address-statestatic final String
Search parameter: address-usestatic final String
Search parameter: birthdatestatic final String
Search parameter: emailstatic final String
Search parameter: genderstatic final String
Search parameter: identifierstatic final String
Search parameter: linkstatic final String
Search parameter: namestatic final String
Search parameter: organizationstatic final String
Search parameter: patientstatic final String
Search parameter: phonestatic final String
Search parameter: phoneticstatic final String
Search parameter: practitionerstatic final String
Search parameter: relatedpersonstatic final String
Search parameter: telecomprotected List
<ContactPoint> A contact detail for the person, e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for telecomFields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddLink()
addName()
copy()
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
boolean
getLink()
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getPhoto()
Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasLink()
boolean
boolean
hasName()
boolean
hasPhoto()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setActive
(boolean value) setActiveElement
(BooleanType value) setAddress
(List<Address> theAddress) setBirthDate
(Date value) setBirthDateElement
(DateType value) setIdentifier
(List<Identifier> theIdentifier) setLink
(List<Person.PersonLinkComponent> theLink) setManagingOrganization
(Reference value) setPhoto
(Attachment value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setTelecom
(List<ContactPoint> theTelecom) protected Person
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
Identifier for a person within a particular scope. -
name
A name associated with the person. -
telecom
A contact detail for the person, e.g. a telephone number or an email address. -
gender
Administrative Gender. -
birthDate
The birth date for the person. -
address
One or more addresses for the person. -
photo
An image that can be displayed as a thumbnail of the person to enhance the identification of the individual. -
managingOrganization
The organization that is the custodian of the person record. -
managingOrganizationTarget
The actual object that is the target of the reference (The organization that is the custodian of the person record.) -
active
Whether this person's record is in active use. -
link
Link to a resource that concerns the same actual person. -
SP_IDENTIFIER
Search parameter: identifierDescription: A person Identifier
Type: token
Path: Person.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: A person Identifier
Type: token
Path: Person.identifier
-
SP_ADDRESS
Search parameter: addressDescription: A server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text
Type: string
Path: Person.address
- See Also:
-
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, state, country, postalCode, and/or text
Type: string
Path: Person.address
-
SP_BIRTHDATE
Search parameter: birthdateDescription: The person's date of birth
Type: date
Path: Person.birthDate
- See Also:
-
BIRTHDATE
Fluent Client search parameter constant for birthdateDescription: The person's date of birth
Type: date
Path: Person.birthDate
-
SP_ADDRESS_STATE
Search parameter: address-stateDescription: A state specified in an address
Type: string
Path: Person.address.state
- See Also:
-
ADDRESS_STATE
Fluent Client search parameter constant for address-stateDescription: A state specified in an address
Type: string
Path: Person.address.state
-
SP_GENDER
Search parameter: genderDescription: The gender of the person
Type: token
Path: Person.gender
- See Also:
-
GENDER
Fluent Client search parameter constant for genderDescription: The gender of the person
Type: token
Path: Person.gender
-
SP_PRACTITIONER
Search parameter: practitionerDescription: The Person links to this Practitioner
Type: reference
Path: Person.link.target
- See Also:
-
PRACTITIONER
Fluent Client search parameter constant for practitionerDescription: The Person links to this Practitioner
Type: reference
Path: Person.link.target
-
INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:practitioner". -
SP_LINK
Search parameter: linkDescription: Any link has this Patient, Person, RelatedPerson or Practitioner reference
Type: reference
Path: Person.link.target
- See Also:
-
LINK
Fluent Client search parameter constant for linkDescription: Any link has this Patient, Person, RelatedPerson or Practitioner reference
Type: reference
Path: Person.link.target
-
INCLUDE_LINK
Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:link". -
SP_RELATEDPERSON
Search parameter: relatedpersonDescription: The Person links to this RelatedPerson
Type: reference
Path: Person.link.target
- See Also:
-
RELATEDPERSON
Fluent Client search parameter constant for relatedpersonDescription: The Person links to this RelatedPerson
Type: reference
Path: Person.link.target
-
INCLUDE_RELATEDPERSON
Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:relatedperson". -
SP_ADDRESS_POSTALCODE
Search parameter: address-postalcodeDescription: A postal code specified in an address
Type: string
Path: Person.address.postalCode
- See Also:
-
ADDRESS_POSTALCODE
Fluent Client search parameter constant for address-postalcodeDescription: A postal code specified in an address
Type: string
Path: Person.address.postalCode
-
SP_ADDRESS_COUNTRY
Search parameter: address-countryDescription: A country specified in an address
Type: string
Path: Person.address.country
- See Also:
-
ADDRESS_COUNTRY
Fluent Client search parameter constant for address-countryDescription: A country specified in an address
Type: string
Path: Person.address.country
-
SP_PHONETIC
Search parameter: phoneticDescription: A portion of name using some kind of phonetic matching algorithm
Type: string
Path: Person.name
- See Also:
-
PHONETIC
Fluent Client search parameter constant for phoneticDescription: A portion of name using some kind of phonetic matching algorithm
Type: string
Path: Person.name
-
SP_PHONE
Search parameter: phoneDescription: A value in a phone contact
Type: token
Path: Person.telecom(system=phone)
- See Also:
-
PHONE
Fluent Client search parameter constant for phoneDescription: A value in a phone contact
Type: token
Path: Person.telecom(system=phone)
-
SP_PATIENT
Search parameter: patientDescription: The Person links to this Patient
Type: reference
Path: Person.link.target
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: The Person links to this Patient
Type: reference
Path: Person.link.target
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:patient". -
SP_ORGANIZATION
Search parameter: organizationDescription: The organization at which this person record is being managed
Type: reference
Path: Person.managingOrganization
- See Also:
-
ORGANIZATION
Fluent Client search parameter constant for organizationDescription: The organization at which this person record is being managed
Type: reference
Path: Person.managingOrganization
-
INCLUDE_ORGANIZATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:organization". -
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: Person.name
- See Also:
-
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: Person.name
-
SP_ADDRESS_USE
Search parameter: address-useDescription: A use code specified in an address
Type: token
Path: Person.address.use
- See Also:
-
ADDRESS_USE
Fluent Client search parameter constant for address-useDescription: A use code specified in an address
Type: token
Path: Person.address.use
-
SP_TELECOM
Search parameter: telecomDescription: The value in any kind of contact
Type: token
Path: Person.telecom
- See Also:
-
TELECOM
Fluent Client search parameter constant for telecomDescription: The value in any kind of contact
Type: token
Path: Person.telecom
-
SP_ADDRESS_CITY
Search parameter: address-cityDescription: A city specified in an address
Type: string
Path: Person.address.city
- See Also:
-
ADDRESS_CITY
Fluent Client search parameter constant for address-cityDescription: A city specified in an address
Type: string
Path: Person.address.city
-
SP_EMAIL
Search parameter: emailDescription: A value in an email contact
Type: token
Path: Person.telecom(system=email)
- See Also:
-
EMAIL
Fluent Client search parameter constant for emailDescription: A value in an email contact
Type: token
Path: Person.telecom(system=email)
-
-
Constructor Details
-
Person
public Person()Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Identifier for a person within a particular scope.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getName
- Returns:
name
(A name associated with the person.)
-
setName
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasName
-
addName
-
addName
-
getNameFirstRep
- Returns:
- The first repetition of repeating field
name
, creating it if it does not already exist
-
getTelecom
- Returns:
telecom
(A contact detail for the person, e.g. a telephone number or an email address.)
-
setTelecom
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTelecom
-
addTelecom
-
addTelecom
-
getTelecomFirstRep
- Returns:
- The first repetition of repeating field
telecom
, creating it if it does not already exist
-
getGenderElement
- Returns:
gender
(Administrative Gender.). This is the underlying object with id, value and extensions. The accessor "getGender" gives direct access to the value
-
hasGenderElement
-
hasGender
-
setGenderElement
- Parameters:
value
-gender
(Administrative Gender.). This is the underlying object with id, value and extensions. The accessor "getGender" gives direct access to the value
-
getGender
- Returns:
- Administrative Gender.
-
setGender
- Parameters:
value
- Administrative Gender.
-
getBirthDateElement
- Returns:
birthDate
(The birth date for the person.). This is the underlying object with id, value and extensions. The accessor "getBirthDate" gives direct access to the value
-
hasBirthDateElement
-
hasBirthDate
-
setBirthDateElement
- Parameters:
value
-birthDate
(The birth date for the person.). This is the underlying object with id, value and extensions. The accessor "getBirthDate" gives direct access to the value
-
getBirthDate
- Returns:
- The birth date for the person.
-
setBirthDate
- Parameters:
value
- The birth date for the person.
-
getAddress
- Returns:
address
(One or more addresses for the person.)
-
setAddress
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAddress
-
addAddress
-
addAddress
-
getAddressFirstRep
- Returns:
- The first repetition of repeating field
address
, creating it if it does not already exist
-
getPhoto
- Returns:
photo
(An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.)
-
hasPhoto
-
setPhoto
- Parameters:
value
-photo
(An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.)
-
getManagingOrganization
- Returns:
managingOrganization
(The organization that is the custodian of the person record.)
-
hasManagingOrganization
-
setManagingOrganization
- Parameters:
value
-managingOrganization
(The organization that is the custodian of the person record.)
-
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. (The organization that is the custodian of the person record.)
-
setManagingOrganizationTarget
- 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. (The organization that is the custodian of the person record.)
-
getActiveElement
- Returns:
active
(Whether this person's 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
-
hasActive
-
setActiveElement
- Parameters:
value
-active
(Whether this person's 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
- Returns:
- Whether this person's record is in active use.
-
setActive
- Parameters:
value
- Whether this person's record is in active use.
-
getLink
- Returns:
link
(Link to a resource that concerns the same actual person.)
-
setLink
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasLink
-
addLink
-
addLink
-
getLinkFirstRep
- Returns:
- The first repetition of repeating field
link
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-