SubstanceAdministration

java.lang.Object
- cdac.medinfo.ccd.templates.SubstanceAdministration

public class SubstanceAdministration
extends java.lang.Object

Java class for SubstanceAdministration complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="SubstanceAdministration">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="realmCode" type="{urn:hl7-org:v3}CS" maxOccurs="unbounded" minOccurs="0"/>
         <element name="typeId" type="{urn:hl7-org:v3}InfrastructureRoot.typeId" minOccurs="0"/>
         <element name="templateId" type="{urn:hl7-org:v3}II" maxOccurs="unbounded" minOccurs="0"/>
         <element name="id" type="{urn:hl7-org:v3}II" maxOccurs="unbounded" minOccurs="0"/>
         <element name="code" type="{urn:hl7-org:v3}CD" minOccurs="0"/>
         <element name="text" type="{urn:hl7-org:v3}ED" minOccurs="0"/>
         <element name="statusCode" type="{urn:hl7-org:v3}CS" minOccurs="0"/>
         <element name="effectiveTime" type="{urn:hl7-org:v3}SXCM_TS" maxOccurs="unbounded" minOccurs="0"/>
         <element name="priorityCode" type="{urn:hl7-org:v3}CE" minOccurs="0"/>
         <element name="repeatNumber" type="{urn:hl7-org:v3}IVL_INT" minOccurs="0"/>
         <element name="routeCode" type="{urn:hl7-org:v3}CE" minOccurs="0"/>
         <element name="approachSiteCode" type="{urn:hl7-org:v3}CD" maxOccurs="unbounded" minOccurs="0"/>
         <element name="doseQuantity" type="{urn:hl7-org:v3}IVL_PQ" minOccurs="0"/>
         <element name="rateQuantity" type="{urn:hl7-org:v3}IVL_PQ" minOccurs="0"/>
         <element name="maxDoseQuantity" type="{urn:hl7-org:v3}RTO_PQ_PQ" minOccurs="0"/>
         <element name="administrationUnitCode" type="{urn:hl7-org:v3}CE" minOccurs="0"/>
         <element name="subject" type="{urn:hl7-org:v3}Subject" minOccurs="0"/>
         <element name="specimen" type="{urn:hl7-org:v3}Specimen" maxOccurs="unbounded" minOccurs="0"/>
         <element name="consumable" type="{urn:hl7-org:v3}Consumable"/>
         <element name="performer" type="{urn:hl7-org:v3}Performer2" maxOccurs="unbounded" minOccurs="0"/>
         <element name="author" type="{urn:hl7-org:v3}Author" maxOccurs="unbounded" minOccurs="0"/>
         <element name="informant" type="{urn:hl7-org:v3}Informant12" maxOccurs="unbounded" minOccurs="0"/>
         <element name="participant" type="{urn:hl7-org:v3}Participant2" maxOccurs="unbounded" minOccurs="0"/>
         <element name="entryRelationship" type="{urn:hl7-org:v3}EntryRelationship" maxOccurs="unbounded" minOccurs="0"/>
         <element name="reference" type="{urn:hl7-org:v3}Reference" maxOccurs="unbounded" minOccurs="0"/>
         <element name="precondition" type="{urn:hl7-org:v3}Precondition" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="nullFlavor" type="{urn:hl7-org:v3}NullFlavor" />
       <attribute name="classCode" use="required" type="{urn:hl7-org:v3}ActClass" fixed="SBADM" />
       <attribute name="moodCode" use="required" type="{urn:hl7-org:v3}x_DocumentSubstanceMood" />
       <attribute name="negationInd" type="{urn:hl7-org:v3}bl" />
     </restriction>
   </complexContent>
 </complexType>

Constructor Summary

Constructors
Constructor and Description

SubstanceAdministration()

Constructors
Constructor and Description
`SubstanceAdministration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CE`	`getAdministrationUnitCode()` Gets the value of the administrationUnitCode property.
`java.util.List<CD>`	`getApproachSiteCode()` Gets the value of the approachSiteCode property.
`java.util.List<Author>`	`getAuthor()` Gets the value of the author property.
`java.util.List<java.lang.String>`	`getClassCode()` Gets the value of the classCode property.
`CD`	`getCode()` Gets the value of the code property.
`Consumable`	`getConsumable()` Gets the value of the consumable property.
`IVLPQ`	`getDoseQuantity()` Gets the value of the doseQuantity property.
`java.util.List<SXCMTS>`	`getEffectiveTime()` Gets the value of the effectiveTime property.
`java.util.List<EntryRelationship>`	`getEntryRelationship()` Gets the value of the entryRelationship property.
`java.util.List<II>`	`getId()` Gets the value of the id property.
`java.util.List<Informant12>`	`getInformant()` Gets the value of the informant property.
`RTOPQPQ`	`getMaxDoseQuantity()` Gets the value of the maxDoseQuantity property.
`XDocumentSubstanceMood`	`getMoodCode()` Gets the value of the moodCode property.
`java.util.List<java.lang.String>`	`getNullFlavor()` Gets the value of the nullFlavor property.
`java.util.List<Participant2>`	`getParticipant()` Gets the value of the participant property.
`java.util.List<Performer2>`	`getPerformer()` Gets the value of the performer property.
`java.util.List<Precondition>`	`getPrecondition()` Gets the value of the precondition property.
`CE`	`getPriorityCode()` Gets the value of the priorityCode property.
`IVLPQ`	`getRateQuantity()` Gets the value of the rateQuantity property.
`java.util.List<CS>`	`getRealmCode()` Gets the value of the realmCode property.
`java.util.List<Reference>`	`getReference()` Gets the value of the reference property.
`IVLINT`	`getRepeatNumber()` Gets the value of the repeatNumber property.
`CE`	`getRouteCode()` Gets the value of the routeCode property.
`java.util.List<Specimen>`	`getSpecimen()` Gets the value of the specimen property.
`CS`	`getStatusCode()` Gets the value of the statusCode property.
`Subject`	`getSubject()` Gets the value of the subject property.
`java.util.List<II>`	`getTemplateId()` Gets the value of the templateId property.
`ED`	`getText()` Gets the value of the text property.
`InfrastructureRootTypeId`	`getTypeId()` Gets the value of the typeId property.
`java.lang.Boolean`	`isNegationInd()` Gets the value of the negationInd property.
`void`	`setAdministrationUnitCode(CE value)` Sets the value of the administrationUnitCode property.
`void`	`setCode(CD value)` Sets the value of the code property.
`void`	`setConsumable(Consumable value)` Sets the value of the consumable property.
`void`	`setDoseQuantity(IVLPQ value)` Sets the value of the doseQuantity property.
`void`	`setMaxDoseQuantity(RTOPQPQ value)` Sets the value of the maxDoseQuantity property.
`void`	`setMoodCode(XDocumentSubstanceMood value)` Sets the value of the moodCode property.
`void`	`setNegationInd(java.lang.Boolean value)` Sets the value of the negationInd property.
`void`	`setPriorityCode(CE value)` Sets the value of the priorityCode property.
`void`	`setRateQuantity(IVLPQ value)` Sets the value of the rateQuantity property.
`void`	`setRepeatNumber(IVLINT value)` Sets the value of the repeatNumber property.
`void`	`setRouteCode(CE value)` Sets the value of the routeCode property.
`void`	`setStatusCode(CS value)` Sets the value of the statusCode property.
`void`	`setSubject(Subject value)` Sets the value of the subject property.
`void`	`setText(ED value)` Sets the value of the text property.
`void`	`setTypeId(InfrastructureRootTypeId value)` Sets the value of the typeId property.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SubstanceAdministration
```
public SubstanceAdministration()
```
- Method Detail
  - getRealmCode
```
public java.util.List<CS> getRealmCode()
```
    Gets the value of the realmCode property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the realmCode property.
    For example, to add a new item, do as follows:
```
    getRealmCode().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CS
  - getTypeId
```
public InfrastructureRootTypeId getTypeId()
```
    Gets the value of the typeId property.
    
    Returns:
    
    possible object is InfrastructureRootTypeId
  - setTypeId
```
public void setTypeId(InfrastructureRootTypeId value)
```
    Sets the value of the typeId property.
    
    Parameters:
    
    value - allowed object is InfrastructureRootTypeId
  - getTemplateId
```
public java.util.List<II> getTemplateId()
```
    Gets the value of the templateId property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the templateId property.
    For example, to add a new item, do as follows:
```
    getTemplateId().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list II
  - getId
```
public java.util.List<II> getId()
```
    Gets the value of the id property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the id property.
    For example, to add a new item, do as follows:
```
    getId().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list II
  - getCode
```
public CD getCode()
```
    Gets the value of the code property.
    
    Returns:
    
    possible object is CD
  - setCode
```
public void setCode(CD value)
```
    Sets the value of the code property.
    
    Parameters:
    
    value - allowed object is CD
  - getText
```
public ED getText()
```
    Gets the value of the text property.
    
    Returns:
    
    possible object is ED
  - setText
```
public void setText(ED value)
```
    Sets the value of the text property.
    
    Parameters:
    
    value - allowed object is ED
  - getStatusCode
```
public CS getStatusCode()
```
    Gets the value of the statusCode property.
    
    Returns:
    
    possible object is CS
  - setStatusCode
```
public void setStatusCode(CS value)
```
    Sets the value of the statusCode property.
    
    Parameters:
    
    value - allowed object is CS
  - getEffectiveTime
```
public java.util.List<SXCMTS> getEffectiveTime()
```
    Gets the value of the effectiveTime property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the effectiveTime property.
    For example, to add a new item, do as follows:
```
    getEffectiveTime().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list SXCMTS
  - getPriorityCode
```
public CE getPriorityCode()
```
    Gets the value of the priorityCode property.
    
    Returns:
    
    possible object is CE
  - setPriorityCode
```
public void setPriorityCode(CE value)
```
    Sets the value of the priorityCode property.
    
    Parameters:
    
    value - allowed object is CE
  - getRepeatNumber
```
public IVLINT getRepeatNumber()
```
    Gets the value of the repeatNumber property.
    
    Returns:
    
    possible object is IVLINT
  - setRepeatNumber
```
public void setRepeatNumber(IVLINT value)
```
    Sets the value of the repeatNumber property.
    
    Parameters:
    
    value - allowed object is IVLINT
  - getRouteCode
```
public CE getRouteCode()
```
    Gets the value of the routeCode property.
    
    Returns:
    
    possible object is CE
  - setRouteCode
```
public void setRouteCode(CE value)
```
    Sets the value of the routeCode property.
    
    Parameters:
    
    value - allowed object is CE
  - getApproachSiteCode
```
public java.util.List<CD> getApproachSiteCode()
```
    Gets the value of the approachSiteCode property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the approachSiteCode property.
    For example, to add a new item, do as follows:
```
    getApproachSiteCode().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CD
  - getDoseQuantity
```
public IVLPQ getDoseQuantity()
```
    Gets the value of the doseQuantity property.
    
    Returns:
    
    possible object is IVLPQ
  - setDoseQuantity
```
public void setDoseQuantity(IVLPQ value)
```
    Sets the value of the doseQuantity property.
    
    Parameters:
    
    value - allowed object is IVLPQ
  - getRateQuantity
```
public IVLPQ getRateQuantity()
```
    Gets the value of the rateQuantity property.
    
    Returns:
    
    possible object is IVLPQ
  - setRateQuantity
```
public void setRateQuantity(IVLPQ value)
```
    Sets the value of the rateQuantity property.
    
    Parameters:
    
    value - allowed object is IVLPQ
  - getMaxDoseQuantity
```
public RTOPQPQ getMaxDoseQuantity()
```
    Gets the value of the maxDoseQuantity property.
    
    Returns:
    
    possible object is RTOPQPQ
  - setMaxDoseQuantity
```
public void setMaxDoseQuantity(RTOPQPQ value)
```
    Sets the value of the maxDoseQuantity property.
    
    Parameters:
    
    value - allowed object is RTOPQPQ
  - getAdministrationUnitCode
```
public CE getAdministrationUnitCode()
```
    Gets the value of the administrationUnitCode property.
    
    Returns:
    
    possible object is CE
  - setAdministrationUnitCode
```
public void setAdministrationUnitCode(CE value)
```
    Sets the value of the administrationUnitCode property.
    
    Parameters:
    
    value - allowed object is CE
  - getSubject
```
public Subject getSubject()
```
    Gets the value of the subject property.
    
    Returns:
    
    possible object is Subject
  - setSubject
```
public void setSubject(Subject value)
```
    Sets the value of the subject property.
    
    Parameters:
    
    value - allowed object is Subject
  - getSpecimen
```
public java.util.List<Specimen> getSpecimen()
```
    Gets the value of the specimen property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the specimen property.
    For example, to add a new item, do as follows:
```
    getSpecimen().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Specimen
  - getConsumable
```
public Consumable getConsumable()
```
    Gets the value of the consumable property.
    
    Returns:
    
    possible object is Consumable
  - setConsumable
```
public void setConsumable(Consumable value)
```
    Sets the value of the consumable property.
    
    Parameters:
    
    value - allowed object is Consumable
  - getPerformer
```
public java.util.List<Performer2> getPerformer()
```
    Gets the value of the performer property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the performer property.
    For example, to add a new item, do as follows:
```
    getPerformer().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Performer2
  - getAuthor
```
public java.util.List<Author> getAuthor()
```
    Gets the value of the author property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the author property.
    For example, to add a new item, do as follows:
```
    getAuthor().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Author
  - getInformant
```
public java.util.List<Informant12> getInformant()
```
    Gets the value of the informant property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the informant property.
    For example, to add a new item, do as follows:
```
    getInformant().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Informant12
  - getParticipant
```
public java.util.List<Participant2> getParticipant()
```
    Gets the value of the participant property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the participant property.
    For example, to add a new item, do as follows:
```
    getParticipant().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Participant2
  - getEntryRelationship
```
public java.util.List<EntryRelationship> getEntryRelationship()
```
    Gets the value of the entryRelationship property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the entryRelationship property.
    For example, to add a new item, do as follows:
```
    getEntryRelationship().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list EntryRelationship
  - getReference
```
public java.util.List<Reference> getReference()
```
    Gets the value of the reference property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the reference property.
    For example, to add a new item, do as follows:
```
    getReference().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Reference
  - getPrecondition
```
public java.util.List<Precondition> getPrecondition()
```
    Gets the value of the precondition property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the precondition property.
    For example, to add a new item, do as follows:
```
    getPrecondition().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Precondition
  - getNullFlavor
```
public java.util.List<java.lang.String> getNullFlavor()
```
    Gets the value of the nullFlavor property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the nullFlavor property.
    For example, to add a new item, do as follows:
```
    getNullFlavor().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getClassCode
```
public java.util.List<java.lang.String> getClassCode()
```
    Gets the value of the classCode property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the classCode property.
    For example, to add a new item, do as follows:
```
    getClassCode().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getMoodCode
```
public XDocumentSubstanceMood getMoodCode()
```
    Gets the value of the moodCode property.
    
    Returns:
    
    possible object is XDocumentSubstanceMood
  - setMoodCode
```
public void setMoodCode(XDocumentSubstanceMood value)
```
    Sets the value of the moodCode property.
    
    Parameters:
    
    value - allowed object is XDocumentSubstanceMood
  - isNegationInd
```
public java.lang.Boolean isNegationInd()
```
    Gets the value of the negationInd property.
    
    Returns:
    
    possible object is Boolean
  - setNegationInd
```
public void setNegationInd(java.lang.Boolean value)
```
    Sets the value of the negationInd property.
    
    Parameters:
    
    value - allowed object is Boolean

Class SubstanceAdministration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubstanceAdministration

Method Detail

getRealmCode

getTypeId

setTypeId

getTemplateId

getId

getCode

setCode

getText

setText

getStatusCode

setStatusCode

getEffectiveTime

getPriorityCode

setPriorityCode

getRepeatNumber

setRepeatNumber

getRouteCode

setRouteCode

getApproachSiteCode

getDoseQuantity

setDoseQuantity

getRateQuantity

setRateQuantity

getMaxDoseQuantity

setMaxDoseQuantity

getAdministrationUnitCode

setAdministrationUnitCode

getSubject

setSubject

getSpecimen

getConsumable

setConsumable

getPerformer

getAuthor

getInformant

getParticipant

getEntryRelationship

getReference

getPrecondition

getNullFlavor

getClassCode

getMoodCode

setMoodCode

isNegationInd

setNegationInd