org.eclipse.ohf.ihe.common.cdar2
Interface POCDMT000040SubstanceAdministration

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
POCDMT000040SubstanceAdministrationImpl

public interface POCDMT000040SubstanceAdministration
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'POCDMT000040 Substance Administration'.

The following features are supported:

See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration()

Method Summary
 CE getAdministrationUnitCode()
          Returns the value of the 'Administration Unit Code' containment reference.
 org.eclipse.emf.common.util.EList getApproachSiteCode()
          Returns the value of the 'Approach Site Code' containment reference list.
 org.eclipse.emf.common.util.EList getAuthor()
          Returns the value of the 'Author' containment reference list.
 org.eclipse.emf.common.util.Enumerator getClassCode()
          Returns the value of the 'Class Code' attribute.
 CD getCode()
          Returns the value of the 'Code' containment reference.
 POCDMT000040Consumable getConsumable()
          Returns the value of the 'Consumable' containment reference.
 IVLPQ getDoseQuantity()
          Returns the value of the 'Dose Quantity' containment reference.
 org.eclipse.emf.common.util.EList getEffectiveTime()
          Returns the value of the 'Effective Time' containment reference list.
 org.eclipse.emf.common.util.EList getEntryRelationship()
          Returns the value of the 'Entry Relationship' containment reference list.
 org.eclipse.emf.common.util.EList getId()
          Returns the value of the 'Id' containment reference list.
 org.eclipse.emf.common.util.EList getInformant()
          Returns the value of the 'Informant' containment reference list.
 RTOPQPQ getMaxDoseQuantity()
          Returns the value of the 'Max Dose Quantity' containment reference.
 XDocumentSubstanceMood getMoodCode()
          Returns the value of the 'Mood Code' attribute.
 org.eclipse.emf.common.util.Enumerator getNullFlavor()
          Returns the value of the 'Null Flavor' attribute.
 org.eclipse.emf.common.util.EList getParticipant()
          Returns the value of the 'Participant' containment reference list.
 org.eclipse.emf.common.util.EList getPerformer()
          Returns the value of the 'Performer' containment reference list.
 org.eclipse.emf.common.util.EList getPrecondition()
          Returns the value of the 'Precondition' containment reference list.
 CE getPriorityCode()
          Returns the value of the 'Priority Code' containment reference.
 IVLPQ getRateQuantity()
          Returns the value of the 'Rate Quantity' containment reference.
 org.eclipse.emf.common.util.EList getRealmCode()
          Returns the value of the 'Realm Code' containment reference list.
 org.eclipse.emf.common.util.EList getReference()
          Returns the value of the 'Reference' containment reference list.
 IVLINT getRepeatNumber()
          Returns the value of the 'Repeat Number' containment reference.
 CE getRouteCode()
          Returns the value of the 'Route Code' containment reference.
 org.eclipse.emf.common.util.EList getSpecimen()
          Returns the value of the 'Specimen' containment reference list.
 CS1 getStatusCode()
          Returns the value of the 'Status Code' containment reference.
 POCDMT000040Subject getSubject()
          Returns the value of the 'Subject' containment reference.
 org.eclipse.emf.common.util.EList getTemplateId()
          Returns the value of the 'Template Id' containment reference list.
 ED getText()
          Returns the value of the 'Text' containment reference.
 POCDMT000040InfrastructureRootTypeId getTypeId()
          Returns the value of the 'Type Id' containment reference.
 boolean isNegationInd()
          Returns the value of the 'Negation Ind' attribute.
 boolean isSetClassCode()
          Returns whether the value of the 'Class Code' attribute is set.
 boolean isSetMoodCode()
          Returns whether the value of the 'Mood Code' attribute is set.
 boolean isSetNegationInd()
          Returns whether the value of the 'Negation Ind' attribute is set.
 void setAdministrationUnitCode(CE value)
          Sets the value of the 'Administration Unit Code' containment reference.
 void setClassCode(org.eclipse.emf.common.util.Enumerator value)
          Sets the value of the 'Class Code' attribute.
 void setCode(CD value)
          Sets the value of the 'Code' containment reference.
 void setConsumable(POCDMT000040Consumable value)
          Sets the value of the 'Consumable' containment reference.
 void setDoseQuantity(IVLPQ value)
          Sets the value of the 'Dose Quantity' containment reference.
 void setMaxDoseQuantity(RTOPQPQ value)
          Sets the value of the 'Max Dose Quantity' containment reference.
 void setMoodCode(XDocumentSubstanceMood value)
          Sets the value of the 'Mood Code' attribute.
 void setNegationInd(boolean value)
          Sets the value of the 'Negation Ind' attribute.
 void setNullFlavor(org.eclipse.emf.common.util.Enumerator value)
          Sets the value of the 'Null Flavor' attribute.
 void setPriorityCode(CE value)
          Sets the value of the 'Priority Code' containment reference.
 void setRateQuantity(IVLPQ value)
          Sets the value of the 'Rate Quantity' containment reference.
 void setRepeatNumber(IVLINT value)
          Sets the value of the 'Repeat Number' containment reference.
 void setRouteCode(CE value)
          Sets the value of the 'Route Code' containment reference.
 void setStatusCode(CS1 value)
          Sets the value of the 'Status Code' containment reference.
 void setSubject(POCDMT000040Subject value)
          Sets the value of the 'Subject' containment reference.
 void setText(ED value)
          Sets the value of the 'Text' containment reference.
 void setTypeId(POCDMT000040InfrastructureRootTypeId value)
          Sets the value of the 'Type Id' containment reference.
 void unsetClassCode()
          Unsets the value of the 'Class Code' attribute.
 void unsetMoodCode()
          Unsets the value of the 'Mood Code' attribute.
 void unsetNegationInd()
          Unsets the value of the 'Negation Ind' attribute.
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getRealmCode

