Class Person
- java.lang.Object
-
- org.hl7.fhir.r5.model.Base
-
- org.hl7.fhir.r5.model.BaseResource
-
- org.hl7.fhir.r5.model.Resource
-
- org.hl7.fhir.r5.model.DomainResource
-
- org.hl7.fhir.r5.model.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
public class Person extends DomainResource
Demographics and administrative information about a person independent of a specific health-related context.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPerson.IdentityAssuranceLevelstatic classPerson.IdentityAssuranceLevelEnumFactorystatic classPerson.PersonCommunicationComponentstatic classPerson.PersonLinkComponent
-
Field Summary
Fields Modifier and Type Field Description protected BooleanTypeactiveWhether this person's record is in active use.protected List<Address>addressOne or more addresses for the person.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 birth date for the person.static ca.uhn.fhir.rest.gclient.DateClientParamBIRTHDATEFluent Client search parameter constant for birthdateprotected List<Person.PersonCommunicationComponent>communicationA language which may be used to communicate with the person about his or her health.static ca.uhn.fhir.rest.gclient.DateClientParamDEATH_DATEFluent Client search parameter constant for death-dateprotected DataTypedeceasedIndicates 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.static ca.uhn.fhir.rest.gclient.TokenClientParamGENDERFluent Client search parameter constant for genderstatic ca.uhn.fhir.rest.gclient.StringClientParamGIVENFluent Client search parameter constant for givenprotected List<Identifier>identifierIdentifier for a person within a particular scope.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic 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.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PRACTITIONERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_RELATEDPERSONConstant for fluent queries to be used to add include statements.protected List<Person.PersonLinkComponent>linkLink to a resource that concerns the same actual person.static ca.uhn.fhir.rest.gclient.ReferenceClientParamLINKFluent Client search parameter constant for linkprotected ReferencemanagingOrganizationThe organization that is the custodian of the person record.protected CodeableConceptmaritalStatusThis field contains a person's most recent marital (civil) status.protected List<HumanName>nameA name associated with the person.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.ReferenceClientParamPATIENTFluent Client search parameter constant for patientstatic 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>photoAn image that can be displayed as a thumbnail of the person to enhance the identification of the individual.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPRACTITIONERFluent Client search parameter constant for practitionerstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamRELATEDPERSONFluent Client search parameter constant for relatedpersonstatic 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_GIVENSearch parameter: givenstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_LINKSearch parameter: linkstatic StringSP_NAMESearch parameter: namestatic StringSP_ORGANIZATIONSearch parameter: organizationstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PHONESearch parameter: phonestatic StringSP_PHONETICSearch parameter: phoneticstatic StringSP_PRACTITIONERSearch parameter: practitionerstatic StringSP_RELATEDPERSONSearch parameter: relatedpersonstatic StringSP_TELECOMSearch parameter: telecomprotected List<ContactPoint>telecomA contact detail for the person, e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamTELECOMFluent Client search parameter constant for telecom-
Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Person()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r5.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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Identifier for a person within a particular scope.
-
active
protected BooleanType active
Whether this person's record is in active use.
-
telecom
protected List<ContactPoint> telecom
A contact detail for the person, e.g. a telephone number or an email address.
-
gender
protected Enumeration<Enumerations.AdministrativeGender> gender
Administrative Gender.
-
maritalStatus
protected CodeableConcept maritalStatus
This field contains a person's most recent marital (civil) status.
-
photo
protected List<Attachment> photo
An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.
-
managingOrganization
protected Reference managingOrganization
The organization that is the custodian of the person record.
-
communication
protected List<Person.PersonCommunicationComponent> communication
A language which may be used to communicate with the person about his or her health.
-
link
protected List<Person.PersonLinkComponent> link
Link to a resource that concerns the same actual person.
-
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: (Person.deceased as dateTime)
- 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: (Person.deceased as dateTime)
-
SP_DECEASED
public static final String SP_DECEASED
Search parameter: deceasedDescription: This person has been marked as deceased, or has a death date entered
Type: token
Path: Person.deceased.exists() and Person.deceased != false
- See Also:
- Constant Field Values
-
DECEASED
public static final ca.uhn.fhir.rest.gclient.TokenClientParam DECEASED
Fluent Client search parameter constant for deceasedDescription: This person has been marked as deceased, or has a death date entered
Type: token
Path: Person.deceased.exists() and Person.deceased != false
-
SP_FAMILY
public static final String SP_FAMILY
Search parameter: familyDescription: A portion of the family name of the person
Type: string
Path: Person.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 person
Type: string
Path: Person.name.family
-
SP_GIVEN
public static final String SP_GIVEN
Search parameter: givenDescription: A portion of the given name of the person
Type: string
Path: Person.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 person
Type: string
Path: Person.name.given
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: A person Identifier
Type: token
Path: Person.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 person Identifier
Type: token
Path: Person.identifier
-
SP_LINK
public static final String SP_LINK
Search parameter: linkDescription: Any link has this Patient, Person, RelatedPerson or Practitioner reference
Type: reference
Path: Person.link.target
- See Also:
- Constant Field Values
-
LINK
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
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 "Person:link".
-
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: Person.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: Person.name
-
SP_ORGANIZATION
public static final String SP_ORGANIZATION
Search parameter: organizationDescription: The organization at which this person record is being managed
Type: reference
Path: Person.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 at which this person record is being managed
Type: reference
Path: Person.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 "Person:organization".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: The Person links to this Patient
Type: reference
Path: Person.link.target.where(resolve() is Patient)
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: The Person links to this Patient
Type: reference
Path: Person.link.target.where(resolve() is Patient)
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:patient".
-
SP_PRACTITIONER
public static final String SP_PRACTITIONER
Search parameter: practitionerDescription: The Person links to this Practitioner
Type: reference
Path: Person.link.target.where(resolve() is Practitioner)
- See Also:
- Constant Field Values
-
PRACTITIONER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRACTITIONER
Fluent Client search parameter constant for practitionerDescription: The Person links to this Practitioner
Type: reference
Path: Person.link.target.where(resolve() is Practitioner)
-
INCLUDE_PRACTITIONER
public static final ca.uhn.fhir.model.api.Include INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:practitioner".
-
SP_RELATEDPERSON
public static final String SP_RELATEDPERSON
Search parameter: relatedpersonDescription: The Person links to this RelatedPerson
Type: reference
Path: Person.link.target.where(resolve() is RelatedPerson)
- See Also:
- Constant Field Values
-
RELATEDPERSON
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATEDPERSON
Fluent Client search parameter constant for relatedpersonDescription: The Person links to this RelatedPerson
Type: reference
Path: Person.link.target.where(resolve() is RelatedPerson)
-
INCLUDE_RELATEDPERSON
public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATEDPERSON
Constant for fluent queries to be used to add include statements. Specifies the path value of "Person:relatedperson".
-
SP_ADDRESS_CITY
public static final String SP_ADDRESS_CITY
Search parameter: address-cityDescription: Multiple Resources: [Patient](patient.html): A city specified in an address [Person](person.html): A city specified in an address [Practitioner](practitioner.html): A city specified in an address [RelatedPerson](relatedperson.html): A city specified in an address
Type: string
Path: Patient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.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: Multiple Resources: [Patient](patient.html): A city specified in an address [Person](person.html): A city specified in an address [Practitioner](practitioner.html): A city specified in an address [RelatedPerson](relatedperson.html): A city specified in an address
Type: string
Path: Patient.address.city | Person.address.city | Practitioner.address.city | RelatedPerson.address.city
-
SP_ADDRESS_COUNTRY
public static final String SP_ADDRESS_COUNTRY
Search parameter: address-countryDescription: Multiple Resources: [Patient](patient.html): A country specified in an address [Person](person.html): A country specified in an address [Practitioner](practitioner.html): A country specified in an address [RelatedPerson](relatedperson.html): A country specified in an address
Type: string
Path: Patient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.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: Multiple Resources: [Patient](patient.html): A country specified in an address [Person](person.html): A country specified in an address [Practitioner](practitioner.html): A country specified in an address [RelatedPerson](relatedperson.html): A country specified in an address
Type: string
Path: Patient.address.country | Person.address.country | Practitioner.address.country | RelatedPerson.address.country
-
SP_ADDRESS_POSTALCODE
public static final String SP_ADDRESS_POSTALCODE
Search parameter: address-postalcodeDescription: Multiple Resources: [Patient](patient.html): A postalCode specified in an address [Person](person.html): A postal code specified in an address [Practitioner](practitioner.html): A postalCode specified in an address [RelatedPerson](relatedperson.html): A postal code specified in an address
Type: string
Path: Patient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.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: Multiple Resources: [Patient](patient.html): A postalCode specified in an address [Person](person.html): A postal code specified in an address [Practitioner](practitioner.html): A postalCode specified in an address [RelatedPerson](relatedperson.html): A postal code specified in an address
Type: string
Path: Patient.address.postalCode | Person.address.postalCode | Practitioner.address.postalCode | RelatedPerson.address.postalCode
-
SP_ADDRESS_STATE
public static final String SP_ADDRESS_STATE
Search parameter: address-stateDescription: Multiple Resources: [Patient](patient.html): A state specified in an address [Person](person.html): A state specified in an address [Practitioner](practitioner.html): A state specified in an address [RelatedPerson](relatedperson.html): A state specified in an address
Type: string
Path: Patient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.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: Multiple Resources: [Patient](patient.html): A state specified in an address [Person](person.html): A state specified in an address [Practitioner](practitioner.html): A state specified in an address [RelatedPerson](relatedperson.html): A state specified in an address
Type: string
Path: Patient.address.state | Person.address.state | Practitioner.address.state | RelatedPerson.address.state
-
SP_ADDRESS_USE
public static final String SP_ADDRESS_USE
Search parameter: address-useDescription: Multiple Resources: [Patient](patient.html): A use code specified in an address [Person](person.html): A use code specified in an address [Practitioner](practitioner.html): A use code specified in an address [RelatedPerson](relatedperson.html): A use code specified in an address
Type: token
Path: Patient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.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: Multiple Resources: [Patient](patient.html): A use code specified in an address [Person](person.html): A use code specified in an address [Practitioner](practitioner.html): A use code specified in an address [RelatedPerson](relatedperson.html): A use code specified in an address
Type: token
Path: Patient.address.use | Person.address.use | Practitioner.address.use | RelatedPerson.address.use
-
SP_ADDRESS
public static final String SP_ADDRESS
Search parameter: addressDescription: Multiple Resources: [Patient](patient.html): 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 [Person](person.html): 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 [Practitioner](practitioner.html): 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 [RelatedPerson](relatedperson.html): 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 | Person.address | Practitioner.address | RelatedPerson.address
- See Also:
- Constant Field Values
-
ADDRESS
public static final ca.uhn.fhir.rest.gclient.StringClientParam ADDRESS
Fluent Client search parameter constant for addressDescription: Multiple Resources: [Patient](patient.html): 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 [Person](person.html): 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 [Practitioner](practitioner.html): 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 [RelatedPerson](relatedperson.html): 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 | Person.address | Practitioner.address | RelatedPerson.address
-
SP_BIRTHDATE
public static final String SP_BIRTHDATE
Search parameter: birthdateDescription: Multiple Resources: [Patient](patient.html): The patient's date of birth [Person](person.html): The person's date of birth [RelatedPerson](relatedperson.html): The Related Person's date of birth
Type: date
Path: Patient.birthDate | Person.birthDate | RelatedPerson.birthDate
- See Also:
- Constant Field Values
-
BIRTHDATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam BIRTHDATE
Fluent Client search parameter constant for birthdateDescription: Multiple Resources: [Patient](patient.html): The patient's date of birth [Person](person.html): The person's date of birth [RelatedPerson](relatedperson.html): The Related Person's date of birth
Type: date
Path: Patient.birthDate | Person.birthDate | RelatedPerson.birthDate
-
SP_EMAIL
public static final String SP_EMAIL
Search parameter: emailDescription: Multiple Resources: [Patient](patient.html): A value in an email contact [Person](person.html): A value in an email contact [Practitioner](practitioner.html): A value in an email contact [PractitionerRole](practitionerrole.html): A value in an email contact [RelatedPerson](relatedperson.html): A value in an email contact
Type: token
Path: Patient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.telecom.where(system='email') | RelatedPerson.telecom.where(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: Multiple Resources: [Patient](patient.html): A value in an email contact [Person](person.html): A value in an email contact [Practitioner](practitioner.html): A value in an email contact [PractitionerRole](practitionerrole.html): A value in an email contact [RelatedPerson](relatedperson.html): A value in an email contact
Type: token
Path: Patient.telecom.where(system='email') | Person.telecom.where(system='email') | Practitioner.telecom.where(system='email') | PractitionerRole.telecom.where(system='email') | RelatedPerson.telecom.where(system='email')
-
SP_GENDER
public static final String SP_GENDER
Search parameter: genderDescription: Multiple Resources: [Patient](patient.html): Gender of the patient [Person](person.html): The gender of the person [Practitioner](practitioner.html): Gender of the practitioner [RelatedPerson](relatedperson.html): Gender of the related person
Type: token
Path: Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender
- See Also:
- Constant Field Values
-
GENDER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam GENDER
Fluent Client search parameter constant for genderDescription: Multiple Resources: [Patient](patient.html): Gender of the patient [Person](person.html): The gender of the person [Practitioner](practitioner.html): Gender of the practitioner [RelatedPerson](relatedperson.html): Gender of the related person
Type: token
Path: Patient.gender | Person.gender | Practitioner.gender | RelatedPerson.gender
-
SP_PHONE
public static final String SP_PHONE
Search parameter: phoneDescription: Multiple Resources: [Patient](patient.html): A value in a phone contact [Person](person.html): A value in a phone contact [Practitioner](practitioner.html): A value in a phone contact [PractitionerRole](practitionerrole.html): A value in a phone contact [RelatedPerson](relatedperson.html): A value in a phone contact
Type: token
Path: Patient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.telecom.where(system='phone') | RelatedPerson.telecom.where(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: Multiple Resources: [Patient](patient.html): A value in a phone contact [Person](person.html): A value in a phone contact [Practitioner](practitioner.html): A value in a phone contact [PractitionerRole](practitionerrole.html): A value in a phone contact [RelatedPerson](relatedperson.html): A value in a phone contact
Type: token
Path: Patient.telecom.where(system='phone') | Person.telecom.where(system='phone') | Practitioner.telecom.where(system='phone') | PractitionerRole.telecom.where(system='phone') | RelatedPerson.telecom.where(system='phone')
-
SP_PHONETIC
public static final String SP_PHONETIC
Search parameter: phoneticDescription: Multiple Resources: [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm [Person](person.html): A portion of name using some kind of phonetic matching algorithm [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm
Type: string
Path: Patient.name | Person.name | Practitioner.name | RelatedPerson.name
- See Also:
- Constant Field Values
-
PHONETIC
public static final ca.uhn.fhir.rest.gclient.StringClientParam PHONETIC
Fluent Client search parameter constant for phoneticDescription: Multiple Resources: [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm [Person](person.html): A portion of name using some kind of phonetic matching algorithm [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm
Type: string
Path: Patient.name | Person.name | Practitioner.name | RelatedPerson.name
-
SP_TELECOM
public static final String SP_TELECOM
Search parameter: telecomDescription: Multiple Resources: [Patient](patient.html): The value in any kind of telecom details of the patient [Person](person.html): The value in any kind of contact [Practitioner](practitioner.html): The value in any kind of contact [PractitionerRole](practitionerrole.html): The value in any kind of contact [RelatedPerson](relatedperson.html): The value in any kind of contact
Type: token
Path: Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.telecom | RelatedPerson.telecom
- See Also:
- Constant Field Values
-
TELECOM
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TELECOM
Fluent Client search parameter constant for telecomDescription: Multiple Resources: [Patient](patient.html): The value in any kind of telecom details of the patient [Person](person.html): The value in any kind of contact [Practitioner](practitioner.html): The value in any kind of contact [PractitionerRole](practitionerrole.html): The value in any kind of contact [RelatedPerson](relatedperson.html): The value in any kind of contact
Type: token
Path: Patient.telecom | Person.telecom | Practitioner.telecom | PractitionerRole.telecom | RelatedPerson.telecom
-
-
Constructor Detail
-
Person
public Person()
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifier for a person within a particular scope.)
-
setIdentifier
public Person setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Person addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getActiveElement
public BooleanType 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
public boolean hasActiveElement()
-
hasActive
public boolean hasActive()
-
setActiveElement
public Person setActiveElement(BooleanType value)
- 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
public boolean getActive()
- Returns:
- Whether this person's record is in active use.
-
setActive
public Person setActive(boolean value)
- Parameters:
value- Whether this person's record is in active use.
-
setName
public Person 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 {3}
-
getTelecom
public List<ContactPoint> getTelecom()
- Returns:
telecom(A contact detail for the person, e.g. a telephone number or an email address.)
-
setTelecom
public Person setTelecom(List<ContactPoint> theTelecom)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasTelecom
public boolean hasTelecom()
-
addTelecom
public ContactPoint addTelecom()
-
addTelecom
public Person addTelecom(ContactPoint t)
-
getTelecomFirstRep
public ContactPoint getTelecomFirstRep()
- Returns:
- The first repetition of repeating field
telecom, creating it if it does not already exist {3}
-
getGenderElement
public Enumeration<Enumerations.AdministrativeGender> 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
public boolean hasGenderElement()
-
hasGender
public boolean hasGender()
-
setGenderElement
public Person setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)
- 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
public Enumerations.AdministrativeGender getGender()
- Returns:
- Administrative Gender.
-
setGender
public Person setGender(Enumerations.AdministrativeGender value)
- Parameters:
value- Administrative Gender.
-
getBirthDateElement
public DateType 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
public boolean hasBirthDateElement()
-
hasBirthDate
public boolean hasBirthDate()
-
setBirthDateElement
public Person setBirthDateElement(DateType value)
- 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
public Date getBirthDate()
- Returns:
- The birth date for the person.
-
setBirthDate
public Person setBirthDate(Date value)
- Parameters:
value- The birth date for the person.
-
getDeceased
public DataType 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 Person setDeceased(DataType value)
- Parameters:
value-deceased(Indicates if the individual is deceased or not.)
-
getAddress
public List<Address> getAddress()
- Returns:
address(One or more addresses for the person.)
-
setAddress
public Person setAddress(List<Address> theAddress)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAddress
public boolean hasAddress()
-
addAddress
public Address addAddress()
-
addAddress
public Person addAddress(Address t)
-
getAddressFirstRep
public Address getAddressFirstRep()
- Returns:
- The first repetition of repeating field
address, creating it if it does not already exist {3}
-
getMaritalStatus
public CodeableConcept getMaritalStatus()
- Returns:
maritalStatus(This field contains a person's most recent marital (civil) status.)
-
hasMaritalStatus
public boolean hasMaritalStatus()
-
setMaritalStatus
public Person setMaritalStatus(CodeableConcept value)
- Parameters:
value-maritalStatus(This field contains a person's most recent marital (civil) status.)
-
getPhoto
public List<Attachment> getPhoto()
- Returns:
photo(An image that can be displayed as a thumbnail of the person to enhance the identification of the individual.)
-
setPhoto
public Person setPhoto(List<Attachment> thePhoto)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPhoto
public boolean hasPhoto()
-
addPhoto
public Attachment addPhoto()
-
addPhoto
public Person addPhoto(Attachment t)
-
getPhotoFirstRep
public Attachment getPhotoFirstRep()
- Returns:
- The first repetition of repeating field
photo, creating it if it does not already exist {3}
-
getManagingOrganization
public Reference getManagingOrganization()
- Returns:
managingOrganization(The organization that is the custodian of the person record.)
-
hasManagingOrganization
public boolean hasManagingOrganization()
-
setManagingOrganization
public Person setManagingOrganization(Reference value)
- Parameters:
value-managingOrganization(The organization that is the custodian of the person record.)
-
getCommunication
public List<Person.PersonCommunicationComponent> getCommunication()
- Returns:
communication(A language which may be used to communicate with the person about his or her health.)
-
setCommunication
public Person setCommunication(List<Person.PersonCommunicationComponent> theCommunication)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCommunication
public boolean hasCommunication()
-
addCommunication
public Person.PersonCommunicationComponent addCommunication()
-
addCommunication
public Person addCommunication(Person.PersonCommunicationComponent t)
-
getCommunicationFirstRep
public Person.PersonCommunicationComponent getCommunicationFirstRep()
- Returns:
- The first repetition of repeating field
communication, creating it if it does not already exist {3}
-
getLink
public List<Person.PersonLinkComponent> getLink()
- Returns:
link(Link to a resource that concerns the same actual person.)
-
setLink
public Person setLink(List<Person.PersonLinkComponent> theLink)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasLink
public boolean hasLink()
-
addLink
public Person.PersonLinkComponent addLink()
-
addLink
public Person addLink(Person.PersonLinkComponent t)
-
getLinkFirstRep
public Person.PersonLinkComponent getLinkFirstRep()
- Returns:
- The first repetition of repeating field
link, creating it if it does not already exist {3}
-
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 Person copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Person 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
-
-