Package org.hl7.fhir.r5.openehr

Class EHR

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

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 EHR
extends Any
implements org.hl7.fhir.instance.model.api.ICompositeType

The EHR object is the root object and access point of an EHR for a subject of care.

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 List<OBJECT_REF>	compositionsList	Master list of all Versioned Composition references in this EHR.
protected List<OBJECT_REF>	contributionsList	List of contributions causing changes to this EHR.
protected OBJECT_REF	directory	Optional directory structure for this EHR.
protected OBJECT_REF	ehr_access	Reference to EHR_ACCESS object for this EHR.
protected HIER_OBJECT_ID	ehr_id	The unique identifier of this EHR.
protected OBJECT_REF	ehr_status	Reference to EHR_STATUS object for this EHR.
protected List<OBJECT_REF>	foldersList	Optional additional Folder structures for this EHR.
protected List<HIER_OBJECT_ID>	system_idList	The identifier of the logical EHR management system in which this EHR was created.
protected List<OBJECT_REF>	tagsList	Optional list of tags associated with this EHR.
protected DV_DATE_TIME	time_created	Time of creation of the EHR.

Constructor Summary

Constructors

Constructor	Description
EHR()	Constructor
EHR(HIER_OBJECT_ID system_id, HIER_OBJECT_ID ehr_id, OBJECT_REF ehr_status, OBJECT_REF ehr_access, DV_DATE_TIME time_created)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
OBJECT_REF	addCompositions()
EHR	addCompositions(OBJECT_REF t)
OBJECT_REF	addContributions()
EHR	addContributions(OBJECT_REF t)
OBJECT_REF	addFolders()
EHR	addFolders(OBJECT_REF t)
HIER_OBJECT_ID	addSystem_id()
EHR	addSystem_id(HIER_OBJECT_ID t)
OBJECT_REF	addTags()
EHR	addTags(OBJECT_REF t)
EHR	copy()
void	copyValues(EHR dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
OBJECT_REF	getCompositionsFirstRep()
List<OBJECT_REF>	getCompositionsList()
OBJECT_REF	getContributionsFirstRep()
List<OBJECT_REF>	getContributionsList()
OBJECT_REF	getDirectory()
OBJECT_REF	getEhr_access()
HIER_OBJECT_ID	getEhr_id()
OBJECT_REF	getEhr_status()
OBJECT_REF	getFoldersFirstRep()
List<OBJECT_REF>	getFoldersList()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
HIER_OBJECT_ID	getSystem_idFirstRep()
List<HIER_OBJECT_ID>	getSystem_idList()
OBJECT_REF	getTagsFirstRep()
List<OBJECT_REF>	getTagsList()
DV_DATE_TIME	getTime_created()
String[]	getTypesForProperty(int hash, String name)
boolean	hasCompositions()
boolean	hasContributions()
boolean	hasDirectory()
boolean	hasEhr_access()
boolean	hasEhr_id()
boolean	hasEhr_status()
boolean	hasFolders()
boolean	hasSystem_id()
boolean	hasTags()
boolean	hasTime_created()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
EHR	setCompositionsList(List<OBJECT_REF> theCompositions)
EHR	setContributionsList(List<OBJECT_REF> theContributions)
EHR	setDirectory(OBJECT_REF value)
EHR	setEhr_access(OBJECT_REF value)
EHR	setEhr_id(HIER_OBJECT_ID value)
EHR	setEhr_status(OBJECT_REF value)
EHR	setFoldersList(List<OBJECT_REF> theFolders)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
EHR	setSystem_idList(List<HIER_OBJECT_ID> theSystem_id)
EHR	setTagsList(List<OBJECT_REF> theTags)
EHR	setTime_created(DV_DATE_TIME value)
protected EHR	typedCopy()

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

system_idList

protected List<HIER_OBJECT_ID> system_idList

The identifier of the logical EHR management system in which this EHR was created.

ehr_id

protected HIER_OBJECT_ID ehr_id

The unique identifier of this EHR. NOTE: it is strongly recommended that a UUID always be used for this field.

contributionsList

protected List<OBJECT_REF> contributionsList

List of contributions causing changes to this EHR. Each contribution contains a list of versions, which may include references to any number of VERSION instances, i.e. items of type VERSIONED_COMPOSITION and VERSIONED_FOLDER.

ehr_status

protected OBJECT_REF ehr_status

Reference to EHR_STATUS object for this EHR.

ehr_access

protected OBJECT_REF ehr_access

Reference to EHR_ACCESS object for this EHR.

compositionsList

protected List<OBJECT_REF> compositionsList

Master list of all Versioned Composition references in this EHR.

directory

protected OBJECT_REF directory

Optional directory structure for this EHR. If present, this is a reference to the first member of folders.

time_created

protected DV_DATE_TIME time_created

Time of creation of the EHR.

foldersList

protected List<OBJECT_REF> foldersList

Optional additional Folder structures for this EHR. If set, the directory attribute refers to the first member

tagsList

protected List<OBJECT_REF> tagsList

Optional list of tags associated with this EHR. Tag target values can only be within the same EHR.

Constructor Details

EHR

public EHR()

Constructor

EHR

public EHR(HIER_OBJECT_ID system_id,
 HIER_OBJECT_ID ehr_id,
 OBJECT_REF ehr_status,
 OBJECT_REF ehr_access,
 DV_DATE_TIME time_created)

Constructor

Method Details

getSystem_idList

public List<HIER_OBJECT_ID> getSystem_idList()

Returns:

invalid reference

#system_id

(The identifier of the logical EHR management system in which this EHR was created.)

setSystem_idList

public EHR setSystem_idList(List<HIER_OBJECT_ID> theSystem_id)

Returns:

Returns a reference to this for easy method chaining

hasSystem_id

public boolean hasSystem_id()

addSystem_id

public HIER_OBJECT_ID addSystem_id()

addSystem_id

public EHR addSystem_id(HIER_OBJECT_ID t)

getSystem_idFirstRep

public HIER_OBJECT_ID getSystem_idFirstRep()

Returns:

The first repetition of repeating field

invalid reference

#system_id

, creating it if it does not already exist {3}

getEhr_id

public HIER_OBJECT_ID getEhr_id()

Returns:

ehr_id (The unique identifier of this EHR. NOTE: it is strongly recommended that a UUID always be used for this field.)

hasEhr_id

public boolean hasEhr_id()

setEhr_id

public EHR setEhr_id(HIER_OBJECT_ID value)

Parameters:

value - ehr_id (The unique identifier of this EHR. NOTE: it is strongly recommended that a UUID always be used for this field.)

getContributionsList

public List<OBJECT_REF> getContributionsList()

Returns:

invalid reference

#contributions

(List of contributions causing changes to this EHR. Each contribution contains a list of versions, which may include references to any number of VERSION instances, i.e. items of type VERSIONED_COMPOSITION and VERSIONED_FOLDER.)

setContributionsList

public EHR setContributionsList(List<OBJECT_REF> theContributions)

Returns:

Returns a reference to this for easy method chaining

hasContributions

public boolean hasContributions()

addContributions

public OBJECT_REF addContributions()

addContributions

public EHR addContributions(OBJECT_REF t)

getContributionsFirstRep

public OBJECT_REF getContributionsFirstRep()

Returns:

The first repetition of repeating field

invalid reference

#contributions

, creating it if it does not already exist {3}

getEhr_status

public OBJECT_REF getEhr_status()

Returns:

ehr_status (Reference to EHR_STATUS object for this EHR.)

hasEhr_status

public boolean hasEhr_status()

setEhr_status

public EHR setEhr_status(OBJECT_REF value)

Parameters:

value - ehr_status (Reference to EHR_STATUS object for this EHR.)

getEhr_access

public OBJECT_REF getEhr_access()

Returns:

ehr_access (Reference to EHR_ACCESS object for this EHR.)

hasEhr_access

public boolean hasEhr_access()

setEhr_access

public EHR setEhr_access(OBJECT_REF value)

Parameters:

value - ehr_access (Reference to EHR_ACCESS object for this EHR.)

getCompositionsList

public List<OBJECT_REF> getCompositionsList()

Returns:

invalid reference

#compositions

(Master list of all Versioned Composition references in this EHR.)

setCompositionsList

public EHR setCompositionsList(List<OBJECT_REF> theCompositions)

Returns:

Returns a reference to this for easy method chaining

hasCompositions

public boolean hasCompositions()

addCompositions

public OBJECT_REF addCompositions()

addCompositions

public EHR addCompositions(OBJECT_REF t)

getCompositionsFirstRep

public OBJECT_REF getCompositionsFirstRep()

Returns:

The first repetition of repeating field

invalid reference

#compositions

, creating it if it does not already exist {3}

getDirectory

public OBJECT_REF getDirectory()

Returns:

directory (Optional directory structure for this EHR. If present, this is a reference to the first member of folders.)

hasDirectory

public boolean hasDirectory()

setDirectory

public EHR setDirectory(OBJECT_REF value)

Parameters:

value - directory (Optional directory structure for this EHR. If present, this is a reference to the first member of folders.)

getTime_created

public DV_DATE_TIME getTime_created()

Returns:

time_created (Time of creation of the EHR.)

hasTime_created

public boolean hasTime_created()

setTime_created

public EHR setTime_created(DV_DATE_TIME value)

Parameters:

value - time_created (Time of creation of the EHR.)

getFoldersList

public List<OBJECT_REF> getFoldersList()

Returns:

invalid reference

#folders

(Optional additional Folder structures for this EHR. If set, the directory attribute refers to the first member)

setFoldersList

public EHR setFoldersList(List<OBJECT_REF> theFolders)

Returns:

Returns a reference to this for easy method chaining

hasFolders

public boolean hasFolders()

addFolders

public OBJECT_REF addFolders()

addFolders

public EHR addFolders(OBJECT_REF t)

getFoldersFirstRep

public OBJECT_REF getFoldersFirstRep()

Returns:

The first repetition of repeating field

invalid reference

#folders

, creating it if it does not already exist {3}

getTagsList

public List<OBJECT_REF> getTagsList()

Returns:

invalid reference

#tags

(Optional list of tags associated with this EHR. Tag target values can only be within the same EHR.)

setTagsList

public EHR setTagsList(List<OBJECT_REF> theTags)

Returns:

Returns a reference to this for easy method chaining

hasTags

public boolean hasTags()

addTags

public OBJECT_REF addTags()

addTags

public EHR addTags(OBJECT_REF t)

getTagsFirstRep

public OBJECT_REF getTagsFirstRep()

Returns:

The first repetition of repeating field

invalid reference

#tags

, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Base

getNamedProperty

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

Overrides:

getNamedProperty in class Base

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 Base

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 Base

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class Base

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 Any

Returns:

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

copy

public EHR copy()

Specified by:

copy in class Any

copyValues

public void copyValues(EHR dst)

typedCopy

protected EHR typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Base

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Base

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class Base