blob: b1b2be038e1a86c8032a421207ba687edc746858 [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>Imaging Study Instance</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
* Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities.
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* </p>
* <ul>
* <li>{@link org.hl7.fhir.ImagingStudyInstance#getNumber <em>Number</em>}</li>
* <li>{@link org.hl7.fhir.ImagingStudyInstance#getUid <em>Uid</em>}</li>
* <li>{@link org.hl7.fhir.ImagingStudyInstance#getSopClass <em>Sop Class</em>}</li>
* <li>{@link org.hl7.fhir.ImagingStudyInstance#getType <em>Type</em>}</li>
* <li>{@link org.hl7.fhir.ImagingStudyInstance#getTitle <em>Title</em>}</li>
* <li>{@link org.hl7.fhir.ImagingStudyInstance#getContent <em>Content</em>}</li>
* </ul>
*
* @see org.hl7.fhir.FhirPackage#getImagingStudyInstance()
* @model extendedMetaData="name='ImagingStudy.Instance' kind='elementOnly'"
* @generated
*/
public interface ImagingStudyInstance extends BackboneElement {
/**
* Returns the value of the '<em><b>Number</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The number of instance in the series.
* <!-- end-model-doc -->
* @return the value of the '<em>Number</em>' containment reference.
* @see #setNumber(UnsignedInt)
* @see org.hl7.fhir.FhirPackage#getImagingStudyInstance_Number()
* @model containment="true"
* extendedMetaData="kind='element' name='number' namespace='##targetNamespace'"
* @generated
*/
UnsignedInt getNumber();
/**
* Sets the value of the '{@link org.hl7.fhir.ImagingStudyInstance#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(UnsignedInt value);
/**
* Returns the value of the '<em><b>Uid</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* Formal identifier for this image or other content.
* <!-- end-model-doc -->
* @return the value of the '<em>Uid</em>' containment reference.
* @see #setUid(Oid)
* @see org.hl7.fhir.FhirPackage#getImagingStudyInstance_Uid()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='uid' namespace='##targetNamespace'"
* @generated
*/
Oid getUid();
/**
* Sets the value of the '{@link org.hl7.fhir.ImagingStudyInstance#getUid <em>Uid</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Uid</em>' containment reference.
* @see #getUid()
* @generated
*/
void setUid(Oid value);
/**
* Returns the value of the '<em><b>Sop Class</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* DICOM instance type.
* <!-- end-model-doc -->
* @return the value of the '<em>Sop Class</em>' containment reference.
* @see #setSopClass(Oid)
* @see org.hl7.fhir.FhirPackage#getImagingStudyInstance_SopClass()
* @model containment="true" required="true"
* extendedMetaData="kind='element' name='sopClass' namespace='##targetNamespace'"
* @generated
*/
Oid getSopClass();
/**
* Sets the value of the '{@link org.hl7.fhir.ImagingStudyInstance#getSopClass <em>Sop Class</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Sop Class</em>' containment reference.
* @see #getSopClass()
* @generated
*/
void setSopClass(Oid value);
/**
* Returns the value of the '<em><b>Type</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* A human-friendly SOP Class name.
* <!-- end-model-doc -->
* @return the value of the '<em>Type</em>' containment reference.
* @see #setType(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getImagingStudyInstance_Type()
* @model containment="true"
* extendedMetaData="kind='element' name='type' namespace='##targetNamespace'"
* @generated
*/
org.hl7.fhir.String getType();
/**
* Sets the value of the '{@link org.hl7.fhir.ImagingStudyInstance#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(org.hl7.fhir.String value);
/**
* Returns the value of the '<em><b>Title</b></em>' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* <!-- begin-model-doc -->
* The description of the instance.
* <!-- end-model-doc -->
* @return the value of the '<em>Title</em>' containment reference.
* @see #setTitle(org.hl7.fhir.String)
* @see org.hl7.fhir.FhirPackage#getImagingStudyInstance_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.ImagingStudyInstance#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>Content</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 -->
* Content of the instance or a rendering thereof (e.g. a JPEG of an image, or an XML of a structured report). May be represented for example by inline encoding; by a URL reference to a WADO-RS service that makes the instance available; or to a FHIR Resource (e.g. Media, Document, etc.). Multiple content attachments may be used for alternate representations of the instance.
* <!-- end-model-doc -->
* @return the value of the '<em>Content</em>' containment reference list.
* @see org.hl7.fhir.FhirPackage#getImagingStudyInstance_Content()
* @model containment="true"
* extendedMetaData="kind='element' name='content' namespace='##targetNamespace'"
* @generated
*/
EList<Attachment> getContent();
} // ImagingStudyInstance