blob: b28ed923c5e5b24e3ddddef0da7b3febfeb5b765 [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 org.eclipse.emf.common.util.EList;
import org.eclipse.mdht.uml.hl7.datatypes.AD;
import org.eclipse.mdht.uml.hl7.datatypes.CE;
import org.eclipse.mdht.uml.hl7.datatypes.CS;
import org.eclipse.mdht.uml.hl7.datatypes.II;
import org.eclipse.mdht.uml.hl7.datatypes.IVL_TS;
import org.eclipse.mdht.uml.hl7.datatypes.TEL;
import org.eclipse.mdht.uml.hl7.rim.Role;
import org.eclipse.mdht.uml.hl7.vocab.NullFlavor;
import org.eclipse.mdht.uml.hl7.vocab.RoleClassMutualRelationship;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Related Entity</b></em>'.
* <!-- end-user-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.mdht.uml.cda.RelatedEntity#getRealmCodes <em>Realm Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RelatedEntity#getTypeId <em>Type Id</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RelatedEntity#getTemplateIds <em>Template Id</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RelatedEntity#getCode <em>Code</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RelatedEntity#getAddrs <em>Addr</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RelatedEntity#getTelecoms <em>Telecom</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RelatedEntity#getEffectiveTime <em>Effective Time</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RelatedEntity#getRelatedPerson <em>Related Person</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RelatedEntity#getSDTCPatient <em>SDTC Patient</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RelatedEntity#getNullFlavor <em>Null Flavor</em>}</li>
* <li>{@link org.eclipse.mdht.uml.cda.RelatedEntity#getClassCode <em>Class Code</em>}</li>
* </ul>
*
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRelatedEntity()
* @model
* @generated
*/
public interface RelatedEntity extends Role {
/**
* 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#getRelatedEntity_RealmCode()
* @model containment="true" ordered="false"
* extendedMetaData="name='realmCode' 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#getRelatedEntity_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="name='typeId' namespace='##targetNamespace' kind='element'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RelatedEntity#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#getRelatedEntity_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="name='templateId' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<II> getTemplateIds();
/**
* 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(CE)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRelatedEntity_Code()
* @model containment="true" ordered="false"
* extendedMetaData="name='code' namespace='##targetNamespace' kind='element'"
* @generated
*/
CE getCode();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RelatedEntity#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(CE value);
/**
* Returns the value of the '<em><b>Addr</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.AD}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Addr</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>Addr</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRelatedEntity_Addr()
* @model containment="true" ordered="false"
* extendedMetaData="name='addr' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<AD> getAddrs();
/**
* Returns the value of the '<em><b>Telecom</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.hl7.datatypes.TEL}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Telecom</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>Telecom</em>' containment reference list.
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRelatedEntity_Telecom()
* @model containment="true" ordered="false"
* extendedMetaData="name='telecom' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList<TEL> getTelecoms();
/**
* Returns the value of the '<em><b>Effective Time</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Effective Time</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>Effective Time</em>' containment reference.
* @see #setEffectiveTime(IVL_TS)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRelatedEntity_EffectiveTime()
* @model containment="true" ordered="false"
* extendedMetaData="name='effectiveTime' namespace='##targetNamespace' kind='element'"
* @generated
*/
IVL_TS getEffectiveTime();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RelatedEntity#getEffectiveTime <em>Effective Time</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Effective Time</em>' containment reference.
* @see #getEffectiveTime()
* @generated
*/
void setEffectiveTime(IVL_TS value);
/**
* Returns the value of the '<em><b>SDTC Patient</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>SDTC Patient</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>SDTC Patient</em>' containment reference.
* @see #setSDTCPatient(SDTCPatient)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRelatedEntity_SDTCPatient()
* @model containment="true" ordered="false"
* extendedMetaData="name='patient' namespace='urn:hl7-org:sdtc' kind='element'"
* @generated
*/
SDTCPatient getSDTCPatient();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RelatedEntity#getSDTCPatient <em>SDTC Patient</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>SDTC Patient</em>' containment reference.
* @see #getSDTCPatient()
* @generated
*/
void setSDTCPatient(SDTCPatient value);
/**
* Returns the value of the '<em><b>Related Person</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Related Person</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>Related Person</em>' containment reference.
* @see #setRelatedPerson(Person)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRelatedEntity_RelatedPerson()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace' kind='element'"
* @generated
*/
Person getRelatedPerson();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RelatedEntity#getRelatedPerson <em>Related Person</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Related Person</em>' containment reference.
* @see #getRelatedPerson()
* @generated
*/
void setRelatedPerson(Person 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#getRelatedEntity_NullFlavor()
* @model unsettable="true" ordered="false"
* extendedMetaData="name='nullFlavor' kind='attribute'"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RelatedEntity#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.RelatedEntity#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.RelatedEntity#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 literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.RoleClassMutualRelationship}.
* <!-- 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.RoleClassMutualRelationship
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(RoleClassMutualRelationship)
* @see org.eclipse.mdht.uml.cda.CDAPackage#getRelatedEntity_ClassCode()
* @model unsettable="true" required="true" ordered="false"
* extendedMetaData="name='classCode' kind='attribute'"
* @generated
*/
RoleClassMutualRelationship getClassCode();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.RelatedEntity#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.RoleClassMutualRelationship
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(RoleClassMutualRelationship value);
/**
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.RelatedEntity#getClassCode <em>Class Code</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(RoleClassMutualRelationship)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.RelatedEntity#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(RoleClassMutualRelationship)
* @generated
*/
boolean isSetClassCode();
} // RelatedEntity