org.openhealthtools.mdht.uml.cda.PatientRole 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.AD;
import org.openhealthtools.mdht.uml.hl7.datatypes.CS;
import org.openhealthtools.mdht.uml.hl7.datatypes.II;
import org.openhealthtools.mdht.uml.hl7.datatypes.TEL;
import org.openhealthtools.mdht.uml.hl7.rim.Role;
import org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor;
import org.openhealthtools.mdht.uml.hl7.vocab.RoleClass;
/**
*
* A representation of the model object 'Patient Role'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.PatientRole#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.PatientRole#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.PatientRole#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.PatientRole#getIds Id}
* - {@link org.openhealthtools.mdht.uml.cda.PatientRole#getAddrs Addr}
* - {@link org.openhealthtools.mdht.uml.cda.PatientRole#getTelecoms Telecom}
* - {@link org.openhealthtools.mdht.uml.cda.PatientRole#getPatient Patient}
* - {@link org.openhealthtools.mdht.uml.cda.PatientRole#getProviderOrganization Provider Organization}
* - {@link org.openhealthtools.mdht.uml.cda.PatientRole#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.PatientRole#getClassCode Class Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatientRole()
* @model
* @generated
*/
public interface PatientRole extends Role {
/**
* 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#getPatientRole_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#getPatientRole_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.PatientRole#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#getPatientRole_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#getPatientRole_Id()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getIds();
/**
* Returns the value of the 'Addr' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.hl7.datatypes.AD}.
*
*
* If the meaning of the 'Addr' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Addr' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatientRole_Addr()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getAddrs();
/**
* Returns the value of the 'Telecom' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.hl7.datatypes.TEL}.
*
*
* If the meaning of the 'Telecom' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Telecom' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatientRole_Telecom()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getTelecoms();
/**
* Returns the value of the 'Patient' containment reference.
*
*
* If the meaning of the 'Patient' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Patient' containment reference.
* @see #setPatient(Patient)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatientRole_Patient()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Patient getPatient();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.PatientRole#getPatient Patient}' containment reference.
*
*
* @param value the new value of the 'Patient' containment reference.
* @see #getPatient()
* @generated
*/
void setPatient(Patient value);
/**
* Returns the value of the 'Provider Organization' containment reference.
*
*
* If the meaning of the 'Provider Organization' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Provider Organization' containment reference.
* @see #setProviderOrganization(Organization)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatientRole_ProviderOrganization()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Organization getProviderOrganization();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.PatientRole#getProviderOrganization Provider Organization}' containment reference.
*
*
* @param value the new value of the 'Provider Organization' containment reference.
* @see #getProviderOrganization()
* @generated
*/
void setProviderOrganization(Organization 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#getPatientRole_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.PatientRole#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.PatientRole#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.PatientRole#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 "PAT".
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.RoleClass}.
*
*
* 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.RoleClass
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(RoleClass)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getPatientRole_ClassCode()
* @model default="PAT" unsettable="true" ordered="false"
* @generated
*/
RoleClass getClassCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.PatientRole#getClassCode Class Code}' attribute.
*
*
* @param value the new value of the 'Class Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.RoleClass
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(RoleClass value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.PatientRole#getClassCode Class Code}' attribute.
*
*
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(RoleClass)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.PatientRole#getClassCode Class Code}' attribute is set.
*
*
* @return whether the value of the 'Class Code' attribute is set.
* @see #unsetClassCode()
* @see #getClassCode()
* @see #setClassCode(RoleClass)
* @generated
*/
boolean isSetClassCode();
/**
*
*
*
* self.isClassCodeDefined() implies self.classCode=vocab::RoleClass::PAT
* @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::RoleClass::PAT'"
* @generated
*/
boolean validateClassCode(DiagnosticChain diagnostics, Map context);
} // PatientRole