public class Person extends BaseResource implements IResource
Definition: Demographics and administrative information about a person independent of a specific health-related context.
Requirements: Need to track persons potentially across multiple roles
Profile Definition: http://hl7.org/fhir/profiles/Person
| Modifier and Type | Class and Description |
|---|---|
static class |
Person.Link
Block class for child element: Person.link ()
|
| Modifier and Type | Field and Description |
|---|---|
static StringClientParam |
ADDRESS
Fluent Client search parameter constant for address
|
static StringClientParam |
ADDRESS_CITY
Fluent Client search parameter constant for address-city
|
static StringClientParam |
ADDRESS_COUNTRY
Fluent Client search parameter constant for address-country
|
static StringClientParam |
ADDRESS_POSTALCODE
Fluent Client search parameter constant for address-postalcode
|
static StringClientParam |
ADDRESS_STATE
Fluent Client search parameter constant for address-state
|
static TokenClientParam |
ADDRESS_USE
Fluent Client search parameter constant for address-use
|
static DateClientParam |
BIRTHDATE
Fluent Client search parameter constant for birthdate
|
static TokenClientParam |
EMAIL
Fluent Client search parameter constant for email
|
static TokenClientParam |
GENDER
Fluent Client search parameter constant for gender
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_LINK
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_ORGANIZATION
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PRACTITIONER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_RELATEDPERSON
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
LINK
Fluent Client search parameter constant for link
|
static StringClientParam |
NAME
Fluent Client search parameter constant for name
|
static ReferenceClientParam |
ORGANIZATION
Fluent Client search parameter constant for organization
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static TokenClientParam |
PHONE
Fluent Client search parameter constant for phone
|
static StringClientParam |
PHONETIC
Fluent Client search parameter constant for phonetic
|
static ReferenceClientParam |
PRACTITIONER
Fluent Client search parameter constant for practitioner
|
static ReferenceClientParam |
RELATEDPERSON
Fluent Client search parameter constant for relatedperson
|
static String |
SP_ADDRESS
Search parameter constant for address
|
static String |
SP_ADDRESS_CITY
Search parameter constant for address-city
|
static String |
SP_ADDRESS_COUNTRY
Search parameter constant for address-country
|
static String |
SP_ADDRESS_POSTALCODE
Search parameter constant for address-postalcode
|
static String |
SP_ADDRESS_STATE
Search parameter constant for address-state
|
static String |
SP_ADDRESS_USE
Search parameter constant for address-use
|
static String |
SP_BIRTHDATE
Search parameter constant for birthdate
|
static String |
SP_EMAIL
Search parameter constant for email
|
static String |
SP_GENDER
Search parameter constant for gender
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_LINK
Search parameter constant for link
|
static String |
SP_NAME
Search parameter constant for name
|
static String |
SP_ORGANIZATION
Search parameter constant for organization
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_PHONE
Search parameter constant for phone
|
static String |
SP_PHONETIC
Search parameter constant for phonetic
|
static String |
SP_PRACTITIONER
Search parameter constant for practitioner
|
static String |
SP_RELATEDPERSON
Search parameter constant for relatedperson
|
static String |
SP_TELECOM
Search parameter constant for telecom
|
static TokenClientParam |
TELECOM
Fluent Client search parameter constant for telecom
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
Person() |
| Modifier and Type | Method and Description |
|---|---|
AddressDt |
addAddress()
Adds and returns a new value for address ()
|
Person |
addAddress(AddressDt theValue)
Adds a given new value for address ()
|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (id)
|
Person |
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier (id)
|
Person.Link |
addLink()
Adds and returns a new value for link ()
|
Person |
addLink(Person.Link theValue)
Adds a given new value for link ()
|
HumanNameDt |
addName()
Adds and returns a new value for name ()
|
Person |
addName(HumanNameDt theValue)
Adds a given new value for name ()
|
ContactPointDt |
addTelecom()
Adds and returns a new value for telecom ()
|
Person |
addTelecom(ContactPointDt theValue)
Adds a given new value for telecom ()
|
Boolean |
getActive()
Gets the value(s) for active (status).
|
BooleanDt |
getActiveElement()
Gets the value(s) for active (status).
|
List<AddressDt> |
getAddress()
Gets the value(s) for address ().
|
AddressDt |
getAddressFirstRep()
Gets the first repetition for address (),
creating it if it does not already exist.
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
Date |
getBirthDate()
Gets the value(s) for birthDate ().
|
DateDt |
getBirthDateElement()
Gets the value(s) for birthDate ().
|
String |
getGender()
Gets the value(s) for gender ().
|
BoundCodeDt<AdministrativeGenderEnum> |
getGenderElement()
Gets the value(s) for gender ().
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (id).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (id),
creating it if it does not already exist.
|
List<Person.Link> |
getLink()
Gets the value(s) for link ().
|
Person.Link |
getLinkFirstRep()
Gets the first repetition for link (),
creating it if it does not already exist.
|
ResourceReferenceDt |
getManagingOrganization()
Gets the value(s) for managingOrganization ().
|
List<HumanNameDt> |
getName()
Gets the value(s) for name ().
|
HumanNameDt |
getNameFirstRep()
Gets the first repetition for name (),
creating it if it does not already exist.
|
AttachmentDt |
getPhoto()
Gets the value(s) for photo ().
|
String |
getResourceName() |
FhirVersionEnum |
getStructureFhirVersionEnum() |
List<ContactPointDt> |
getTelecom()
Gets the value(s) for telecom ().
|
ContactPointDt |
getTelecomFirstRep()
Gets the first repetition for telecom (),
creating it if it does not already exist.
|
boolean |
isEmpty() |
Person |
setActive(boolean theBoolean)
Sets the value for active (status)
|
Person |
setActive(BooleanDt theValue)
Sets the value(s) for active (status)
|
Person |
setAddress(List<AddressDt> theValue)
Sets the value(s) for address ()
|
Person |
setBirthDate(DateDt theValue)
Sets the value(s) for birthDate ()
|
Person |
setBirthDate(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for birthDate ()
|
Person |
setBirthDateWithDayPrecision(Date theDate)
Sets the value for birthDate ()
|
Person |
setGender(AdministrativeGenderEnum theValue)
Sets the value(s) for gender ()
|
Person |
setGender(BoundCodeDt<AdministrativeGenderEnum> theValue)
Sets the value(s) for gender ()
|
Person |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (id)
|
Person |
setLink(List<Person.Link> theValue)
Sets the value(s) for link ()
|
Person |
setManagingOrganization(ResourceReferenceDt theValue)
Sets the value(s) for managingOrganization ()
|
Person |
setName(List<HumanNameDt> theValue)
Sets the value(s) for name ()
|
Person |
setPhoto(AttachmentDt theValue)
Sets the value(s) for photo ()
|
Person |
setTelecom(List<ContactPointDt> theValue)
Sets the value(s) for telecom ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_IDENTIFIER
Description: A person Identifier
Type: token
Path: Person.identifier
public static final TokenClientParam IDENTIFIER
Description: A person Identifier
Type: token
Path: Person.identifier
public static final String SP_NAME
Description: A portion of name in any name part
Type: string
Path: Person.name
public static final StringClientParam NAME
Description: A portion of name in any name part
Type: string
Path: Person.name
public static final String SP_PHONETIC
Description: A portion of name using some kind of phonetic matching algorithm
Type: string
Path: Person.name
public static final StringClientParam PHONETIC
Description: A portion of name using some kind of phonetic matching algorithm
Type: string
Path: Person.name
public static final String SP_TELECOM
Description: The value in any kind of contact
Type: token
Path: Person.telecom
public static final TokenClientParam TELECOM
Description: The value in any kind of contact
Type: token
Path: Person.telecom
public static final String SP_PHONE
Description: A value in a phone contact
Type: token
Path: Person.telecom(system=phone)
public static final TokenClientParam PHONE
Description: A value in a phone contact
Type: token
Path: Person.telecom(system=phone)
public static final String SP_EMAIL
Description: A value in an email contact
Type: token
Path: Person.telecom(system=email)
public static final TokenClientParam EMAIL
Description: A value in an email contact
Type: token
Path: Person.telecom(system=email)
public static final String SP_ADDRESS
Description: An address in any kind of address/part
Type: string
Path: Person.address
public static final StringClientParam ADDRESS
Description: An address in any kind of address/part
Type: string
Path: Person.address
public static final String SP_ADDRESS_CITY
Description: A city specified in an address
Type: string
Path: Person.address.city
public static final StringClientParam ADDRESS_CITY
Description: A city specified in an address
Type: string
Path: Person.address.city
public static final String SP_ADDRESS_STATE
Description: A state specified in an address
Type: string
Path: Person.address.state
public static final StringClientParam ADDRESS_STATE
Description: A state specified in an address
Type: string
Path: Person.address.state
public static final String SP_ADDRESS_POSTALCODE
Description: A postal code specified in an address
Type: string
Path: Person.address.postalCode
public static final StringClientParam ADDRESS_POSTALCODE
Description: A postal code specified in an address
Type: string
Path: Person.address.postalCode
public static final String SP_ADDRESS_COUNTRY
Description: A country specified in an address
Type: string
Path: Person.address.country
public static final StringClientParam ADDRESS_COUNTRY
Description: A country specified in an address
Type: string
Path: Person.address.country
public static final String SP_ADDRESS_USE
Description: A use code specified in an address
Type: token
Path: Person.address.use
public static final TokenClientParam ADDRESS_USE
Description: A use code specified in an address
Type: token
Path: Person.address.use
public static final String SP_GENDER
Description: The gender of the person
Type: token
Path: Person.gender
public static final TokenClientParam GENDER
Description: The gender of the person
Type: token
Path: Person.gender
public static final String SP_BIRTHDATE
Description: The person's date of birth
Type: date
Path: Person.birthDate
public static final DateClientParam BIRTHDATE
Description: The person's date of birth
Type: date
Path: Person.birthDate
public static final String SP_ORGANIZATION
Description: The organization at which this person record is being managed
Type: reference
Path: Person.managingOrganization
public static final ReferenceClientParam ORGANIZATION
Description: The organization at which this person record is being managed
Type: reference
Path: Person.managingOrganization
public static final String SP_LINK
Description: Any link has this Patient, Person, RelatedPerson or Practitioner reference
Type: reference
Path: Person.link.target
public static final ReferenceClientParam LINK
Description: Any link has this Patient, Person, RelatedPerson or Practitioner reference
Type: reference
Path: Person.link.target
public static final String SP_PATIENT
Description: The Person links to this Patient
Type: reference
Path: Person.link.target
public static final ReferenceClientParam PATIENT
Description: The Person links to this Patient
Type: reference
Path: Person.link.target
public static final String SP_PRACTITIONER
Description: The Person links to this Practitioner
Type: reference
Path: Person.link.target
public static final ReferenceClientParam PRACTITIONER
Description: The Person links to this Practitioner
Type: reference
Path: Person.link.target
public static final String SP_RELATEDPERSON
Description: The Person links to this RelatedPerson
Type: reference
Path: Person.link.target
public static final ReferenceClientParam RELATEDPERSON
Description: The Person links to this RelatedPerson
Type: reference
Path: Person.link.target
public static final Include INCLUDE_LINK
public static final Include INCLUDE_ORGANIZATION
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_PRACTITIONER
public static final Include INCLUDE_RELATEDPERSON
public Person()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic List<IdentifierDt> getIdentifier()
null.
Definition: Identifier for a person within a particular scope.
public Person setIdentifier(List<IdentifierDt> theValue)
Definition: Identifier for a person within a particular scope.
public IdentifierDt addIdentifier()
Definition: Identifier for a person within a particular scope.
public Person addIdentifier(IdentifierDt theValue)
Definition: Identifier for a person within a particular scope.
theValue - The identifier to add (must not be null)public IdentifierDt getIdentifierFirstRep()
Definition: Identifier for a person within a particular scope.
public List<HumanNameDt> getName()
null.
Definition: A name associated with the person
public Person setName(List<HumanNameDt> theValue)
Definition: A name associated with the person
public HumanNameDt addName()
Definition: A name associated with the person
public Person addName(HumanNameDt theValue)
Definition: A name associated with the person
theValue - The name to add (must not be null)public HumanNameDt getNameFirstRep()
Definition: A name associated with the person
public List<ContactPointDt> getTelecom()
null.
Definition: A contact detail for the person, e.g. a telephone number or an email address.
public Person setTelecom(List<ContactPointDt> theValue)
Definition: A contact detail for the person, e.g. a telephone number or an email address.
public ContactPointDt addTelecom()
Definition: A contact detail for the person, e.g. a telephone number or an email address.
public Person addTelecom(ContactPointDt theValue)
Definition: A contact detail for the person, e.g. a telephone number or an email address.
theValue - The telecom to add (must not be null)public ContactPointDt getTelecomFirstRep()
Definition: A contact detail for the person, e.g. a telephone number or an email address.
public BoundCodeDt<AdministrativeGenderEnum> getGenderElement()
null.
Definition: Administrative Gender
public String getGender()
null.
Definition: Administrative Gender
public Person setGender(BoundCodeDt<AdministrativeGenderEnum> theValue)
Definition: Administrative Gender
public Person setGender(AdministrativeGenderEnum theValue)
Definition: Administrative Gender
public DateDt getBirthDateElement()
null.
Definition: The birth date for the person.
public Date getBirthDate()
null.
Definition: The birth date for the person.
public Person setBirthDate(DateDt theValue)
Definition: The birth date for the person.
public Person setBirthDate(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The birth date for the person.
public Person setBirthDateWithDayPrecision(Date theDate)
Definition: The birth date for the person.
public List<AddressDt> getAddress()
null.
Definition: One or more addresses for the person
public Person setAddress(List<AddressDt> theValue)
Definition: One or more addresses for the person
public AddressDt addAddress()
Definition: One or more addresses for the person
public Person addAddress(AddressDt theValue)
Definition: One or more addresses for the person
theValue - The address to add (must not be null)public AddressDt getAddressFirstRep()
Definition: One or more addresses for the person
public AttachmentDt getPhoto()
null.
Definition: An image that can be displayed as a thumbnail of the person to enhance the identification of the individual
public Person setPhoto(AttachmentDt theValue)
Definition: An image that can be displayed as a thumbnail of the person to enhance the identification of the individual
public ResourceReferenceDt getManagingOrganization()
null.
Definition: The organization that is the custodian of the person record
public Person setManagingOrganization(ResourceReferenceDt theValue)
Definition: The organization that is the custodian of the person record
public BooleanDt getActiveElement()
null.
Definition: Whether this person's record is in active use
public Boolean getActive()
null.
Definition: Whether this person's record is in active use
public Person setActive(BooleanDt theValue)
Definition: Whether this person's record is in active use
public Person setActive(boolean theBoolean)
Definition: Whether this person's record is in active use
public List<Person.Link> getLink()
null.
Definition:
public Person setLink(List<Person.Link> theValue)
Definition:
public Person.Link addLink()
Definition:
public Person addLink(Person.Link theValue)
Definition:
theValue - The link to add (must not be null)public Person.Link getLinkFirstRep()
Definition:
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.