org.openhealthtools.mdht.uml.cda.IntendedRecipient 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.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.x_InformationRecipientRole;
/**
*
* A representation of the model object 'Intended Recipient'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getIds Id}
* - {@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getAddrs Addr}
* - {@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getTelecoms Telecom}
* - {@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getInformationRecipient Information Recipient}
* - {@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getReceivedOrganization Received Organization}
* - {@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getClassCode Class Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getIntendedRecipient()
* @model
* @generated
*/
public interface IntendedRecipient 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#getIntendedRecipient_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#getIntendedRecipient_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#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#getIntendedRecipient_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#getIntendedRecipient_Id()
* @model containment="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#getIntendedRecipient_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#getIntendedRecipient_Telecom()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getTelecoms();
/**
* Returns the value of the 'Information Recipient' containment reference.
*
*
* If the meaning of the 'Information Recipient' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Information Recipient' containment reference.
* @see #setInformationRecipient(Person)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getIntendedRecipient_InformationRecipient()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Person getInformationRecipient();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getInformationRecipient Information Recipient}' containment reference.
*
*
* @param value the new value of the 'Information Recipient' containment reference.
* @see #getInformationRecipient()
* @generated
*/
void setInformationRecipient(Person value);
/**
* Returns the value of the 'Received Organization' containment reference.
*
*
* If the meaning of the 'Received Organization' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Received Organization' containment reference.
* @see #setReceivedOrganization(Organization)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getIntendedRecipient_ReceivedOrganization()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Organization getReceivedOrganization();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getReceivedOrganization Received Organization}' containment reference.
*
*
* @param value the new value of the 'Received Organization' containment reference.
* @see #getReceivedOrganization()
* @generated
*/
void setReceivedOrganization(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#getIntendedRecipient_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#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.IntendedRecipient#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.IntendedRecipient#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.x_InformationRecipientRole}.
*
*
* 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.x_InformationRecipientRole
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(x_InformationRecipientRole)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getIntendedRecipient_ClassCode()
* @model default="ASSIGNED" unsettable="true" ordered="false"
* @generated
*/
x_InformationRecipientRole getClassCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getClassCode Class Code}' attribute.
*
*
* @param value the new value of the 'Class Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.x_InformationRecipientRole
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(x_InformationRecipientRole value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getClassCode Class Code}' attribute.
*
*
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(x_InformationRecipientRole)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.IntendedRecipient#getClassCode Class Code}' attribute is set.
*
*
* @return whether the value of the 'Class Code' attribute is set.
* @see #unsetClassCode()
* @see #getClassCode()
* @see #setClassCode(x_InformationRecipientRole)
* @generated
*/
boolean isSetClassCode();
} // IntendedRecipient