blob: 27c6c127abe3f9f1b250b4e77184d3bd91dca3c9 [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>Diagnostic Order</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* A record of a request for a diagnostic investigation service to be performed.
* 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.DiagnosticOrder#getSubject <em>Subject</em>}</li>
* <li>{@link org.hl7.fhir.DiagnosticOrder#getOrderer <em>Orderer</em>}</li>
* <li>{@link org.hl7.fhir.DiagnosticOrder#getIdentifier <em>Identifier</em>}</li>
* <li>{@link org.hl7.fhir.DiagnosticOrder#getEncounter <em>Encounter</em>}</li>
* <li>{@link org.hl7.fhir.DiagnosticOrder#getReason <em>Reason</em>}</li>
* <li>{@link org.hl7.fhir.DiagnosticOrder#getSupportingInformation <em>Supporting Information</em>}</li>
* <li>{@link org.hl7.fhir.DiagnosticOrder#getSpecimen <em>Specimen</em>}</li>
* <li>{@link org.hl7.fhir.DiagnosticOrder#getStatus <em>Status</em>}</li>
* <li>{@link org.hl7.fhir.DiagnosticOrder#getPriority <em>Priority</em>}</li>
* <li>{@link org.hl7.fhir.DiagnosticOrder#getEvent <em>Event</em>}</li>
* <li>{@link org.hl7.fhir.DiagnosticOrder#getItem <em>Item</em>}</li>
* <li>{@link org.hl7.fhir.DiagnosticOrder#getNote <em>Note</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder()
* @model extendedMetaData="name='DiagnosticOrder' kind='elementOnly'"
* @generated
*/
public interface DiagnosticOrder extends DomainResource {
/**
* Returns the value of the '<em><b>Subject</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Who or what the investigation is to be performed on. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
* <!-- end-model-doc -->
* @return the value of the '<em>Subject</em>' containment reference.
* @see #setSubject(Reference)
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_Subject()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='subject' namespace='##targetNamespace'"
* @generated
*/
Reference getSubject();
/**
* Sets the value of the '{@link org.hl7.fhir.DiagnosticOrder#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>Orderer</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The practitioner that holds legal responsibility for ordering the investigation.
* <!-- end-model-doc -->
* @return the value of the '<em>Orderer</em>' containment reference.
* @see #setOrderer(Reference)
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_Orderer()
* @model containment="true"
* extendedMetaData="kind='element' name='orderer' namespace='##targetNamespace'"
* @generated
*/
Reference getOrderer();
/**
* Sets the value of the '{@link org.hl7.fhir.DiagnosticOrder#getOrderer <em>Orderer</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Orderer</em>' containment reference.
* @see #getOrderer()
* @generated
*/
void setOrderer(Reference value);
/**
* 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 -->
* Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
* <!-- end-model-doc -->
* @return the value of the '<em>Identifier</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_Identifier()
* @model containment="true"
* extendedMetaData="kind='element' name='identifier' namespace='##targetNamespace'"
* @generated
*/
EList<Identifier> getIdentifier();
/**
* Returns the value of the '<em><b>Encounter</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* An encounter that provides additional information about the healthcare context in which this request is made.
* <!-- end-model-doc -->
* @return the value of the '<em>Encounter</em>' containment reference.
* @see #setEncounter(Reference)
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_Encounter()
* @model containment="true"
* extendedMetaData="kind='element' name='encounter' namespace='##targetNamespace'"
* @generated
*/
Reference getEncounter();
/**
* Sets the value of the '{@link org.hl7.fhir.DiagnosticOrder#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>Reason</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 -->
* An explanation or justification for why this diagnostic investigation is being requested. This is often for billing purposes. May relate to the resources referred to in supportingInformation.
* <!-- end-model-doc -->
* @return the value of the '<em>Reason</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_Reason()
* @model containment="true"
* extendedMetaData="kind='element' name='reason' namespace='##targetNamespace'"
* @generated
*/
EList<CodeableConcept> getReason();
/**
* Returns the value of the '<em><b>Supporting Information</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 -->
* Additional clinical information about the patient or specimen that may influence test interpretations. This includes observations explicitly requested by the producer(filler) to provide context or supporting information needed to complete the order.
* <!-- end-model-doc -->
* @return the value of the '<em>Supporting Information</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_SupportingInformation()
* @model containment="true"
* extendedMetaData="kind='element' name='supportingInformation' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getSupportingInformation();
/**
* Returns the value of the '<em><b>Specimen</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 -->
* One or more specimens that the diagnostic investigation is about.
* <!-- end-model-doc -->
* @return the value of the '<em>Specimen</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_Specimen()
* @model containment="true"
* extendedMetaData="kind='element' name='specimen' namespace='##targetNamespace'"
* @generated
*/
EList<Reference> getSpecimen();
/**
* 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 order.
* <!-- end-model-doc -->
* @return the value of the '<em>Status</em>' containment reference.
* @see #setStatus(DiagnosticOrderStatus)
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_Status()
* @model containment="true"
* extendedMetaData="kind='element' name='status' namespace='##targetNamespace'"
* @generated
*/
DiagnosticOrderStatus getStatus();
/**
* Sets the value of the '{@link org.hl7.fhir.DiagnosticOrder#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(DiagnosticOrderStatus value);
/**
* Returns the value of the '<em><b>Priority</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The clinical priority associated with this order.
* <!-- end-model-doc -->
* @return the value of the '<em>Priority</em>' containment reference.
* @see #setPriority(DiagnosticOrderPriority)
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_Priority()
* @model containment="true"
* extendedMetaData="kind='element' name='priority' namespace='##targetNamespace'"
* @generated
*/
DiagnosticOrderPriority getPriority();
/**
* Sets the value of the '{@link org.hl7.fhir.DiagnosticOrder#getPriority <em>Priority</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Priority</em>' containment reference.
* @see #getPriority()
* @generated
*/
void setPriority(DiagnosticOrderPriority value);
/**
* Returns the value of the '<em><b>Event</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.DiagnosticOrderEvent}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A summary of the events of interest that have occurred as the request is processed; e.g. when the order was made, various processing steps (specimens received), when it was completed.
* <!-- end-model-doc -->
* @return the value of the '<em>Event</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_Event()
* @model containment="true"
* extendedMetaData="kind='element' name='event' namespace='##targetNamespace'"
* @generated
*/
EList<DiagnosticOrderEvent> getEvent();
/**
* Returns the value of the '<em><b>Item</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.DiagnosticOrderItem}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.
* <!-- end-model-doc -->
* @return the value of the '<em>Item</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_Item()
* @model containment="true"
* extendedMetaData="kind='element' name='item' namespace='##targetNamespace'"
* @generated
*/
EList<DiagnosticOrderItem> getItem();
/**
* Returns the value of the '<em><b>Note</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.Annotation}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Any other notes associated with this patient, specimen or order (e.g. "patient hates needles").
* <!-- end-model-doc -->
* @return the value of the '<em>Note</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getDiagnosticOrder_Note()
* @model containment="true"
* extendedMetaData="kind='element' name='note' namespace='##targetNamespace'"
* @generated
*/
EList<Annotation> getNote();
} // DiagnosticOrder