| /** |
| */ |
| package org.hl7.fhir; |
| |
| import org.eclipse.emf.common.util.EList; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>List</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * A set of information summarized from a list of other resources. |
| * 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.List#getIdentifier <em>Identifier</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getTitle <em>Title</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getCode <em>Code</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getSubject <em>Subject</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getSource <em>Source</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getEncounter <em>Encounter</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getStatus <em>Status</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getDate <em>Date</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getOrderedBy <em>Ordered By</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getMode <em>Mode</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getNote <em>Note</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getEntry <em>Entry</em>}</li> |
| * <li>{@link org.hl7.fhir.List#getEmptyReason <em>Empty Reason</em>}</li> |
| * </ul> |
| * |
| * @see org.hl7.fhir.FhirPackage#getList() |
| * @model extendedMetaData="name='List' kind='elementOnly'" |
| * @generated |
| */ |
| public interface List 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 --> |
| * Identifier for the List assigned for business purposes outside the context of FHIR. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Identifier</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getList_Identifier() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<Identifier> getIdentifier(); |
| |
| /** |
| * Returns the value of the '<em><b>Title</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * A label for the list assigned by the author. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Title</em>' containment reference. |
| * @see #setTitle(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getList_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.List#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>Code</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * This code defines the purpose of the list - why it was created. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Code</em>' containment reference. |
| * @see #setCode(CodeableConcept) |
| * @see org.hl7.fhir.FhirPackage#getList_Code() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='code' namespace='##targetNamespace'" |
| * @generated |
| */ |
| CodeableConcept getCode(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.List#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>Subject</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The common subject (or patient) of the resources that are in the list, if there is one. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Subject</em>' containment reference. |
| * @see #setSubject(Reference) |
| * @see org.hl7.fhir.FhirPackage#getList_Subject() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='subject' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Reference getSubject(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.List#getSubject <em>Subject</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Subject</em>' containment reference. |
| * @see #getSubject() |
| * @generated |
| */ |
| void setSubject(Reference value); |
| |
| /** |
| * Returns the value of the '<em><b>Source</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Source</em>' containment reference. |
| * @see #setSource(Reference) |
| * @see org.hl7.fhir.FhirPackage#getList_Source() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='source' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Reference getSource(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.List#getSource <em>Source</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Source</em>' containment reference. |
| * @see #getSource() |
| * @generated |
| */ |
| void setSource(Reference value); |
| |
| /** |
| * Returns the value of the '<em><b>Encounter</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The encounter that is the context in which this list was created. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Encounter</em>' containment reference. |
| * @see #setEncounter(Reference) |
| * @see org.hl7.fhir.FhirPackage#getList_Encounter() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='encounter' namespace='##targetNamespace'" |
| * @generated |
| */ |
| Reference getEncounter(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.List#getEncounter <em>Encounter</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Encounter</em>' containment reference. |
| * @see #getEncounter() |
| * @generated |
| */ |
| void setEncounter(Reference value); |
| |
| /** |
| * Returns the value of the '<em><b>Status</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Indicates the current state of this list. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Status</em>' containment reference. |
| * @see #setStatus(ListStatus) |
| * @see org.hl7.fhir.FhirPackage#getList_Status() |
| * @model containment="true" required="true" |
| * extendedMetaData="kind='element' name='status' namespace='##targetNamespace'" |
| * @generated |
| */ |
| ListStatus getStatus(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.List#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(ListStatus value); |
| |
| /** |
| * Returns the value of the '<em><b>Date</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The date that the list was prepared. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Date</em>' containment reference. |
| * @see #setDate(DateTime) |
| * @see org.hl7.fhir.FhirPackage#getList_Date() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='date' namespace='##targetNamespace'" |
| * @generated |
| */ |
| DateTime getDate(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.List#getDate <em>Date</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Date</em>' containment reference. |
| * @see #getDate() |
| * @generated |
| */ |
| void setDate(DateTime value); |
| |
| /** |
| * Returns the value of the '<em><b>Ordered By</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * What order applies to the items in the list. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Ordered By</em>' containment reference. |
| * @see #setOrderedBy(CodeableConcept) |
| * @see org.hl7.fhir.FhirPackage#getList_OrderedBy() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='orderedBy' namespace='##targetNamespace'" |
| * @generated |
| */ |
| CodeableConcept getOrderedBy(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.List#getOrderedBy <em>Ordered By</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Ordered By</em>' containment reference. |
| * @see #getOrderedBy() |
| * @generated |
| */ |
| void setOrderedBy(CodeableConcept value); |
| |
| /** |
| * Returns the value of the '<em><b>Mode</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Mode</em>' containment reference. |
| * @see #setMode(ListMode) |
| * @see org.hl7.fhir.FhirPackage#getList_Mode() |
| * @model containment="true" required="true" |
| * extendedMetaData="kind='element' name='mode' namespace='##targetNamespace'" |
| * @generated |
| */ |
| ListMode getMode(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.List#getMode <em>Mode</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Mode</em>' containment reference. |
| * @see #getMode() |
| * @generated |
| */ |
| void setMode(ListMode value); |
| |
| /** |
| * Returns the value of the '<em><b>Note</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Comments that apply to the overall list. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Note</em>' containment reference. |
| * @see #setNote(org.hl7.fhir.String) |
| * @see org.hl7.fhir.FhirPackage#getList_Note() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='note' namespace='##targetNamespace'" |
| * @generated |
| */ |
| org.hl7.fhir.String getNote(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.List#getNote <em>Note</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Note</em>' containment reference. |
| * @see #getNote() |
| * @generated |
| */ |
| void setNote(org.hl7.fhir.String value); |
| |
| /** |
| * Returns the value of the '<em><b>Entry</b></em>' containment reference list. |
| * The list contents are of type {@link org.hl7.fhir.ListEntry}. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Entries in this list. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Entry</em>' containment reference list. |
| * @see org.hl7.fhir.FhirPackage#getList_Entry() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='entry' namespace='##targetNamespace'" |
| * @generated |
| */ |
| EList<ListEntry> getEntry(); |
| |
| /** |
| * Returns the value of the '<em><b>Empty Reason</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * If the list is empty, why the list is empty. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Empty Reason</em>' containment reference. |
| * @see #setEmptyReason(CodeableConcept) |
| * @see org.hl7.fhir.FhirPackage#getList_EmptyReason() |
| * @model containment="true" |
| * extendedMetaData="kind='element' name='emptyReason' namespace='##targetNamespace'" |
| * @generated |
| */ |
| CodeableConcept getEmptyReason(); |
| |
| /** |
| * Sets the value of the '{@link org.hl7.fhir.List#getEmptyReason <em>Empty Reason</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Empty Reason</em>' containment reference. |
| * @see #getEmptyReason() |
| * @generated |
| */ |
| void setEmptyReason(CodeableConcept value); |
| |
| } // List |
