ca.uhn.fhir.model.dstu.resource

Class FamilyHistory

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

ca.uhn.fhir.model.dstu.resource.FamilyHistory

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

public class FamilyHistory
extends BaseResource
implements IResource

HAPI/FHIR FamilyHistory Resource (Information about patient's relatives, relevant for patient)

Definition: Significant health events and conditions for people related to the subject relevant in the context of care for the subject

Requirements:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FamilyHistory.Relation Block class for child element: FamilyHistory.relation (Relative described by history)
static class	FamilyHistory.RelationCondition Block class for child element: FamilyHistory.relation.condition (Condition that the related person had)

Field Summary

Fields

Modifier and Type	Field and Description
static Include	INCLUDE_SUBJECT Constant for fluent queries to be used to add include statements.
static String	SP_SUBJECT Search parameter constant for subject
static ReferenceClientParam	SUBJECT Fluent Client search parameter constant for subject

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors

Constructor and Description
FamilyHistory()

Method Summary

Methods

Modifier and Type	Method and Description
IdentifierDt	addIdentifier() Adds and returns a new value for identifier (External Id(s) for this record)
FamilyHistory	addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) Adds a new value for identifier (External Id(s) for this record)
FamilyHistory	addIdentifier(String theSystem, String theValue) Adds a new value for identifier (External Id(s) for this record)
FamilyHistory.Relation	addRelation() Adds and returns a new value for relation (Relative described by history)
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
List<IdentifierDt>	getIdentifier() Gets the value(s) for identifier (External Id(s) for this record).
IdentifierDt	getIdentifierFirstRep() Gets the first repetition for identifier (External Id(s) for this record), creating it if it does not already exist.
StringDt	getNote() Gets the value(s) for note (Additional details not covered elsewhere).
List<FamilyHistory.Relation>	getRelation() Gets the value(s) for relation (Relative described by history).
FamilyHistory.Relation	getRelationFirstRep() Gets the first repetition for relation (Relative described by history), creating it if it does not already exist.
ResourceReferenceDt	getSubject() Gets the value(s) for subject (Patient history is about).
boolean	isEmpty()
FamilyHistory	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier (External Id(s) for this record)
FamilyHistory	setNote(String theString) Sets the value for note (Additional details not covered elsewhere)
FamilyHistory	setNote(StringDt theValue) Sets the value(s) for note (Additional details not covered elsewhere)
FamilyHistory	setRelation(List<FamilyHistory.Relation> theValue) Sets the value(s) for relation (Relative described by history)
FamilyHistory	setSubject(ResourceReferenceDt theValue) Sets the value(s) for subject (Patient history is about)

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

getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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

Field Detail

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter constant for subject

Description: The identity of a subject to list family history items for
Type: reference
Path: FamilyHistory.subject

See Also:

Constant Field Values

SUBJECT

public static final ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description: The identity of a subject to list family history items for
Type: reference
Path: FamilyHistory.subject

INCLUDE_SUBJECT

public static final Include INCLUDE_SUBJECT

Constant for fluent queries to be used to add include statements. Specifies the path value of "FamilyHistory.subject".

Constructor Detail

FamilyHistory

public FamilyHistory()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getIdentifier

public List<IdentifierDt> getIdentifier()

Gets the value(s) for identifier (External Id(s) for this record). creating it if it does not exist. Will not return null.

Definition: This records identifiers associated with this family 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 FamilyHistory setIdentifier(List<IdentifierDt> theValue)

Sets the value(s) for identifier (External Id(s) for this record)

Definition: This records identifiers associated with this family 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 (External Id(s) for this record)

Definition: This records identifiers associated with this family 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)

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

Gets the first repetition for identifier (External Id(s) for this record), creating it if it does not already exist.

Definition: This records identifiers associated with this family 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 FamilyHistory addIdentifier(IdentifierUseEnum theUse,
                          String theSystem,
                          String theValue,
                          String theLabel)

Adds a new value for identifier (External Id(s) for this record)

Definition: This records identifiers associated with this family 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)

Returns:

Returns a reference to this object, to allow for simple chaining.

addIdentifier

public FamilyHistory addIdentifier(String theSystem,
                          String theValue)

Adds a new value for identifier (External Id(s) for this record)

Definition: This records identifiers associated with this family 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)

Returns:

Returns a reference to this object, to allow for simple chaining.

getSubject

public ResourceReferenceDt getSubject()

Gets the value(s) for subject (Patient history is about). creating it if it does not exist. Will not return null.

Definition: The person who this history concerns

setSubject

public FamilyHistory setSubject(ResourceReferenceDt theValue)

Sets the value(s) for subject (Patient history is about)

Definition: The person who this history concerns

getNote

public StringDt getNote()

Gets the value(s) for note (Additional details not covered elsewhere). creating it if it does not exist. Will not return null.

Definition: Conveys information about family history not specific to individual relations.

setNote

public FamilyHistory setNote(StringDt theValue)

Sets the value(s) for note (Additional details not covered elsewhere)

Definition: Conveys information about family history not specific to individual relations.

setNote

public FamilyHistory setNote(String theString)

Sets the value for note (Additional details not covered elsewhere)

Definition: Conveys information about family history not specific to individual relations.

getRelation

public List<FamilyHistory.Relation> getRelation()

Gets the value(s) for relation (Relative described by history). creating it if it does not exist. Will not return null.

Definition: The related person. Each FamilyHistory resource contains the entire family history for a single person.

setRelation

public FamilyHistory setRelation(List<FamilyHistory.Relation> theValue)

Sets the value(s) for relation (Relative described by history)

Definition: The related person. Each FamilyHistory resource contains the entire family history for a single person.

addRelation

public FamilyHistory.Relation addRelation()

Adds and returns a new value for relation (Relative described by history)

Definition: The related person. Each FamilyHistory resource contains the entire family history for a single person.

getRelationFirstRep

public FamilyHistory.Relation getRelationFirstRep()

Gets the first repetition for relation (Relative described by history), creating it if it does not already exist.

Definition: The related person. Each FamilyHistory resource contains the entire family history for a single person.