FamilyMemberHistory (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.FamilyMemberHistory

All Implemented Interfaces:

Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource
```
public class FamilyMemberHistory
extends DomainResource
```
Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FamilyMemberHistory.FamilyHistoryStatus`
`static class`	`FamilyMemberHistory.FamilyHistoryStatusEnumFactory`
`static class`	`FamilyMemberHistory.FamilyMemberHistoryConditionComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SP_CODE`
`static String`	`SP_DATE`
`static String`	`SP_GENDER`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_PATIENT`
`static String`	`SP_RELATIONSHIP`

Constructor Summary

Constructors
Constructor and Description
`FamilyMemberHistory()`
`FamilyMemberHistory(Reference patient, Enumeration<FamilyMemberHistory.FamilyHistoryStatus> status, CodeableConcept relationship)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FamilyMemberHistory.FamilyMemberHistoryConditionComponent`	`addCondition()`
`FamilyMemberHistory`	`addCondition(FamilyMemberHistory.FamilyMemberHistoryConditionComponent t)`
`Identifier`	`addIdentifier()`
`FamilyMemberHistory`	`addIdentifier(Identifier t)`
`FamilyMemberHistory`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`Type`	`getAge()`
`Age`	`getAgeAge()`
`Range`	`getAgeRange()`
`StringType`	`getAgeStringType()`
`Type`	`getBorn()`
`DateType`	`getBornDateType()`
`Period`	`getBornPeriod()`
`StringType`	`getBornStringType()`
`List<FamilyMemberHistory.FamilyMemberHistoryConditionComponent>`	`getCondition()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`Type`	`getDeceased()`
`Age`	`getDeceasedAge()`
`BooleanType`	`getDeceasedBooleanType()`
`DateType`	`getDeceasedDateType()`
`Range`	`getDeceasedRange()`
`StringType`	`getDeceasedStringType()`
`Enumerations.AdministrativeGender`	`getGender()`
`Enumeration<Enumerations.AdministrativeGender>`	`getGenderElement()`
`List<Identifier>`	`getIdentifier()`
`String`	`getName()`
`StringType`	`getNameElement()`
`Annotation`	`getNote()`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`CodeableConcept`	`getRelationship()`
`ResourceType`	`getResourceType()`
`FamilyMemberHistory.FamilyHistoryStatus`	`getStatus()`
`Enumeration<FamilyMemberHistory.FamilyHistoryStatus>`	`getStatusElement()`
`boolean`	`hasAge()`
`boolean`	`hasAgeAge()`
`boolean`	`hasAgeRange()`
`boolean`	`hasAgeStringType()`
`boolean`	`hasBorn()`
`boolean`	`hasBornDateType()`
`boolean`	`hasBornPeriod()`
`boolean`	`hasBornStringType()`
`boolean`	`hasCondition()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasDeceased()`
`boolean`	`hasDeceasedAge()`
`boolean`	`hasDeceasedBooleanType()`
`boolean`	`hasDeceasedDateType()`
`boolean`	`hasDeceasedRange()`
`boolean`	`hasDeceasedStringType()`
`boolean`	`hasGender()`
`boolean`	`hasGenderElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasName()`
`boolean`	`hasNameElement()`
`boolean`	`hasNote()`
`boolean`	`hasPatient()`
`boolean`	`hasRelationship()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`isEmpty()`
`FamilyMemberHistory`	`setAge(Type value)`
`FamilyMemberHistory`	`setBorn(Type value)`
`FamilyMemberHistory`	`setDate(Date value)`
`FamilyMemberHistory`	`setDateElement(DateTimeType value)`
`FamilyMemberHistory`	`setDeceased(Type value)`
`FamilyMemberHistory`	`setGender(Enumerations.AdministrativeGender value)`
`FamilyMemberHistory`	`setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)`
`FamilyMemberHistory`	`setName(String value)`
`FamilyMemberHistory`	`setNameElement(StringType value)`
`FamilyMemberHistory`	`setNote(Annotation value)`
`FamilyMemberHistory`	`setPatient(Reference value)`
`FamilyMemberHistory`	`setPatientTarget(Patient value)`
`FamilyMemberHistory`	`setRelationship(CodeableConcept value)`
`FamilyMemberHistory`	`setStatus(FamilyMemberHistory.FamilyHistoryStatus value)`
`FamilyMemberHistory`	`setStatusElement(Enumeration<FamilyMemberHistory.FamilyHistoryStatus> value)`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.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.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasUserData, listChildrenByName, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getMeta, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
setId

- Field Detail
  - SP_DATE
```
public static final String SP_DATE
```
    See Also:
    
    Constant Field Values
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_CODE
```
public static final String SP_CODE
```
    See Also:
    
    Constant Field Values
  - SP_GENDER
```
public static final String SP_GENDER
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_RELATIONSHIP
```
public static final String SP_RELATIONSHIP
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FamilyMemberHistory
```
public FamilyMemberHistory()
```
  - FamilyMemberHistory
```
public FamilyMemberHistory(Reference patient,
                           Enumeration<FamilyMemberHistory.FamilyHistoryStatus> status,
                           CodeableConcept relationship)
```
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (This records identifiers associated with this family member history record that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).)
  - addIdentifier