org.eclipse.emf.common.util.EList getRealmCode()
Returns the value of the 'Realm Code' containment reference list. The list contents are of type CS1.

If the meaning of the 'Realm Code' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Realm Code' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_RealmCode()

getTypeId

POCDMT000040InfrastructureRootTypeId getTypeId()
Returns the value of the 'Type Id' containment reference.

If the meaning of the 'Type Id' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Type Id' containment reference.
See Also:
setTypeId(POCDMT000040InfrastructureRootTypeId), CDAR2Package.getPOCDMT000040SubstanceAdministration_TypeId()

setTypeId

void setTypeId(POCDMT000040InfrastructureRootTypeId value)
Sets the value of the 'Type Id' containment reference.

Parameters:
value - the new value of the 'Type Id' containment reference.
See Also:
getTypeId()

getTemplateId

org.eclipse.emf.common.util.EList getTemplateId()
Returns the value of the 'Template Id' containment reference list. The list contents are of type II.

If the meaning of the 'Template Id' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Template Id' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_TemplateId()

getId

org.eclipse.emf.common.util.EList getId()
Returns the value of the 'Id' containment reference list. The list contents are of type II.

If the meaning of the 'Id' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_Id()

getCode

CD getCode()
Returns the value of the 'Code' containment reference.

If the meaning of the 'Code' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Code' containment reference.
See Also:
setCode(CD), CDAR2Package.getPOCDMT000040SubstanceAdministration_Code()

setCode

void setCode(CD value)
Sets the value of the 'Code' containment reference.

Parameters:
value - the new value of the 'Code' containment reference.
See Also:
getCode()

getText

ED getText()
Returns the value of the 'Text' containment reference.

If the meaning of the 'Text' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Text' containment reference.
See Also:
setText(ED), CDAR2Package.getPOCDMT000040SubstanceAdministration_Text()

setText

void setText(ED value)
Sets the value of the 'Text' containment reference.

Parameters:
value - the new value of the 'Text' containment reference.
See Also:
getText()

getStatusCode

CS1 getStatusCode()
Returns the value of the 'Status Code' containment reference.

If the meaning of the 'Status Code' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Status Code' containment reference.
See Also:
setStatusCode(CS1), CDAR2Package.getPOCDMT000040SubstanceAdministration_StatusCode()

setStatusCode

void setStatusCode(CS1 value)
Sets the value of the 'Status Code' containment reference.

Parameters:
value - the new value of the 'Status Code' containment reference.
See Also:
getStatusCode()

getEffectiveTime

org.eclipse.emf.common.util.EList getEffectiveTime()
Returns the value of the 'Effective Time' containment reference list. The list contents are of type SXCMTS.

If the meaning of the 'Effective Time' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Effective Time' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_EffectiveTime()

getPriorityCode

CE getPriorityCode()
Returns the value of the 'Priority Code' containment reference.

If the meaning of the 'Priority Code' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Priority Code' containment reference.
See Also:
setPriorityCode(CE), CDAR2Package.getPOCDMT000040SubstanceAdministration_PriorityCode()

setPriorityCode

void setPriorityCode(CE value)
Sets the value of the 'Priority Code' containment reference.

Parameters:
value - the new value of the 'Priority Code' containment reference.
See Also:
getPriorityCode()

getRepeatNumber

IVLINT getRepeatNumber()
Returns the value of the 'Repeat Number' containment reference.

If the meaning of the 'Repeat Number' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Repeat Number' containment reference.
See Also:
setRepeatNumber(IVLINT), CDAR2Package.getPOCDMT000040SubstanceAdministration_RepeatNumber()

setRepeatNumber

void setRepeatNumber(IVLINT value)
Sets the value of the 'Repeat Number' containment reference.

Parameters:
value - the new value of the 'Repeat Number' containment reference.
See Also:
getRepeatNumber()

getRouteCode

CE getRouteCode()
Returns the value of the 'Route Code' containment reference.

If the meaning of the 'Route Code' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Route Code' containment reference.
See Also:
setRouteCode(CE), CDAR2Package.getPOCDMT000040SubstanceAdministration_RouteCode()

setRouteCode

void setRouteCode(CE value)
Sets the value of the 'Route Code' containment reference.

Parameters:
value - the new value of the 'Route Code' containment reference.
See Also:
getRouteCode()

getApproachSiteCode

org.eclipse.emf.common.util.EList getApproachSiteCode()
Returns the value of the 'Approach Site Code' containment reference list. The list contents are of type CD.

If the meaning of the 'Approach Site Code' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Approach Site Code' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_ApproachSiteCode()

getDoseQuantity

IVLPQ getDoseQuantity()
Returns the value of the 'Dose Quantity' containment reference.

If the meaning of the 'Dose Quantity' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Dose Quantity' containment reference.
See Also:
setDoseQuantity(IVLPQ), CDAR2Package.getPOCDMT000040SubstanceAdministration_DoseQuantity()

setDoseQuantity

void setDoseQuantity(IVLPQ value)
Sets the value of the 'Dose Quantity' containment reference.

Parameters:
value - the new value of the 'Dose Quantity' containment reference.
See Also:
getDoseQuantity()

getRateQuantity

IVLPQ getRateQuantity()
Returns the value of the 'Rate Quantity' containment reference.

If the meaning of the 'Rate Quantity' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Rate Quantity' containment reference.
See Also:
setRateQuantity(IVLPQ), CDAR2Package.getPOCDMT000040SubstanceAdministration_RateQuantity()

setRateQuantity

void setRateQuantity(IVLPQ value)
Sets the value of the 'Rate Quantity' containment reference.

Parameters:
value - the new value of the 'Rate Quantity' containment reference.
See Also:
getRateQuantity()

getMaxDoseQuantity

RTOPQPQ getMaxDoseQuantity()
Returns the value of the 'Max Dose Quantity' containment reference.

If the meaning of the 'Max Dose Quantity' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Max Dose Quantity' containment reference.
See Also:
setMaxDoseQuantity(RTOPQPQ), CDAR2Package.getPOCDMT000040SubstanceAdministration_MaxDoseQuantity()

setMaxDoseQuantity

