org.openhealthtools.mdht.uml.cda.Reference 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.BL;
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_ActRelationshipExternalReference;
/**
*
* A representation of the model object 'Reference'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.Reference#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.Reference#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.Reference#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.Reference#getSeperatableInd Seperatable Ind}
* - {@link org.openhealthtools.mdht.uml.cda.Reference#getExternalAct External Act}
* - {@link org.openhealthtools.mdht.uml.cda.Reference#getExternalObservation External Observation}
* - {@link org.openhealthtools.mdht.uml.cda.Reference#getExternalProcedure External Procedure}
* - {@link org.openhealthtools.mdht.uml.cda.Reference#getExternalDocument External Document}
* - {@link org.openhealthtools.mdht.uml.cda.Reference#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.Reference#getTypeCode Type Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getReference()
* @model
* @generated
*/
public interface Reference 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#getReference_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#getReference_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Reference#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#getReference_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getTemplateIds();
/**
* Returns the value of the 'Seperatable Ind' containment reference.
*
*
* If the meaning of the 'Seperatable Ind' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Seperatable Ind' containment reference.
* @see #setSeperatableInd(BL)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getReference_SeperatableInd()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
BL getSeperatableInd();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Reference#getSeperatableInd Seperatable Ind}' containment reference.
*
*
* @param value the new value of the 'Seperatable Ind' containment reference.
* @see #getSeperatableInd()
* @generated
*/
void setSeperatableInd(BL value);
/**
* Returns the value of the 'External Act' containment reference.
*
*
* If the meaning of the 'External Act' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'External Act' containment reference.
* @see #setExternalAct(ExternalAct)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getReference_ExternalAct()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
ExternalAct getExternalAct();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Reference#getExternalAct External Act}' containment reference.
*
*
* @param value the new value of the 'External Act' containment reference.
* @see #getExternalAct()
* @generated
*/
void setExternalAct(ExternalAct value);
/**
* Returns the value of the 'External Observation' containment reference.
*
*
* If the meaning of the 'External Observation' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'External Observation' containment reference.
* @see #setExternalObservation(ExternalObservation)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getReference_ExternalObservation()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
ExternalObservation getExternalObservation();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Reference#getExternalObservation External Observation}' containment reference.
*
*
* @param value the new value of the 'External Observation' containment reference.
* @see #getExternalObservation()
* @generated
*/
void setExternalObservation(ExternalObservation value);
/**
* Returns the value of the 'External Procedure' containment reference.
*
*
* If the meaning of the 'External Procedure' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'External Procedure' containment reference.
* @see #setExternalProcedure(ExternalProcedure)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getReference_ExternalProcedure()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
ExternalProcedure getExternalProcedure();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Reference#getExternalProcedure External Procedure}' containment reference.
*
*
* @param value the new value of the 'External Procedure' containment reference.
* @see #getExternalProcedure()
* @generated
*/
void setExternalProcedure(ExternalProcedure value);
/**
* Returns the value of the 'External Document' containment reference.
*
*
* If the meaning of the 'External Document' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'External Document' containment reference.
* @see #setExternalDocument(ExternalDocument)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getReference_ExternalDocument()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
ExternalDocument getExternalDocument();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Reference#getExternalDocument External Document}' containment reference.
*
*
* @param value the new value of the 'External Document' containment reference.
* @see #getExternalDocument()
* @generated
*/
void setExternalDocument(ExternalDocument 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#getReference_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Reference#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.Reference#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.Reference#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_ActRelationshipExternalReference}.
*
*
* 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_ActRelationshipExternalReference
* @see #isSetTypeCode()
* @see #unsetTypeCode()
* @see #setTypeCode(x_ActRelationshipExternalReference)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getReference_TypeCode()
* @model unsettable="true" required="true" ordered="false"
* @generated
*/
x_ActRelationshipExternalReference getTypeCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Reference#getTypeCode Type Code}' attribute.
*
*
* @param value the new value of the 'Type Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.x_ActRelationshipExternalReference
* @see #isSetTypeCode()
* @see #unsetTypeCode()
* @see #getTypeCode()
* @generated
*/
void setTypeCode(x_ActRelationshipExternalReference value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.Reference#getTypeCode Type Code}' attribute.
*
*
* @see #isSetTypeCode()
* @see #getTypeCode()
* @see #setTypeCode(x_ActRelationshipExternalReference)
* @generated
*/
void unsetTypeCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.Reference#getTypeCode Type Code}' attribute is set.
*
*
* @return whether the value of the 'Type Code' attribute is set.
* @see #unsetTypeCode()
* @see #getTypeCode()
* @see #setTypeCode(x_ActRelationshipExternalReference)
* @generated
*/
boolean isSetTypeCode();
/**
*
*
*
* Bag{self.externalAct.oclIsUndefined(), self.externalDocument.oclIsUndefined(), self.externalObservation.oclIsUndefined(), self.externalProcedure.oclIsUndefined()}->one(x | x = false)
* @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='Bag{self.externalAct.oclIsUndefined(), self.externalDocument.oclIsUndefined(), self.externalObservation.oclIsUndefined(), self.externalProcedure.oclIsUndefined()}->one(x | x = false)'"
* @generated
*/
boolean validateExternalActChoice(DiagnosticChain diagnostics, Map context);
} // Reference