org.openhealthtools.mdht.uml.cda.RelatedDocument 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.CS;
import org.openhealthtools.mdht.uml.hl7.datatypes.II;
import org.openhealthtools.mdht.uml.hl7.rim.ActRelationship;
import org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor;
import org.openhealthtools.mdht.uml.hl7.vocab.x_ActRelationshipDocument;
/**
*
* A representation of the model object 'Related Document'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.RelatedDocument#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedDocument#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedDocument#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedDocument#getParentDocument Parent Document}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedDocument#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.RelatedDocument#getTypeCode Type Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRelatedDocument()
* @model
* @generated
*/
public interface RelatedDocument extends ActRelationship {
/**
* 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#getRelatedDocument_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#getRelatedDocument_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedDocument#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#getRelatedDocument_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getTemplateIds();
/**
* Returns the value of the 'Parent Document' containment reference.
*
*
* If the meaning of the 'Parent Document' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Parent Document' containment reference.
* @see #setParentDocument(ParentDocument)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRelatedDocument_ParentDocument()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
ParentDocument getParentDocument();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedDocument#getParentDocument Parent Document}' containment reference.
*
*
* @param value the new value of the 'Parent Document' containment reference.
* @see #getParentDocument()
* @generated
*/
void setParentDocument(ParentDocument 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#getRelatedDocument_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedDocument#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.RelatedDocument#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.RelatedDocument#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 'Type Code' attribute.
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.x_ActRelationshipDocument}.
*
*
* If the meaning of the 'Type Code' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Type Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.x_ActRelationshipDocument
* @see #isSetTypeCode()
* @see #unsetTypeCode()
* @see #setTypeCode(x_ActRelationshipDocument)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getRelatedDocument_TypeCode()
* @model unsettable="true" required="true" ordered="false"
* @generated
*/
x_ActRelationshipDocument getTypeCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedDocument#getTypeCode Type Code}' attribute.
*
*
* @param value the new value of the 'Type Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.x_ActRelationshipDocument
* @see #isSetTypeCode()
* @see #unsetTypeCode()
* @see #getTypeCode()
* @generated
*/
void setTypeCode(x_ActRelationshipDocument value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedDocument#getTypeCode Type Code}' attribute.
*
*
* @see #isSetTypeCode()
* @see #getTypeCode()
* @see #setTypeCode(x_ActRelationshipDocument)
* @generated
*/
void unsetTypeCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.RelatedDocument#getTypeCode Type Code}' attribute is set.
*
*
* @return whether the value of the 'Type Code' attribute is set.
* @see #unsetTypeCode()
* @see #getTypeCode()
* @see #setTypeCode(x_ActRelationshipDocument)
* @generated
*/
boolean isSetTypeCode();
} // RelatedDocument