Package org.hl7.fhir.r5.openehr

Class INSTRUCTION

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

org.hl7.fhir.r5.openehr.ENTRY

org.hl7.fhir.r5.openehr.CARE_ENTRY

org.hl7.fhir.r5.openehr.INSTRUCTION

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

Used to specify actions in the future. Enables simple and complex specifications to be expressed, including in a fully-computable workflow form. Used for any actionable statement such as medication and therapeutic orders, monitoring, recall and review. Enough details must be provided for the specification to be directly executed by an actor, either human or machine. Not to be used for plan items which are only specified in general terms.

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<ACTIVITY>	activitiesList	List of all activities in Instruction.
protected DV_DATE_TIME	expiry_time	Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired.
protected DV_TEXT	narrative	Mandatory human-readable version of what the Instruction is about.
protected DV_PARSABLE	wf_definition	Optional workflow engine executable expression of the Instruction.

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

guideline_id, protocol

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

encoding, language, other_participationsList, provider, subject, workflow_id

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
INSTRUCTION()	Constructor
INSTRUCTION(DV_TEXT narrative)	Constructor

Method Summary

Modifier and Type	Method	Description
ACTIVITY	addActivities()
INSTRUCTION	addActivities(ACTIVITY t)
Base	addChild(String name)
INSTRUCTION	copy()
void	copyValues(INSTRUCTION dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
ACTIVITY	getActivitiesFirstRep()
List<ACTIVITY>	getActivitiesList()
DV_DATE_TIME	getExpiry_time()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
DV_TEXT	getNarrative()
Base[]	getProperty(int hash, String name, boolean checkValid)
String[]	getTypesForProperty(int hash, String name)
DV_PARSABLE	getWf_definition()
boolean	hasActivities()
boolean	hasExpiry_time()
boolean	hasNarrative()
boolean	hasWf_definition()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
INSTRUCTION	setActivitiesList(List<ACTIVITY> theActivities)
INSTRUCTION	setExpiry_time(DV_DATE_TIME value)
INSTRUCTION	setNarrative(DV_TEXT value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
INSTRUCTION	setWf_definition(DV_PARSABLE value)
protected INSTRUCTION	typedCopy()

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

copyValues, getGuideline_id, getProtocol, hasGuideline_id, hasProtocol, setGuideline_id, setProtocol

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

addOther_participations, addOther_participations, copyValues, getEncoding, getLanguage, getOther_participationsFirstRep, getOther_participationsList, getProvider, getSubject, getWorkflow_id, hasEncoding, hasLanguage, hasOther_participations, hasProvider, hasSubject, hasWorkflow_id, setEncoding, setLanguage, setOther_participationsList, setProvider, setSubject, setWorkflow_id

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

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

narrative

protected DV_TEXT narrative

Mandatory human-readable version of what the Instruction is about.

expiry_time

protected DV_DATE_TIME expiry_time

Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. This helps prevent false listing of Instructions as Active when they clearly must have been terminated in some way or other.

wf_definition

protected DV_PARSABLE wf_definition

Optional workflow engine executable expression of the Instruction.

activitiesList

protected List<ACTIVITY> activitiesList

List of all activities in Instruction.

Constructor Details

INSTRUCTION

public INSTRUCTION()

Constructor

INSTRUCTION

public INSTRUCTION(DV_TEXT narrative)

Constructor

Method Details

getNarrative

public DV_TEXT getNarrative()

Returns:

narrative (Mandatory human-readable version of what the Instruction is about.)

hasNarrative

public boolean hasNarrative()

setNarrative

public INSTRUCTION setNarrative(DV_TEXT value)

Parameters:

value - narrative (Mandatory human-readable version of what the Instruction is about.)

getExpiry_time

public DV_DATE_TIME getExpiry_time()

Returns:

expiry_time (Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. This helps prevent false listing of Instructions as Active when they clearly must have been terminated in some way or other.)

hasExpiry_time

public boolean hasExpiry_time()

setExpiry_time

public INSTRUCTION setExpiry_time(DV_DATE_TIME value)

Parameters:

value - expiry_time (Optional expiry date/time to assist determination of when an Instruction can be assumed to have expired. This helps prevent false listing of Instructions as Active when they clearly must have been terminated in some way or other.)

getWf_definition

public DV_PARSABLE getWf_definition()

Returns:

wf_definition (Optional workflow engine executable expression of the Instruction.)

hasWf_definition

public boolean hasWf_definition()

setWf_definition

public INSTRUCTION setWf_definition(DV_PARSABLE value)

Parameters:

value - wf_definition (Optional workflow engine executable expression of the Instruction.)

getActivitiesList

public List<ACTIVITY> getActivitiesList()

Returns:

invalid reference

#activities

(List of all activities in Instruction.)

setActivitiesList

public INSTRUCTION setActivitiesList(List<ACTIVITY> theActivities)

Returns:

Returns a reference to this for easy method chaining

hasActivities

public boolean hasActivities()

addActivities

public ACTIVITY addActivities()

addActivities

public INSTRUCTION addActivities(ACTIVITY t)

getActivitiesFirstRep

public ACTIVITY getActivitiesFirstRep()

Returns:

The first repetition of repeating field

invalid reference

#activities

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

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class CARE_ENTRY

getNamedProperty

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

Overrides:

getNamedProperty in class CARE_ENTRY

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 CARE_ENTRY

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 CARE_ENTRY

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class CARE_ENTRY

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class CARE_ENTRY

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class CARE_ENTRY

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class CARE_ENTRY

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 CARE_ENTRY

Returns:

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

copy

public INSTRUCTION copy()

Specified by:

copy in class CARE_ENTRY

copyValues

public void copyValues(INSTRUCTION dst)

typedCopy

protected INSTRUCTION typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class CARE_ENTRY

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class CARE_ENTRY

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class CARE_ENTRY