org.hl7.fhir.dstu3.model.FamilyMemberHistory

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 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	Description
`static class`	`FamilyMemberHistory.FamilyHistoryStatus`
`static class`	`FamilyMemberHistory.FamilyHistoryStatusEnumFactory`
`static class`	`FamilyMemberHistory.FamilyMemberHistoryConditionComponent`

Field Summary

Fields
Modifier and Type	Field	Description
`protected Type`	`age`	The age of the relative at the time the family member history is recorded.
`protected Type`	`born`	The actual or approximate date of birth of the relative.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CODE`	Fluent Client search parameter constant for code
`protected List<FamilyMemberHistory.FamilyMemberHistoryConditionComponent>`	`condition`	The significant Conditions (or condition) that the family member had.
`protected DateTimeType`	`date`	The date (and possibly time) when the family member history was taken.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE`	Fluent Client search parameter constant for date
`protected Type`	`deceased`	Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
`protected List<Reference>`	`definition`	A protocol or questionnaire that was adhered to in whole or in part by this event.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`DEFINITION`	Fluent Client search parameter constant for definition
`protected List<Resource>`	`definitionTarget`	The actual objects that are the target of the reference (A protocol or questionnaire that was adhered to in whole or in part by this event.)
`protected BooleanType`	`estimatedAge`	If true, indicates that the age value specified is an estimated value.
`protected Enumeration<Enumerations.AdministrativeGender>`	`gender`	Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`GENDER`	Fluent Client search parameter constant for gender
`protected List<Identifier>`	`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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER`	Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_DEFINITION`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT`	Constant for fluent queries to be used to add include statements.
`protected StringType`	`name`	This will either be a name or a description; e.g.
`protected BooleanType`	`notDone`	If true, indicates the taking of an individual family member's history did not occur.
`protected CodeableConcept`	`notDoneReason`	Describes why the family member's history is absent.
`protected List<Annotation>`	`note`	This property allows a non condition-specific note to the made about the related person.
`protected Reference`	`patient`	The person who this history concerns.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT`	Fluent Client search parameter constant for patient
`protected Patient`	`patientTarget`	The actual object that is the target of the reference (The person who this history concerns.)
`protected List<CodeableConcept>`	`reasonCode`	Describes why the family member history occurred in coded or textual form.
`protected List<Reference>`	`reasonReference`	Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
`protected List<Resource>`	`reasonReferenceTarget`	The actual objects that are the target of the reference (Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.)
`protected CodeableConcept`	`relationship`	The type of relationship this person has to the patient (father, mother, brother etc.).
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`RELATIONSHIP`	Fluent Client search parameter constant for relationship
`static String`	`SP_CODE`	Search parameter: code
`static String`	`SP_DATE`	Search parameter: date
`static String`	`SP_DEFINITION`	Search parameter: definition
`static String`	`SP_GENDER`	Search parameter: gender
`static String`	`SP_IDENTIFIER`	Search parameter: identifier
`static String`	`SP_PATIENT`	Search parameter: patient
`static String`	`SP_RELATIONSHIP`	Search parameter: relationship
`static String`	`SP_STATUS`	Search parameter: status
`protected Enumeration<FamilyMemberHistory.FamilyHistoryStatus>`	`status`	A code specifying the status of the record of the family history of a specific family member.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS`	Fluent Client search parameter constant for status

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

id, implicitRules, language, meta

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

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	Description
`FamilyMemberHistory()`	Constructor
`FamilyMemberHistory(Enumeration<FamilyMemberHistory.FamilyHistoryStatus> status, Reference patient, CodeableConcept relationship)`	Constructor

Method Summary

