org.openhealthtools.mdht.uml.cda.ClinicalDocument Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2009, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.openhealthtools.mdht.uml.cda;
import java.util.Map;
import org.eclipse.emf.common.util.DiagnosticChain;
import org.eclipse.emf.common.util.EList;
import org.openhealthtools.mdht.uml.hl7.datatypes.CE;
import org.openhealthtools.mdht.uml.hl7.datatypes.CS;
import org.openhealthtools.mdht.uml.hl7.datatypes.II;
import org.openhealthtools.mdht.uml.hl7.datatypes.INT;
import org.openhealthtools.mdht.uml.hl7.datatypes.ST;
import org.openhealthtools.mdht.uml.hl7.datatypes.TS;
import org.openhealthtools.mdht.uml.hl7.rim.Act;
import org.openhealthtools.mdht.uml.hl7.vocab.ActClinicalDocument;
import org.openhealthtools.mdht.uml.hl7.vocab.ActMood;
import org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor;
/**
*
* A representation of the model object 'Clinical Document'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getId Id}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getCode Code}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getTitle Title}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getEffectiveTime Effective Time}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getConfidentialityCode Confidentiality Code}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getLanguageCode Language Code}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getSetId Set Id}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getVersionNumber Version Number}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getCopyTime Copy Time}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getRecordTargets Record Target}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getAuthors Author}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getDataEnterer Data Enterer}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getInformants Informant}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getCustodian Custodian}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getInformationRecipients Information Recipient}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getLegalAuthenticator Legal Authenticator}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getAuthenticators Authenticator}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getParticipants Participant}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getInFulfillmentOfs In Fulfillment Of}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getDocumentationOfs Documentation Of}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getRelatedDocuments Related Document}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getAuthorizations Authorization}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getComponentOf Component Of}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getComponent Component}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getClassCode Class Code}
* - {@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getMoodCode Mood Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument()
* @model
* @generated
*/
public interface ClinicalDocument extends Act {
/**
* Returns the value of the 'Realm Code' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.hl7.datatypes.CS}.
*
*
* If the meaning of the 'Realm Code' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Realm Code' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_RealmCode()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getRealmCodes();
/**
* 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...
*
*
* @return the value of the 'Type Id' containment reference.
* @see #setTypeId(InfrastructureRootTypeId)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_TypeId()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getTypeId Type Id}' containment reference.
*
*
* @param value the new value of the 'Type Id' containment reference.
* @see #getTypeId()
* @generated
*/
void setTypeId(InfrastructureRootTypeId value);
/**
* Returns the value of the 'Template Id' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.hl7.datatypes.II}.
*
*
* If the meaning of the 'Template Id' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Template Id' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getTemplateIds();
/**
* Returns the value of the 'Id' containment reference.
*
*
* If the meaning of the 'Id' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Id' containment reference.
* @see #setId(II)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_Id()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
II getId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getId Id}' containment reference.
*
*
* @param value the new value of the 'Id' containment reference.
* @see #getId()
* @generated
*/
void setId(II value);
/**
* 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...
*
*
* @return the value of the 'Code' containment reference.
* @see #setCode(CE)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_Code()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
CE getCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getCode Code}' containment reference.
*
*
* @param value the new value of the 'Code' containment reference.
* @see #getCode()
* @generated
*/
void setCode(CE value);
/**
* Returns the value of the 'Title' containment reference.
*
*
* If the meaning of the 'Title' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Title' containment reference.
* @see #setTitle(ST)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_Title()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
ST getTitle();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getTitle Title}' containment reference.
*
*
* @param value the new value of the 'Title' containment reference.
* @see #getTitle()
* @generated
*/
void setTitle(ST value);
/**
* Returns the value of the 'Effective Time' containment reference.
*
*
* If the meaning of the 'Effective Time' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Effective Time' containment reference.
* @see #setEffectiveTime(TS)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_EffectiveTime()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
TS getEffectiveTime();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getEffectiveTime Effective Time}' containment reference.
*
*
* @param value the new value of the 'Effective Time' containment reference.
* @see #getEffectiveTime()
* @generated
*/
void setEffectiveTime(TS value);
/**
* Returns the value of the 'Confidentiality Code' containment reference.
*
*
* If the meaning of the 'Confidentiality Code' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Confidentiality Code' containment reference.
* @see #setConfidentialityCode(CE)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_ConfidentialityCode()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
CE getConfidentialityCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getConfidentialityCode Confidentiality Code}' containment reference.
*
*
* @param value the new value of the 'Confidentiality Code' containment reference.
* @see #getConfidentialityCode()
* @generated
*/
void setConfidentialityCode(CE value);
/**
* Returns the value of the 'Language Code' containment reference.
*
*
* If the meaning of the 'Language Code' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Language Code' containment reference.
* @see #setLanguageCode(CS)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_LanguageCode()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
CS getLanguageCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getLanguageCode Language Code}' containment reference.
*
*
* @param value the new value of the 'Language Code' containment reference.
* @see #getLanguageCode()
* @generated
*/
void setLanguageCode(CS value);
/**
* Returns the value of the 'Set Id' containment reference.
*
*
* If the meaning of the 'Set Id' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Set Id' containment reference.
* @see #setSetId(II)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_SetId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
II getSetId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getSetId Set Id}' containment reference.
*
*
* @param value the new value of the 'Set Id' containment reference.
* @see #getSetId()
* @generated
*/
void setSetId(II value);
/**
* Returns the value of the 'Version Number' containment reference.
*
*
* If the meaning of the 'Version Number' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Version Number' containment reference.
* @see #setVersionNumber(INT)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_VersionNumber()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
INT getVersionNumber();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getVersionNumber Version Number}' containment reference.
*
*
* @param value the new value of the 'Version Number' containment reference.
* @see #getVersionNumber()
* @generated
*/
void setVersionNumber(INT value);
/**
* Returns the value of the 'Copy Time' containment reference.
*
*
* If the meaning of the 'Copy Time' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Copy Time' containment reference.
* @see #setCopyTime(TS)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_CopyTime()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
TS getCopyTime();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getCopyTime Copy Time}' containment reference.
*
*
* @param value the new value of the 'Copy Time' containment reference.
* @see #getCopyTime()
* @generated
*/
void setCopyTime(TS value);
/**
* Returns the value of the 'Record Target' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.RecordTarget}.
*
*
* If the meaning of the 'Record Target' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Record Target' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_RecordTarget()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getRecordTargets();
/**
* Returns the value of the 'Author' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Author}.
*
*
* If the meaning of the 'Author' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Author' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_Author()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getAuthors();
/**
* Returns the value of the 'Data Enterer' containment reference.
*
*
* If the meaning of the 'Data Enterer' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Data Enterer' containment reference.
* @see #setDataEnterer(DataEnterer)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_DataEnterer()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
DataEnterer getDataEnterer();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getDataEnterer Data Enterer}' containment reference.
*
*
* @param value the new value of the 'Data Enterer' containment reference.
* @see #getDataEnterer()
* @generated
*/
void setDataEnterer(DataEnterer value);
/**
* Returns the value of the 'Informant' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Informant12}.
*
*
* If the meaning of the 'Informant' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Informant' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_Informant()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getInformants();
/**
* Returns the value of the 'Custodian' containment reference.
*
*
* If the meaning of the 'Custodian' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Custodian' containment reference.
* @see #setCustodian(Custodian)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_Custodian()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Custodian getCustodian();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getCustodian Custodian}' containment reference.
*
*
* @param value the new value of the 'Custodian' containment reference.
* @see #getCustodian()
* @generated
*/
void setCustodian(Custodian value);
/**
* Returns the value of the 'Information Recipient' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.InformationRecipient}.
*
*
* If the meaning of the 'Information Recipient' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Information Recipient' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_InformationRecipient()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getInformationRecipients();
/**
* Returns the value of the 'Legal Authenticator' containment reference.
*
*
* If the meaning of the 'Legal Authenticator' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Legal Authenticator' containment reference.
* @see #setLegalAuthenticator(LegalAuthenticator)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_LegalAuthenticator()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
LegalAuthenticator getLegalAuthenticator();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getLegalAuthenticator Legal Authenticator}' containment reference.
*
*
* @param value the new value of the 'Legal Authenticator' containment reference.
* @see #getLegalAuthenticator()
* @generated
*/
void setLegalAuthenticator(LegalAuthenticator value);
/**
* Returns the value of the 'Authenticator' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Authenticator}.
*
*
* If the meaning of the 'Authenticator' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Authenticator' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_Authenticator()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getAuthenticators();
/**
* Returns the value of the 'Participant' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Participant1}.
*
*
* If the meaning of the 'Participant' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Participant' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_Participant()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getParticipants();
/**
* Returns the value of the 'In Fulfillment Of' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.InFulfillmentOf}.
*
*
* If the meaning of the 'In Fulfillment Of' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'In Fulfillment Of' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_InFulfillmentOf()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getInFulfillmentOfs();
/**
* Returns the value of the 'Documentation Of' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.DocumentationOf}.
*
*
* If the meaning of the 'Documentation Of' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Documentation Of' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_DocumentationOf()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getDocumentationOfs();
/**
* Returns the value of the 'Related Document' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.RelatedDocument}.
*
*
* If the meaning of the 'Related Document' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Related Document' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_RelatedDocument()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getRelatedDocuments();
/**
* Returns the value of the 'Authorization' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Authorization}.
*
*
* If the meaning of the 'Authorization' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Authorization' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_Authorization()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getAuthorizations();
/**
* Returns the value of the 'Component Of' containment reference.
*
*
* If the meaning of the 'Component Of' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Component Of' containment reference.
* @see #setComponentOf(Component1)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_ComponentOf()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Component1 getComponentOf();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getComponentOf Component Of}' containment reference.
*
*
* @param value the new value of the 'Component Of' containment reference.
* @see #getComponentOf()
* @generated
*/
void setComponentOf(Component1 value);
/**
* Returns the value of the 'Component' containment reference.
*
*
* If the meaning of the 'Component' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Component' containment reference.
* @see #setComponent(Component2)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_Component()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Component2 getComponent();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getComponent Component}' containment reference.
*
*
* @param value the new value of the 'Component' containment reference.
* @see #getComponent()
* @generated
*/
void setComponent(Component2 value);
/**
* Returns the value of the 'Null Flavor' attribute.
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor}.
*
*
* If the meaning of the 'Null Flavor' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Null Flavor' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor
* @see #isSetNullFlavor()
* @see #unsetNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getNullFlavor Null Flavor}' attribute.
*
*
* @param value the new value of the 'Null Flavor' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor
* @see #isSetNullFlavor()
* @see #unsetNullFlavor()
* @see #getNullFlavor()
* @generated
*/
void setNullFlavor(NullFlavor value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getNullFlavor Null Flavor}' attribute.
*
*
* @see #isSetNullFlavor()
* @see #getNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @generated
*/
void unsetNullFlavor();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getNullFlavor Null Flavor}' attribute is set.
*
*
* @return whether the value of the 'Null Flavor' attribute is set.
* @see #unsetNullFlavor()
* @see #getNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @generated
*/
boolean isSetNullFlavor();
/**
* Returns the value of the 'Class Code' attribute.
* The default value is "DOCCLIN".
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.ActClinicalDocument}.
*
*
* If the meaning of the 'Class Code' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Class Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.ActClinicalDocument
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(ActClinicalDocument)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_ClassCode()
* @model default="DOCCLIN" unsettable="true" ordered="false"
* @generated
*/
ActClinicalDocument getClassCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getClassCode Class Code}' attribute.
*
*
* @param value the new value of the 'Class Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.ActClinicalDocument
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(ActClinicalDocument value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getClassCode Class Code}' attribute.
*
*
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(ActClinicalDocument)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getClassCode Class Code}' attribute is set.
*
*
* @return whether the value of the 'Class Code' attribute is set.
* @see #unsetClassCode()
* @see #getClassCode()
* @see #setClassCode(ActClinicalDocument)
* @generated
*/
boolean isSetClassCode();
/**
* Returns the value of the 'Mood Code' attribute.
* The default value is "EVN".
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.ActMood}.
*
*
* If the meaning of the 'Mood Code' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Mood Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.ActMood
* @see #isSetMoodCode()
* @see #unsetMoodCode()
* @see #setMoodCode(ActMood)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getClinicalDocument_MoodCode()
* @model default="EVN" unsettable="true" ordered="false"
* @generated
*/
ActMood getMoodCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getMoodCode Mood Code}' attribute.
*
*
* @param value the new value of the 'Mood Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.ActMood
* @see #isSetMoodCode()
* @see #unsetMoodCode()
* @see #getMoodCode()
* @generated
*/
void setMoodCode(ActMood value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getMoodCode Mood Code}' attribute.
*
*
* @see #isSetMoodCode()
* @see #getMoodCode()
* @see #setMoodCode(ActMood)
* @generated
*/
void unsetMoodCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.ClinicalDocument#getMoodCode Mood Code}' attribute is set.
*
*
* @return whether the value of the 'Mood Code' attribute is set.
* @see #unsetMoodCode()
* @see #getMoodCode()
* @see #setMoodCode(ActMood)
* @generated
*/
boolean isSetMoodCode();
/**
*
*
*
* self.classCode=vocab::ActClinicalDocument::DOCCLIN
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.classCode=vocab::ActClinicalDocument::DOCCLIN'"
* @generated
*/
boolean validateClassCode(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* self.moodCode=vocab::ActMood::EVN
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.moodCode=vocab::ActMood::EVN'"
* @generated
*/
boolean validateMoodCode(DiagnosticChain diagnostics, Map context);
/**
*
*
* @model structuredBodyRequired="true" structuredBodyOrdered="false"
* @generated
*/
void setStructuredBody(StructuredBody structuredBody);
/**
*
*
* @model sectionRequired="true" sectionOrdered="false"
* @generated
*/
void addSection(Section section);
/**
*
*
*
* self.recordTarget.patientRole.patient
*
* @model kind="operation" unique="false" ordered="false"
* annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.recordTarget.patientRole.patient'"
* @generated
*/
EList getPatients();
/**
*
*
*
* self.recordTarget.patientRole
*
* @model kind="operation" unique="false" ordered="false"
* annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.recordTarget.patientRole'"
* @generated
*/
EList getPatientRoles();
/**
*
*
*
* if self.component.structuredBody.oclIsUndefined() then Bag{} else self.component.structuredBody.component.section endif
*
* @model kind="operation" unique="false" ordered="false"
* annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='if self.component.structuredBody.oclIsUndefined() then Bag{} else self.component.structuredBody.component.section endif'"
* @generated
*/
EList getSections();
/**
*
*
* @model kind="operation" unique="false" ordered="false"
* @generated
*/
EList getAllSections();
/**
*
*
*
* self.code.code = code and self.code.codeSystem = codeSystem and self.code.codeSystemName = codeSystemName
*
* @model required="true" ordered="false" codeRequired="true" codeOrdered="false" codeSystemRequired="true" codeSystemOrdered="false" codeSystemNameRequired="true" codeSystemNameOrdered="false"
* annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.code.code = code and self.code.codeSystem = codeSystem and self.code.codeSystemName = codeSystemName'"
* @generated
*/
boolean hasCode(String code, String codeSystem, String codeSystemName);
/**
*
*
*
* self.getSections()->exists(sect : cda::Section | sect.hasTemplateId(templateId))
*
* @model required="true" ordered="false" templateIdRequired="true" templateIdOrdered="false"
* annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.getSections()->exists(sect : cda::Section | sect.hasTemplateId(templateId))'"
* @generated
*/
boolean hasSectionTemplate(String templateId);
/**
*
*
*
* self.templateId->exists(id : datatypes::II | id.root = templateId)
*
* @model required="true" ordered="false" templateIdRequired="true" templateIdOrdered="false"
* annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.templateId->exists(id : datatypes::II | id.root = templateId)'"
* @generated
*/
boolean hasTemplateId(String templateId);
/**
*
*
* @model patientRoleRequired="true" patientRoleOrdered="false"
* @generated
*/
void addPatientRole(PatientRole patientRole);
/**
*
*
* @model patientRequired="true" patientOrdered="false"
* @generated
*/
void addPatient(Patient patient);
} // ClinicalDocument