blob: 5fb2ba66cf39d204bfbe7857d3186877a54b09be [file] [log] [blame]
/*******************************************************************************
* 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.eclipse.mdht.uml.cda;
import java.util.Map;
import org.eclipse.emf.common.util.DiagnosticChain;
import org.eclipse.emf.common.util.EList;
import org.eclipse.mdht.uml.hl7.datatypes.CS;
import org.eclipse.mdht.uml.hl7.datatypes.II;
import org.eclipse.mdht.uml.hl7.vocab.ActClass;
import org.eclipse.mdht.uml.hl7.vocab.ActMood;
import org.eclipse.mdht.uml.hl7.vocab.NullFlavor;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Region Of Interest</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getRealmCodes <em>Realm Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getTypeId <em>Type Id</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getTemplateIds <em>Template Id</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getIds <em>Id</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getCode <em>Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getValues <em>Value</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getSubject <em>Subject</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getSpecimens <em>Specimen</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getPerformers <em>Performer</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getAuthors <em>Author</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getInformants <em>Informant</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getParticipants <em>Participant</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getEntryRelationships <em>Entry Relationship</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getReferences <em>Reference</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getPreconditions <em>Precondition</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getRegionOfInterestId <em>Region Of Interest Id</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getNullFlavor <em>Null Flavor</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getClassCode <em>Class Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getMoodCode <em>Mood Code</em>}</li>
* </ul>
*
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest()
* @model
* @generated
*/
public interface RegionOfInterest extends ClinicalStatement {
/**
* Returns the value of the '<em><b>Realm Code</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.CS}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Realm Code</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Realm Code</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_RealmCode()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<CS> getRealmCodes();
/**
* Returns the value of the '<em><b>Type Id</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Type Id</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Type Id</em>' containment reference.
* @see #setTypeId(InfrastructureRootTypeId)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getTypeId <em>Type Id</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Type Id</em>' containment reference.
* @see #getTypeId()
* @generated
*/
void setTypeId(InfrastructureRootTypeId value);
/**
* Returns the value of the '<em><b>Template Id</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.II}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Template Id</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Template Id</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<II> getTemplateIds();
/**
* Returns the value of the '<em><b>Id</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.II}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Id</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Id</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_Id()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<II> getIds();
/**
* Returns the value of the '<em><b>Code</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Code</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Code</em>' containment reference.
* @see #setCode(CS)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_Code()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
CS getCode();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getCode <em>Code</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Code</em>' containment reference.
* @see #getCode()
* @generated
*/
void setCode(CS value);
/**
* Returns the value of the '<em><b>Value</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.cda.RegionOfInterestValue}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Value</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Value</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_Value()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<RegionOfInterestValue> getValues();
/**
* Returns the value of the '<em><b>Subject</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Subject</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Subject</em>' containment reference.
* @see #setSubject(Subject)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_Subject()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
Subject getSubject();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getSubject <em>Subject</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Subject</em>' containment reference.
* @see #getSubject()
* @generated
*/
void setSubject(Subject value);
/**
* Returns the value of the '<em><b>Specimen</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.cda.Specimen}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Specimen</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Specimen</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_Specimen()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<Specimen> getSpecimens();
/**
* Returns the value of the '<em><b>Performer</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.cda.Performer2}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Performer</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Performer</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_Performer()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<Performer2> getPerformers();
/**
* Returns the value of the '<em><b>Author</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.cda.Author}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Author</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Author</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_Author()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<Author> getAuthors();
/**
* Returns the value of the '<em><b>Informant</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.cda.Informant12}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Informant</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Informant</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_Informant()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<Informant12> getInformants();
/**
* Returns the value of the '<em><b>Participant</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.cda.Participant2}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Participant</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Participant</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_Participant()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<Participant2> getParticipants();
/**
* Returns the value of the '<em><b>Entry Relationship</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.cda.EntryRelationship}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Entry Relationship</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Entry Relationship</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_EntryRelationship()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<EntryRelationship> getEntryRelationships();
/**
* Returns the value of the '<em><b>Reference</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.cda.Reference}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Reference</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Reference</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_Reference()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<Reference> getReferences();
/**
* Returns the value of the '<em><b>Precondition</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.cda.Precondition}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Precondition</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Precondition</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_Precondition()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<Precondition> getPreconditions();
/**
* Returns the value of the '<em><b>Region Of Interest Id</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Region Of Interest Id</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Region Of Interest Id</em>' attribute.
* @see #setRegionOfInterestId(String)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_RegionOfInterestId()
* @model dataType="org.eclipse.uml2.types.String" required="true" ordered="false"
* extendedMetaData="name='ID' kind='attribute'"
* @generated
*/
String getRegionOfInterestId();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getRegionOfInterestId <em>Region Of Interest Id</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Region Of Interest Id</em>' attribute.
* @see #getRegionOfInterestId()
* @generated
*/
void setRegionOfInterestId(String value);
/**
* Returns the value of the '<em><b>Null Flavor</b></em>' attribute.
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.NullFlavor}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Null Flavor</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Null Flavor</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.NullFlavor
* @see #isSetNullFlavor()
* @see #unsetNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getNullFlavor <em>Null Flavor</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Null Flavor</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.NullFlavor
* @see #isSetNullFlavor()
* @see #unsetNullFlavor()
* @see #getNullFlavor()
* @generated
*/
void setNullFlavor(NullFlavor value);
/**
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getNullFlavor <em>Null Flavor</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetNullFlavor()
* @see #getNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @generated
*/
void unsetNullFlavor();
/**
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getNullFlavor <em>Null Flavor</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Null Flavor</em>' attribute is set.
* @see #unsetNullFlavor()
* @see #getNullFlavor()
* @see #setNullFlavor(NullFlavor)
* @generated
*/
boolean isSetNullFlavor();
/**
* Returns the value of the '<em><b>Class Code</b></em>' attribute.
* The default value is <code>"ROIOVL"</code>.
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.ActClass}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Class Code</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Class Code</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.ActClass
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(ActClass)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_ClassCode()
* @model default="ROIOVL" unsettable="true" required="true" ordered="false"
* @generated
*/
ActClass getClassCode();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getClassCode <em>Class Code</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Class Code</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.ActClass
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(ActClass value);
/**
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getClassCode <em>Class Code</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(ActClass)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getClassCode <em>Class Code</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Class Code</em>' attribute is set.
* @see #unsetClassCode()
* @see #getClassCode()
* @see #setClassCode(ActClass)
* @generated
*/
boolean isSetClassCode();
/**
* Returns the value of the '<em><b>Mood Code</b></em>' attribute.
* The default value is <code>"EVN"</code>.
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.ActMood}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Mood Code</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Mood Code</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.ActMood
* @see #isSetMoodCode()
* @see #unsetMoodCode()
* @see #setMoodCode(ActMood)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRegionOfInterest_MoodCode()
* @model default="EVN" unsettable="true" required="true" ordered="false"
* @generated
*/
ActMood getMoodCode();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getMoodCode <em>Mood Code</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Mood Code</em>' attribute.
* @see org.eclipse.mdht.uml.hl7.vocab.ActMood
* @see #isSetMoodCode()
* @see #unsetMoodCode()
* @see #getMoodCode()
* @generated
*/
void setMoodCode(ActMood value);
/**
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getMoodCode <em>Mood Code</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetMoodCode()
* @see #getMoodCode()
* @see #setMoodCode(ActMood)
* @generated
*/
void unsetMoodCode();
/**
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.RegionOfInterest#getMoodCode <em>Mood Code</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Mood Code</em>' attribute is set.
* @see #unsetMoodCode()
* @see #getMoodCode()
* @see #setMoodCode(ActMood)
* @generated
*/
boolean isSetMoodCode();
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
* <!-- end-model-doc -->
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.isClassCodeDefined() implies self.classCode=vocab::ActClass::ROIOVL'"
* @generated
*/
boolean validateClassCode(DiagnosticChain diagnostics, Map<Object, Object> context);
/**
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
* <!-- end-model-doc -->
* @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<Object, Object> context);
} // RegionOfInterest