Package com.ibm.fhir.model.resource
Class FamilyMemberHistory
- 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.FamilyMemberHistory
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") public class FamilyMemberHistory extends DomainResource
Significant health conditions for a person related to the patient relevant in the context of care for the patient.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FamilyMemberHistory.Builder
static class
FamilyMemberHistory.Condition
The significant Conditions (or condition) that the family member had.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static FamilyMemberHistory.Builder
builder()
boolean
equals(java.lang.Object obj)
Element
getAge()
The age of the relative at the time the family member history is recorded.Element
getBorn()
The actual or approximate date of birth of the relative.java.util.List<FamilyMemberHistory.Condition>
getCondition()
The significant Conditions (or condition) that the family member had.CodeableConcept
getDataAbsentReason()
Describes why the family member's history is not available.DateTime
getDate()
The date (and possibly time) when the family member history was recorded or last updated.Element
getDeceased()
Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.Boolean
getEstimatedAge()
If true, indicates that the age value specified is an estimated value.java.util.List<Identifier>
getIdentifier()
Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.java.util.List<Canonical>
getInstantiatesCanonical()
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.java.util.List<Uri>
getInstantiatesUri()
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.String
getName()
This will either be a name or a description; e.g.java.util.List<Annotation>
getNote()
This property allows a non condition-specific note to the made about the related person.Reference
getPatient()
The person who this history concerns.java.util.List<CodeableConcept>
getReasonCode()
Describes why the family member history occurred in coded or textual form.java.util.List<Reference>
getReasonReference()
Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.CodeableConcept
getRelationship()
The type of relationship this person has to the patient (father, mother, brother etc.).CodeableConcept
getSex()
The birth sex of the family member.FamilyHistoryStatus
getStatus()
A code specifying the status of the record of the family history of a specific family member.boolean
hasChildren()
int
hashCode()
FamilyMemberHistory.Builder
toBuilder()
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 java.util.List<Identifier> getIdentifier()
Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getInstantiatesCanonical
public java.util.List<Canonical> getInstantiatesCanonical()
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.- Returns:
- An unmodifiable list containing immutable objects of type
Canonical
that may be empty.
-
getInstantiatesUri
public java.util.List<Uri> getInstantiatesUri()
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.- Returns:
- An unmodifiable list containing immutable objects of type
Uri
that may be empty.
-
getStatus
public FamilyHistoryStatus getStatus()
A code specifying the status of the record of the family history of a specific family member.- Returns:
- An immutable object of type
FamilyHistoryStatus
that is non-null.
-
getDataAbsentReason
public CodeableConcept getDataAbsentReason()
Describes why the family member's history is not available.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getPatient
public Reference getPatient()
The person who this history concerns.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getDate
public DateTime getDate()
The date (and possibly time) when the family member history was recorded or last updated.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getName
public String getName()
This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".- Returns:
- An immutable object of type
String
that may be null.
-
getRelationship
public CodeableConcept getRelationship()
The type of relationship this person has to the patient (father, mother, brother etc.).- Returns:
- An immutable object of type
CodeableConcept
that is non-null.
-
getSex
public CodeableConcept getSex()
The birth sex of the family member.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getBorn
public Element getBorn()
The actual or approximate date of birth of the relative.
-
getAge
public Element getAge()
The age of the relative at the time the family member history is recorded.
-
getEstimatedAge
public Boolean getEstimatedAge()
If true, indicates that the age value specified is an estimated value.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getDeceased
public Element getDeceased()
Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
-
getReasonCode
public java.util.List<CodeableConcept> getReasonCode()
Describes why the family member history occurred in coded or textual form.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getReasonReference
public java.util.List<Reference> getReasonReference()
Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getNote
public java.util.List<Annotation> getNote()
This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.- Returns:
- An unmodifiable list containing immutable objects of type
Annotation
that may be empty.
-
getCondition
public java.util.List<FamilyMemberHistory.Condition> getCondition()
The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.- Returns:
- An unmodifiable list containing immutable objects of type
FamilyMemberHistory.Condition
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept 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:
accept
in interfaceVisitable
- Specified by:
accept
in 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
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public FamilyMemberHistory.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static FamilyMemberHistory.Builder builder()
-
-