Package org.hl7.fhir.dstu2.model
Class Patient
java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.Patient
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
Demographics and other administrative information about an individual or
animal receiving care or other health-related services.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static enum
static class
static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected BooleanType
Whether this patient record is in active use.Addresses for the individual.protected Patient.AnimalComponent
This patient is known to be an animal.protected DateType
The date of birth for the individual.Patient's nominated care provider.The actual objects that are the target of the reference (Patient's nominated care provider.)protected List
<Patient.PatientCommunicationComponent> Languages which may be used to communicate with the patient about his or her health.protected List
<Patient.ContactComponent> A contact party (e.g.protected Type
Indicates if the individual is deceased or not.protected Enumeration
<Enumerations.AdministrativeGender> Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.protected List
<Identifier> An identifier for this patient.protected List
<Patient.PatientLinkComponent> Link to another patient resource that concerns the same actual patient.protected Reference
Organization that is the custodian of the patient record.protected Organization
The actual object that is the target of the reference (Organization that is the custodian of the patient record.)protected CodeableConcept
This field contains a patient's most recent marital (civil) status.protected Type
Indicates whether the patient is part of a multiple or indicates the actual birth order.A name associated with the individual.protected List
<Attachment> Image of the patient.static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
protected List
<ContactPoint> A contact detail (e.g.Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.dstu2.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
-
Method Summary
Modifier and TypeMethodDescriptionaddLink()
addName()
addPhoto()
copy()
boolean
equalsDeep
(Base other) boolean
equalsShallow
(Base other) fhirType()
boolean
getLink()
getName()
getPhoto()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasLink()
boolean
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
hasPhoto()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> childrenList) setActive
(boolean value) setActiveElement
(BooleanType value) setAnimal
(Patient.AnimalComponent value) setBirthDate
(Date value) setBirthDateElement
(DateType value) setDeceased
(Type value) setManagingOrganization
(Reference value) setMaritalStatus
(CodeableConcept value) setMultipleBirth
(Type value) void
setProperty
(String name, Base value) protected Patient
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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
An identifier for this patient. -
active
Whether this patient record is in active use. -
name
A name associated with the individual. -
telecom
A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. -
gender
Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. -
birthDate
The date of birth for the individual. -
deceased
Indicates if the individual is deceased or not. -
address
Addresses for the individual. -
maritalStatus
This field contains a patient's most recent marital (civil) status. -
multipleBirth
Indicates whether the patient is part of a multiple or indicates the actual birth order. -
photo
Image of the patient. -
contact
A contact party (e.g. guardian, partner, friend) for the patient. -
animal
This patient is known to be an animal. -
communication
Languages which may be used to communicate with the patient about his or her health. -
careProvider
Patient's nominated care provider. -
careProviderTarget
The actual objects that are the target of the reference (Patient's nominated care provider.) -
managingOrganization
Organization that is the custodian of the patient record. -
managingOrganizationTarget
The actual object that is the target of the reference (Organization that is the custodian of the patient record.) -
link
Link to another patient resource that concerns the same actual patient. -
SP_BIRTHDATE
- See Also:
-
SP_DECEASED
- See Also:
-
SP_ADDRESSSTATE
- See Also:
-
SP_GENDER
- See Also:
-
SP_ANIMALSPECIES
- See Also:
-
SP_LINK
- See Also:
-
SP_LANGUAGE
- See Also:
-
SP_DEATHDATE
- See Also:
-
SP_ANIMALBREED
- See Also:
-
SP_ADDRESSCOUNTRY
- See Also:
-
SP_PHONETIC
- See Also:
-
SP_TELECOM
- See Also:
-
SP_ADDRESSCITY
- See Also:
-
SP_EMAIL
- See Also:
-
SP_IDENTIFIER
- See Also:
-
SP_GIVEN
- See Also:
-
SP_ADDRESS
- See Also:
-
SP_ACTIVE
- See Also:
-
SP_ADDRESSPOSTALCODE
- See Also:
-
SP_CAREPROVIDER
- See Also:
-
SP_PHONE
- See Also:
-
SP_ORGANIZATION
- See Also:
-
SP_NAME
- See Also:
-
SP_ADDRESSUSE
- See Also:
-
SP_FAMILY
- See Also:
-
-
Constructor Details
-
Patient
public Patient()
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(An identifier for this patient.)
-
hasIdentifier
-
addIdentifier
- Returns:
identifier
(An identifier for this patient.)
-
addIdentifier
-
getActiveElement
- Returns:
active
(Whether this patient 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 patient 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 patient record is in active use.
-
setActive
- Parameters:
value
- Whether this patient record is in active use.
-
getName
- Returns:
name
(A name associated with the individual.)
-
hasName
-
addName
- Returns:
name
(A name associated with the individual.)
-
addName
-
getTelecom
- Returns:
telecom
(A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.)
-
hasTelecom
-
addTelecom
- Returns:
telecom
(A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.)
-
addTelecom
-
getGenderElement
- Returns:
gender
(Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.). This is the underlying object with id, value and extensions. The accessor "getGender" gives direct access to the value
-
hasGenderElement
-
hasGender
-
setGenderElement
- Parameters:
value
-gender
(Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.). This is the underlying object with id, value and extensions. The accessor "getGender" gives direct access to the value
-
getGender
- Returns:
- Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
-
setGender
- Parameters:
value
- Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
-
getBirthDateElement
- Returns:
birthDate
(The date of birth for the individual.). This is the underlying object with id, value and extensions. The accessor "getBirthDate" gives direct access to the value
-
hasBirthDateElement
-
hasBirthDate
-
setBirthDateElement
- Parameters:
value
-birthDate
(The date of birth for the individual.). This is the underlying object with id, value and extensions. The accessor "getBirthDate" gives direct access to the value
-
getBirthDate
- Returns:
- The date of birth for the individual.
-
setBirthDate
- Parameters:
value
- The date of birth for the individual.
-
getDeceased
- Returns:
deceased
(Indicates if the individual is deceased or not.)
-
getDeceasedBooleanType
- Returns:
deceased
(Indicates if the individual is deceased or not.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDeceasedBooleanType
-
getDeceasedDateTimeType
- Returns:
deceased
(Indicates if the individual is deceased or not.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDeceasedDateTimeType
-
hasDeceased
-
setDeceased
- Parameters:
value
-deceased
(Indicates if the individual is deceased or not.)
-
getAddress
- Returns:
address
(Addresses for the individual.)
-
hasAddress
-
addAddress
- Returns:
address
(Addresses for the individual.)
-
addAddress
-
getMaritalStatus
- Returns:
maritalStatus
(This field contains a patient's most recent marital (civil) status.)
-
hasMaritalStatus
-
setMaritalStatus
- Parameters:
value
-maritalStatus
(This field contains a patient's most recent marital (civil) status.)
-
getMultipleBirth
- Returns:
multipleBirth
(Indicates whether the patient is part of a multiple or indicates the actual birth order.)
-
getMultipleBirthBooleanType
- Returns:
multipleBirth
(Indicates whether the patient is part of a multiple or indicates the actual birth order.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasMultipleBirthBooleanType
-
getMultipleBirthIntegerType
- Returns:
multipleBirth
(Indicates whether the patient is part of a multiple or indicates the actual birth order.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasMultipleBirthIntegerType
-
hasMultipleBirth
-
setMultipleBirth
- Parameters:
value
-multipleBirth
(Indicates whether the patient is part of a multiple or indicates the actual birth order.)
-
getPhoto
- Returns:
photo
(Image of the patient.)
-
hasPhoto
-
addPhoto
- Returns:
photo
(Image of the patient.)
-
addPhoto
-
getContact
- Returns:
contact
(A contact party (e.g. guardian, partner, friend) for the patient.)
-
hasContact
-
addContact
- Returns:
contact
(A contact party (e.g. guardian, partner, friend) for the patient.)
-
addContact
-
getAnimal
- Returns:
animal
(This patient is known to be an animal.)
-
hasAnimal
-
setAnimal
- Parameters:
value
-animal
(This patient is known to be an animal.)
-
getCommunication
- Returns:
communication
(Languages which may be used to communicate with the patient about his or her health.)
-
hasCommunication
-
addCommunication
- Returns:
communication
(Languages which may be used to communicate with the patient about his or her health.)
-
addCommunication
-
getCareProvider
- Returns:
careProvider
(Patient's nominated care provider.)
-
hasCareProvider
-
addCareProvider
- Returns:
careProvider
(Patient's nominated care provider.)
-
addCareProvider
-
getCareProviderTarget
- Returns:
careProvider
(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Patient's nominated care provider.)
-
getManagingOrganization
- Returns:
managingOrganization
(Organization that is the custodian of the patient record.)
-
hasManagingOrganization
-
setManagingOrganization
- Parameters:
value
-managingOrganization
(Organization that is the custodian of the patient 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. (Organization that is the custodian of the patient 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. (Organization that is the custodian of the patient record.)
-
getLink
- Returns:
link
(Link to another patient resource that concerns the same actual patient.)
-
hasLink
-
addLink
- Returns:
link
(Link to another patient resource that concerns the same actual patient.)
-
addLink
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
setProperty
- Overrides:
setProperty
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
-