Modifier and Type	Method	Description
`Base`	`addChild(String name)`
`FamilyMemberHistory.FamilyMemberHistoryConditionComponent`	`addCondition()`
`FamilyMemberHistory`	`addCondition(FamilyMemberHistory.FamilyMemberHistoryConditionComponent t)`
`Reference`	`addDefinition()`
`FamilyMemberHistory`	`addDefinition(Reference t)`
`Identifier`	`addIdentifier()`
`FamilyMemberHistory`	`addIdentifier(Identifier t)`
`Annotation`	`addNote()`
`FamilyMemberHistory`	`addNote(Annotation t)`
`CodeableConcept`	`addReasonCode()`
`FamilyMemberHistory`	`addReasonCode(CodeableConcept t)`
`Reference`	`addReasonReference()`
`FamilyMemberHistory`	`addReasonReference(Reference t)`
`FamilyMemberHistory`	`copy()`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`Type`	`getAge()`
`Age`	`getAgeAge()`
`Range`	`getAgeRange()`
`StringType`	`getAgeStringType()`
`Type`	`getBorn()`
`DateType`	`getBornDateType()`
`Period`	`getBornPeriod()`
`StringType`	`getBornStringType()`
`List<FamilyMemberHistory.FamilyMemberHistoryConditionComponent>`	`getCondition()`
`FamilyMemberHistory.FamilyMemberHistoryConditionComponent`	`getConditionFirstRep()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`Type`	`getDeceased()`
`Age`	`getDeceasedAge()`
`BooleanType`	`getDeceasedBooleanType()`
`DateType`	`getDeceasedDateType()`
`Range`	`getDeceasedRange()`
`StringType`	`getDeceasedStringType()`
`List<Reference>`	`getDefinition()`
`Reference`	`getDefinitionFirstRep()`
`List<Resource>`	`getDefinitionTarget()`	Deprecated. Use Reference#setResource(IBaseResource) instead
`boolean`	`getEstimatedAge()`
`BooleanType`	`getEstimatedAgeElement()`
`Enumerations.AdministrativeGender`	`getGender()`
`Enumeration<Enumerations.AdministrativeGender>`	`getGenderElement()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`String`	`getName()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`StringType`	`getNameElement()`
`boolean`	`getNotDone()`
`BooleanType`	`getNotDoneElement()`
`CodeableConcept`	`getNotDoneReason()`
`List<Annotation>`	`getNote()`
`Annotation`	`getNoteFirstRep()`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<CodeableConcept>`	`getReasonCode()`
`CodeableConcept`	`getReasonCodeFirstRep()`
`List<Reference>`	`getReasonReference()`
`Reference`	`getReasonReferenceFirstRep()`
`List<Resource>`	`getReasonReferenceTarget()`	Deprecated. Use Reference#setResource(IBaseResource) instead
`CodeableConcept`	`getRelationship()`
`ResourceType`	`getResourceType()`
`FamilyMemberHistory.FamilyHistoryStatus`	`getStatus()`
`Enumeration<FamilyMemberHistory.FamilyHistoryStatus>`	`getStatusElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`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`	`hasDefinition()`
`boolean`	`hasEstimatedAge()`
`boolean`	`hasEstimatedAgeElement()`
`boolean`	`hasGender()`
`boolean`	`hasGenderElement()`
`boolean`	`hasIdentifier()`
`boolean`	`hasName()`
`boolean`	`hasNameElement()`
`boolean`	`hasNotDone()`
`boolean`	`hasNotDoneElement()`
`boolean`	`hasNotDoneReason()`
`boolean`	`hasNote()`
`boolean`	`hasPatient()`
`boolean`	`hasReasonCode()`
`boolean`	`hasReasonReference()`
`boolean`	`hasRelationship()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`FamilyMemberHistory`	`setAge(Type value)`
`FamilyMemberHistory`	`setBorn(Type value)`
`FamilyMemberHistory`	`setCondition(List<FamilyMemberHistory.FamilyMemberHistoryConditionComponent> theCondition)`
`FamilyMemberHistory`	`setDate(Date value)`
`FamilyMemberHistory`	`setDateElement(DateTimeType value)`
`FamilyMemberHistory`	`setDeceased(Type value)`
`FamilyMemberHistory`	`setDefinition(List<Reference> theDefinition)`
`FamilyMemberHistory`	`setEstimatedAge(boolean value)`
`FamilyMemberHistory`	`setEstimatedAgeElement(BooleanType value)`
`FamilyMemberHistory`	`setGender(Enumerations.AdministrativeGender value)`
`FamilyMemberHistory`	`setGenderElement(Enumeration<Enumerations.AdministrativeGender> value)`
`FamilyMemberHistory`	`setIdentifier(List<Identifier> theIdentifier)`
`FamilyMemberHistory`	`setName(String value)`
`FamilyMemberHistory`	`setNameElement(StringType value)`
`FamilyMemberHistory`	`setNotDone(boolean value)`
`FamilyMemberHistory`	`setNotDoneElement(BooleanType value)`
`FamilyMemberHistory`	`setNotDoneReason(CodeableConcept value)`
`FamilyMemberHistory`	`setNote(List<Annotation> theNote)`
`FamilyMemberHistory`	`setPatient(Reference value)`
`FamilyMemberHistory`	`setPatientTarget(Patient value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`FamilyMemberHistory`	`setReasonCode(List<CodeableConcept> theReasonCode)`
`FamilyMemberHistory`	`setReasonReference(List<Reference> theReasonReference)`
`FamilyMemberHistory`	`setRelationship(CodeableConcept value)`
`FamilyMemberHistory`	`setStatus(FamilyMemberHistory.FamilyHistoryStatus value)`
`FamilyMemberHistory`	`setStatusElement(Enumeration<FamilyMemberHistory.FamilyHistoryStatus> value)`
`protected FamilyMemberHistory`	`typedCopy()`

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

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, 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

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, setId

Field Details
- identifier
  
  protected List<Identifier> 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).
- definition
  
  protected List<Reference> definition
  
  A protocol or questionnaire that was adhered to in whole or in part by this event.
- definitionTarget
  
  protected List<Resource> definitionTarget
  
  The actual objects that are the target of the reference (A protocol or questionnaire that was adhered to in whole or in part by this event.)
- status
  
  protected Enumeration<FamilyMemberHistory.FamilyHistoryStatus> status
  
  A code specifying the status of the record of the family history of a specific family member.
- notDone
  
  protected BooleanType notDone
  
  If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.
- notDoneReason
  
  protected CodeableConcept notDoneReason
  
  Describes why the family member's history is absent.
- patient
  
  protected Reference patient
  
  The person who this history concerns.
- patientTarget
  
  protected Patient patientTarget
  
  The actual object that is the target of the reference (The person who this history concerns.)
- date
  
  protected DateTimeType date
  
  The date (and possibly time) when the family member history was taken.
- name
  
  protected StringType name
  
  This will either be a name or a description; e.g. "Aunt Susan", "my cousin with the red hair".
- relationship
  
  protected CodeableConcept relationship
  
  The type of relationship this person has to the patient (father, mother, brother etc.).
- gender
  
  protected Enumeration<Enumerations.AdministrativeGender> gender
  
  Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
- born
  
  protected Type born
  
  The actual or approximate date of birth of the relative.
- age
  
  protected Type age
  
  The age of the relative at the time the family member history is recorded.
- estimatedAge
  
  protected BooleanType estimatedAge
  
  If true, indicates that the age value specified is an estimated value.
- deceased
  
  protected Type deceased
  
  Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.
- reasonCode
  
  protected List<CodeableConcept> reasonCode
  
  Describes why the family member history occurred in coded or textual form.
- reasonReference
  
  protected List<Reference> reasonReference
  
  Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.
- reasonReferenceTarget
  
  protected List<Resource> reasonReferenceTarget
  
  The actual objects that are the target of the reference (Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.)
- note
  
  protected List<Annotation> 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.
- condition
  
  protected List<FamilyMemberHistory.FamilyMemberHistoryConditionComponent> 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.
- SP_DATE
  
  public static final String SP_DATE
  
  Search parameter: date
  Description: When history was captured/updated
  Type: date
  Path: FamilyMemberHistory.date
  
  See Also:
  
  Constant Field Values
- DATE
  
  public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
  
  Fluent Client search parameter constant for date
  Description: When history was captured/updated
  Type: date
  Path: FamilyMemberHistory.date
- SP_IDENTIFIER
  
  public static final String SP_IDENTIFIER
  
  Search parameter: identifier
  Description: A search by a record identifier
  Type: token
  Path: FamilyMemberHistory.identifier
  
  See Also:
  
  Constant Field Values
- IDENTIFIER
  
  public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
  
  Fluent Client search parameter constant for identifier
  Description: A search by a record identifier
  Type: token
  Path: FamilyMemberHistory.identifier
- SP_CODE
  
  public static final String SP_CODE
  
  Search parameter: code
  Description: A search by a condition code
  Type: token
  Path: FamilyMemberHistory.condition.code
  
  See Also:
  
  Constant Field Values
- CODE
  
  public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
  
  Fluent Client search parameter constant for code
  Description: A search by a condition code
  Type: token
  Path: FamilyMemberHistory.condition.code
- SP_GENDER
  
  public static final String SP_GENDER
  
  Search parameter: 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 ca.uhn.fhir.rest.gclient.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
- SP_PATIENT
  
  public static final String SP_PATIENT
  
  Search parameter: 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 ca.uhn.fhir.rest.gclient.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
- INCLUDE_PATIENT
  
  public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
  
  Constant for fluent queries to be used to add include statements. Specifies the path value of "FamilyMemberHistory:patient".
- SP_DEFINITION
  
  public static final String SP_DEFINITION
  
  Search parameter: definition
  Description: Instantiates protocol or definition
  Type: reference
  Path: FamilyMemberHistory.definition
  
  See Also:
  
  Constant Field Values
- DEFINITION
  
  public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEFINITION
  
  Fluent Client search parameter constant for definition
  Description: Instantiates protocol or definition
  Type: reference
  Path: FamilyMemberHistory.definition
- INCLUDE_DEFINITION
  
  public static final ca.uhn.fhir.model.api.Include INCLUDE_DEFINITION
  
  Constant for fluent queries to be used to add include statements. Specifies the path value of "FamilyMemberHistory:definition".
- SP_RELATIONSHIP
  
  public static final String SP_RELATIONSHIP
  
  Search parameter: relationship
  Description: A search by a relationship type
  Type: token
  Path: FamilyMemberHistory.relationship
  
  See Also:
  
  Constant Field Values
- RELATIONSHIP
  
  public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATIONSHIP
  
  Fluent Client search parameter constant for relationship
  Description: A search by a relationship type
  Type: token
  Path: FamilyMemberHistory.relationship
- SP_STATUS
  
  public static final String SP_STATUS
  
  Search parameter: status
  Description: partial | completed | entered-in-error | health-unknown
  Type: token
  Path: FamilyMemberHistory.status
  
  See Also:
  
  Constant Field Values
- STATUS
  
  public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
  
  Fluent Client search parameter constant for status
  Description: partial | completed | entered-in-error | health-unknown
  Type: token
  Path: FamilyMemberHistory.status
Constructor Details
- FamilyMemberHistory
  
  public FamilyMemberHistory()
  
  Constructor
- FamilyMemberHistory
  
  public FamilyMemberHistory(Enumeration<FamilyMemberHistory.FamilyHistoryStatus> status, Reference patient, CodeableConcept relationship)
  
  Constructor
Method Details
- 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).)
- setIdentifier
  
  public FamilyMemberHistory setIdentifier(List<Identifier> theIdentifier)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasIdentifier
  
  public boolean hasIdentifier()
- addIdentifier
  
  public Identifier addIdentifier()
- addIdentifier
  
  public FamilyMemberHistory addIdentifier(Identifier t)
- getIdentifierFirstRep
  
  public Identifier getIdentifierFirstRep()
  
  Returns:
  
  The first repetition of repeating field identifier, creating it if it does not already exist
- getDefinition
  
  public List<Reference> getDefinition()
  
  Returns:
  
  definition (A protocol or questionnaire that was adhered to in whole or in part by this event.)
- setDefinition
  
  public FamilyMemberHistory setDefinition(List<Reference> theDefinition)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasDefinition
  
  public boolean hasDefinition()
- addDefinition
  
  public Reference addDefinition()
- addDefinition
  
  public FamilyMemberHistory addDefinition(Reference t)
- getDefinitionFirstRep
  
  public Reference getDefinitionFirstRep()
  
  Returns:
  
  The first repetition of repeating field definition, creating it if it does not already exist
- getDefinitionTarget
  
  @Deprecated public List<Resource> getDefinitionTarget()
  
  Deprecated.
  Use Reference#setResource(IBaseResource) instead
- getStatusElement
  
  public Enumeration<FamilyMemberHistory.FamilyHistoryStatus> getStatusElement()
  
  Returns:
  
  status (A code specifying the status of the record of the family history of a specific family member.). 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 the status of the record of the family history of a specific family member.). 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 the status of the record of the family history of a specific family member.
- setStatus
  
  public FamilyMemberHistory setStatus(FamilyMemberHistory.FamilyHistoryStatus value)
  
  Parameters:
  
  value - A code specifying the status of the record of the family history of a specific family member.
- getNotDoneElement
  
  public BooleanType getNotDoneElement()
  
  Returns:
  
  notDone (If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.). This is the underlying object with id, value and extensions. The accessor "getNotDone" gives direct access to the value
- hasNotDoneElement
  
  public boolean hasNotDoneElement()
- hasNotDone
  
  public boolean hasNotDone()
- setNotDoneElement
  
  public FamilyMemberHistory setNotDoneElement(BooleanType value)
  
  Parameters:
  
  value - notDone (If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.). This is the underlying object with id, value and extensions. The accessor "getNotDone" gives direct access to the value
- getNotDone
  
  public boolean getNotDone()
  
  Returns:
  
  If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.
- setNotDone
  
  public FamilyMemberHistory setNotDone(boolean value)
  
  Parameters:
  
  value - If true, indicates the taking of an individual family member's history did not occur. The notDone element should not be used to document negated conditions, such as a family member that did not have a condition.
- getNotDoneReason
  
  public CodeableConcept getNotDoneReason()
  
  Returns:
  
  notDoneReason (Describes why the family member's history is absent.)
- hasNotDoneReason
  
  public boolean hasNotDoneReason()
- setNotDoneReason
  
  public FamilyMemberHistory setNotDoneReason(CodeableConcept value)
  
  Parameters:
  
  value - notDoneReason (Describes why the family member's history is absent.)
- 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.
- 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 org.hl7.fhir.exceptions.FHIRException
  
  Returns:
  
  born (The actual or approximate date of birth of the relative.)
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- hasBornPeriod
  
  public boolean hasBornPeriod()
- getBornDateType
  
  public DateType getBornDateType() throws org.hl7.fhir.exceptions.FHIRException
  
  Returns:
  
  born (The actual or approximate date of birth of the relative.)
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- hasBornDateType
  
  public boolean hasBornDateType()
- getBornStringType
  
  public StringType getBornStringType() throws org.hl7.fhir.exceptions.FHIRException
  
  Returns:
  
  born (The actual or approximate date of birth of the relative.)
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- hasBornStringType
  
  public boolean hasBornStringType()
- hasBorn
  
  public boolean hasBorn()
- setBorn
  
  public FamilyMemberHistory setBorn(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
  
  Parameters:
  
  value - born (The actual or approximate date of birth of the relative.)
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRFormatError
- getAge
  
  public Type getAge()
  
  Returns:
  
  age (The age of the relative at the time the family member history is recorded.)
- getAgeAge
  
  public Age getAgeAge() throws org.hl7.fhir.exceptions.FHIRException
  
  Returns:
  
  age (The age of the relative at the time the family member history is recorded.)
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- hasAgeAge
  
  public boolean hasAgeAge()
- getAgeRange
  
  public Range getAgeRange() throws org.hl7.fhir.exceptions.FHIRException
  
  Returns:
  
  age (The age of the relative at the time the family member history is recorded.)
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- hasAgeRange
  
  public boolean hasAgeRange()
- getAgeStringType
  
  public StringType getAgeStringType() throws org.hl7.fhir.exceptions.FHIRException
  
  Returns:
  
  age (The age of the relative at the time the family member history is recorded.)
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- hasAgeStringType
  
  public boolean hasAgeStringType()
- hasAge
  
  public boolean hasAge()
- setAge
  
  public FamilyMemberHistory setAge(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
  
  Parameters:
  
  value - age (The age of the relative at the time the family member history is recorded.)
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRFormatError
- getEstimatedAgeElement
  
  public BooleanType getEstimatedAgeElement()
  
  Returns:
  
  estimatedAge (If true, indicates that the age value specified is an estimated value.). This is the underlying object with id, value and extensions. The accessor "getEstimatedAge" gives direct access to the value
- hasEstimatedAgeElement
  
  public boolean hasEstimatedAgeElement()
- hasEstimatedAge
  
  public boolean hasEstimatedAge()
- setEstimatedAgeElement
  
  public FamilyMemberHistory setEstimatedAgeElement(BooleanType value)
  
  Parameters:
  
  value - estimatedAge (If true, indicates that the age value specified is an estimated value.). This is the underlying object with id, value and extensions. The accessor "getEstimatedAge" gives direct access to the value
- getEstimatedAge
  
  public boolean getEstimatedAge()
  
  Returns:
  
  If true, indicates that the age value specified is an estimated value.
- setEstimatedAge
  
  public FamilyMemberHistory setEstimatedAge(boolean value)
  
  Parameters:
  
  value - If true, indicates that the age value specified is an estimated value.
- 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 org.hl7.fhir.exceptions.FHIRException
  
  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:
  
  org.hl7.fhir.exceptions.FHIRException
- hasDeceasedBooleanType
  
  public boolean hasDeceasedBooleanType()
- getDeceasedAge
  
  public Age getDeceasedAge() throws org.hl7.fhir.exceptions.FHIRException
  
  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:
  
  org.hl7.fhir.exceptions.FHIRException
- hasDeceasedAge
  
  public boolean hasDeceasedAge()
- getDeceasedRange
  
  public Range getDeceasedRange() throws org.hl7.fhir.exceptions.FHIRException
  
  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:
  
  org.hl7.fhir.exceptions.FHIRException
- hasDeceasedRange
  
  public boolean hasDeceasedRange()
- getDeceasedDateType
  
  public DateType getDeceasedDateType() throws org.hl7.fhir.exceptions.FHIRException
  
  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:
  
  org.hl7.fhir.exceptions.FHIRException
- hasDeceasedDateType
  
  public boolean hasDeceasedDateType()
- getDeceasedStringType
  
  public StringType getDeceasedStringType() throws org.hl7.fhir.exceptions.FHIRException
  
  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:
  
  org.hl7.fhir.exceptions.FHIRException
- hasDeceasedStringType
  
  public boolean hasDeceasedStringType()
- hasDeceased
  
  public boolean hasDeceased()
- setDeceased
  
  public FamilyMemberHistory setDeceased(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
  
  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.)
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRFormatError
- getReasonCode
  
  public List<CodeableConcept> getReasonCode()
  
  Returns:
  
  reasonCode (Describes why the family member history occurred in coded or textual form.)
- setReasonCode
  
  public FamilyMemberHistory setReasonCode(List<CodeableConcept> theReasonCode)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasReasonCode
  
  public boolean hasReasonCode()
- addReasonCode
  
  public CodeableConcept addReasonCode()
- addReasonCode
  
  public FamilyMemberHistory addReasonCode(CodeableConcept t)
- getReasonCodeFirstRep
  
  public CodeableConcept getReasonCodeFirstRep()
  
  Returns:
  
  The first repetition of repeating field reasonCode, creating it if it does not already exist
- getReasonReference
  
  public List<Reference> getReasonReference()
  
  Returns:
  
  reasonReference (Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.)
- setReasonReference
  
  public FamilyMemberHistory setReasonReference(List<Reference> theReasonReference)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasReasonReference
  
  public boolean hasReasonReference()
- addReasonReference
  
  public Reference addReasonReference()
- addReasonReference
  
  public FamilyMemberHistory addReasonReference(Reference t)
- getReasonReferenceFirstRep
  
  public Reference getReasonReferenceFirstRep()
  
  Returns:
  
  The first repetition of repeating field reasonReference, creating it if it does not already exist
- getReasonReferenceTarget
  
  @Deprecated public List<Resource> getReasonReferenceTarget()
  
  Deprecated.
  Use Reference#setResource(IBaseResource) instead
- getNote
  
  public List<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.)
- setNote
  
  public FamilyMemberHistory setNote(List<Annotation> theNote)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasNote
  
  public boolean hasNote()
- addNote
  
  public Annotation addNote()
- addNote
  
  public FamilyMemberHistory addNote(Annotation t)
- getNoteFirstRep
  
  public Annotation getNoteFirstRep()
  
  Returns:
  
  The first repetition of repeating field note, creating it if it does not already exist
- 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.)
- setCondition
  
  public FamilyMemberHistory setCondition(List<FamilyMemberHistory.FamilyMemberHistoryConditionComponent> theCondition)
  
  Returns:
  
  Returns a reference to this for easy method chaining
- hasCondition
  
  public boolean hasCondition()
- addCondition
  
  public FamilyMemberHistory.FamilyMemberHistoryConditionComponent addCondition()
- addCondition
  
  public FamilyMemberHistory addCondition(FamilyMemberHistory.FamilyMemberHistoryConditionComponent t)
- getConditionFirstRep
  
  public FamilyMemberHistory.FamilyMemberHistoryConditionComponent getConditionFirstRep()
  
  Returns:
  
  The first repetition of repeating field condition, creating it if it does not already exist
- listChildren
  
  protected void listChildren(List<Property> children)
  
  Overrides:
  
  listChildren in class DomainResource
- getNamedProperty
  
  public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getNamedProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- getProperty
  
  public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- setProperty
  
  public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  setProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- setProperty
  
  public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  setProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- makeProperty
  
  public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  makeProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- getTypesForProperty
  
  public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  getTypesForProperty in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- addChild
  
  public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
  
  Overrides:
  
  addChild in class DomainResource
  
  Throws:
  
  org.hl7.fhir.exceptions.FHIRException
- fhirType
  
  public String fhirType()
  
  Specified by:
  
  fhirType in interface org.hl7.fhir.instance.model.api.IBase
  
  Overrides:
  
  fhirType in class DomainResource
- copy
  
  public FamilyMemberHistory copy()
  
  Specified by:
  
  copy in class DomainResource
- typedCopy
  
  protected FamilyMemberHistory typedCopy()
- 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 org.hl7.fhir.instance.model.api.IBase
  
  Overrides:
  
  isEmpty in class DomainResource
- getResourceType
  
  public ResourceType getResourceType()
  
  Specified by:
  
  getResourceType in class Resource

Class FamilyMemberHistory

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class org.hl7.fhir.dstu3.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.IBase

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

Field Details

identifier

definition

definitionTarget

status

notDone

notDoneReason

patient

patientTarget

date

name

relationship

gender

born

age

estimatedAge

deceased

reasonCode

reasonReference

reasonReferenceTarget

note

condition

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

SP_CODE

CODE

SP_GENDER

GENDER

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_DEFINITION

DEFINITION

INCLUDE_DEFINITION

SP_RELATIONSHIP

RELATIONSHIP

SP_STATUS

STATUS

Constructor Details

FamilyMemberHistory

FamilyMemberHistory

Method Details

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getDefinition

setDefinition

hasDefinition

addDefinition

addDefinition

getDefinitionFirstRep

getDefinitionTarget

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus