ClinicalDocument

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

public class ClinicalDocument
extends java.lang.Object

Java class for ClinicalDocument complex type.

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

 <complexType name="ClinicalDocument">
   <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"/>
         <element name="templateId" type="{urn:hl7-org:v3}II" maxOccurs="unbounded" minOccurs="0"/>
         <element name="id" type="{urn:hl7-org:v3}II"/>
         <element name="code" type="{urn:hl7-org:v3}CE"/>
         <element name="title" type="{urn:hl7-org:v3}ST" minOccurs="0"/>
         <element name="effectiveTime" type="{urn:hl7-org:v3}TS"/>
         <element name="confidentialityCode" type="{urn:hl7-org:v3}CE"/>
         <element name="languageCode" type="{urn:hl7-org:v3}CS" minOccurs="0"/>
         <element name="setId" type="{urn:hl7-org:v3}II" minOccurs="0"/>
         <element name="versionNumber" type="{urn:hl7-org:v3}INT" minOccurs="0"/>
         <element name="copyTime" type="{urn:hl7-org:v3}TS" minOccurs="0"/>
         <element name="recordTarget" type="{urn:hl7-org:v3}RecordTarget" maxOccurs="unbounded"/>
         <element name="author" type="{urn:hl7-org:v3}Author" maxOccurs="unbounded"/>
         <element name="dataEnterer" type="{urn:hl7-org:v3}DataEnterer" minOccurs="0"/>
         <element name="informant" type="{urn:hl7-org:v3}Informant12" maxOccurs="unbounded" minOccurs="0"/>
         <element name="custodian" type="{urn:hl7-org:v3}Custodian"/>
         <element name="informationRecipient" type="{urn:hl7-org:v3}InformationRecipient" maxOccurs="unbounded" minOccurs="0"/>
         <element name="legalAuthenticator" type="{urn:hl7-org:v3}LegalAuthenticator" minOccurs="0"/>
         <element name="authenticator" type="{urn:hl7-org:v3}Authenticator" maxOccurs="unbounded" minOccurs="0"/>
         <element name="participant" type="{urn:hl7-org:v3}Participant1" maxOccurs="unbounded" minOccurs="0"/>
         <element name="inFulfillmentOf" type="{urn:hl7-org:v3}InFulfillmentOf" maxOccurs="unbounded" minOccurs="0"/>
         <element name="documentationOf" type="{urn:hl7-org:v3}DocumentationOf" maxOccurs="unbounded" minOccurs="0"/>
         <element name="relatedDocument" type="{urn:hl7-org:v3}RelatedDocument" maxOccurs="unbounded" minOccurs="0"/>
         <element name="authorization" type="{urn:hl7-org:v3}Authorization" maxOccurs="unbounded" minOccurs="0"/>
         <element name="componentOf" type="{urn:hl7-org:v3}Component1" minOccurs="0"/>
         <element name="component" type="{urn:hl7-org:v3}Component2"/>
       </sequence>
       <attribute name="nullFlavor" type="{urn:hl7-org:v3}NullFlavor" />
       <attribute name="classCode" type="{urn:hl7-org:v3}ActClinicalDocument" fixed="DOCCLIN" />
       <attribute name="moodCode" type="{urn:hl7-org:v3}ActMood" fixed="EVN" />
     </restriction>
   </complexContent>
 </complexType>

Constructor Summary

Constructors
Constructor and Description

ClinicalDocument()

Constructors
Constructor and Description
`ClinicalDocument()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<Authenticator>`	`getAuthenticator()` Gets the value of the authenticator property.
`java.util.List<Author>`	`getAuthor()` Gets the value of the author property.
`java.util.List<Authorization>`	`getAuthorization()` Gets the value of the authorization property.
`ActClinicalDocument`	`getClassCode()` Gets the value of the classCode property.
`CE`	`getCode()` Gets the value of the code property.
`Component2`	`getComponent()` Gets the value of the component property.
`Component1`	`getComponentOf()` Gets the value of the componentOf property.
`CE`	`getConfidentialityCode()` Gets the value of the confidentialityCode property.
`TS`	`getCopyTime()` Gets the value of the copyTime property.
`Custodian`	`getCustodian()` Gets the value of the custodian property.
`DataEnterer`	`getDataEnterer()` Gets the value of the dataEnterer property.
`java.util.List<DocumentationOf>`	`getDocumentationOf()` Gets the value of the documentationOf property.
`TS`	`getEffectiveTime()` Gets the value of the effectiveTime property.
`II`	`getId()` Gets the value of the id property.
`java.util.List<Informant12>`	`getInformant()` Gets the value of the informant property.
`java.util.List<InformationRecipient>`	`getInformationRecipient()` Gets the value of the informationRecipient property.
`java.util.List<InFulfillmentOf>`	`getInFulfillmentOf()` Gets the value of the inFulfillmentOf property.
`CS`	`getLanguageCode()` Gets the value of the languageCode property.
`LegalAuthenticator`	`getLegalAuthenticator()` Gets the value of the legalAuthenticator property.
`java.util.List<java.lang.String>`	`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<Participant1>`	`getParticipant()` Gets the value of the participant property.
`java.util.List<CS>`	`getRealmCode()` Gets the value of the realmCode property.
`java.util.List<RecordTarget>`	`getRecordTarget()` Gets the value of the recordTarget property.
`java.util.List<RelatedDocument>`	`getRelatedDocument()` Gets the value of the relatedDocument property.
`II`	`getSetId()` Gets the value of the setId property.
`java.util.List<II>`	`getTemplateId()` Gets the value of the templateId property.
`ST`	`getTitle()` Gets the value of the title property.
`InfrastructureRootTypeId`	`getTypeId()` Gets the value of the typeId property.
`INT`	`getVersionNumber()` Gets the value of the versionNumber property.
`void`	`setClassCode(ActClinicalDocument value)` Sets the value of the classCode property.
`void`	`setCode(CE value)` Sets the value of the code property.
`void`	`setComponent(Component2 value)` Sets the value of the component property.
`void`	`setComponentOf(Component1 value)` Sets the value of the componentOf property.
`void`	`setConfidentialityCode(CE value)` Sets the value of the confidentialityCode property.
`void`	`setCopyTime(TS value)` Sets the value of the copyTime property.
`void`	`setCustodian(Custodian value)` Sets the value of the custodian property.
`void`	`setDataEnterer(DataEnterer value)` Sets the value of the dataEnterer property.
`void`	`setEffectiveTime(TS value)` Sets the value of the effectiveTime property.
`void`	`setId(II value)` Sets the value of the id property.
`void`	`setLanguageCode(CS value)` Sets the value of the languageCode property.
`void`	`setLegalAuthenticator(LegalAuthenticator value)` Sets the value of the legalAuthenticator property.
`void`	`setSetId(II value)` Sets the value of the setId property.
`void`	`setTitle(ST value)` Sets the value of the title property.
`void`	`setTypeId(InfrastructureRootTypeId value)` Sets the value of the typeId property.
`void`	`setVersionNumber(INT value)` Sets the value of the versionNumber property.

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

- Constructor Detail
  - ClinicalDocument
```
public ClinicalDocument()
```
- 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 II getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is II
  - setId
```
public void setId(II value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is II
  - getCode
```
public CE getCode()
```
    Gets the value of the code property.
    
    Returns:
    
    possible object is CE
  - setCode
```
public void setCode(CE value)
```
    Sets the value of the code property.
    
    Parameters:
    
    value - allowed object is CE
  - getTitle
```
public ST getTitle()
```
    Gets the value of the title property.
    
    Returns:
    
    possible object is ST
  - setTitle
```
public void setTitle(ST value)
```
    Sets the value of the title property.
    
    Parameters:
    
    value - allowed object is ST
  - getEffectiveTime
```
public TS getEffectiveTime()
```
    Gets the value of the effectiveTime property.
    
    Returns:
    
    possible object is TS
  - setEffectiveTime
```
public void setEffectiveTime(TS value)
```
    Sets the value of the effectiveTime property.
    
    Parameters:
    
    value - allowed object is TS
  - getConfidentialityCode
```
public CE getConfidentialityCode()
```
    Gets the value of the confidentialityCode property.
    
    Returns:
    
    possible object is CE
  - setConfidentialityCode
```
public void setConfidentialityCode(CE value)
```
    Sets the value of the confidentialityCode property.
    
    Parameters:
    
    value - allowed object is CE
  - getLanguageCode
```
public CS getLanguageCode()
```
    Gets the value of the languageCode property.
    
    Returns:
    
    possible object is CS
  - setLanguageCode
```
public void setLanguageCode(CS value)
```
    Sets the value of the languageCode property.
    
    Parameters:
    
    value - allowed object is CS
  - getSetId
```
public II getSetId()
```
    Gets the value of the setId property.
    
    Returns:
    
    possible object is II
  - setSetId
```
public void setSetId(II value)
```
    Sets the value of the setId property.
    
    Parameters:
    
    value - allowed object is II
  - getVersionNumber
```
public INT getVersionNumber()
```
    Gets the value of the versionNumber property.
    
    Returns:
    
    possible object is INT
  - setVersionNumber
```
public void setVersionNumber(INT value)
```
    Sets the value of the versionNumber property.
    
    Parameters:
    
    value - allowed object is INT
  - getCopyTime
```
public TS getCopyTime()
```
    Gets the value of the copyTime property.
    
    Returns:
    
    possible object is TS
  - setCopyTime
```
public void setCopyTime(TS value)
```
    Sets the value of the copyTime property.
    
    Parameters:
    
    value - allowed object is TS
  - getRecordTarget
```
public java.util.List<RecordTarget> getRecordTarget()
```
    Gets the value of the recordTarget 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 recordTarget property.
    For example, to add a new item, do as follows:
```
    getRecordTarget().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list RecordTarget
  - 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
  - getDataEnterer
