blob: 05bdad9fe32d1c62e8f4b8e7fc11c62f25888183 [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 Specification Name</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* The detailed description of a substance, typically at a level beyond what is used for prescribing.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.SubstanceSpecificationName#getName <em>Name</em>}</li>
* <li>{@link org.hl7.fhir.SubstanceSpecificationName#getType <em>Type</em>}</li>
* <li>{@link org.hl7.fhir.SubstanceSpecificationName#getStatus <em>Status</em>}</li>
* <li>{@link org.hl7.fhir.SubstanceSpecificationName#getPreferred <em>Preferred</em>}</li>
* <li>{@link org.hl7.fhir.SubstanceSpecificationName#getLanguage <em>Language</em>}</li>
* <li>{@link org.hl7.fhir.SubstanceSpecificationName#getDomain <em>Domain</em>}</li>
* <li>{@link org.hl7.fhir.SubstanceSpecificationName#getJurisdiction <em>Jurisdiction</em>}</li>
* <li>{@link org.hl7.fhir.SubstanceSpecificationName#getSynonym <em>Synonym</em>}</li>
* <li>{@link org.hl7.fhir.SubstanceSpecificationName#getTranslation <em>Translation</em>}</li>
* <li>{@link org.hl7.fhir.SubstanceSpecificationName#getOfficial <em>Official</em>}</li>
* <li>{@link org.hl7.fhir.SubstanceSpecificationName#getSource <em>Source</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName()
* @model extendedMetaData="name='SubstanceSpecification.Name' kind='elementOnly'"
* @generated
*/
public interface SubstanceSpecificationName extends BackboneElement {
/**
* Returns the value of the '<em><b>Name</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The actual name.
* <!-- end-model-doc -->
* @return the value of the '<em>Name</em>' containment reference.
* @see #setName(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName_Name()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='name' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getName();
/**
* Sets the value of the '{@link org.hl7.fhir.SubstanceSpecificationName#getName <em>Name</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Name</em>' containment reference.
* @see #getName()
* @generated
*/
void setName(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Type</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Name type.
* <!-- end-model-doc -->
* @return the value of the '<em>Type</em>' containment reference.
* @see #setType(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName_Type()
* @model containment="true"
* extendedMetaData="kind='element' name='type' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getType();
/**
* Sets the value of the '{@link org.hl7.fhir.SubstanceSpecificationName#getType <em>Type</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Type</em>' containment reference.
* @see #getType()
* @generated
*/
void setType(CodeableConcept value);
/**
* Returns the value of the '<em><b>Status</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The status of the name.
* <!-- end-model-doc -->
* @return the value of the '<em>Status</em>' containment reference.
* @see #setStatus(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName_Status()
* @model containment="true"
* extendedMetaData="kind='element' name='status' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getStatus();
/**
* Sets the value of the '{@link org.hl7.fhir.SubstanceSpecificationName#getStatus <em>Status</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Status</em>' containment reference.
* @see #getStatus()
* @generated
*/
void setStatus(CodeableConcept value);
/**
* Returns the value of the '<em><b>Preferred</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* If this is the preferred name for this substance.
* <!-- end-model-doc -->
* @return the value of the '<em>Preferred</em>' containment reference.
* @see #setPreferred(org.hl7.fhir.Boolean)
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName_Preferred()
* @model containment="true"
* extendedMetaData="kind='element' name='preferred' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.Boolean getPreferred();
/**
* Sets the value of the '{@link org.hl7.fhir.SubstanceSpecificationName#getPreferred <em>Preferred</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Preferred</em>' containment reference.
* @see #getPreferred()
* @generated
*/
void setPreferred(org.hl7.fhir.Boolean value);
/**
* Returns the value of the '<em><b>Language</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 -->
* Language of the name.
* <!-- end-model-doc -->
* @return the value of the '<em>Language</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName_Language()
* @model containment="true"
* extendedMetaData="kind='element' name='language' namespace='##targetNamespace'"
* @generated
*/
EList<CodeableConcept> getLanguage();
/**
* Returns the value of the '<em><b>Domain</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 -->
* The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.
* <!-- end-model-doc -->
* @return the value of the '<em>Domain</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName_Domain()
* @model containment="true"
* extendedMetaData="kind='element' name='domain' namespace='##targetNamespace'"
* @generated
*/
EList<CodeableConcept> getDomain();
/**
* Returns the value of the '<em><b>Jurisdiction</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 -->
* The jurisdiction where this name applies.
* <!-- end-model-doc -->
* @return the value of the '<em>Jurisdiction</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName_Jurisdiction()
* @model containment="true"
* extendedMetaData="kind='element' name='jurisdiction' namespace='##targetNamespace'"
* @generated
*/
EList<CodeableConcept> getJurisdiction();
/**
* Returns the value of the '<em><b>Synonym</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.SubstanceSpecificationName}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A synonym of this name.
* <!-- end-model-doc -->
* @return the value of the '<em>Synonym</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName_Synonym()
* @model containment="true"
* extendedMetaData="kind='element' name='synonym' namespace='##targetNamespace'"
* @generated
*/
EList<SubstanceSpecificationName> getSynonym();
/**
* Returns the value of the '<em><b>Translation</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.SubstanceSpecificationName}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A translation for this name.
* <!-- end-model-doc -->
* @return the value of the '<em>Translation</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName_Translation()
* @model containment="true"
* extendedMetaData="kind='element' name='translation' namespace='##targetNamespace'"
* @generated
*/
EList<SubstanceSpecificationName> getTranslation();
/**
* Returns the value of the '<em><b>Official</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.SubstanceSpecificationOfficial}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Details of the official nature of this name.
* <!-- end-model-doc -->
* @return the value of the '<em>Official</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName_Official()
* @model containment="true"
* extendedMetaData="kind='element' name='official' namespace='##targetNamespace'"
* @generated
*/
EList<SubstanceSpecificationOfficial> getOfficial();
/**
* Returns the value of the '<em><b>Source</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Reference}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Supporting literature.
* <!-- end-model-doc -->
* @return the value of the '<em>Source</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getSubstanceSpecificationName_Source()
* @model containment="true"
* extendedMetaData="kind='element' name='source' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getSource();
} // SubstanceSpecificationName