FamilyMemberHistory (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.FamilyMemberHistory

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class FamilyMemberHistory
extends BaseResource
implements IResource
```
HAPI/FHIR FamilyMemberHistory Resource (clinical.general)
Definition: Significant health events and conditions for a person related to the patient relevant in the context of care for the patient.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/FamilyMemberHistory

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FamilyMemberHistory.Condition
Block class for child element: FamilyMemberHistory.condition ()

Nested Classes
Modifier and Type	Class and Description
`static class`	`FamilyMemberHistory.Condition` Block class for child element: FamilyMemberHistory.condition ()

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`CODE` Fluent Client search parameter constant for code
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static TokenClientParam`	`GENDER` Fluent Client search parameter constant for gender
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static TokenClientParam`	`RELATIONSHIP` Fluent Client search parameter constant for relationship
`static String`	`SP_CODE` Search parameter constant for code
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_GENDER` Search parameter constant for gender
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_RELATIONSHIP` Search parameter constant for relationship

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

FamilyMemberHistory()

Constructors
Constructor and Description
`FamilyMemberHistory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FamilyMemberHistory.Condition`	`addCondition()` Adds and returns a new value for condition ()
`FamilyMemberHistory`	`addCondition(FamilyMemberHistory.Condition theValue)` Adds a given new value for condition ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`FamilyMemberHistory`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier (id)
`IDatatype`	`getAge()` Gets the value(s) for age[x] ().
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`IDatatype`	`getBorn()` Gets the value(s) for born[x] ().
`List<FamilyMemberHistory.Condition>`	`getCondition()` Gets the value(s) for condition ().
`FamilyMemberHistory.Condition`	`getConditionFirstRep()` Gets the first repetition for condition (), creating it if it does not already exist.
`Date`	`getDate()` Gets the value(s) for date (when.recorded).
`DateTimeDt`	`getDateElement()` Gets the value(s) for date (when.recorded).
`IDatatype`	`getDeceased()` Gets the value(s) for deceased[x] ().
`String`	`getGender()` Gets the value(s) for gender ().
`BoundCodeDt<AdministrativeGenderEnum>`	`getGenderElement()` Gets the value(s) for gender ().
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (id).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (id), creating it if it does not already exist.
`String`	`getName()` Gets the value(s) for name ().
`StringDt`	`getNameElement()` Gets the value(s) for name ().
`AnnotationDt`	`getNote()` Gets the value(s) for note ().
`ResourceReferenceDt`	`getPatient()` Gets the value(s) for patient (who.focus).
`CodeableConceptDt`	`getRelationship()` Gets the value(s) for relationship ().
`String`	`getResourceName()`
`String`	`getStatus()` Gets the value(s) for status (status).
`BoundCodeDt<FamilyHistoryStatusEnum>`	`getStatusElement()` Gets the value(s) for status (status).
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`boolean`	`isEmpty()`
`FamilyMemberHistory`	`setAge(IDatatype theValue)` Sets the value(s) for age[x] ()
`FamilyMemberHistory`	`setBorn(IDatatype theValue)` Sets the value(s) for born[x] ()
`FamilyMemberHistory`	`setCondition(List<FamilyMemberHistory.Condition> theValue)` Sets the value(s) for condition ()
`FamilyMemberHistory`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date (when.recorded)
`FamilyMemberHistory`	`setDate(DateTimeDt theValue)` Sets the value(s) for date (when.recorded)
`FamilyMemberHistory`	`setDateWithSecondsPrecision(Date theDate)` Sets the value for date (when.recorded)
`FamilyMemberHistory`	`setDeceased(IDatatype theValue)` Sets the value(s) for deceased[x] ()
`FamilyMemberHistory`	`setGender(AdministrativeGenderEnum theValue)` Sets the value(s) for gender ()
`FamilyMemberHistory`	`setGender(BoundCodeDt<AdministrativeGenderEnum> theValue)` Sets the value(s) for gender ()
`FamilyMemberHistory`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`FamilyMemberHistory`	`setName(String theString)` Sets the value for name ()
`FamilyMemberHistory`	`setName(StringDt theValue)` Sets the value(s) for name ()
`FamilyMemberHistory`	`setNote(AnnotationDt theValue)` Sets the value(s) for note ()
`FamilyMemberHistory`	`setPatient(ResourceReferenceDt theValue)` Sets the value(s) for patient (who.focus)
`FamilyMemberHistory`	`setRelationship(CodeableConceptDt theValue)` Sets the value(s) for relationship ()
`FamilyMemberHistory`	`setStatus(BoundCodeDt<FamilyHistoryStatusEnum> theValue)` Sets the value(s) for status (status)
`FamilyMemberHistory`	`setStatus(FamilyHistoryStatusEnum theValue)` Sets the value(s) for status (status)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

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

- Field Detail
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description:
    Type: date
    Path: FamilyMemberHistory.date
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description:
    Type: date
    Path: FamilyMemberHistory.date
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description: The identity of a subject to list family member history items for
    Type: reference
    Path: FamilyMemberHistory.patient
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: The identity of a subject to list family member history items for
    Type: reference
    Path: FamilyMemberHistory.patient
  - SP_CODE
```
public static final String SP_CODE
```
    Search parameter constant for code
    Description: A search by a condition code
    Type: token
    Path: FamilyMemberHistory.condition.code
    
    See Also:
    
    Constant Field Values
  - CODE
```
public static final TokenClientParam CODE
```
    Fluent Client search parameter constant for code
    Description: A search by a condition code
    Type: token
    Path: FamilyMemberHistory.condition.code
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: A search by a record identifier
    Type: token
    Path: FamilyMemberHistory.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: A search by a record identifier
    Type: token
    Path: FamilyMemberHistory.identifier
  - SP_RELATIONSHIP
```
public static final String SP_RELATIONSHIP
```
    Search parameter constant for relationship
    Description: A search by a relationship type
    Type: token
    Path: FamilyMemberHistory.relationship
    
    See Also:
    
    Constant Field Values
  - RELATIONSHIP
```
public static final TokenClientParam RELATIONSHIP
```
    Fluent Client search parameter constant for relationship
    Description: A search by a relationship type
    Type: token
    Path: FamilyMemberHistory.relationship
  - SP_GENDER
```
public static final String SP_GENDER
```
    Search parameter constant for gender
    Description: A search by a gender code of a family member
    Type: token
    Path: FamilyMemberHistory.gender
    
    See Also:
    
    Constant Field Values
  - GENDER
```
public static final TokenClientParam GENDER
```
    Fluent Client search parameter constant for gender
    Description: A search by a gender code of a family member
    Type: token
    Path: FamilyMemberHistory.gender
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "FamilyMemberHistory:patient".
- Constructor Detail
  - FamilyMemberHistory
```
public FamilyMemberHistory()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.
    Definition: 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)
  - setIdentifier