```
public DataEnterer getDataEnterer()
```
    Gets the value of the dataEnterer property.
    
    Returns:
    
    possible object is DataEnterer
  - setDataEnterer
```
public void setDataEnterer(DataEnterer value)
```
    Sets the value of the dataEnterer property.
    
    Parameters:
    
    value - allowed object is DataEnterer
  - 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
  - getCustodian
```
public Custodian getCustodian()
```
    Gets the value of the custodian property.
    
    Returns:
    
    possible object is Custodian
  - setCustodian
```
public void setCustodian(Custodian value)
```
    Sets the value of the custodian property.
    
    Parameters:
    
    value - allowed object is Custodian
  - getInformationRecipient
```
public java.util.List<InformationRecipient> getInformationRecipient()
```
    Gets the value of the informationRecipient 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 informationRecipient property.
    For example, to add a new item, do as follows:
```
    getInformationRecipient().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list InformationRecipient
  - getLegalAuthenticator
```
public LegalAuthenticator getLegalAuthenticator()
```
    Gets the value of the legalAuthenticator property.
    
    Returns:
    
    possible object is LegalAuthenticator
  - setLegalAuthenticator
```
public void setLegalAuthenticator(LegalAuthenticator value)
```
    Sets the value of the legalAuthenticator property.
    
    Parameters:
    
    value - allowed object is LegalAuthenticator
  - getAuthenticator
```
public java.util.List<Authenticator> getAuthenticator()
```
    Gets the value of the authenticator 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 authenticator property.
    For example, to add a new item, do as follows:
```
    getAuthenticator().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Authenticator
  - getParticipant
```
public java.util.List<Participant1> 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 Participant1
  - getInFulfillmentOf
```
public java.util.List<InFulfillmentOf> getInFulfillmentOf()
```
    Gets the value of the inFulfillmentOf 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 inFulfillmentOf property.
    For example, to add a new item, do as follows:
```
    getInFulfillmentOf().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list InFulfillmentOf
  - getDocumentationOf
```
public java.util.List<DocumentationOf> getDocumentationOf()
```
    Gets the value of the documentationOf 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 documentationOf property.
    For example, to add a new item, do as follows:
```
    getDocumentationOf().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DocumentationOf
  - getRelatedDocument
```
public java.util.List<RelatedDocument> getRelatedDocument()
```
    Gets the value of the relatedDocument 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 relatedDocument property.
    For example, to add a new item, do as follows:
```
    getRelatedDocument().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list RelatedDocument
  - getAuthorization
```
public java.util.List<Authorization> getAuthorization()
```
    Gets the value of the authorization 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 authorization property.
    For example, to add a new item, do as follows:
```
    getAuthorization().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Authorization
  - getComponentOf
```
public Component1 getComponentOf()
```
    Gets the value of the componentOf property.
    
    Returns:
    
    possible object is Component1
  - setComponentOf
```
public void setComponentOf(Component1 value)
```
    Sets the value of the componentOf property.
    
    Parameters:
    
    value - allowed object is Component1
  - getComponent
```
public Component2 getComponent()
```
    Gets the value of the component property.
    
    Returns:
    
    possible object is Component2
  - setComponent
```
public void setComponent(Component2 value)
```
    Sets the value of the component property.
    
    Parameters:
    
    value - allowed object is Component2
  - 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 ActClinicalDocument getClassCode()
```
    Gets the value of the classCode property.
    
    Returns:
    
    possible object is ActClinicalDocument
  - setClassCode
```
public void setClassCode(ActClinicalDocument value)
```
    Sets the value of the classCode property.
    
    Parameters:
    
    value - allowed object is ActClinicalDocument
  - getMoodCode
```
public java.util.List<java.lang.String> getMoodCode()
```
    Gets the value of the moodCode 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 moodCode property.
    For example, to add a new item, do as follows:
```
    getMoodCode().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String

Class ClinicalDocument

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClinicalDocument

Method Detail

getRealmCode

getTypeId

setTypeId

getTemplateId

getId

setId

getCode

setCode

getTitle

setTitle

getEffectiveTime

setEffectiveTime

getConfidentialityCode

setConfidentialityCode

getLanguageCode

setLanguageCode

getSetId

setSetId

getVersionNumber

setVersionNumber

getCopyTime

setCopyTime

getRecordTarget

getAuthor

getDataEnterer

setDataEnterer

getInformant

getCustodian

setCustodian

getInformationRecipient

getLegalAuthenticator

setLegalAuthenticator

getAuthenticator

getParticipant

getInFulfillmentOf

getDocumentationOf

getRelatedDocument

getAuthorization

getComponentOf

setComponentOf

getComponent

setComponent

getNullFlavor

getClassCode

setClassCode

getMoodCode