org.openhealthtools.mdht.uml.cda.StructuredBody 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.rim.Act;
import org.openhealthtools.mdht.uml.hl7.vocab.ActClass;
import org.openhealthtools.mdht.uml.hl7.vocab.ActMood;
import org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor;
/**
*
* A representation of the model object 'Structured Body'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.StructuredBody#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.StructuredBody#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.StructuredBody#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.StructuredBody#getConfidentialityCode Confidentiality Code}
* - {@link org.openhealthtools.mdht.uml.cda.StructuredBody#getLanguageCode Language Code}
* - {@link org.openhealthtools.mdht.uml.cda.StructuredBody#getComponents Component}
* - {@link org.openhealthtools.mdht.uml.cda.StructuredBody#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.StructuredBody#getClassCode Class Code}
* - {@link org.openhealthtools.mdht.uml.cda.StructuredBody#getMoodCode Mood Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getStructuredBody()
* @model
* @generated
*/
public interface StructuredBody 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#getStructuredBody_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#getStructuredBody_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.StructuredBody#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#getStructuredBody_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getTemplateIds();
/**
* 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#getStructuredBody_ConfidentialityCode()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
CE getConfidentialityCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.StructuredBody#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#getStructuredBody_LanguageCode()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
CS getLanguageCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.StructuredBody#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 'Component' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Component3}.
*
*
* If the meaning of the 'Component' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Component' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getStructuredBody_Component()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getComponents();
/**
* 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#getStructuredBody_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.StructuredBody#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.StructuredBody#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.StructuredBody#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 "DOCBODY".
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.ActClass}.
*
*
* 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.ActClass
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(ActClass)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getStructuredBody_ClassCode()
* @model default="DOCBODY" unsettable="true" ordered="false"
* @generated
*/
ActClass getClassCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.StructuredBody#getClassCode Class Code}' attribute.
*
*
* @param value the new value of the 'Class Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.ActClass
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(ActClass value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.StructuredBody#getClassCode Class Code}' attribute.
*
*
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(ActClass)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.StructuredBody#getClassCode Class Code}' attribute is set.
*
*
* @return whether the value of the 'Class Code' attribute is set.
* @see #unsetClassCode()
* @see #getClassCode()
* @see #setClassCode(ActClass)
* @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#getStructuredBody_MoodCode()
* @model default="EVN" unsettable="true" ordered="false"
* @generated
*/
ActMood getMoodCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.StructuredBody#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.StructuredBody#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.StructuredBody#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.isClassCodeDefined() implies self.classCode=vocab::ActClass::DOCBODY
* @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.isClassCodeDefined() implies self.classCode=vocab::ActClass::DOCBODY'"
* @generated
*/
boolean validateClassCode(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* self.isMoodCodeDefined() implies 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.isMoodCodeDefined() implies self.moodCode=vocab::ActMood::EVN'"
* @generated
*/
boolean validateMoodCode(DiagnosticChain diagnostics, Map context);
} // StructuredBody