org.openhealthtools.mdht.uml.cda.Encounter 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 org.eclipse.emf.common.util.EList;
import org.openhealthtools.mdht.uml.hl7.datatypes.CD;
import org.openhealthtools.mdht.uml.hl7.datatypes.CE;
import org.openhealthtools.mdht.uml.hl7.datatypes.CS;
import org.openhealthtools.mdht.uml.hl7.datatypes.ED;
import org.openhealthtools.mdht.uml.hl7.datatypes.II;
import org.openhealthtools.mdht.uml.hl7.datatypes.IVL_TS;
import org.openhealthtools.mdht.uml.hl7.vocab.ActClass;
import org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor;
import org.openhealthtools.mdht.uml.hl7.vocab.x_DocumentEncounterMood;
/**
*
* A representation of the model object 'Encounter'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getIds Id}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getCode Code}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getText Text}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getStatusCode Status Code}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getEffectiveTime Effective Time}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getPriorityCode Priority Code}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getSubject Subject}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getSpecimens Specimen}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getPerformers Performer}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getAuthors Author}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getInformants Informant}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getParticipants Participant}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getEntryRelationships Entry Relationship}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getReferences Reference}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getPreconditions Precondition}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getClassCode Class Code}
* - {@link org.openhealthtools.mdht.uml.cda.Encounter#getMoodCode Mood Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEncounter()
* @model
* @generated
*/
public interface Encounter 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#getEncounter_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#getEncounter_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#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#getEncounter_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#getEncounter_Id()
* @model containment="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(CD)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEncounter_Code()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
CD getCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#getCode Code}' containment reference.
*
*
* @param value the new value of the 'Code' containment reference.
* @see #getCode()
* @generated
*/
void setCode(CD value);
/**
* Returns the value of the 'Text' containment reference.
*
*
* If the meaning of the 'Text' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Text' containment reference.
* @see #setText(ED)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEncounter_Text()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
ED getText();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#getText Text}' containment reference.
*
*
* @param value the new value of the 'Text' containment reference.
* @see #getText()
* @generated
*/
void setText(ED value);
/**
* Returns the value of the 'Status Code' containment reference.
*
*
* If the meaning of the 'Status Code' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Status Code' containment reference.
* @see #setStatusCode(CS)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEncounter_StatusCode()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
CS getStatusCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#getStatusCode Status Code}' containment reference.
*
*
* @param value the new value of the 'Status Code' containment reference.
* @see #getStatusCode()
* @generated
*/
void setStatusCode(CS 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(IVL_TS)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEncounter_EffectiveTime()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
IVL_TS getEffectiveTime();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#getEffectiveTime Effective Time}' containment reference.
*
*
* @param value the new value of the 'Effective Time' containment reference.
* @see #getEffectiveTime()
* @generated
*/
void setEffectiveTime(IVL_TS value);
/**
* Returns the value of the 'Priority Code' containment reference.
*
*
* If the meaning of the 'Priority Code' reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Priority Code' containment reference.
* @see #setPriorityCode(CE)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEncounter_PriorityCode()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
CE getPriorityCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#getPriorityCode Priority Code}' containment reference.
*
*
* @param value the new value of the 'Priority Code' containment reference.
* @see #getPriorityCode()
* @generated
*/
void setPriorityCode(CE value);
/**
* 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#getEncounter_Subject()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Subject getSubject();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#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#getEncounter_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#getEncounter_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#getEncounter_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#getEncounter_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#getEncounter_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#getEncounter_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#getEncounter_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#getEncounter_Precondition()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getPreconditions();
/**
* 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#getEncounter_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#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.Encounter#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.Encounter#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 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#getEncounter_ClassCode()
* @model unsettable="true" required="true" ordered="false"
* @generated
*/
ActClass getClassCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#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.Encounter#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.Encounter#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 literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.x_DocumentEncounterMood}.
*
*
* 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.x_DocumentEncounterMood
* @see #isSetMoodCode()
* @see #unsetMoodCode()
* @see #setMoodCode(x_DocumentEncounterMood)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEncounter_MoodCode()
* @model unsettable="true" required="true" ordered="false"
* @generated
*/
x_DocumentEncounterMood getMoodCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#getMoodCode Mood Code}' attribute.
*
*
* @param value the new value of the 'Mood Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.x_DocumentEncounterMood
* @see #isSetMoodCode()
* @see #unsetMoodCode()
* @see #getMoodCode()
* @generated
*/
void setMoodCode(x_DocumentEncounterMood value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#getMoodCode Mood Code}' attribute.
*
*
* @see #isSetMoodCode()
* @see #getMoodCode()
* @see #setMoodCode(x_DocumentEncounterMood)
* @generated
*/
void unsetMoodCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.Encounter#getMoodCode Mood Code}' attribute is set.
*
*
* @return whether the value of the 'Mood Code' attribute is set.
* @see #unsetMoodCode()
* @see #getMoodCode()
* @see #setMoodCode(x_DocumentEncounterMood)
* @generated
*/
boolean isSetMoodCode();
} // Encounter