org.openhealthtools.mdht.uml.cda.Specimen 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.Participation;
import org.openhealthtools.mdht.uml.hl7.vocab.NullFlavor;
import org.openhealthtools.mdht.uml.hl7.vocab.ParticipationType;
/**
*
* A representation of the model object 'Specimen'.
*
*
*
* The following features are supported:
*
* - {@link org.openhealthtools.mdht.uml.cda.Specimen#getRealmCodes Realm Code}
* - {@link org.openhealthtools.mdht.uml.cda.Specimen#getTypeId Type Id}
* - {@link org.openhealthtools.mdht.uml.cda.Specimen#getTemplateIds Template Id}
* - {@link org.openhealthtools.mdht.uml.cda.Specimen#getSpecimenRole Specimen Role}
* - {@link org.openhealthtools.mdht.uml.cda.Specimen#getNullFlavor Null Flavor}
* - {@link org.openhealthtools.mdht.uml.cda.Specimen#getTypeCode Type Code}
*
*
*
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getSpecimen()
* @model
* @generated
*/
public interface Specimen extends Participation {
/**
* 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#getSpecimen_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#getSpecimen_TypeId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
InfrastructureRootTypeId getTypeId();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Specimen#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#getSpecimen_TemplateId()
* @model containment="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
EList getTemplateIds();
/**
* Returns the value of the 'Specimen Role' containment reference.
*
*
* If the meaning of the 'Specimen Role' containment reference isn't clear,
* there really should be more of a description here...
*
*
* @return the value of the 'Specimen Role' containment reference.
* @see #setSpecimenRole(SpecimenRole)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getSpecimen_SpecimenRole()
* @model containment="true" required="true" ordered="false"
* extendedMetaData="namespace='##targetNamespace'"
* @generated
*/
SpecimenRole getSpecimenRole();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Specimen#getSpecimenRole Specimen Role}' containment reference.
*
*
* @param value the new value of the 'Specimen Role' containment reference.
* @see #getSpecimenRole()
* @generated
*/
void setSpecimenRole(SpecimenRole 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#getSpecimen_NullFlavor()
* @model unsettable="true" ordered="false"
* @generated
*/
NullFlavor getNullFlavor();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Specimen#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.Specimen#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.Specimen#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 "SPC".
* The literals are from the enumeration {@link org.openhealthtools.mdht.uml.hl7.vocab.ParticipationType}.
*
*
* 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.ParticipationType
* @see #isSetTypeCode()
* @see #unsetTypeCode()
* @see #setTypeCode(ParticipationType)
* @see org.openhealthtools.mdht.uml.cda.CDAPackage#getSpecimen_TypeCode()
* @model default="SPC" unsettable="true" ordered="false"
* @generated
*/
ParticipationType getTypeCode();
/**
* Sets the value of the '{@link org.openhealthtools.mdht.uml.cda.Specimen#getTypeCode Type Code}' attribute.
*
*
* @param value the new value of the 'Type Code' attribute.
* @see org.openhealthtools.mdht.uml.hl7.vocab.ParticipationType
* @see #isSetTypeCode()
* @see #unsetTypeCode()
* @see #getTypeCode()
* @generated
*/
void setTypeCode(ParticipationType value);
/**
* Unsets the value of the '{@link org.openhealthtools.mdht.uml.cda.Specimen#getTypeCode Type Code}' attribute.
*
*
* @see #isSetTypeCode()
* @see #getTypeCode()
* @see #setTypeCode(ParticipationType)
* @generated
*/
void unsetTypeCode();
/**
* Returns whether the value of the '{@link org.openhealthtools.mdht.uml.cda.Specimen#getTypeCode Type Code}' attribute is set.
*
*
* @return whether the value of the 'Type Code' attribute is set.
* @see #unsetTypeCode()
* @see #getTypeCode()
* @see #setTypeCode(ParticipationType)
* @generated
*/
boolean isSetTypeCode();
/**
*
*
*
* self.isTypeCodeDefined() implies self.typeCode=vocab::ParticipationType::SPC
* @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='self.isTypeCodeDefined() implies self.typeCode=vocab::ParticipationType::SPC'"
* @generated
*/
boolean validateTypeCode(DiagnosticChain diagnostics, Map context);
} // Specimen