blob: 33b346d69e143c3281268de7d02210ba08dd723c [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>Guidance Response Action</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* A guidance response is the formal response to a previous guidance request. It is a derivative of the knowledge response that provides additional information relevant specifically to clinical decision support such as a description of any proposed actions to be taken.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getActionIdentifier <em>Action Identifier</em>}</li>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getNumber <em>Number</em>}</li>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getSupportingEvidence <em>Supporting Evidence</em>}</li>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getDocumentation <em>Documentation</em>}</li>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getParticipant <em>Participant</em>}</li>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getTitle <em>Title</em>}</li>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getDescription <em>Description</em>}</li>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getTextEquivalent <em>Text Equivalent</em>}</li>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getConcept <em>Concept</em>}</li>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getType <em>Type</em>}</li>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getResource <em>Resource</em>}</li>
* <li>{@link org.hl7.fhir.GuidanceResponseAction#getActions <em>Actions</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction()
* @model extendedMetaData="name='GuidanceResponse.Action' kind='elementOnly'"
* @generated
*/
public interface GuidanceResponseAction extends BackboneElement {
/**
* Returns the value of the '<em><b>Action Identifier</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A unique identifier for the action.
* <!-- end-model-doc -->
* @return the value of the '<em>Action Identifier</em>' containment reference.
* @see #setActionIdentifier(Identifier)
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction_ActionIdentifier()
* @model containment="true"
* extendedMetaData="kind='element' name='actionIdentifier' namespace='##targetNamespace'"
* @generated
*/
Identifier getActionIdentifier();
/**
* Sets the value of the '{@link org.hl7.fhir.GuidanceResponseAction#getActionIdentifier <em>Action Identifier</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Action Identifier</em>' containment reference.
* @see #getActionIdentifier()
* @generated
*/
void setActionIdentifier(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 action.
* <!-- end-model-doc -->
* @return the value of the '<em>Number</em>' containment reference.
* @see #setNumber(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction_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.GuidanceResponseAction#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>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 action.
* <!-- end-model-doc -->
* @return the value of the '<em>Supporting Evidence</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction_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 action.
* <!-- end-model-doc -->
* @return the value of the '<em>Documentation</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction_Documentation()
* @model containment="true"
* extendedMetaData="kind='element' name='documentation' namespace='##targetNamespace'"
* @generated
*/
EList<Attachment> getDocumentation();
/**
* Returns the value of the '<em><b>Participant</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 -->
* The participant in the action.
* <!-- end-model-doc -->
* @return the value of the '<em>Participant</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction_Participant()
* @model containment="true"
* extendedMetaData="kind='element' name='participant' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getParticipant();
/**
* 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 action.
* <!-- end-model-doc -->
* @return the value of the '<em>Title</em>' containment reference.
* @see #setTitle(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction_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.GuidanceResponseAction#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 action.
* <!-- end-model-doc -->
* @return the value of the '<em>Description</em>' containment reference.
* @see #setDescription(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction_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.GuidanceResponseAction#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 action to be performed.
* <!-- 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#getGuidanceResponseAction_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.GuidanceResponseAction#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>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 action.
* <!-- end-model-doc -->
* @return the value of the '<em>Concept</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction_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 action to perform (create, update, remove).
* <!-- end-model-doc -->
* @return the value of the '<em>Type</em>' containment reference.
* @see #setType(GuidanceResponseActionType)
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction_Type()
* @model containment="true"
* extendedMetaData="kind='element' name='type' namespace='##targetNamespace'"
* @generated
*/
GuidanceResponseActionType getType();
/**
* Sets the value of the '{@link org.hl7.fhir.GuidanceResponseAction#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(GuidanceResponseActionType 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 action (e.g. CommunicationRequest).
* <!-- end-model-doc -->
* @return the value of the '<em>Resource</em>' containment reference.
* @see #setResource(Reference)
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction_Resource()
* @model containment="true"
* extendedMetaData="kind='element' name='resource' namespace='##targetNamespace'"
* @generated
*/
Reference getResource();
/**
* Sets the value of the '{@link org.hl7.fhir.GuidanceResponseAction#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>Actions</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.GuidanceResponseAction}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Sub actions.
* <!-- end-model-doc -->
* @return the value of the '<em>Actions</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getGuidanceResponseAction_Actions()
* @model containment="true"
* extendedMetaData="kind='element' name='actions' namespace='##targetNamespace'"
* @generated
*/
EList<GuidanceResponseAction> getActions();
} // GuidanceResponseAction