```
public FamilyMemberHistory setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (id)
    Definition: 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 IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (id)
    Definition: 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(IdentifierDt theValue)
```
    Adds a given new value for identifier (id)
    Definition: 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)
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (id), creating it if it does not already exist.
    Definition: 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)
  - getPatient
```
public ResourceReferenceDt getPatient()
```
    Gets the value(s) for patient (who.focus). creating it if it does not exist. Will not return null.
    Definition: The person who this history concerns
  - setPatient
```
public FamilyMemberHistory setPatient(ResourceReferenceDt theValue)
```
    Sets the value(s) for patient (who.focus)
    Definition: The person who this history concerns
  - getDateElement
```
public DateTimeDt getDateElement()
```
    Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.
    Definition: The date (and possibly time) when the family member history was taken
  - getDate
```
public Date getDate()
```
    Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.
    Definition: The date (and possibly time) when the family member history was taken
  - setDate
```
public FamilyMemberHistory setDate(DateTimeDt theValue)
```
    Sets the value(s) for date (when.recorded)
    Definition: The date (and possibly time) when the family member history was taken
  - setDate
```
public FamilyMemberHistory setDate(Date theDate,
                                   TemporalPrecisionEnum thePrecision)
```
    Sets the value for date (when.recorded)
    Definition: The date (and possibly time) when the family member history was taken
  - setDateWithSecondsPrecision
```
public FamilyMemberHistory setDateWithSecondsPrecision(Date theDate)
```
    Sets the value for date (when.recorded)
    Definition: The date (and possibly time) when the family member history was taken
  - getStatusElement
```
public BoundCodeDt<FamilyHistoryStatusEnum> getStatusElement()
```
    Gets the value(s) for status (status). creating it if it does not exist. Will not return null.
    Definition: A code specifying a state of a Family Member History record.
  - getStatus
```
public String getStatus()
```
    Gets the value(s) for status (status). creating it if it does not exist. Will not return null.
    Definition: A code specifying a state of a Family Member History record.
  - setStatus
```
public FamilyMemberHistory setStatus(BoundCodeDt<FamilyHistoryStatusEnum> theValue)
```
    Sets the value(s) for status (status)
    Definition: A code specifying a state of a Family Member History record.
  - setStatus
```
public FamilyMemberHistory setStatus(FamilyHistoryStatusEnum theValue)
```
    Sets the value(s) for status (status)
    Definition: A code specifying a state of a Family Member History record.
  - getNameElement
