org.openhealthtools.mdht.uml.cda.RelatedSubject 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.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_DocumentSubject;
/**
*
* A representation of the model object 'Related Subject'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getCode Code}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getAddrs Addr}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getTelecoms Telecom}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getSubject Subject}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getClassCode Class Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRelatedSubject()
* @model
* @generated
*/
public interface RelatedSubject 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#getRelatedSubject_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#getRelatedSubject_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedSubject#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#getRelatedSubject_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @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#getRelatedSubject_Code()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
CE getCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedSubject#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#getRelatedSubject_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#getRelatedSubject_Telecom()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getTelecoms();
/**
* Returns the value of the 'Subject' containment reference.
*
*
* If the meaning of the 'Subject' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Subject' containment reference.
* @see #setSubject(SubjectPerson)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRelatedSubject_Subject()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
SubjectPerson getSubject();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getSubject Subject}' containment reference.
*
*
* @param value the new value of the 'Subject' containment reference.
* @see #getSubject()
* @generated
*/
void setSubject(SubjectPerson 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#getRelatedSubject_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedSubject#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.RelatedSubject#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.RelatedSubject#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 "PRS".
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.x_DocumentSubject}.
*
*
* 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_DocumentSubject
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #setClassCode(x_DocumentSubject)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRelatedSubject_ClassCode()
* @model default="PRS" unsettable="true" ordered="false"
* @generated
*/
x_DocumentSubject getClassCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getClassCode Class Code}' attribute.
*
*
* @param value the new value of the 'Class Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.x_DocumentSubject
* @see #isSetClassCode()
* @see #unsetClassCode()
* @see #getClassCode()
* @generated
*/
void setClassCode(x_DocumentSubject value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getClassCode Class Code}' attribute.
*
*
* @see #isSetClassCode()
* @see #getClassCode()
* @see #setClassCode(x_DocumentSubject)
* @generated
*/
void unsetClassCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedSubject#getClassCode Class Code}' attribute is set.
*
*
* @return whether the value of the 'Class Code' attribute is set.
* @see #unsetClassCode()
* @see #getClassCode()
* @see #setClassCode(x_DocumentSubject)
* @generated
*/
boolean isSetClassCode();
} // RelatedSubject