org.openhealthtools.mdht.uml.cda.RelatedEntity 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.CE;
import org.openhealthtools.mdht.uml.hl7.datatypes.CS;
import org.openhealthtools.mdht.uml.hl7.datatypes.II;
import org.openhealthtools.mdht.uml.hl7.datatypes.IVL_TS;
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.RoleClassMutualRelationship;
/**
*
* A representation of the model object 'Related Entity'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getCode Code}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getAddrs Addr}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getTelecoms Telecom}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getEffectiveTime Effective Time}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getRelatedPerson Related Person}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getSDTCPatient SDTC Patient}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getClassCode Class Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRelatedEntity()
* @model
* @generated
*/
public interface RelatedEntity 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#getRelatedEntity_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#getRelatedEntity_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.RelatedEntity#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#getRelatedEntity_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="name='templateId' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList getTemplateIds();
/**
* 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#getRelatedEntity_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.RelatedEntity#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#getRelatedEntity_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#getRelatedEntity_Telecom()
* @model containment="true" ordered="false"
* extendedMetaData="name='telecom' namespace='##targetNamespace' kind='element'"
* @generated
*/
EList getTelecoms();
/**
* Returns the value of the 'Effective Time' containment reference.
*
*
* If the meaning of the 'Effective Time' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Effective Time' containment reference.
* @see #setEffectiveTime(IVL_TS)
* @see org.openhealthtools.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.openhealthtools.mdht.uml.cda.RelatedEntity#getEffectiveTime Effective Time}' containment reference.
*
*
* @param value the new value of the 'Effective Time' containment reference.
* @see #getEffectiveTime()
* @generated
*/
void setEffectiveTime(IVL_TS value);
/**
* 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#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.openhealthtools.mdht.uml.cda.RelatedEntity#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 'Related Person' containment reference.
*
*
* If the meaning of the 'Related Person' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Related Person' containment reference.
* @see #setRelatedPerson(Person)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRelatedEntity_RelatedPerson()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Person getRelatedPerson();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getRelatedPerson Related Person}' containment reference.
*
*
* @param value the new value of the 'Related Person' containment reference.
* @see #getRelatedPerson()
* @generated
*/
void setRelatedPerson(Person 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#getRelatedEntity_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.RelatedEntity#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.RelatedEntity#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.RelatedEntity#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 literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.RoleClassMutualRelationship}.
*
*
* 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.RoleClassMutualRelationship
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(RoleClassMutualRelationship)
* @see org.openhealthtools.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.openhealthtools.mdht.uml.cda.RelatedEntity#getClassCode Class Code}' attribute.
*
*
* @param value the new value of the 'Class Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.RoleClassMutualRelationship
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(RoleClassMutualRelationship value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getClassCode Class Code}' attribute.
*
*
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(RoleClassMutualRelationship)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedEntity#getClassCode Class Code}' attribute is set.
*
*
* @return whether the value of the 'Class Code' attribute is set.
* @see #unsetClassCode()
* @see #getClassCode()
* @see #setClassCode(RoleClassMutualRelationship)
* @generated
*/
boolean isSetClassCode();
} // RelatedEntity