blob: 67b545c7611725a43b11468e7b7ea5e7de3f58ae [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>Observation Component</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* Measurements and simple assertions made about a patient, device or other subject.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.ObservationComponent#getCode <em>Code</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getValueQuantity <em>Value Quantity</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getValueCodeableConcept <em>Value Codeable Concept</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getValueString <em>Value String</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getValueRange <em>Value Range</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getValueRatio <em>Value Ratio</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getValueSampledData <em>Value Sampled Data</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getValueAttachment <em>Value Attachment</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getValueTime <em>Value Time</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getValueDateTime <em>Value Date Time</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getValuePeriod <em>Value Period</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getDataAbsentReason <em>Data Absent Reason</em>}</li>
* <li>{@link org.hl7.fhir.ObservationComponent#getReferenceRange <em>Reference Range</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getObservationComponent()
* @model extendedMetaData="name='Observation.Component' kind='elementOnly'"
* @generated
*/
public interface ObservationComponent extends BackboneElement {
/**
* Returns the value of the '<em><b>Code</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Describes what was observed. Sometimes this is called the observation "code".
* <!-- end-model-doc -->
* @return the value of the '<em>Code</em>' containment reference.
* @see #setCode(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_Code()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='code' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getCode();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#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>Value Quantity</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Value Quantity</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Value Quantity</em>' containment reference.
* @see #setValueQuantity(Quantity)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_ValueQuantity()
* @model containment="true"
* extendedMetaData="kind='element' name='valueQuantity' namespace='##targetNamespace'"
* @generated
*/
Quantity getValueQuantity();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#getValueQuantity <em>Value Quantity</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Value Quantity</em>' containment reference.
* @see #getValueQuantity()
* @generated
*/
void setValueQuantity(Quantity value);
/**
* Returns the value of the '<em><b>Value Codeable Concept</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Value Codeable Concept</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Value Codeable Concept</em>' containment reference.
* @see #setValueCodeableConcept(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_ValueCodeableConcept()
* @model containment="true"
* extendedMetaData="kind='element' name='valueCodeableConcept' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getValueCodeableConcept();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#getValueCodeableConcept <em>Value Codeable Concept</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Value Codeable Concept</em>' containment reference.
* @see #getValueCodeableConcept()
* @generated
*/
void setValueCodeableConcept(CodeableConcept value);
/**
* Returns the value of the '<em><b>Value String</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Value String</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Value String</em>' containment reference.
* @see #setValueString(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_ValueString()
* @model containment="true"
* extendedMetaData="kind='element' name='valueString' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getValueString();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#getValueString <em>Value String</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Value String</em>' containment reference.
* @see #getValueString()
* @generated
*/
void setValueString(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Value Range</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Value Range</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Value Range</em>' containment reference.
* @see #setValueRange(Range)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_ValueRange()
* @model containment="true"
* extendedMetaData="kind='element' name='valueRange' namespace='##targetNamespace'"
* @generated
*/
Range getValueRange();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#getValueRange <em>Value Range</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Value Range</em>' containment reference.
* @see #getValueRange()
* @generated
*/
void setValueRange(Range value);
/**
* Returns the value of the '<em><b>Value Ratio</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Value Ratio</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Value Ratio</em>' containment reference.
* @see #setValueRatio(Ratio)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_ValueRatio()
* @model containment="true"
* extendedMetaData="kind='element' name='valueRatio' namespace='##targetNamespace'"
* @generated
*/
Ratio getValueRatio();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#getValueRatio <em>Value Ratio</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Value Ratio</em>' containment reference.
* @see #getValueRatio()
* @generated
*/
void setValueRatio(Ratio value);
/**
* Returns the value of the '<em><b>Value Sampled Data</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Value Sampled Data</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Value Sampled Data</em>' containment reference.
* @see #setValueSampledData(SampledData)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_ValueSampledData()
* @model containment="true"
* extendedMetaData="kind='element' name='valueSampledData' namespace='##targetNamespace'"
* @generated
*/
SampledData getValueSampledData();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#getValueSampledData <em>Value Sampled Data</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Value Sampled Data</em>' containment reference.
* @see #getValueSampledData()
* @generated
*/
void setValueSampledData(SampledData value);
/**
* Returns the value of the '<em><b>Value Attachment</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Value Attachment</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Value Attachment</em>' containment reference.
* @see #setValueAttachment(Attachment)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_ValueAttachment()
* @model containment="true"
* extendedMetaData="kind='element' name='valueAttachment' namespace='##targetNamespace'"
* @generated
*/
Attachment getValueAttachment();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#getValueAttachment <em>Value Attachment</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Value Attachment</em>' containment reference.
* @see #getValueAttachment()
* @generated
*/
void setValueAttachment(Attachment value);
/**
* Returns the value of the '<em><b>Value Time</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Value Time</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Value Time</em>' containment reference.
* @see #setValueTime(Time)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_ValueTime()
* @model containment="true"
* extendedMetaData="kind='element' name='valueTime' namespace='##targetNamespace'"
* @generated
*/
Time getValueTime();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#getValueTime <em>Value Time</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Value Time</em>' containment reference.
* @see #getValueTime()
* @generated
*/
void setValueTime(Time value);
/**
* Returns the value of the '<em><b>Value Date Time</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Value Date Time</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Value Date Time</em>' containment reference.
* @see #setValueDateTime(DateTime)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_ValueDateTime()
* @model containment="true"
* extendedMetaData="kind='element' name='valueDateTime' namespace='##targetNamespace'"
* @generated
*/
DateTime getValueDateTime();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#getValueDateTime <em>Value Date Time</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Value Date Time</em>' containment reference.
* @see #getValueDateTime()
* @generated
*/
void setValueDateTime(DateTime value);
/**
* Returns the value of the '<em><b>Value Period</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Value Period</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Value Period</em>' containment reference.
* @see #setValuePeriod(Period)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_ValuePeriod()
* @model containment="true"
* extendedMetaData="kind='element' name='valuePeriod' namespace='##targetNamespace'"
* @generated
*/
Period getValuePeriod();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#getValuePeriod <em>Value Period</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Value Period</em>' containment reference.
* @see #getValuePeriod()
* @generated
*/
void setValuePeriod(Period value);
/**
* Returns the value of the '<em><b>Data Absent Reason</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Provides a reason why the expected value in the element Observation.value[x] is missing.
* <!-- end-model-doc -->
* @return the value of the '<em>Data Absent Reason</em>' containment reference.
* @see #setDataAbsentReason(CodeableConcept)
* @see org.hl7.fhir.FhirPackage#getObservationComponent_DataAbsentReason()
* @model containment="true"
* extendedMetaData="kind='element' name='dataAbsentReason' namespace='##targetNamespace'"
* @generated
*/
CodeableConcept getDataAbsentReason();
/**
* Sets the value of the '{@link org.hl7.fhir.ObservationComponent#getDataAbsentReason <em>Data Absent Reason</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Data Absent Reason</em>' containment reference.
* @see #getDataAbsentReason()
* @generated
*/
void setDataAbsentReason(CodeableConcept value);
/**
* Returns the value of the '<em><b>Reference Range</b></em>' containment reference list.
* The list contents are of type {@link org.hl7.fhir.ObservationReferenceRange}.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Guidance on how to interpret the value by comparison to a normal or recommended range.
* <!-- end-model-doc -->
* @return the value of the '<em>Reference Range</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getObservationComponent_ReferenceRange()
* @model containment="true"
* extendedMetaData="kind='element' name='referenceRange' namespace='##targetNamespace'"
* @generated
*/
EList<ObservationReferenceRange> getReferenceRange();
} // ObservationComponent