Package org.hl7.fhir.r5.openehr

Class HISTORY

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.LogicalBase

org.hl7.fhir.r5.openehr.Any

org.hl7.fhir.r5.openehr.PATHABLE

org.hl7.fhir.r5.openehr.LOCATABLE

org.hl7.fhir.r5.openehr.DATA_STRUCTURE

org.hl7.fhir.r5.openehr.HISTORY

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType

public class HISTORY
extends DATA_STRUCTURE
implements org.hl7.fhir.instance.model.api.ICompositeType

Root object of a linear history, i.e. time series structure. This is a generic class whose type parameter must be a descendant of ITEM_STRUCTURE, ensuring that each Event in the events of a given instance is of the same structural type, i.e. ITEM_TREE, ITEM_LIST etc. For a periodic series of events, period will be set, and the time of each Event in the History must correspond; i.e. the EVENT.offset must be a multiple of period for each Event. Missing events in a period History are however allowed.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected DV_DURATION	duration	Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.
protected List<EVENT>	eventsList	The events in the series.
protected DV_DATE_TIME	origin	Time origin of this event history.
protected DV_DURATION	period	Period between samples in this segment if periodic.
protected ITEM_STRUCTURE	summary	Optional summary data that aggregates, organizes, reduces and transforms the event series.

Fields inherited from class org.hl7.fhir.r5.openehr.PATHABLE

archetype_details, archetype_node_id, feeder_audit, linksList, name, uid

Constructor Summary

Constructors

Constructor	Description
HISTORY()	Constructor
HISTORY(DV_DATE_TIME origin)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
HISTORY	addEvents(EVENT t)
HISTORY	copy()
void	copyValues(HISTORY dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
DV_DURATION	getDuration()
List<EVENT>	getEventsList()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
DV_DATE_TIME	getOrigin()
DV_DURATION	getPeriod()
Base[]	getProperty(int hash, String name, boolean checkValid)
ITEM_STRUCTURE	getSummary()
String[]	getTypesForProperty(int hash, String name)
boolean	hasDuration()
boolean	hasEvents()
boolean	hasOrigin()
boolean	hasPeriod()
boolean	hasSummary()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
HISTORY	setDuration(DV_DURATION value)
HISTORY	setEventsList(List<EVENT> theEvents)
HISTORY	setOrigin(DV_DATE_TIME value)
HISTORY	setPeriod(DV_DURATION value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
HISTORY	setSummary(ITEM_STRUCTURE value)
protected HISTORY	typedCopy()

Methods inherited from class org.hl7.fhir.r5.openehr.DATA_STRUCTURE

copyValues

Methods inherited from class org.hl7.fhir.r5.openehr.LOCATABLE

copyValues

Methods inherited from class org.hl7.fhir.r5.openehr.PATHABLE

addLinks, addLinks, copyValues, getArchetype_details, getArchetype_node_id, getArchetype_node_idElement, getFeeder_audit, getLinksFirstRep, getLinksList, getName, getUid, hasArchetype_details, hasArchetype_node_id, hasArchetype_node_idElement, hasFeeder_audit, hasLinks, hasName, hasUid, setArchetype_details, setArchetype_node_id, setArchetype_node_idElement, setFeeder_audit, setLinksList, setName, setUid

Methods inherited from class org.hl7.fhir.r5.openehr.Any

copyValues

Methods inherited from class org.hl7.fhir.r5.model.LogicalBase

getFHIRPublicationVersion, getIdBase, setIdBase

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, removeChild, setCopyUserData, setUserData, setUserDataINN, setXhtml

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

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Field Details

origin

protected DV_DATE_TIME origin

Time origin of this event history. The first event is not necessarily at the origin point.

period

protected DV_DURATION period

Period between samples in this segment if periodic.

duration

protected DV_DURATION duration

Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.

summary

protected ITEM_STRUCTURE summary

Optional summary data that aggregates, organizes, reduces and transforms the event series. This may be a text or image that presents a graphical presentation, or some data that assists with the interpretation of the data

eventsList

protected List<EVENT> eventsList

The events in the series. This attribute is of a generic type whose parameter must be a descendant of ITEM_STRUCTURE

Constructor Details

HISTORY

public HISTORY()

Constructor

HISTORY

public HISTORY(DV_DATE_TIME origin)

Constructor

Method Details

getOrigin

public DV_DATE_TIME getOrigin()

Returns:

origin (Time origin of this event history. The first event is not necessarily at the origin point.)

hasOrigin

public boolean hasOrigin()

setOrigin

public HISTORY setOrigin(DV_DATE_TIME value)

Parameters:

value - origin (Time origin of this event history. The first event is not necessarily at the origin point.)

getPeriod

public DV_DURATION getPeriod()

Returns:

period (Period between samples in this segment if periodic.)

hasPeriod

public boolean hasPeriod()

setPeriod

public HISTORY setPeriod(DV_DURATION value)

Parameters:

value - period (Period between samples in this segment if periodic.)

getDuration

public DV_DURATION getDuration()

Returns:

duration (Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.)

hasDuration

public boolean hasDuration()

setDuration

public HISTORY setDuration(DV_DURATION value)

Parameters:

value - duration (Duration of the entire History; either corresponds to the duration of all the events, and/or the duration represented by the summary, if it exists.)

getSummary

public ITEM_STRUCTURE getSummary()

Returns:

summary (Optional summary data that aggregates, organizes, reduces and transforms the event series. This may be a text or image that presents a graphical presentation, or some data that assists with the interpretation of the data)

hasSummary

public boolean hasSummary()

setSummary

public HISTORY setSummary(ITEM_STRUCTURE value)

Parameters:

value - summary (Optional summary data that aggregates, organizes, reduces and transforms the event series. This may be a text or image that presents a graphical presentation, or some data that assists with the interpretation of the data)

getEventsList

public List<EVENT> getEventsList()

Returns:

invalid reference

#events

(The events in the series. This attribute is of a generic type whose parameter must be a descendant of ITEM_STRUCTURE)

setEventsList

public HISTORY setEventsList(List<EVENT> theEvents)

Returns:

Returns a reference to this for easy method chaining

hasEvents

public boolean hasEvents()

addEvents

public HISTORY addEvents(EVENT t)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class PATHABLE

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class PATHABLE

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 PATHABLE

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 PATHABLE

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class PATHABLE

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class PATHABLE

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class PATHABLE

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class PATHABLE

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 DATA_STRUCTURE

Returns:

the FHIR type name of the instance (not the java class name)

copy

public HISTORY copy()

Specified by:

copy in class DATA_STRUCTURE

copyValues

public void copyValues(HISTORY dst)

typedCopy

protected HISTORY typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class PATHABLE

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class PATHABLE

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class PATHABLE