public class Patient extends BaseResource implements IResource
Definition: Demographics and other administrative information about a person or animal receiving care or other health-related services
Requirements: Tracking patient is the center of the healthcare process
Profile Definition: http://hl7.org/fhir/profiles/Patient
| Modifier and Type | Class and Description |
|---|---|
static class |
Patient.Animal
Block class for child element: Patient.animal (If this patient is an animal (non-human))
|
static class |
Patient.Contact
Block class for child element: Patient.contact (A contact party (e.g.
|
static class |
Patient.Link
Block class for child element: Patient.link (Link to another patient resource that concerns the same actual person)
|
| Modifier and Type | Field and Description |
|---|---|
static TokenClientParam |
ACTIVE
Fluent Client search parameter constant for active
|
static StringClientParam |
ADDRESS
Fluent Client search parameter constant for address
|
static TokenClientParam |
ANIMAL_BREED
Fluent Client search parameter constant for animal-breed
|
static TokenClientParam |
ANIMAL_SPECIES
Fluent Client search parameter constant for animal-species
|
static DateClientParam |
BIRTHDATE
Fluent Client search parameter constant for birthdate
|
static StringClientParam |
FAMILY
Fluent Client search parameter constant for family
|
static TokenClientParam |
GENDER
Fluent Client search parameter constant for gender
|
static StringClientParam |
GIVEN
Fluent Client search parameter constant for given
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_LINK_OTHER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_MANAGINGORGANIZATION
Constant for fluent queries to be used to add include statements.
|
static TokenClientParam |
LANGUAGE
Fluent Client search parameter constant for language
|
static ReferenceClientParam |
LINK
Fluent Client search parameter constant for link
|
static StringClientParam |
NAME
Fluent Client search parameter constant for name
|
static StringClientParam |
PHONETIC
Fluent Client search parameter constant for phonetic
|
static ReferenceClientParam |
PROVIDER
Fluent Client search parameter constant for provider
|
static String |
SP_ACTIVE
Search parameter constant for active
|
static String |
SP_ADDRESS
Search parameter constant for address
|
static String |
SP_ANIMAL_BREED
Search parameter constant for animal-breed
|
static String |
SP_ANIMAL_SPECIES
Search parameter constant for animal-species
|
static String |
SP_BIRTHDATE
Search parameter constant for birthdate
|
static String |
SP_FAMILY
Search parameter constant for family
|
static String |
SP_GENDER
Search parameter constant for gender
|
static String |
SP_GIVEN
Search parameter constant for given
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_LANGUAGE
Search parameter constant for language
|
static String |
SP_LINK
Search parameter constant for link
|
static String |
SP_NAME
Search parameter constant for name
|
static String |
SP_PHONETIC
Search parameter constant for phonetic
|
static String |
SP_PROVIDER
Search parameter constant for provider
|
static String |
SP_TELECOM
Search parameter constant for telecom
|
static StringClientParam |
TELECOM
Fluent Client search parameter constant for telecom
|
SP_RES_ID, SP_RES_LANGUAGE| Constructor and Description |
|---|
Patient() |
| Modifier and Type | Method and Description |
|---|---|
AddressDt |
addAddress()
Adds and returns a new value for address (Addresses for the individual)
|
ResourceReferenceDt |
addCareProvider()
Adds and returns a new value for careProvider (Patient's nominated care provider)
|
CodeableConceptDt |
addCommunication()
Adds and returns a new value for communication (Languages which may be used to communicate with the patient about his or her health)
|
Patient.Contact |
addContact()
Adds and returns a new value for contact (A contact party (e.g.
|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (An identifier for the person as this patient)
|
Patient |
addIdentifier(IdentifierUseEnum theUse,
String theSystem,
String theValue,
String theLabel)
Adds a new value for identifier (An identifier for the person as this patient)
|
Patient |
addIdentifier(String theSystem,
String theValue)
Adds a new value for identifier (An identifier for the person as this patient)
|
Patient.Link |
addLink()
Adds and returns a new value for link (Link to another patient resource that concerns the same actual person)
|
HumanNameDt |
addName()
Adds and returns a new value for name (A name associated with the patient)
|
AttachmentDt |
addPhoto()
Adds and returns a new value for photo (Image of the person)
|
ContactDt |
addTelecom()
Adds and returns a new value for telecom (A contact detail for the individual)
|
Patient |
addTelecom(ContactUseEnum theContactUse,
String theValue)
Adds a new value for telecom (A contact detail for the individual)
|
Patient |
addTelecom(String theValue)
Adds a new value for telecom (A contact detail for the individual)
|
BooleanDt |
getActive()
Gets the value(s) for active (Whether this patient's record is in active use).
|
List<AddressDt> |
getAddress()
Gets the value(s) for address (Addresses for the individual).
|
AddressDt |
getAddressFirstRep()
Gets the first repetition for address (Addresses for the individual),
creating it if it does not already exist.
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType)
Returns a list containing all child elements matching a given type
|
Patient.Animal |
getAnimal()
Gets the value(s) for animal (If this patient is an animal (non-human)).
|
DateTimeDt |
getBirthDate()
Gets the value(s) for birthDate (The date and time of birth for the individual).
|
List<ResourceReferenceDt> |
getCareProvider()
Gets the value(s) for careProvider (Patient's nominated care provider).
|
List<CodeableConceptDt> |
getCommunication()
Gets the value(s) for communication (Languages which may be used to communicate with the patient about his or her health).
|
CodeableConceptDt |
getCommunicationFirstRep()
Gets the first repetition for communication (Languages which may be used to communicate with the patient about his or her health),
creating it if it does not already exist.
|
List<Patient.Contact> |
getContact()
Gets the value(s) for contact (A contact party (e.g.
|
Patient.Contact |
getContactFirstRep()
Gets the first repetition for contact (A contact party (e.g.
|
IDatatype |
getDeceased()
Gets the value(s) for deceased[x] (Indicates if the individual is deceased or not).
|
BoundCodeableConceptDt<AdministrativeGenderCodesEnum> |
getGender()
Gets the value(s) for gender (Gender for administrative purposes).
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (An identifier for the person as this patient).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (An identifier for the person as this patient),
creating it if it does not already exist.
|
List<Patient.Link> |
getLink()
Gets the value(s) for link (Link to another patient resource that concerns the same actual person).
|
Patient.Link |
getLinkFirstRep()
Gets the first repetition for link (Link to another patient resource that concerns the same actual person),
creating it if it does not already exist.
|
ResourceReferenceDt |
getManagingOrganization()
Gets the value(s) for managingOrganization (Organization that is the custodian of the patient record).
|
BoundCodeableConceptDt<MaritalStatusCodesEnum> |
getMaritalStatus()
Gets the value(s) for maritalStatus (Marital (civil) status of a person).
|
IDatatype |
getMultipleBirth()
Gets the value(s) for multipleBirth[x] (Whether patient is part of a multiple birth).
|
List<HumanNameDt> |
getName()
Gets the value(s) for name (A name associated with the patient).
|
HumanNameDt |
getNameFirstRep()
Gets the first repetition for name (A name associated with the patient),
creating it if it does not already exist.
|
List<AttachmentDt> |
getPhoto()
Gets the value(s) for photo (Image of the person).
|
AttachmentDt |
getPhotoFirstRep()
Gets the first repetition for photo (Image of the person),
creating it if it does not already exist.
|
List<ContactDt> |
getTelecom()
Gets the value(s) for telecom (A contact detail for the individual).
|
ContactDt |
getTelecomFirstRep()
Gets the first repetition for telecom (A contact detail for the individual),
creating it if it does not already exist.
|
boolean |
isEmpty() |
Patient |
setActive(boolean theBoolean)
Sets the value for active (Whether this patient's record is in active use)
|
Patient |
setActive(BooleanDt theValue)
Sets the value(s) for active (Whether this patient's record is in active use)
|
Patient |
setAddress(List<AddressDt> theValue)
Sets the value(s) for address (Addresses for the individual)
|
Patient |
setAnimal(Patient.Animal theValue)
Sets the value(s) for animal (If this patient is an animal (non-human))
|
Patient |
setBirthDate(Date theDate,
TemporalPrecisionEnum thePrecision)
Sets the value for birthDate (The date and time of birth for the individual)
|
Patient |
setBirthDate(DateTimeDt theValue)
Sets the value(s) for birthDate (The date and time of birth for the individual)
|
Patient |
setBirthDateWithSecondsPrecision(Date theDate)
Sets the value for birthDate (The date and time of birth for the individual)
|
Patient |
setCareProvider(List<ResourceReferenceDt> theValue)
Sets the value(s) for careProvider (Patient's nominated care provider)
|
Patient |
setCommunication(List<CodeableConceptDt> theValue)
Sets the value(s) for communication (Languages which may be used to communicate with the patient about his or her health)
|
Patient |
setContact(List<Patient.Contact> theValue)
Sets the value(s) for contact (A contact party (e.g.
|
Patient |
setDeceased(IDatatype theValue)
Sets the value(s) for deceased[x] (Indicates if the individual is deceased or not)
|
Patient |
setGender(AdministrativeGenderCodesEnum theValue)
Sets the value(s) for gender (Gender for administrative purposes)
|
Patient |
setGender(BoundCodeableConceptDt<AdministrativeGenderCodesEnum> theValue)
Sets the value(s) for gender (Gender for administrative purposes)
|
Patient |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (An identifier for the person as this patient)
|
Patient |
setLink(List<Patient.Link> theValue)
Sets the value(s) for link (Link to another patient resource that concerns the same actual person)
|
Patient |
setManagingOrganization(ResourceReferenceDt theValue)
Sets the value(s) for managingOrganization (Organization that is the custodian of the patient record)
|
Patient |
setMaritalStatus(BoundCodeableConceptDt<MaritalStatusCodesEnum> theValue)
Sets the value(s) for maritalStatus (Marital (civil) status of a person)
|
Patient |
setMaritalStatus(MaritalStatusCodesEnum theValue)
Sets the value(s) for maritalStatus (Marital (civil) status of a person)
|
Patient |
setMultipleBirth(IDatatype theValue)
Sets the value(s) for multipleBirth[x] (Whether patient is part of a multiple birth)
|
Patient |
setName(List<HumanNameDt> theValue)
Sets the value(s) for name (A name associated with the patient)
|
Patient |
setPhoto(List<AttachmentDt> theValue)
Sets the value(s) for photo (Image of the person)
|
Patient |
setTelecom(List<ContactDt> theValue)
Sets the value(s) for telecom (A contact detail for the individual)
|
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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, setResourceMetadatapublic static final String SP_IDENTIFIER
Description: A patient identifier
Type: token
Path: Patient.identifier
public static final TokenClientParam IDENTIFIER
Description: A patient identifier
Type: token
Path: Patient.identifier
public static final String SP_NAME
Description: A portion of either family or given name of the patient
Type: string
Path: Patient.name
public static final StringClientParam NAME
Description: A portion of either family or given name of the patient
Type: string
Path: Patient.name
public static final String SP_FAMILY
Description: A portion of the family name of the patient
Type: string
Path: Patient.name.family
public static final StringClientParam FAMILY
Description: A portion of the family name of the patient
Type: string
Path: Patient.name.family
public static final String SP_GIVEN
Description: A portion of the given name of the patient
Type: string
Path: Patient.name.given
public static final StringClientParam GIVEN
Description: A portion of the given name of the patient
Type: string
Path: Patient.name.given
public static final String SP_PHONETIC
Description: A portion of either family or given name using some kind of phonetic matching algorithm
Type: string
Path:
public static final StringClientParam PHONETIC
Description: A portion of either family or given name using some kind of phonetic matching algorithm
Type: string
Path:
public static final String SP_TELECOM
Description: The value in any kind of telecom details of the patient
Type: string
Path: Patient.telecom
public static final StringClientParam TELECOM
Description: The value in any kind of telecom details of the patient
Type: string
Path: Patient.telecom
public static final String SP_ADDRESS
Description: An address in any kind of address/part of the patient
Type: string
Path: Patient.address
public static final StringClientParam ADDRESS
Description: An address in any kind of address/part of the patient
Type: string
Path: Patient.address
public static final String SP_GENDER
Description: Gender of the patient
Type: token
Path: Patient.gender
public static final TokenClientParam GENDER
Description: Gender of the patient
Type: token
Path: Patient.gender
public static final String SP_LANGUAGE
Description: Language code (irrespective of use value)
Type: token
Path: Patient.communication
public static final TokenClientParam LANGUAGE
Description: Language code (irrespective of use value)
Type: token
Path: Patient.communication
public static final String SP_BIRTHDATE
Description: The patient's date of birth
Type: date
Path: Patient.birthDate
public static final DateClientParam BIRTHDATE
Description: The patient's date of birth
Type: date
Path: Patient.birthDate
public static final String SP_PROVIDER
Description: The organization at which this person is a patient
Type: reference
Path: Patient.managingOrganization
public static final ReferenceClientParam PROVIDER
Description: The organization at which this person is a patient
Type: reference
Path: Patient.managingOrganization
public static final Include INCLUDE_MANAGINGORGANIZATION
public static final String SP_ACTIVE
Description: Whether the patient record is active
Type: token
Path: Patient.active
public static final TokenClientParam ACTIVE
Description: Whether the patient record is active
Type: token
Path: Patient.active
public static final String SP_ANIMAL_SPECIES
Description: The species for animal patients
Type: token
Path: Patient.animal.species
public static final TokenClientParam ANIMAL_SPECIES
Description: The species for animal patients
Type: token
Path: Patient.animal.species
public static final String SP_ANIMAL_BREED
Description: The breed for animal patients
Type: token
Path: Patient.animal.breed
public static final TokenClientParam ANIMAL_BREED
Description: The breed for animal patients
Type: token
Path: Patient.animal.breed
public static final String SP_LINK
Description: All patients linked to the given patient
Type: reference
Path: Patient.link.other
public static final ReferenceClientParam LINK
Description: All patients linked to the given patient
Type: reference
Path: Patient.link.other
public static final Include INCLUDE_LINK_OTHER
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
ICompositeElementgetAllPopulatedChildElementsOfType in interface ICompositeElementtheType - The type to match. If set to null, all child elements will be returnedpublic List<IdentifierDt> getIdentifier()
null.
Definition: An identifier that applies to this person as a patient
public Patient setIdentifier(List<IdentifierDt> theValue)
Definition: An identifier that applies to this person as a patient
public IdentifierDt addIdentifier()
Definition: An identifier that applies to this person as a patient
public IdentifierDt getIdentifierFirstRep()
Definition: An identifier that applies to this person as a patient
public Patient addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)
Definition: An identifier that applies to this person as a patient
public Patient addIdentifier(String theSystem, String theValue)
Definition: An identifier that applies to this person as a patient
public List<HumanNameDt> getName()
null.
Definition: A name associated with the individual.
public Patient setName(List<HumanNameDt> theValue)
Definition: A name associated with the individual.
public HumanNameDt addName()
Definition: A name associated with the individual.
public HumanNameDt getNameFirstRep()
Definition: A name associated with the individual.
public List<ContactDt> getTelecom()
null.
Definition: A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
public Patient setTelecom(List<ContactDt> theValue)
Definition: A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
public ContactDt addTelecom()
Definition: A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
public ContactDt getTelecomFirstRep()
Definition: A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
public Patient addTelecom(ContactUseEnum theContactUse, String theValue)
Definition: A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
public Patient addTelecom(String theValue)
Definition: A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
public BoundCodeableConceptDt<AdministrativeGenderCodesEnum> getGender()
null.
Definition: Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
public Patient setGender(BoundCodeableConceptDt<AdministrativeGenderCodesEnum> theValue)
Definition: Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
public Patient setGender(AdministrativeGenderCodesEnum theValue)
Definition: Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
public DateTimeDt getBirthDate()
null.
Definition: The date and time of birth for the individual
public Patient setBirthDate(DateTimeDt theValue)
Definition: The date and time of birth for the individual
public Patient setBirthDateWithSecondsPrecision(Date theDate)
Definition: The date and time of birth for the individual
public Patient setBirthDate(Date theDate, TemporalPrecisionEnum thePrecision)
Definition: The date and time of birth for the individual
public IDatatype getDeceased()
null.
Definition: Indicates if the individual is deceased or not
public Patient setDeceased(IDatatype theValue)
Definition: Indicates if the individual is deceased or not
public List<AddressDt> getAddress()
null.
Definition: Addresses for the individual
public Patient setAddress(List<AddressDt> theValue)
Definition: Addresses for the individual
public AddressDt addAddress()
Definition: Addresses for the individual
public AddressDt getAddressFirstRep()
Definition: Addresses for the individual
public BoundCodeableConceptDt<MaritalStatusCodesEnum> getMaritalStatus()
null.
Definition: This field contains a patient's most recent marital (civil) status.
public Patient setMaritalStatus(BoundCodeableConceptDt<MaritalStatusCodesEnum> theValue)
Definition: This field contains a patient's most recent marital (civil) status.
public Patient setMaritalStatus(MaritalStatusCodesEnum theValue)
Definition: This field contains a patient's most recent marital (civil) status.
public IDatatype getMultipleBirth()
null.
Definition: Indicates whether the patient is part of a multiple or indicates the actual birth order.
public Patient setMultipleBirth(IDatatype theValue)
Definition: Indicates whether the patient is part of a multiple or indicates the actual birth order.
public List<AttachmentDt> getPhoto()
null.
Definition: Image of the person
public Patient setPhoto(List<AttachmentDt> theValue)
Definition: Image of the person
public AttachmentDt addPhoto()
Definition: Image of the person
public AttachmentDt getPhotoFirstRep()
Definition: Image of the person
public List<Patient.Contact> getContact()
null.
Definition: A contact party (e.g. guardian, partner, friend) for the patient
public Patient setContact(List<Patient.Contact> theValue)
Definition: A contact party (e.g. guardian, partner, friend) for the patient
public Patient.Contact addContact()
Definition: A contact party (e.g. guardian, partner, friend) for the patient
public Patient.Contact getContactFirstRep()
Definition: A contact party (e.g. guardian, partner, friend) for the patient
public Patient.Animal getAnimal()
null.
Definition: This element has a value if the patient is an animal
public Patient setAnimal(Patient.Animal theValue)
Definition: This element has a value if the patient is an animal
public List<CodeableConceptDt> getCommunication()
null.
Definition: Languages which may be used to communicate with the patient about his or her health
public Patient setCommunication(List<CodeableConceptDt> theValue)
Definition: Languages which may be used to communicate with the patient about his or her health
public CodeableConceptDt addCommunication()
Definition: Languages which may be used to communicate with the patient about his or her health
public CodeableConceptDt getCommunicationFirstRep()
Definition: Languages which may be used to communicate with the patient about his or her health
public List<ResourceReferenceDt> getCareProvider()
null.
Definition: Patient's nominated care provider
public Patient setCareProvider(List<ResourceReferenceDt> theValue)
Definition: Patient's nominated care provider
public ResourceReferenceDt addCareProvider()
Definition: Patient's nominated care provider
public ResourceReferenceDt getManagingOrganization()
null.
Definition: Organization that is the custodian of the patient record
public Patient setManagingOrganization(ResourceReferenceDt theValue)
Definition: Organization that is the custodian of the patient record
public List<Patient.Link> getLink()
null.
Definition: Link to another patient resource that concerns the same actual person
public Patient setLink(List<Patient.Link> theValue)
Definition: Link to another patient resource that concerns the same actual person
public Patient.Link addLink()
Definition: Link to another patient resource that concerns the same actual person
public Patient.Link getLinkFirstRep()
Definition: Link to another patient resource that concerns the same actual person
public BooleanDt getActive()
null.
Definition: Whether this patient record is in active use
public Patient setActive(BooleanDt theValue)
Definition: Whether this patient record is in active use
public Patient setActive(boolean theBoolean)
Definition: Whether this patient record is in active use
Copyright © 2014 University Health Network. All rights reserved.