```
public StringDt getNameElement()
```
    Gets the value(s) for name (). creating it if it does not exist. Will not return null.
    Definition: This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\"
  - getName
```
public String getName()
```
    Gets the value(s) for name (). creating it if it does not exist. Will not return null.
    Definition: This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\"
  - setName
```
public FamilyMemberHistory setName(StringDt theValue)
```
    Sets the value(s) for name ()
    Definition: This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\"
  - setName
```
public FamilyMemberHistory setName(String theString)
```
    Sets the value for name ()
    Definition: This will either be a name or a description; e.g. \"Aunt Susan\", \"my cousin with the red hair\"
  - getRelationship
```
public CodeableConceptDt getRelationship()
```
    Gets the value(s) for relationship (). creating it if it does not exist. Will not return null.
    Definition: The type of relationship this person has to the patient (father, mother, brother etc.)
  - setRelationship
```
public FamilyMemberHistory setRelationship(CodeableConceptDt theValue)
```
    Sets the value(s) for relationship ()
    Definition: The type of relationship this person has to the patient (father, mother, brother etc.)
  - getGenderElement
```
public BoundCodeDt<AdministrativeGenderEnum> getGenderElement()
```
    Gets the value(s) for gender (). creating it if it does not exist. Will not return null.
    Definition: Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
  - getGender
```
public String getGender()
```
    Gets the value(s) for gender (). creating it if it does not exist. Will not return null.
    Definition: Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
  - setGender
```
public FamilyMemberHistory setGender(BoundCodeDt<AdministrativeGenderEnum> theValue)
```
    Sets the value(s) for gender ()
    Definition: Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
  - setGender
```
public FamilyMemberHistory setGender(AdministrativeGenderEnum theValue)
```
    Sets the value(s) for gender ()
    Definition: Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
  - getBorn
```
public IDatatype getBorn()
```
    Gets the value(s) for born[x] (). creating it if it does not exist. Will not return null.
    Definition: The actual or approximate date of birth of the relative
  - setBorn
```
public FamilyMemberHistory setBorn(IDatatype theValue)
```
    Sets the value(s) for born[x] ()
    Definition: The actual or approximate date of birth of the relative
  - getAge
```
public IDatatype getAge()
```
    Gets the value(s) for age[x] (). creating it if it does not exist. Will not return null.
    Definition: The actual or approximate age of the relative at the time the family member history is recorded
  - setAge
```
public FamilyMemberHistory setAge(IDatatype theValue)
```
    Sets the value(s) for age[x] ()
    Definition: The actual or approximate age of the relative at the time the family member history is recorded
  - getDeceased
```
public IDatatype getDeceased()
```
    Gets the value(s) for deceased[x] (). creating it if it does not exist. Will not return null.
    Definition: Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record
  - setDeceased
```
public FamilyMemberHistory setDeceased(IDatatype theValue)
```
    Sets the value(s) for deceased[x] ()
    Definition: Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record
  - getNote
```
public AnnotationDt getNote()
```
    Gets the value(s) for note (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - setNote
```
public FamilyMemberHistory setNote(AnnotationDt theValue)
```
    Sets the value(s) for note ()
    Definition: 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.Condition> getCondition()
```
    Gets the value(s) for condition (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - setCondition
```
public FamilyMemberHistory setCondition(List<FamilyMemberHistory.Condition> theValue)
```
    Sets the value(s) for condition ()
    Definition: 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.Condition addCondition()
```
    Adds and returns a new value for condition ()
    Definition: 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.Condition theValue)
```
    Adds a given new value for condition ()
    Definition: 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.
    
    Parameters:
    
    theValue - The condition to add (must not be null)
  - getConditionFirstRep
```
public FamilyMemberHistory.Condition getConditionFirstRep()
```
    Gets the first repetition for condition (), creating it if it does not already exist.
    Definition: 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.
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class FamilyMemberHistory

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_DATE

DATE

SP_PATIENT

PATIENT

SP_CODE

CODE

SP_IDENTIFIER

IDENTIFIER

SP_RELATIONSHIP

RELATIONSHIP

SP_GENDER

GENDER

INCLUDE_PATIENT

Constructor Detail

FamilyMemberHistory

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getPatient

setPatient

getDateElement

getDate

setDate

setDate

setDateWithSecondsPrecision

getStatusElement

getStatus

setStatus

setStatus

getNameElement

getName

setName

setName

getRelationship

setRelationship

getGenderElement

getGender

setGender

setGender

getBorn

setBorn

getAge

setAge

getDeceased

setDeceased

getNote

setNote

getCondition

setCondition

addCondition

addCondition

getConditionFirstRep

getResourceName

getStructureFhirVersionEnum