/******************************************************************************* | |
* 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.AD; | |
import org.eclipse.mdht.uml.hl7.datatypes.CS; | |
import org.eclipse.mdht.uml.hl7.datatypes.II; | |
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.RoleClass; | |
/** | |
* <!-- begin-user-doc --> | |
* A representation of the model object '<em><b>Patient Role</b></em>'. | |
* <!-- end-user-doc --> | |
* | |
* <p> | |
* The following features are supported: | |
* </p> | |
* <ul> | |
* <li>{@link org.eclipse.mdht.uml.cda.PatientRole#getRealmCodes <em>Realm Code</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.PatientRole#getTypeId <em>Type Id</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.PatientRole#getTemplateIds <em>Template Id</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.PatientRole#getIds <em>Id</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.PatientRole#getAddrs <em>Addr</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.PatientRole#getTelecoms <em>Telecom</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.PatientRole#getPatient <em>Patient</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.PatientRole#getProviderOrganization <em>Provider Organization</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.PatientRole#getNullFlavor <em>Null Flavor</em>}</li> | |
* <li>{@link org.eclipse.mdht.uml.cda.PatientRole#getClassCode <em>Class Code</em>}</li> | |
* </ul> | |
* | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPatientRole() | |
* @model | |
* @generated | |
*/ | |
public interface PatientRole 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#getPatientRole_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#getPatientRole_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.PatientRole#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#getPatientRole_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#getPatientRole_Id() | |
* @model containment="true" required="true" ordered="false" | |
* extendedMetaData="namespace='##targetNamespace' kind='element'" | |
* @generated | |
*/ | |
EList<II> getIds(); | |
/** | |
* 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#getPatientRole_Addr() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="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#getPatientRole_Telecom() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="namespace='##targetNamespace' kind='element'" | |
* @generated | |
*/ | |
EList<TEL> getTelecoms(); | |
/** | |
* Returns the value of the '<em><b>Patient</b></em>' containment reference. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>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>Patient</em>' containment reference. | |
* @see #setPatient(Patient) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPatientRole_Patient() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="namespace='##targetNamespace' kind='element'" | |
* @generated | |
*/ | |
Patient getPatient(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.PatientRole#getPatient <em>Patient</em>}' containment reference. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @param value the new value of the '<em>Patient</em>' containment reference. | |
* @see #getPatient() | |
* @generated | |
*/ | |
void setPatient(Patient value); | |
/** | |
* Returns the value of the '<em><b>Provider Organization</b></em>' containment reference. | |
* <!-- begin-user-doc --> | |
* <p> | |
* If the meaning of the '<em>Provider Organization</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>Provider Organization</em>' containment reference. | |
* @see #setProviderOrganization(Organization) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPatientRole_ProviderOrganization() | |
* @model containment="true" ordered="false" | |
* extendedMetaData="namespace='##targetNamespace' kind='element'" | |
* @generated | |
*/ | |
Organization getProviderOrganization(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.PatientRole#getProviderOrganization <em>Provider Organization</em>}' containment reference. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @param value the new value of the '<em>Provider Organization</em>' containment reference. | |
* @see #getProviderOrganization() | |
* @generated | |
*/ | |
void setProviderOrganization(Organization 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#getPatientRole_NullFlavor() | |
* @model unsettable="true" ordered="false" | |
* @generated | |
*/ | |
NullFlavor getNullFlavor(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.PatientRole#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.PatientRole#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.PatientRole#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>"PAT"</code>. | |
* The literals are from the enumeration {@link org.eclipse.mdht.uml.hl7.vocab.RoleClass}. | |
* <!-- 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.RoleClass | |
* @see #isSetClassCode() | |
* @see #unsetClassCode() | |
* @see #setClassCode(RoleClass) | |
* @see org.eclipse.mdht.uml.cda.CDAPackage#getPatientRole_ClassCode() | |
* @model default="PAT" unsettable="true" ordered="false" | |
* @generated | |
*/ | |
RoleClass getClassCode(); | |
/** | |
* Sets the value of the '{@link org.eclipse.mdht.uml.cda.PatientRole#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.RoleClass | |
* @see #isSetClassCode() | |
* @see #unsetClassCode() | |
* @see #getClassCode() | |
* @generated | |
*/ | |
void setClassCode(RoleClass value); | |
/** | |
* Unsets the value of the '{@link org.eclipse.mdht.uml.cda.PatientRole#getClassCode <em>Class Code</em>}' attribute. | |
* <!-- begin-user-doc --> | |
* <!-- end-user-doc --> | |
* @see #isSetClassCode() | |
* @see #getClassCode() | |
* @see #setClassCode(RoleClass) | |
* @generated | |
*/ | |
void unsetClassCode(); | |
/** | |
* Returns whether the value of the '{@link org.eclipse.mdht.uml.cda.PatientRole#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(RoleClass) | |
* @generated | |
*/ | |
boolean isSetClassCode(); | |
/** | |
* <!-- 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::RoleClass::PAT'" | |
* @generated | |
*/ | |
boolean validateClassCode(DiagnosticChain diagnostics, Map<Object, Object> context); | |
} // PatientRole |