Package org.hl7.fhir.dstu2.model

Class FamilyMemberHistory

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.BaseResource

org.hl7.fhir.dstu2.model.Resource

org.hl7.fhir.dstu2.model.DomainResource

org.hl7.fhir.dstu2.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 enum	FamilyMemberHistory.FamilyHistoryStatus
static class	FamilyMemberHistory.FamilyHistoryStatusEnumFactory
static class	FamilyMemberHistory.FamilyMemberHistoryConditionComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected Type	age	The actual or approximate 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.
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.
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 Enumeration<Enumerations.AdministrativeGender>	gender	Administrative Gender - the gender that the relative is considered to have for administration and record keeping purposes.
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.
protected StringType	name	This will either be a name or a description; e.g.
protected 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.
protected Patient	patientTarget	The actual object that is the target of the reference (The person who this history concerns.)
protected CodeableConcept	relationship	The type of relationship this person has to the patient (father, mother, brother etc.).
static final String	SP_CODE
static final String	SP_DATE
static final String	SP_GENDER
static final String	SP_IDENTIFIER
static final String	SP_PATIENT
static final String	SP_RELATIONSHIP
protected Enumeration<FamilyMemberHistory.FamilyHistoryStatus>	status	A code specifying a state of a Family Member History record.

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
FamilyMemberHistory.FamilyMemberHistoryConditionComponent	addCondition()
FamilyMemberHistory	addCondition(FamilyMemberHistory.FamilyMemberHistoryConditionComponent t)
Identifier	addIdentifier()
FamilyMemberHistory	addIdentifier(Identifier 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()
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()
protected void	listChildren(List<Property> childrenList)
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)
void	setProperty(String name, Base value)
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.dstu2.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText

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

getStructureFhirVersionEnum, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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, isDeleted, 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).

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.

status

protected Enumeration<FamilyMemberHistory.FamilyHistoryStatus> status

A code specifying a state of a Family Member History record.

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 actual or approximate age of the relative at the time the family member history is recorded.

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.

note

protected 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

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 Details

FamilyMemberHistory

public FamilyMemberHistory()

FamilyMemberHistory

public FamilyMemberHistory(Reference patient,
 Enumeration<FamilyMemberHistory.FamilyHistoryStatus> status,
 CodeableConcept relationship)

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).)

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 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)

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 org.hl7.fhir.exceptions.FHIRException

Returns:

age (The actual or approximate 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 actual or approximate 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 actual or approximate 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)

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 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)

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)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

setProperty

public void setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty 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