blob: 88beb578d60c7e1b483f285856ac2d5b1c039e67 [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>Order Set Item</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* This resource allows for the definition of an order set as a sharable, consumable, and executable artifact in support of clinical decision support.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.OrderSetItem#getIdentifier <em>Identifier</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getNumber <em>Number</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getTitle <em>Title</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getDescription <em>Description</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getTextEquivalent <em>Text Equivalent</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getSupportingEvidence <em>Supporting Evidence</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getDocumentation <em>Documentation</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getParticipantType <em>Participant Type</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getConcept <em>Concept</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getType <em>Type</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getGroupingBehavior <em>Grouping Behavior</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getSelectionBehavior <em>Selection Behavior</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getRequiredBehavior <em>Required Behavior</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getPrecheckBehavior <em>Precheck Behavior</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getCardinalityBehavior <em>Cardinality Behavior</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getResource <em>Resource</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getCustomization <em>Customization</em>}</li>
* <li>{@link org.hl7.fhir.OrderSetItem#getItems <em>Items</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getOrderSetItem()
* @model extendedMetaData="name='OrderSet.Item' kind='elementOnly'"
* @generated
*/
public interface OrderSetItem extends BackboneElement {
/**
* Returns the value of the '<em><b>Identifier</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A unique identifier for the item.
* <!-- end-model-doc -->
* @return the value of the '<em>Identifier</em>' containment reference.
* @see #setIdentifier(Identifier)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_Identifier()
* @model containment="true"
* extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'"
* @generated
*/
Identifier getIdentifier();
/**
* Sets the value of the '{@link org.hl7.fhir.OrderSetItem#getIdentifier <em>Identifier</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Identifier</em>' containment reference.
* @see #getIdentifier()
* @generated
*/
void setIdentifier(Identifier value);
/**
* Returns the value of the '<em><b>Number</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A user-visible number for the item.
* <!-- end-model-doc -->
* @return the value of the '<em>Number</em>' containment reference.
* @see #setNumber(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_Number()
* @model containment="true"
* extendedMetaData="kind='element' name='number' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getNumber();
/**
* Sets the value of the '{@link org.hl7.fhir.OrderSetItem#getNumber <em>Number</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Number</em>' containment reference.
* @see #getNumber()
* @generated
*/
void setNumber(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Title</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The title of the item.
* <!-- end-model-doc -->
* @return the value of the '<em>Title</em>' containment reference.
* @see #setTitle(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_Title()
* @model containment="true"
* extendedMetaData="kind='element' name='title' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getTitle();
/**
* Sets the value of the '{@link org.hl7.fhir.OrderSetItem#getTitle <em>Title</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Title</em>' containment reference.
* @see #getTitle()
* @generated
*/
void setTitle(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Description</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A short description of the item.
* <!-- end-model-doc -->
* @return the value of the '<em>Description</em>' containment reference.
* @see #setDescription(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_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.OrderSetItem#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>Text Equivalent</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A text equivalent of the item in the orderset.
* <!-- end-model-doc -->
* @return the value of the '<em>Text Equivalent</em>' containment reference.
* @see #setTextEquivalent(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_TextEquivalent()
* @model containment="true"
* extendedMetaData="kind='element' name='textEquivalent' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getTextEquivalent();
/**
* Sets the value of the '{@link org.hl7.fhir.OrderSetItem#getTextEquivalent <em>Text Equivalent</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Text Equivalent</em>' containment reference.
* @see #getTextEquivalent()
* @generated
*/
void setTextEquivalent(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Supporting Evidence</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Attachment}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Supporting evidence for the item.
* <!-- end-model-doc -->
* @return the value of the '<em>Supporting Evidence</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_SupportingEvidence()
* @model containment="true"
* extendedMetaData="kind='element' name='supportingEvidence' namespace='##targetNamespace'"
* @generated
*/
EList<Attachment> getSupportingEvidence();
/**
* Returns the value of the '<em><b>Documentation</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Attachment}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Supporting documentation for the item.
* <!-- end-model-doc -->
* @return the value of the '<em>Documentation</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_Documentation()
* @model containment="true"
* extendedMetaData="kind='element' name='documentation' namespace='##targetNamespace'"
* @generated
*/
EList<Attachment> getDocumentation();
/**
* Returns the value of the '<em><b>Participant Type</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.OrderSetParticipantType}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The type of participant in the item.
* <!-- end-model-doc -->
* @return the value of the '<em>Participant Type</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_ParticipantType()
* @model containment="true"
* extendedMetaData="kind='element' name='participantType' namespace='##targetNamespace'"
* @generated
*/
EList<OrderSetParticipantType> getParticipantType();
/**
* Returns the value of the '<em><b>Concept</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 -->
* Concepts associated with the item.
* <!-- end-model-doc -->
* @return the value of the '<em>Concept</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_Concept()
* @model containment="true"
* extendedMetaData="kind='element' name='concept' namespace='##targetNamespace'"
* @generated
*/
EList<CodeableConcept> getConcept();
/**
* Returns the value of the '<em><b>Type</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The type of item (create, update, remove).
* <!-- end-model-doc -->
* @return the value of the '<em>Type</em>' containment reference.
* @see #setType(OrderSetItemType)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_Type()
* @model containment="true"
* extendedMetaData="kind='element' name='type' namespace='##targetNamespace'"
* @generated
*/
OrderSetItemType getType();
/**
* Sets the value of the '{@link org.hl7.fhir.OrderSetItem#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(OrderSetItemType value);
/**
* Returns the value of the '<em><b>Grouping Behavior</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Defines organization behavior of a group: gives the reason why the items are grouped together.
* <!-- end-model-doc -->
* @return the value of the '<em>Grouping Behavior</em>' containment reference.
* @see #setGroupingBehavior(OrderSetItemGroupingBehavior)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_GroupingBehavior()
* @model containment="true"
* extendedMetaData="kind='element' name='groupingBehavior' namespace='##targetNamespace'"
* @generated
*/
OrderSetItemGroupingBehavior getGroupingBehavior();
/**
* Sets the value of the '{@link org.hl7.fhir.OrderSetItem#getGroupingBehavior <em>Grouping Behavior</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Grouping Behavior</em>' containment reference.
* @see #getGroupingBehavior()
* @generated
*/
void setGroupingBehavior(OrderSetItemGroupingBehavior value);
/**
* Returns the value of the '<em><b>Selection Behavior</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Defines selection behavior of a group: specifies the number of selectable items in the group that may be selected by the end user when the items of the group are displayed.
* <!-- end-model-doc -->
* @return the value of the '<em>Selection Behavior</em>' containment reference.
* @see #setSelectionBehavior(OrderSetItemSelectionBehavior)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_SelectionBehavior()
* @model containment="true"
* extendedMetaData="kind='element' name='selectionBehavior' namespace='##targetNamespace'"
* @generated
*/
OrderSetItemSelectionBehavior getSelectionBehavior();
/**
* Sets the value of the '{@link org.hl7.fhir.OrderSetItem#getSelectionBehavior <em>Selection Behavior</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Selection Behavior</em>' containment reference.
* @see #getSelectionBehavior()
* @generated
*/
void setSelectionBehavior(OrderSetItemSelectionBehavior value);
/**
* Returns the value of the '<em><b>Required Behavior</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Defines requiredness behavior for selecting an action or an action group; i.e., whether the action or action group is required or optional.
* <!-- end-model-doc -->
* @return the value of the '<em>Required Behavior</em>' containment reference.
* @see #setRequiredBehavior(OrderSetItemRequiredBehavior)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_RequiredBehavior()
* @model containment="true"
* extendedMetaData="kind='element' name='requiredBehavior' namespace='##targetNamespace'"
* @generated
*/
OrderSetItemRequiredBehavior getRequiredBehavior();
/**
* Sets the value of the '{@link org.hl7.fhir.OrderSetItem#getRequiredBehavior <em>Required Behavior</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Required Behavior</em>' containment reference.
* @see #getRequiredBehavior()
* @generated
*/
void setRequiredBehavior(OrderSetItemRequiredBehavior value);
/**
* Returns the value of the '<em><b>Precheck Behavior</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Defines selection frequency behavior for an action or group; i.e., for most frequently selected items, the end-user system may provide convenience options in the UI (such as pre-selection) in order to (1) communicate to the end user what the most frequently selected item is, or should, be in a particular context, and (2) save the end user time.
* <!-- end-model-doc -->
* @return the value of the '<em>Precheck Behavior</em>' containment reference.
* @see #setPrecheckBehavior(OrderSetItemPrecheckBehavior)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_PrecheckBehavior()
* @model containment="true"
* extendedMetaData="kind='element' name='precheckBehavior' namespace='##targetNamespace'"
* @generated
*/
OrderSetItemPrecheckBehavior getPrecheckBehavior();
/**
* Sets the value of the '{@link org.hl7.fhir.OrderSetItem#getPrecheckBehavior <em>Precheck Behavior</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Precheck Behavior</em>' containment reference.
* @see #getPrecheckBehavior()
* @generated
*/
void setPrecheckBehavior(OrderSetItemPrecheckBehavior value);
/**
* Returns the value of the '<em><b>Cardinality Behavior</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Defines behavior for an action or a group for how many times that item may be repeated, i.e., cardinality. For example, if a user is documenting lesions, the lesion element may be repeated several times, once for each occurrence of a lesion on the patient or tissue sample or image.
* <!-- end-model-doc -->
* @return the value of the '<em>Cardinality Behavior</em>' containment reference.
* @see #setCardinalityBehavior(OrderSetItemCardinalityBehavior)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_CardinalityBehavior()
* @model containment="true"
* extendedMetaData="kind='element' name='cardinalityBehavior' namespace='##targetNamespace'"
* @generated
*/
OrderSetItemCardinalityBehavior getCardinalityBehavior();
/**
* Sets the value of the '{@link org.hl7.fhir.OrderSetItem#getCardinalityBehavior <em>Cardinality Behavior</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Cardinality Behavior</em>' containment reference.
* @see #getCardinalityBehavior()
* @generated
*/
void setCardinalityBehavior(OrderSetItemCardinalityBehavior value);
/**
* Returns the value of the '<em><b>Resource</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The resource that is the target of the item (e.g. CommunicationRequest).
* <!-- end-model-doc -->
* @return the value of the '<em>Resource</em>' containment reference.
* @see #setResource(Reference)
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_Resource()
* @model containment="true"
* extendedMetaData="kind='element' name='resource' namespace='##targetNamespace'"
* @generated
*/
Reference getResource();
/**
* Sets the value of the '{@link org.hl7.fhir.OrderSetItem#getResource <em>Resource</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Resource</em>' containment reference.
* @see #getResource()
* @generated
*/
void setResource(Reference value);
/**
* Returns the value of the '<em><b>Customization</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.OrderSetCustomization}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Customizations that should be applied to the statically defined resource.
* <!-- end-model-doc -->
* @return the value of the '<em>Customization</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_Customization()
* @model containment="true"
* extendedMetaData="kind='element' name='customization' namespace='##targetNamespace'"
* @generated
*/
EList<OrderSetCustomization> getCustomization();
/**
* Returns the value of the '<em><b>Items</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.OrderSetItem}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Sub items for the orderable.
* <!-- end-model-doc -->
* @return the value of the '<em>Items</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getOrderSetItem_Items()
* @model containment="true"
* extendedMetaData="kind='element' name='items' namespace='##targetNamespace'"
* @generated
*/
EList<OrderSetItem> getItems();
} // OrderSetItem