```
public FamilyMemberHistory addIdentifier(Identifier t)
```
  - getPatient
```
public Reference getPatient()
```
    Returns:
    
    patient (The person who this history concerns.)
  - hasPatient
```
public boolean hasPatient()
```
  - setPatient
```
public FamilyMemberHistory setPatient(Reference value)
```
    Parameters:
    
    value - patient (The person who this history concerns.)
  - getPatientTarget
```
public Patient getPatientTarget()
```
    Returns:
    
    patient 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. (The person who this history concerns.)
  - setPatientTarget
```
public FamilyMemberHistory setPatientTarget(Patient value)
```
    Parameters:
    
    value - patient 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. (The person who this history concerns.)
  - getDateElement
```
public DateTimeType getDateElement()
```
    Returns:
    
    date (The date (and possibly time) when the family member history was taken.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - hasDateElement
```
public boolean hasDateElement()
```
  - hasDate
```
public boolean hasDate()
```
  - setDateElement
```
public FamilyMemberHistory setDateElement(DateTimeType value)
```
    Parameters:
    
    value - date (The date (and possibly time) when the family member history was taken.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - getDate
```
public Date getDate()
```
    Returns:
    
    The date (and possibly time) when the family member history was taken.
  - setDate
```
public FamilyMemberHistory setDate(Date value)
```
    Parameters:
    
    value - The date (and possibly time) when the family member history was taken.
  - getStatusElement
```
public Enumeration<FamilyMemberHistory.FamilyHistoryStatus> getStatusElement()
```
    Returns:
    
    status (A code specifying a state of a Family Member History record.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public FamilyMemberHistory setStatusElement(Enumeration<FamilyMemberHistory.FamilyHistoryStatus> value)
```
    Parameters:
    
    value - status (A code specifying a state of a Family Member History record.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public FamilyMemberHistory.FamilyHistoryStatus getStatus()
```
    Returns:
    
    A code specifying a state of a Family Member History record.
  - setStatus
```
public FamilyMemberHistory setStatus(FamilyMemberHistory.FamilyHistoryStatus value)
```
    Parameters:
    
    value - A code specifying a state of a Family Member History record.
  - getNameElement
```
public StringType getNameElement()
```
    Returns:
    
    name (This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
  - hasNameElement
```
public boolean hasNameElement()
```
  - hasName
```
public boolean hasName()
```
  - setNameElement
```
public FamilyMemberHistory setNameElement(StringType value)
```
    Parameters:
    
    value - name (This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
  - getName
```
public String getName()
```
    Returns:
    
    This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
  - setName
```
public FamilyMemberHistory setName(String value)
```
    Parameters:
    
    value - This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
  - getRelationship
```
public CodeableConcept getRelationship()
```
    Returns:
    
    relationship (The type of relationship this person has to the patient (father, mother, brother etc.).)
  - hasRelationship
```
public boolean hasRelationship()
```
  - setRelationship
```
public FamilyMemberHistory setRelationship(CodeableConcept value)
```
    Parameters:
    
    value - relationship (The type of relationship this person has to the patient (father, mother, brother etc.).)
  - getGenderElement
```
public Enumeration<Enumerations.AdministrativeGender> getGenderElement()
```
    Returns:
    
    gender (Administrative Gender - the gender that the relative 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 FamilyMemberHistory setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)
```
    Parameters:
    
    value - gender (Administrative Gender - the gender that the relative 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 relative is considered to have for administration and record keeping purposes.
  - setGender
```
public FamilyMemberHistory setGender(Enumerations.AdministrativeGender value)
```
    Parameters:
    
    value - Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
  - getBorn
```
public Type getBorn()
```
    Returns:
    
    born (The actual or approximate date of birth of the relative.)
  - getBornPeriod
```
public Period getBornPeriod()
                     throws Exception
```
    Returns:
    
    born (The actual or approximate date of birth of the relative.)
    
    Throws:
    
    Exception
  - hasBornPeriod
```
public boolean hasBornPeriod()
                      throws Exception
```
    Throws:
    
    Exception
  - getBornDateType
```
public DateType getBornDateType()
                         throws Exception
```
    Returns:
    
    born (The actual or approximate date of birth of the relative.)
    
    Throws:
    
    Exception
  - hasBornDateType
```
public boolean hasBornDateType()
                        throws Exception
```
    Throws:
    
    Exception
  - getBornStringType
```
public StringType getBornStringType()
                             throws Exception
```
    Returns:
    
    born (The actual or approximate date of birth of the relative.)
    
    Throws:
    
    Exception
  - hasBornStringType
```
public boolean hasBornStringType()
                          throws Exception
```
    Throws:
    
    Exception
  - hasBorn
```
public boolean hasBorn()
```
  - setBorn
```
public FamilyMemberHistory setBorn(Type value)
```
    Parameters:
    
    value - born (The actual or approximate date of birth of the relative.)
  - getAge
```
public Type getAge()
```
    Returns:
    
    age (The actual or approximate age of the relative at the time the family member history is recorded.)
  - getAgeAge
```
public Age getAgeAge()
              throws Exception
```
    Returns:
    
    age (The actual or approximate age of the relative at the time the family member history is recorded.)
    
    Throws:
    
    Exception
  - hasAgeAge
```
public boolean hasAgeAge()
                  throws Exception
```
    Throws:
    
    Exception
  - getAgeRange
```
public Range getAgeRange()
                  throws Exception
```
    Returns:
    
    age (The actual or approximate age of the relative at the time the family member history is recorded.)
    
    Throws:
    
    Exception
  - hasAgeRange
```
public boolean hasAgeRange()
                    throws Exception
```
    Throws:
    
    Exception
  - getAgeStringType
```
public StringType getAgeStringType()
                            throws Exception
```
    Returns:
    
    age (The actual or approximate age of the relative at the time the family member history is recorded.)
    
    Throws:
    
    Exception
  - hasAgeStringType
```
public boolean hasAgeStringType()
                         throws Exception
```
    Throws:
    
    Exception
  - hasAge
```
public boolean hasAge()
```
  - setAge
```
public FamilyMemberHistory setAge(Type value)
```
    Parameters:
    
    value - age (The actual or approximate age of the relative at the time the family member history is recorded.)
  - getDeceased
```
public Type getDeceased()
```
    Returns:
    
    deceased (Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.)
  - getDeceasedBooleanType
```
public BooleanType getDeceasedBooleanType()
                                   throws Exception
```
    Returns:
    
    deceased (Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.)
    
    Throws:
    
    Exception
  - hasDeceasedBooleanType
```
public boolean hasDeceasedBooleanType()
                               throws Exception
```
    Throws:
    
    Exception
  - getDeceasedAge
```
public Age getDeceasedAge()
                   throws Exception
```
    Returns:
    
    deceased (Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.)
    
    Throws:
    
    Exception
  - hasDeceasedAge
```
public boolean hasDeceasedAge()
                       throws Exception
```
    Throws:
    
    Exception
  - getDeceasedRange
```
public Range getDeceasedRange()
                       throws Exception
```
    Returns:
    
    deceased (Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.)
    
    Throws:
    
    Exception
  - hasDeceasedRange
```
public boolean hasDeceasedRange()
                         throws Exception
```
    Throws:
    
    Exception
  - getDeceasedDateType
```
public DateType getDeceasedDateType()
                             throws Exception
```
    Returns:
    
    deceased (Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.)
    
    Throws:
    
    Exception
  - hasDeceasedDateType
```
public boolean hasDeceasedDateType()
                            throws Exception
```
    Throws:
    
    Exception
  - getDeceasedStringType
```
public StringType getDeceasedStringType()
                                 throws Exception
```
    Returns:
    
    deceased (Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.)
    
    Throws:
    
    Exception
  - hasDeceasedStringType
```
public boolean hasDeceasedStringType()
                              throws Exception
```
    Throws:
    
    Exception
  - hasDeceased
```
public boolean hasDeceased()
```
  - setDeceased
```
public FamilyMemberHistory setDeceased(Type value)
```
    Parameters:
    
    value - deceased (Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.)
  - getNote
```
public Annotation getNote()
```
    Returns:
    
    note (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.)
  - hasNote
```
public boolean hasNote()
```
  - setNote
```
public FamilyMemberHistory setNote(Annotation value)
```
    Parameters:
    
    value - note (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.)
  - getCondition
```
public List<FamilyMemberHistory.FamilyMemberHistoryConditionComponent> getCondition()
```
    Returns:
    
    condition (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.)
  - hasCondition
```
public boolean hasCondition()
```
  - addCondition
```
public FamilyMemberHistory.FamilyMemberHistoryConditionComponent addCondition()
```
    Returns:
    
    condition (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.)
  - addCondition
```
public FamilyMemberHistory addCondition(FamilyMemberHistory.FamilyMemberHistoryConditionComponent t)
```
  - copy
```
public FamilyMemberHistory copy()
```
    Specified by:
    
    copy in class DomainResource
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class FamilyMemberHistory

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.instance.model.DomainResource

Methods inherited from class org.hl7.fhir.instance.model.Resource

Methods inherited from class org.hl7.fhir.instance.model.BaseResource

Methods inherited from class org.hl7.fhir.instance.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

SP_DATE

SP_IDENTIFIER

SP_CODE

SP_GENDER

SP_PATIENT

SP_RELATIONSHIP

Constructor Detail

FamilyMemberHistory

FamilyMemberHistory

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getPatient

hasPatient

setPatient

getPatientTarget

setPatientTarget

getDateElement

hasDateElement

hasDate

setDateElement

getDate

setDate

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getNameElement

hasNameElement

hasName

setNameElement

getName

setName

getRelationship

hasRelationship

setRelationship

getGenderElement

hasGenderElement

hasGender

setGenderElement

getGender

setGender

getBorn

getBornPeriod

hasBornPeriod

getBornDateType

hasBornDateType

getBornStringType

hasBornStringType

hasBorn

setBorn

getAge

getAgeAge

hasAgeAge

getAgeRange

hasAgeRange

getAgeStringType

hasAgeStringType

hasAge

setAge

getDeceased

getDeceasedBooleanType

hasDeceasedBooleanType