org.openhealthtools.mdht.uml.cda.AssignedEntity 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.CE;
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.RoleClassAssignedEntity;
/**
*
* A representation of the model object 'Assigned Entity'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getIds Id}
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getCode Code}
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getAddrs Addr}
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getTelecoms Telecom}
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getAssignedPerson Assigned Person}
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getRepresentedOrganizations Represented Organization}
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getSDTCPatient SDTC Patient}
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getClassCode Class Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getAssignedEntity()
* @model
* @generated
*/
public interface AssignedEntity 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#getAssignedEntity_RealmCode()
* @model containment="true" ordered="false"
* extendedMetaData="name='realmCode' namespace='##targetNamespace' kind='element'"
* @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#getAssignedEntity_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="name='typeId' namespace='##targetNamespace' kind='element'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.AssignedEntity#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#getAssignedEntity_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="name='templateId' namespace='##targetNamespace' kind='element'"
* @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#getAssignedEntity_Id()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="name='id' namespace='##targetNamespace' kind='element'"
* @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(CE)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getAssignedEntity_Code()
* @model containment="true" ordered="false"
* extendedMetaData="name='code' namespace='##targetNamespace' kind='element'"
* @generated
*/
CE getCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getCode Code}' containment reference.
*
*
* @param value the new value of the 'Code' containment reference.
* @see #getCode()
* @generated
*/
void setCode(CE value);
/**
* 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#getAssignedEntity_Addr()
* @model containment="true" ordered="false"
* extendedMetaData="name='addr' namespace='##targetNamespace' kind='element'"
* @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#getAssignedEntity_Telecom()
* @model containment="true" ordered="false"
* extendedMetaData="name='telecom' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList getTelecoms();
/**
* Returns the value of the 'SDTC Patient' containment reference.
*
*
* If the meaning of the 'SDTC Patient' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'SDTC Patient' containment reference.
* @see #setSDTCPatient(SDTCPatient)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getAssignedEntity_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.openhealthtools.mdht.uml.cda.AssignedEntity#getSDTCPatient SDTC Patient}' containment reference.
*
*
* @param value the new value of the 'SDTC Patient' containment reference.
* @see #getSDTCPatient()
* @generated
*/
void setSDTCPatient(SDTCPatient value);
/**
* Returns the value of the 'Assigned Person' containment reference.
*
*
* If the meaning of the 'Assigned Person' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Assigned Person' containment reference.
* @see #setAssignedPerson(Person)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getAssignedEntity_AssignedPerson()
* @model containment="true" ordered="false"
* extendedMetaData="name='assignedPerson' namespace='##targetNamespace' kind='element'"
* @generated
*/
Person getAssignedPerson();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getAssignedPerson Assigned Person}' containment reference.
*
*
* @param value the new value of the 'Assigned Person' containment reference.
* @see #getAssignedPerson()
* @generated
*/
void setAssignedPerson(Person value);
/**
* Returns the value of the 'Represented Organization' containment reference list.
* The list contents are of type {@link org.openhealthtools.mdht.uml.cda.Organization}.
*
*
* If the meaning of the 'Represented Organization' containment reference list isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Represented Organization' containment reference list.
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getAssignedEntity_RepresentedOrganization()
* @model containment="true" ordered="false"
* extendedMetaData="name='representedOrganization' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList getRepresentedOrganizations();
/**
* 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#getAssignedEntity_NullFlavor()
* @model unsettable="true" ordered="false"
* extendedMetaData="name='nullFlavor' kind='attribute'"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.AssignedEntity#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.AssignedEntity#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.AssignedEntity#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 "ASSIGNED".
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.RoleClassAssignedEntity}.
*
*
* 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.RoleClassAssignedEntity
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(RoleClassAssignedEntity)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getAssignedEntity_ClassCode()
* @model default="ASSIGNED" unsettable="true" ordered="false"
* extendedMetaData="name='classCode' kind='attribute'"
* @generated
*/
RoleClassAssignedEntity getClassCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getClassCode Class Code}' attribute.
*
*
* @param value the new value of the 'Class Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.RoleClassAssignedEntity
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(RoleClassAssignedEntity value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getClassCode Class Code}' attribute.
*
*
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(RoleClassAssignedEntity)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.AssignedEntity#getClassCode Class Code}' attribute is set.
*
*
* @return whether the value of the 'Class Code' attribute is set.
* @see #unsetClassCode()
* @see #getClassCode()
* @see #setClassCode(RoleClassAssignedEntity)
* @generated
*/
boolean isSetClassCode();
/**
*
*
*
* self.isClassCodeDefined() implies self.classCode=vocab::RoleClassAssignedEntity::ASSIGNED
* @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::RoleClassAssignedEntity::ASSIGNED'"
* @generated
*/
boolean validateClassCode(DiagnosticChain diagnostics, Map context);
} // AssignedEntity