org.openhealthtools.mdht.uml.cda.RegionOfInterest 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.CS;
import org.openhealthtools.mdht.uml.hl7.datatypes.II;
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 'Region Of Interest'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getIds Id}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getCode Code}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getValues Value}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getSubject Subject}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getSpecimens Specimen}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getPerformers Performer}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getAuthors Author}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getInformants Informant}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getParticipants Participant}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getEntryRelationships Entry Relationship}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getReferences Reference}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getPreconditions Precondition}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getRegionOfInterestId Region Of Interest Id}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getClassCode Class Code}
* - {@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getMoodCode Mood Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRegionOfInterest()
* @model
* @generated
*/
public interface RegionOfInterest extends ClinicalStatement {
/**
* 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#getRegionOfInterest_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#getRegionOfInterest_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#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#getRegionOfInterest_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getTemplateIds();
/**
* Returns the value of the 'Id' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.hl7.datatypes.II}.
*
*
* If the meaning of the 'Id' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Id' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRegionOfInterest_Id()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getIds();
/**
* 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(CS)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRegionOfInterest_Code()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
CS getCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getCode Code}' containment reference.
*
*
* @param value the new value of the 'Code' containment reference.
* @see #getCode()
* @generated
*/
void setCode(CS value);
/**
* Returns the value of the 'Value' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.RegionOfInterestValue}.
*
*
* If the meaning of the 'Value' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Value' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRegionOfInterest_Value()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getValues();
/**
* Returns the value of the 'Subject' containment reference.
*
*
* If the meaning of the 'Subject' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Subject' containment reference.
* @see #setSubject(Subject)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRegionOfInterest_Subject()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Subject getSubject();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getSubject Subject}' containment reference.
*
*
* @param value the new value of the 'Subject' containment reference.
* @see #getSubject()
* @generated
*/
void setSubject(Subject value);
/**
* Returns the value of the 'Specimen' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Specimen}.
*
*
* If the meaning of the 'Specimen' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Specimen' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRegionOfInterest_Specimen()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getSpecimens();
/**
* Returns the value of the 'Performer' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Performer2}.
*
*
* If the meaning of the 'Performer' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Performer' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRegionOfInterest_Performer()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getPerformers();
/**
* 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#getRegionOfInterest_Author()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getAuthors();
/**
* 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#getRegionOfInterest_Informant()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getInformants();
/**
* Returns the value of the 'Participant' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Participant2}.
*
*
* 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#getRegionOfInterest_Participant()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getParticipants();
/**
* Returns the value of the 'Entry Relationship' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.EntryRelationship}.
*
*
* If the meaning of the 'Entry Relationship' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Entry Relationship' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRegionOfInterest_EntryRelationship()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getEntryRelationships();
/**
* Returns the value of the 'Reference' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Reference}.
*
*
* If the meaning of the 'Reference' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Reference' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRegionOfInterest_Reference()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getReferences();
/**
* Returns the value of the 'Precondition' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Precondition}.
*
*
* If the meaning of the 'Precondition' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Precondition' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRegionOfInterest_Precondition()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getPreconditions();
/**
* Returns the value of the 'Region Of Interest Id' attribute.
*
*
* If the meaning of the 'Region Of Interest Id' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Region Of Interest Id' attribute.
* @see #setRegionOfInterestId(String)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRegionOfInterest_RegionOfInterestId()
* @model required="true" ordered="false"
* extendedMetaData="name='ID' kind='attribute'"
* @generated
*/
String getRegionOfInterestId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#getRegionOfInterestId Region Of Interest Id}' attribute.
*
*
* @param value the new value of the 'Region Of Interest Id' attribute.
* @see #getRegionOfInterestId()
* @generated
*/
void setRegionOfInterestId(String 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#getRegionOfInterest_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#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.RegionOfInterest#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.RegionOfInterest#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 "ROIOVL".
* 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#getRegionOfInterest_ClassCode()
* @model default="ROIOVL" unsettable="true" required="true" ordered="false"
* @generated
*/
ActClass getClassCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#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.RegionOfInterest#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.RegionOfInterest#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#getRegionOfInterest_MoodCode()
* @model default="EVN" unsettable="true" required="true" ordered="false"
* @generated
*/
ActMood getMoodCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RegionOfInterest#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.RegionOfInterest#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.RegionOfInterest#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::ROIOVL
* @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::ROIOVL'"
* @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);
} // RegionOfInterest