Package com.ibm.fhir.model.resource
Class Patient
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.Patient
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") public class Patient extends DomainResource
Demographics and other administrative information about an individual or animal receiving care or other health-related services.Maturity level: FMM5 (Normative)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classPatient.Builderstatic classPatient.CommunicationA language which may be used to communicate with the patient about his or her health.static classPatient.ContactA contact party (e.g.static classPatient.LinkLink to another patient resource that concerns the same actual patient.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource
id, implicitRules, language, meta
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static Patient.Builderbuilder()booleanequals(Object obj)BooleangetActive()Whether this patient record is in active use.List<Address>getAddress()An address for the individual.DategetBirthDate()The date of birth for the individual.List<Patient.Communication>getCommunication()A language which may be used to communicate with the patient about his or her health.List<Patient.Contact>getContact()A contact party (e.g.ElementgetDeceased()Indicates if the individual is deceased or not.AdministrativeGendergetGender()Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.List<Reference>getGeneralPractitioner()Patient's nominated care provider.List<Identifier>getIdentifier()An identifier for this patient.List<Patient.Link>getLink()Link to another patient resource that concerns the same actual patient.ReferencegetManagingOrganization()Organization that is the custodian of the patient record.CodeableConceptgetMaritalStatus()This field contains a patient's most recent marital (civil) status.ElementgetMultipleBirth()Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).List<HumanName>getName()A name associated with the individual.List<Attachment>getPhoto()Image of the patient.List<ContactPoint>getTelecom()A contact detail (e.g.booleanhasChildren()inthashCode()Patient.BuildertoBuilder()Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
An identifier for this patient.- Returns:
- An unmodifiable list containing immutable objects of type
Identifierthat may be empty.
-
getActive
public Boolean getActive()
Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.It is often used to filter patient lists to exclude inactive patients
Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
- Returns:
- An immutable object of type
Booleanthat may be null.
-
getName
public List<HumanName> getName()
A name associated with the individual.- Returns:
- An unmodifiable list containing immutable objects of type
HumanNamethat may be empty.
-
getTelecom
public List<ContactPoint> getTelecom()
A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.- Returns:
- An unmodifiable list containing immutable objects of type
ContactPointthat may be empty.
-
getGender
public AdministrativeGender getGender()
Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.- Returns:
- An immutable object of type
AdministrativeGenderthat may be null.
-
getBirthDate
public Date getBirthDate()
The date of birth for the individual.- Returns:
- An immutable object of type
Datethat may be null.
-
getDeceased
public Element getDeceased()
Indicates if the individual is deceased or not.- Returns:
- An immutable object of type
Elementthat may be null.
-
getAddress
public List<Address> getAddress()
An address for the individual.- Returns:
- An unmodifiable list containing immutable objects of type
Addressthat may be empty.
-
getMaritalStatus
public CodeableConcept getMaritalStatus()
This field contains a patient's most recent marital (civil) status.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getMultipleBirth
public Element getMultipleBirth()
Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).- Returns:
- An immutable object of type
Elementthat may be null.
-
getPhoto
public List<Attachment> getPhoto()
Image of the patient.- Returns:
- An unmodifiable list containing immutable objects of type
Attachmentthat may be empty.
-
getContact
public List<Patient.Contact> getContact()
A contact party (e.g. guardian, partner, friend) for the patient.- Returns:
- An unmodifiable list containing immutable objects of type
Patient.Contactthat may be empty.
-
getCommunication
public List<Patient.Communication> getCommunication()
A language which may be used to communicate with the patient about his or her health.- Returns:
- An unmodifiable list containing immutable objects of type
Patient.Communicationthat may be empty.
-
getGeneralPractitioner
public List<Reference> getGeneralPractitioner()
Patient's nominated care provider.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getManagingOrganization
public Reference getManagingOrganization()
Organization that is the custodian of the patient record.- Returns:
- An immutable object of type
Referencethat may be null.
-
getLink
public List<Patient.Link> getLink()
Link to another patient resource that concerns the same actual patient.- Returns:
- An unmodifiable list containing immutable objects of type
Patient.Linkthat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classDomainResource
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
toBuilder
public Patient.Builder toBuilder()
Description copied from class:ResourceCreate a new Builder from the contents of this Resource- Specified by:
toBuilderin classDomainResource
-
builder
public static Patient.Builder builder()
-
-