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
public class Patient extends DomainResource
Demographics and other administrative information about an individual or animal receiving care or other health-related services.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPatient.AnimalComponentstatic classPatient.ContactComponentstatic classPatient.LinkTypestatic classPatient.LinkTypeEnumFactorystatic classPatient.PatientCommunicationComponentstatic classPatient.PatientLinkComponent
-
Field Summary
Fields Modifier and Type Field Description protected BooleanTypeactiveWhether this patient record is in active use.protected List<Address>addressAddresses for the individual.protected Patient.AnimalComponentanimalThis patient is known to be an animal.protected DateTypebirthDateThe date of birth for the individual.protected List<Reference>careProviderPatient's nominated care provider.protected List<Resource>careProviderTargetThe actual objects that are the target of the reference (Patient's nominated care provider.)protected List<Patient.PatientCommunicationComponent>communicationLanguages which may be used to communicate with the patient about his or her health.protected List<Patient.ContactComponent>contactA contact party (e.g.protected TypedeceasedIndicates if the individual is deceased or not.protected Enumeration<Enumerations.AdministrativeGender>genderAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.protected List<Identifier>identifierAn identifier for this patient.protected List<Patient.PatientLinkComponent>linkLink to another patient resource that concerns the same actual patient.protected ReferencemanagingOrganizationOrganization that is the custodian of the patient record.protected OrganizationmanagingOrganizationTargetThe actual object that is the target of the reference (Organization that is the custodian of the patient record.)protected CodeableConceptmaritalStatusThis field contains a patient's most recent marital (civil) status.protected TypemultipleBirthIndicates whether the patient is part of a multiple or indicates the actual birth order.protected List<HumanName>nameA name associated with the individual.protected List<Attachment>photoImage of the patient.static StringSP_ACTIVEstatic StringSP_ADDRESSstatic StringSP_ADDRESSCITYstatic StringSP_ADDRESSCOUNTRYstatic StringSP_ADDRESSPOSTALCODEstatic StringSP_ADDRESSSTATEstatic StringSP_ADDRESSUSEstatic StringSP_ANIMALBREEDstatic StringSP_ANIMALSPECIESstatic StringSP_BIRTHDATEstatic StringSP_CAREPROVIDERstatic StringSP_DEATHDATEstatic StringSP_DECEASEDstatic StringSP_EMAILstatic StringSP_FAMILYstatic StringSP_GENDERstatic StringSP_GIVENstatic StringSP_IDENTIFIERstatic StringSP_LANGUAGEstatic StringSP_LINKstatic StringSP_NAMEstatic StringSP_ORGANIZATIONstatic StringSP_PHONEstatic StringSP_PHONETICstatic StringSP_TELECOMprotected List<ContactPoint>telecomA 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
-
-
Constructor Summary
Constructors Constructor Description Patient()
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
An identifier for this patient.
-
active
protected BooleanType active
Whether this patient record is in active use.
-
telecom
protected List<ContactPoint> telecom
A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
-
gender
protected Enumeration<Enumerations.AdministrativeGender> gender
Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
-
maritalStatus
protected CodeableConcept maritalStatus
This field contains a patient's most recent marital (civil) status.
-
multipleBirth
protected Type multipleBirth
Indicates whether the patient is part of a multiple or indicates the actual birth order.
-
photo
protected List<Attachment> photo
Image of the patient.
-
contact
protected List<Patient.ContactComponent> contact
A contact party (e.g. guardian, partner, friend) for the patient.
-
animal
protected Patient.AnimalComponent animal
This patient is known to be an animal.
-
communication
protected List<Patient.PatientCommunicationComponent> communication
Languages which may be used to communicate with the patient about his or her health.
-
careProvider
protected List<Reference> careProvider
Patient's nominated care provider.
-
careProviderTarget
protected List<Resource> careProviderTarget
The actual objects that are the target of the reference (Patient's nominated care provider.)
-
managingOrganization
protected Reference managingOrganization
Organization that is the custodian of the patient record.
-
managingOrganizationTarget
protected Organization managingOrganizationTarget
The actual object that is the target of the reference (Organization that is the custodian of the patient record.)
-
link
protected List<Patient.PatientLinkComponent> link
Link to another patient resource that concerns the same actual patient.
-
SP_BIRTHDATE
public static final String SP_BIRTHDATE
- See Also:
- Constant Field Values
-
SP_DECEASED
public static final String SP_DECEASED
- See Also:
- Constant Field Values
-
SP_ADDRESSSTATE
public static final String SP_ADDRESSSTATE
- See Also:
- Constant Field Values
-
SP_GENDER
public static final String SP_GENDER
- See Also:
- Constant Field Values
-
SP_ANIMALSPECIES
public static final String SP_ANIMALSPECIES
- See Also:
- Constant Field Values
-
SP_LINK
public static final String SP_LINK
- See Also:
- Constant Field Values
-
SP_LANGUAGE
public static final String SP_LANGUAGE
- See Also:
- Constant Field Values
-
SP_DEATHDATE
public static final String SP_DEATHDATE
- See Also:
- Constant Field Values
-
SP_ANIMALBREED
public static final String SP_ANIMALBREED
- See Also:
- Constant Field Values
-
SP_ADDRESSCOUNTRY
public static final String SP_ADDRESSCOUNTRY
- See Also:
- Constant Field Values
-
SP_PHONETIC
public static final String SP_PHONETIC
- See Also:
- Constant Field Values
-
SP_TELECOM
public static final String SP_TELECOM
- See Also:
- Constant Field Values
-
SP_ADDRESSCITY
public static final String SP_ADDRESSCITY
- See Also:
- Constant Field Values
-
SP_EMAIL
public static final String SP_EMAIL
- See Also:
- Constant Field Values
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
- See Also:
- Constant Field Values
-
SP_GIVEN
public static final String SP_GIVEN
- See Also:
- Constant Field Values
-
SP_ADDRESS
public static final String SP_ADDRESS
- See Also:
- Constant Field Values
-
SP_ACTIVE
public static final String SP_ACTIVE
- See Also:
- Constant Field Values
-
SP_ADDRESSPOSTALCODE
public static final String SP_ADDRESSPOSTALCODE
- See Also:
- Constant Field Values
-
SP_CAREPROVIDER
public static final String SP_CAREPROVIDER
- See Also:
- Constant Field Values
-
SP_PHONE
public static final String SP_PHONE
- See Also:
- Constant Field Values
-
SP_ORGANIZATION
public static final String SP_ORGANIZATION
- See Also:
- Constant Field Values
-
SP_NAME
public static final String SP_NAME
- See Also:
- Constant Field Values
-
SP_ADDRESSUSE
public static final String SP_ADDRESSUSE
- See Also:
- Constant Field Values
-
SP_FAMILY
public static final String SP_FAMILY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Patient
public Patient()
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(An identifier for this patient.)
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
- Returns:
identifier(An identifier for this patient.)
-
addIdentifier
public Patient addIdentifier(Identifier t)
-
getActiveElement
public BooleanType 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
public boolean hasActiveElement()
-
hasActive
public boolean hasActive()
-
setActiveElement
public Patient setActiveElement(BooleanType value)
- 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
public boolean getActive()
- Returns:
- Whether this patient record is in active use.
-
setActive
public Patient setActive(boolean value)
- Parameters:
value- Whether this patient record is in active use.
-
hasName
public boolean hasName()
-
getTelecom
public List<ContactPoint> getTelecom()
- Returns:
telecom(A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.)
-
hasTelecom
public boolean hasTelecom()
-
addTelecom
public ContactPoint addTelecom()
- Returns:
telecom(A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.)
-
addTelecom
public Patient addTelecom(ContactPoint t)
-
getGenderElement
public Enumeration<Enumerations.AdministrativeGender> 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
public boolean hasGenderElement()
-
hasGender
public boolean hasGender()
-
setGenderElement
public Patient setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)
- 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
public Enumerations.AdministrativeGender getGender()
- Returns:
- Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
-
setGender
public Patient setGender(Enumerations.AdministrativeGender value)
- Parameters:
value- Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
-
getBirthDateElement
public DateType 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
public boolean hasBirthDateElement()
-
hasBirthDate
public boolean hasBirthDate()
-
setBirthDateElement
public Patient setBirthDateElement(DateType value)
- 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
public Date getBirthDate()
- Returns:
- The date of birth for the individual.
-
setBirthDate
public Patient setBirthDate(Date value)
- Parameters:
value- The date of birth for the individual.
-
getDeceased
public Type 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 Patient setDeceased(Type value)
- Parameters:
value-deceased(Indicates if the individual is deceased or not.)
-
getAddress
public List<Address> getAddress()
- Returns:
address(Addresses for the individual.)
-
hasAddress
public boolean hasAddress()
-
addAddress
public Address addAddress()
- Returns:
address(Addresses for the individual.)
-
addAddress
public Patient addAddress(Address t)
-
getMaritalStatus
public CodeableConcept getMaritalStatus()
- Returns:
maritalStatus(This field contains a patient's most recent marital (civil) status.)
-
hasMaritalStatus
public boolean hasMaritalStatus()
-
setMaritalStatus
public Patient setMaritalStatus(CodeableConcept value)
- Parameters:
value-maritalStatus(This field contains a patient's most recent marital (civil) status.)
-
getMultipleBirth
public Type getMultipleBirth()
- Returns:
multipleBirth(Indicates whether the patient is part of a multiple or indicates the actual birth order.)
-
getMultipleBirthBooleanType
public BooleanType getMultipleBirthBooleanType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
multipleBirth(Indicates whether the patient is part of a multiple or indicates the actual birth order.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasMultipleBirthBooleanType
public boolean hasMultipleBirthBooleanType()
-
getMultipleBirthIntegerType
public IntegerType getMultipleBirthIntegerType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
multipleBirth(Indicates whether the patient is part of a multiple or indicates the actual birth order.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasMultipleBirthIntegerType
public boolean hasMultipleBirthIntegerType()
-
hasMultipleBirth
public boolean hasMultipleBirth()
-
setMultipleBirth
public Patient setMultipleBirth(Type value)
- Parameters:
value-multipleBirth(Indicates whether the patient is part of a multiple or indicates the actual birth order.)
-
getPhoto
public List<Attachment> getPhoto()
- Returns:
photo(Image of the patient.)
-
hasPhoto
public boolean hasPhoto()
-
addPhoto
public Attachment addPhoto()
- Returns:
photo(Image of the patient.)
-
addPhoto
public Patient addPhoto(Attachment t)
-
getContact
public List<Patient.ContactComponent> getContact()
- Returns:
contact(A contact party (e.g. guardian, partner, friend) for the patient.)
-
hasContact
public boolean hasContact()
-
addContact
public Patient.ContactComponent addContact()
- Returns:
contact(A contact party (e.g. guardian, partner, friend) for the patient.)
-
addContact
public Patient addContact(Patient.ContactComponent t)
-
getAnimal
public Patient.AnimalComponent getAnimal()
- Returns:
animal(This patient is known to be an animal.)
-
hasAnimal
public boolean hasAnimal()
-
setAnimal
public Patient setAnimal(Patient.AnimalComponent value)
- Parameters:
value-animal(This patient is known to be an animal.)
-
getCommunication
public List<Patient.PatientCommunicationComponent> getCommunication()
- Returns:
communication(Languages which may be used to communicate with the patient about his or her health.)
-
hasCommunication
public boolean hasCommunication()
-
addCommunication
public Patient.PatientCommunicationComponent addCommunication()
- Returns:
communication(Languages which may be used to communicate with the patient about his or her health.)
-
addCommunication
public Patient addCommunication(Patient.PatientCommunicationComponent t)
-
getCareProvider
public List<Reference> getCareProvider()
- Returns:
careProvider(Patient's nominated care provider.)
-
hasCareProvider
public boolean hasCareProvider()
-
addCareProvider
public Reference addCareProvider()
- Returns:
careProvider(Patient's nominated care provider.)
-
addCareProvider
public Patient addCareProvider(Reference t)
-
getCareProviderTarget
public List<Resource> 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
public Reference getManagingOrganization()
- Returns:
managingOrganization(Organization that is the custodian of the patient record.)
-
hasManagingOrganization
public boolean hasManagingOrganization()
-
setManagingOrganization
public Patient setManagingOrganization(Reference value)
- Parameters:
value-managingOrganization(Organization that is the custodian of the patient record.)
-
getManagingOrganizationTarget
public Organization getManagingOrganizationTarget()
- Returns:
managingOrganizationThe 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
public Patient setManagingOrganizationTarget(Organization value)
- Parameters:
value-managingOrganizationThe 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
public List<Patient.PatientLinkComponent> getLink()
- Returns:
link(Link to another patient resource that concerns the same actual patient.)
-
hasLink
public boolean hasLink()
-
addLink
public Patient.PatientLinkComponent addLink()
- Returns:
link(Link to another patient resource that concerns the same actual patient.)
-
addLink
public Patient addLink(Patient.PatientLinkComponent t)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin 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 Patient copy()
- Specified by:
copyin classDomainResource
-
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
-
-