blob: ebe4c851d90162f803254da4ed9605ddb2d8dd9e [file] [log] [blame]
/**
*/
package org.hl7.fhir;
import org.eclipse.emf.common.util.EList;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Substance</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* A homogeneous material with a definite composition.
* If the element is present, it must have either a @value, an @id, or extensions
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.Substance#getIdentifier <em>Identifier</em>}</li>
* <li>{@link org.hl7.fhir.Substance#getCategory <em>Category</em>}</li>
* <li>{@link org.hl7.fhir.Substance#getCode <em>Code</em>}</li>
* <li>{@link org.hl7.fhir.Substance#getDescription <em>Description</em>}</li>
* <li>{@link org.hl7.fhir.Substance#getInstance <em>Instance</em>}</li>
* <li>{@link org.hl7.fhir.Substance#getIngredient <em>Ingredient</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getSubstance()
* @model extendedMetaData="name='Substance' kind='elementOnly'"
* @generated
*/
public interface Substance extends DomainResource {
/**
* Returns the value of the '<em><b>Identifier</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Identifier}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Unique identifier for the substance.
* <!-- end-model-doc -->
* @return the value of the '<em>Identifier</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSubstance_Identifier()
* @model containment="true"
* extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'"
* @generated
*/
EList<Identifier> getIdentifier();
/**
* Returns the value of the '<em><b>Category</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.CodeableConcept}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
* <!-- end-model-doc -->
* @return the value of the '<em>Category</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSubstance_Category()
* @model containment="true"
* extendedMetaData="kind='element' name='category' namespace='##targetNamespace'"
* @generated
*/
EList<CodeableConcept> getCategory();
/**
* Returns the value of the '<em><b>Code</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A code (or set of codes) that identify this substance.
* <!-- end-model-doc -->
* @return the value of the '<em>Code</em>' containment reference.
* @see #setCode(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getSubstance_Code()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='code' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getCode();
/**
* Sets the value of the '{@link org.hl7.fhir.Substance#getCode <em>Code</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Code</em>' containment reference.
* @see #getCode()
* @generated
*/
void setCode(CodeableConcept value);
/**
* Returns the value of the '<em><b>Description</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A description of the substance - its appearance, handling requirements, and other usage notes.
* <!-- end-model-doc -->
* @return the value of the '<em>Description</em>' containment reference.
* @see #setDescription(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getSubstance_Description()
* @model containment="true"
* extendedMetaData="kind='element' name='description' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getDescription();
/**
* Sets the value of the '{@link org.hl7.fhir.Substance#getDescription <em>Description</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Description</em>' containment reference.
* @see #getDescription()
* @generated
*/
void setDescription(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Instance</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.SubstanceInstance}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.
* <!-- end-model-doc -->
* @return the value of the '<em>Instance</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSubstance_Instance()
* @model containment="true"
* extendedMetaData="kind='element' name='instance' namespace='##targetNamespace'"
* @generated
*/
EList<SubstanceInstance> getInstance();
/**
* Returns the value of the '<em><b>Ingredient</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.SubstanceIngredient}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A substance can be composed of other substances.
* <!-- end-model-doc -->
* @return the value of the '<em>Ingredient</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSubstance_Ingredient()
* @model containment="true"
* extendedMetaData="kind='element' name='ingredient' namespace='##targetNamespace'"
* @generated
*/
EList<SubstanceIngredient> getIngredient();
} // Substance