void setMaxDoseQuantity(RTOPQPQ value)
Sets the value of the 'Max Dose Quantity' containment reference.

Parameters:
value - the new value of the 'Max Dose Quantity' containment reference.
See Also:
getMaxDoseQuantity()

getAdministrationUnitCode

CE getAdministrationUnitCode()
Returns the value of the 'Administration Unit Code' containment reference.

If the meaning of the 'Administration Unit Code' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Administration Unit Code' containment reference.
See Also:
setAdministrationUnitCode(CE), CDAR2Package.getPOCDMT000040SubstanceAdministration_AdministrationUnitCode()

setAdministrationUnitCode

void setAdministrationUnitCode(CE value)
Sets the value of the 'Administration Unit Code' containment reference.

Parameters:
value - the new value of the 'Administration Unit Code' containment reference.
See Also:
getAdministrationUnitCode()

getSubject

POCDMT000040Subject getSubject()
Returns the value of the 'Subject' containment reference.

If the meaning of the 'Subject' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Subject' containment reference.
See Also:
setSubject(POCDMT000040Subject), CDAR2Package.getPOCDMT000040SubstanceAdministration_Subject()

setSubject

void setSubject(POCDMT000040Subject value)
Sets the value of the 'Subject' containment reference.

Parameters:
value - the new value of the 'Subject' containment reference.
See Also:
getSubject()

getSpecimen

org.eclipse.emf.common.util.EList getSpecimen()
Returns the value of the 'Specimen' containment reference list. The list contents are of type POCDMT000040Specimen.

If the meaning of the 'Specimen' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Specimen' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_Specimen()

getConsumable

POCDMT000040Consumable getConsumable()
Returns the value of the 'Consumable' containment reference.

If the meaning of the 'Consumable' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Consumable' containment reference.
See Also:
setConsumable(POCDMT000040Consumable), CDAR2Package.getPOCDMT000040SubstanceAdministration_Consumable()

setConsumable

void setConsumable(POCDMT000040Consumable value)
Sets the value of the 'Consumable' containment reference.

Parameters:
value - the new value of the 'Consumable' containment reference.
See Also:
getConsumable()

getPerformer

org.eclipse.emf.common.util.EList getPerformer()
Returns the value of the 'Performer' containment reference list. The list contents are of type POCDMT000040Performer2.

If the meaning of the 'Performer' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Performer' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_Performer()

getAuthor

org.eclipse.emf.common.util.EList getAuthor()
Returns the value of the 'Author' containment reference list. The list contents are of type POCDMT000040Author.

If the meaning of the 'Author' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Author' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_Author()

getInformant

org.eclipse.emf.common.util.EList getInformant()
Returns the value of the 'Informant' containment reference list. The list contents are of type POCDMT000040Informant12.

If the meaning of the 'Informant' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Informant' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_Informant()

getParticipant

org.eclipse.emf.common.util.EList getParticipant()
Returns the value of the 'Participant' containment reference list. The list contents are of type POCDMT000040Participant2.

If the meaning of the 'Participant' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Participant' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_Participant()

getEntryRelationship

org.eclipse.emf.common.util.EList getEntryRelationship()
Returns the value of the 'Entry Relationship' containment reference list. The list contents are of type POCDMT000040EntryRelationship.

If the meaning of the 'Entry Relationship' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Entry Relationship' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_EntryRelationship()

getReference

org.eclipse.emf.common.util.EList getReference()
Returns the value of the 'Reference' containment reference list. The list contents are of type POCDMT000040Reference.

If the meaning of the 'Reference' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Reference' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_Reference()

getPrecondition

org.eclipse.emf.common.util.EList getPrecondition()
Returns the value of the 'Precondition' containment reference list. The list contents are of type POCDMT000040Precondition.

If the meaning of the 'Precondition' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Precondition' containment reference list.
See Also:
CDAR2Package.getPOCDMT000040SubstanceAdministration_Precondition()

getClassCode

