org.openhealthtools.mdht.uml.cda.Entry 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.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_ActRelationshipEntry;
/**
*
* A representation of the model object 'Entry'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getAct Act}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getEncounter Encounter}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getObservation Observation}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getObservationMedia Observation Media}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getOrganizer Organizer}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getProcedure Procedure}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getRegionOfInterest Region Of Interest}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getSubstanceAdministration Substance Administration}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getSupply Supply}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getTypeCode Type Code}
* - {@link org.openhealthtools.mdht.uml.cda.Entry#getContextConductionInd Context Conduction Ind}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry()
* @model
* @generated
*/
public interface Entry 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#getEntry_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#getEntry_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#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#getEntry_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getTemplateIds();
/**
* Returns the value of the 'Act' containment reference.
*
*
* If the meaning of the 'Act' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Act' containment reference.
* @see #setAct(Act)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry_Act()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Act getAct();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getAct Act}' containment reference.
*
*
* @param value the new value of the 'Act' containment reference.
* @see #getAct()
* @generated
*/
void setAct(Act value);
/**
* Returns the value of the 'Encounter' containment reference.
*
*
* If the meaning of the 'Encounter' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Encounter' containment reference.
* @see #setEncounter(Encounter)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry_Encounter()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Encounter getEncounter();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getEncounter Encounter}' containment reference.
*
*
* @param value the new value of the 'Encounter' containment reference.
* @see #getEncounter()
* @generated
*/
void setEncounter(Encounter value);
/**
* Returns the value of the 'Observation' containment reference.
*
*
* If the meaning of the 'Observation' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Observation' containment reference.
* @see #setObservation(Observation)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry_Observation()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Observation getObservation();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getObservation Observation}' containment reference.
*
*
* @param value the new value of the 'Observation' containment reference.
* @see #getObservation()
* @generated
*/
void setObservation(Observation value);
/**
* Returns the value of the 'Observation Media' containment reference.
*
*
* If the meaning of the 'Observation Media' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Observation Media' containment reference.
* @see #setObservationMedia(ObservationMedia)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry_ObservationMedia()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
ObservationMedia getObservationMedia();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getObservationMedia Observation Media}' containment reference.
*
*
* @param value the new value of the 'Observation Media' containment reference.
* @see #getObservationMedia()
* @generated
*/
void setObservationMedia(ObservationMedia value);
/**
* Returns the value of the 'Organizer' containment reference.
*
*
* If the meaning of the 'Organizer' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Organizer' containment reference.
* @see #setOrganizer(Organizer)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry_Organizer()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Organizer getOrganizer();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getOrganizer Organizer}' containment reference.
*
*
* @param value the new value of the 'Organizer' containment reference.
* @see #getOrganizer()
* @generated
*/
void setOrganizer(Organizer value);
/**
* Returns the value of the 'Procedure' containment reference.
*
*
* If the meaning of the 'Procedure' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Procedure' containment reference.
* @see #setProcedure(Procedure)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry_Procedure()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Procedure getProcedure();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getProcedure Procedure}' containment reference.
*
*
* @param value the new value of the 'Procedure' containment reference.
* @see #getProcedure()
* @generated
*/
void setProcedure(Procedure value);
/**
* Returns the value of the 'Region Of Interest' containment reference.
*
*
* If the meaning of the 'Region Of Interest' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Region Of Interest' containment reference.
* @see #setRegionOfInterest(RegionOfInterest)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry_RegionOfInterest()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
RegionOfInterest getRegionOfInterest();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getRegionOfInterest Region Of Interest}' containment reference.
*
*
* @param value the new value of the 'Region Of Interest' containment reference.
* @see #getRegionOfInterest()
* @generated
*/
void setRegionOfInterest(RegionOfInterest value);
/**
* Returns the value of the 'Substance Administration' containment reference.
*
*
* If the meaning of the 'Substance Administration' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Substance Administration' containment reference.
* @see #setSubstanceAdministration(SubstanceAdministration)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry_SubstanceAdministration()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
SubstanceAdministration getSubstanceAdministration();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getSubstanceAdministration Substance Administration}' containment reference.
*
*
* @param value the new value of the 'Substance Administration' containment reference.
* @see #getSubstanceAdministration()
* @generated
*/
void setSubstanceAdministration(SubstanceAdministration value);
/**
* Returns the value of the 'Supply' containment reference.
*
*
* If the meaning of the 'Supply' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Supply' containment reference.
* @see #setSupply(Supply)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry_Supply()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
Supply getSupply();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getSupply Supply}' containment reference.
*
*
* @param value the new value of the 'Supply' containment reference.
* @see #getSupply()
* @generated
*/
void setSupply(Supply 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#getEntry_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#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.Entry#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.Entry#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 default value is "COMP".
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.x_ActRelationshipEntry}.
*
*
* 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_ActRelationshipEntry
* @see #isSetTypeCode()
* @see #unsetTypeCode()
* @see #setTypeCode(x_ActRelationshipEntry)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry_TypeCode()
* @model default="COMP" unsettable="true" ordered="false"
* @generated
*/
x_ActRelationshipEntry getTypeCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getTypeCode Type Code}' attribute.
*
*
* @param value the new value of the 'Type Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.x_ActRelationshipEntry
* @see #isSetTypeCode()
* @see #unsetTypeCode()
* @see #getTypeCode()
* @generated
*/
void setTypeCode(x_ActRelationshipEntry value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getTypeCode Type Code}' attribute.
*
*
* @see #isSetTypeCode()
* @see #getTypeCode()
* @see #setTypeCode(x_ActRelationshipEntry)
* @generated
*/
void unsetTypeCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getTypeCode Type Code}' attribute is set.
*
*
* @return whether the value of the 'Type Code' attribute is set.
* @see #unsetTypeCode()
* @see #getTypeCode()
* @see #setTypeCode(x_ActRelationshipEntry)
* @generated
*/
boolean isSetTypeCode();
/**
* Returns the value of the 'Context Conduction Ind' attribute.
* The default value is "true".
*
*
* If the meaning of the 'Context Conduction Ind' attribute isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Context Conduction Ind' attribute.
* @see #isSetContextConductionInd()
* @see #unsetContextConductionInd()
* @see #setContextConductionInd(Boolean)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getEntry_ContextConductionInd()
* @model default="true" unsettable="true" ordered="false"
* @generated
*/
Boolean getContextConductionInd();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getContextConductionInd Context Conduction Ind}' attribute.
*
*
* @param value the new value of the 'Context Conduction Ind' attribute.
* @see #isSetContextConductionInd()
* @see #unsetContextConductionInd()
* @see #getContextConductionInd()
* @generated
*/
void setContextConductionInd(Boolean value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getContextConductionInd Context Conduction Ind}' attribute.
*
*
* @see #isSetContextConductionInd()
* @see #getContextConductionInd()
* @see #setContextConductionInd(Boolean)
* @generated
*/
void unsetContextConductionInd();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.Entry#getContextConductionInd Context Conduction Ind}' attribute is set.
*
*
* @return whether the value of the 'Context Conduction Ind' attribute is set.
* @see #unsetContextConductionInd()
* @see #getContextConductionInd()
* @see #setContextConductionInd(Boolean)
* @generated
*/
boolean isSetContextConductionInd();
/**
*
*
*
* Bag{self.act.oclIsUndefined(), self.encounter.oclIsUndefined(), self.observation.oclIsUndefined(), self.observationMedia.oclIsUndefined(), self.organizer.oclIsUndefined(), self.procedure.oclIsUndefined(), self.regionOfInterest.oclIsUndefined(), self.substanceAdministration.oclIsUndefined(), self.supply.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.act.oclIsUndefined(), self.encounter.oclIsUndefined(), self.observation.oclIsUndefined(), self.observationMedia.oclIsUndefined(), self.organizer.oclIsUndefined(), self.procedure.oclIsUndefined(), self.regionOfInterest.oclIsUndefined(), self.substanceAdministration.oclIsUndefined(), self.supply.oclIsUndefined()}->one(x | x = false)'"
* @generated
*/
boolean validateClinicalStatement(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* not self.contextConductionInd.oclIsUndefined() implies self.contextConductionInd=true
* @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='not self.contextConductionInd.oclIsUndefined() implies self.contextConductionInd=true'"
* @generated
*/
boolean validateContextConductionInd(DiagnosticChain diagnostics, Map context);
} // Entry