blob: ec16adb1dad3d9d7943beb0ac02f6bb8c11e0ffd [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2016 David Carlson 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:
* David Carlson (Clinical Cloud Solutions, LLC) - initial API and implementation
*******************************************************************************/
/**
*/
package org.eclipse.mdht.uml.fhir.core.resource;
import org.eclipse.emf.common.util.EList;
import org.eclipse.mdht.uml.fhir.core.datatype.Annotation;
import org.eclipse.mdht.uml.fhir.core.datatype.Code;
import org.eclipse.mdht.uml.fhir.core.datatype.CodeableConcept;
import org.eclipse.mdht.uml.fhir.core.datatype.DataType;
import org.eclipse.mdht.uml.fhir.core.datatype.Date;
import org.eclipse.mdht.uml.fhir.core.datatype.Identifier;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Goal</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getIdentifiers <em>Identifier</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getSubject <em>Subject</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getStartx <em>Startx</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getTargetx <em>Targetx</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getCategories <em>Category</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getDescription <em>Description</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getStatus <em>Status</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getStatusDate <em>Status Date</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getStatusReason <em>Status Reason</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getAuthor <em>Author</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getPriority <em>Priority</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getAddresses <em>Addresses</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getNotes <em>Note</em>}</li>
* <li>{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getOutcomes <em>Outcome</em>}</li>
* </ul>
*
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal()
* @model
* @generated
*/
public interface Goal extends DomainResource {
/**
* Returns the value of the '<em><b>Identifier</b></em>' reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.datatype.Identifier}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Identifier</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Identifier</em>' reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Identifier()
* @model
* @generated
*/
EList<Identifier> getIdentifiers();
/**
* Returns the value of the '<em><b>Subject</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Subject</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Subject</em>' reference.
* @see #setSubject(Resource)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Subject()
* @model
* @generated
*/
Resource getSubject();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getSubject <em>Subject</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Subject</em>' reference.
* @see #getSubject()
* @generated
*/
void setSubject(Resource value);
/**
* Returns the value of the '<em><b>Startx</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Startx</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Startx</em>' reference.
* @see #setStartx(DataType)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Startx()
* @model annotation="http://www.eclipse.org/uml2/2.0.0/UML originalName='start[x]'"
* @generated
*/
DataType getStartx();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getStartx <em>Startx</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Startx</em>' reference.
* @see #getStartx()
* @generated
*/
void setStartx(DataType value);
/**
* Returns the value of the '<em><b>Targetx</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Targetx</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Targetx</em>' reference.
* @see #setTargetx(DataType)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Targetx()
* @model annotation="http://www.eclipse.org/uml2/2.0.0/UML originalName='target[x]'"
* @generated
*/
DataType getTargetx();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getTargetx <em>Targetx</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Targetx</em>' reference.
* @see #getTargetx()
* @generated
*/
void setTargetx(DataType value);
/**
* Returns the value of the '<em><b>Category</b></em>' reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.datatype.CodeableConcept}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Category</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Category</em>' reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Category()
* @model
* @generated
*/
EList<CodeableConcept> getCategories();
/**
* Returns the value of the '<em><b>Description</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Description</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Description</em>' reference.
* @see #setDescription(org.eclipse.mdht.uml.fhir.core.datatype.String)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Description()
* @model required="true"
* @generated
*/
org.eclipse.mdht.uml.fhir.core.datatype.String getDescription();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getDescription <em>Description</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Description</em>' reference.
* @see #getDescription()
* @generated
*/
void setDescription(org.eclipse.mdht.uml.fhir.core.datatype.String value);
/**
* Returns the value of the '<em><b>Status</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Status</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Status</em>' reference.
* @see #setStatus(Code)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Status()
* @model required="true"
* @generated
*/
Code getStatus();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getStatus <em>Status</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Status</em>' reference.
* @see #getStatus()
* @generated
*/
void setStatus(Code value);
/**
* Returns the value of the '<em><b>Status Date</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Status Date</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Status Date</em>' reference.
* @see #setStatusDate(Date)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_StatusDate()
* @model
* @generated
*/
Date getStatusDate();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getStatusDate <em>Status Date</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Status Date</em>' reference.
* @see #getStatusDate()
* @generated
*/
void setStatusDate(Date value);
/**
* Returns the value of the '<em><b>Status Reason</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Status Reason</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Status Reason</em>' reference.
* @see #setStatusReason(CodeableConcept)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_StatusReason()
* @model
* @generated
*/
CodeableConcept getStatusReason();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getStatusReason <em>Status Reason</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Status Reason</em>' reference.
* @see #getStatusReason()
* @generated
*/
void setStatusReason(CodeableConcept value);
/**
* Returns the value of the '<em><b>Author</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Author</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Author</em>' reference.
* @see #setAuthor(Resource)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Author()
* @model
* @generated
*/
Resource getAuthor();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getAuthor <em>Author</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Author</em>' reference.
* @see #getAuthor()
* @generated
*/
void setAuthor(Resource value);
/**
* Returns the value of the '<em><b>Priority</b></em>' reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Priority</em>' reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Priority</em>' reference.
* @see #setPriority(CodeableConcept)
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Priority()
* @model
* @generated
*/
CodeableConcept getPriority();
/**
* Sets the value of the '{@link org.eclipse.mdht.uml.fhir.core.resource.Goal#getPriority <em>Priority</em>}' reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Priority</em>' reference.
* @see #getPriority()
* @generated
*/
void setPriority(CodeableConcept value);
/**
* Returns the value of the '<em><b>Addresses</b></em>' reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.resource.Resource}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Addresses</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Addresses</em>' reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Addresses()
* @model
* @generated
*/
EList<Resource> getAddresses();
/**
* Returns the value of the '<em><b>Note</b></em>' reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.datatype.Annotation}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Note</em>' reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Note</em>' reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Note()
* @model
* @generated
*/
EList<Annotation> getNotes();
/**
* Returns the value of the '<em><b>Outcome</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.mdht.uml.fhir.core.resource.GoalOutcome}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Outcome</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Outcome</em>' containment reference list.
* @see org.eclipse.mdht.uml.fhir.core.resource.FhirResourcePackage#getGoal_Outcome()
* @model containment="true"
* @generated
*/
EList<GoalOutcome> getOutcomes();
} // Goal