org.eclipse.emf.common.util.Enumerator getClassCode()
Returns the value of the 'Class Code' attribute. The default value is "SBADM".

If the meaning of the 'Class Code' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Class Code' attribute.
See Also:
isSetClassCode(), unsetClassCode(), setClassCode(Enumerator), CDAR2Package.getPOCDMT000040SubstanceAdministration_ClassCode()

setClassCode

void setClassCode(org.eclipse.emf.common.util.Enumerator value)
Sets the value of the 'Class Code' attribute.

Parameters:
value - the new value of the 'Class Code' attribute.
See Also:
isSetClassCode(), unsetClassCode(), getClassCode()

unsetClassCode

void unsetClassCode()
Unsets the value of the 'Class Code' attribute.

See Also:
isSetClassCode(), getClassCode(), setClassCode(Enumerator)

isSetClassCode

boolean isSetClassCode()
Returns whether the value of the 'Class Code' attribute is set.

Returns:
whether the value of the 'Class Code' attribute is set.
See Also:
unsetClassCode(), getClassCode(), setClassCode(Enumerator)

getMoodCode

XDocumentSubstanceMood getMoodCode()
Returns the value of the 'Mood Code' attribute. The default value is "INT". The literals are from the enumeration XDocumentSubstanceMood.

If the meaning of the 'Mood Code' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Mood Code' attribute.
See Also:
XDocumentSubstanceMood, isSetMoodCode(), unsetMoodCode(), setMoodCode(XDocumentSubstanceMood), CDAR2Package.getPOCDMT000040SubstanceAdministration_MoodCode()

setMoodCode

void setMoodCode(XDocumentSubstanceMood value)
Sets the value of the 'Mood Code' attribute.

Parameters:
value - the new value of the 'Mood Code' attribute.
See Also:
XDocumentSubstanceMood, isSetMoodCode(), unsetMoodCode(), getMoodCode()

unsetMoodCode

void unsetMoodCode()
Unsets the value of the 'Mood Code' attribute.

See Also:
isSetMoodCode(), getMoodCode(), setMoodCode(XDocumentSubstanceMood)

isSetMoodCode

boolean isSetMoodCode()
Returns whether the value of the 'Mood Code' attribute is set.

Returns:
whether the value of the 'Mood Code' attribute is set.
See Also:
unsetMoodCode(), getMoodCode(), setMoodCode(XDocumentSubstanceMood)

isNegationInd

boolean isNegationInd()
Returns the value of the 'Negation Ind' attribute.

If the meaning of the 'Negation Ind' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Negation Ind' attribute.
See Also:
isSetNegationInd(), unsetNegationInd(), setNegationInd(boolean), CDAR2Package.getPOCDMT000040SubstanceAdministration_NegationInd()

setNegationInd

void setNegationInd(boolean value)
Sets the value of the 'Negation Ind' attribute.

Parameters:
value - the new value of the 'Negation Ind' attribute.
See Also:
isSetNegationInd(), unsetNegationInd(), isNegationInd()

unsetNegationInd

void unsetNegationInd()
Unsets the value of the 'Negation Ind' attribute.

See Also:
isSetNegationInd(), isNegationInd(), setNegationInd(boolean)

isSetNegationInd

boolean isSetNegationInd()
Returns whether the value of the 'Negation Ind' attribute is set.

Returns:
whether the value of the 'Negation Ind' attribute is set.
See Also:
unsetNegationInd(), isNegationInd(), setNegationInd(boolean)

getNullFlavor

org.eclipse.emf.common.util.Enumerator getNullFlavor()
Returns the value of the 'Null Flavor' attribute.

If the meaning of the 'Null Flavor' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Null Flavor' attribute.
See Also:
setNullFlavor(Enumerator), CDAR2Package.getPOCDMT000040SubstanceAdministration_NullFlavor()

setNullFlavor

void setNullFlavor(org.eclipse.emf.common.util.Enumerator value)
Sets the value of the 'Null Flavor' attribute.

Parameters:
value - the new value of the 'Null Flavor' attribute.
See Also:
getNullFlavor()