public class ImagingStudy extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
ImagingStudy.ImagingStudySeriesComponent |
static class |
ImagingStudy.ImagingStudySeriesInstanceComponent |
static class |
ImagingStudy.InstanceAvailability |
static class |
ImagingStudy.InstanceAvailabilityEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
protected Identifier |
accession
Accession Number is an identifier related to some aspect of imaging workflow and data management.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
ACCESSION
Fluent Client search parameter constant for accession
|
protected Enumeration<ImagingStudy.InstanceAvailability> |
availability
Availability of study (online, offline or nearline).
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
BODYSITE
Fluent Client search parameter constant for bodysite
|
protected StringType |
description
Institution-generated description or classification of the Study performed.
|
static ca.uhn.fhir.rest.gclient.UriClientParam |
DICOM_CLASS
Fluent Client search parameter constant for dicom-class
|
protected List<Identifier> |
identifier
Other identifiers for the study.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_ORDER
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
protected Reference |
interpreter
Who read the study and interpreted the images or other content.
|
protected Practitioner |
interpreterTarget
The actual object that is the target of the reference (Who read the study and interpreted the images or other content.)
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
MODALITY
Fluent Client search parameter constant for modality
|
protected List<Coding> |
modalityList
A list of all the Series.ImageModality values that are actual acquisition modalities, i.e.
|
protected UnsignedIntType |
numberOfInstances
Number of SOP Instances in Study.
|
protected UnsignedIntType |
numberOfSeries
Number of Series in Study.
|
protected List<Reference> |
order
A list of the diagnostic orders that resulted in this imaging study being performed.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
ORDER
Fluent Client search parameter constant for order
|
protected List<DiagnosticOrder> |
orderTarget
The actual objects that are the target of the reference (A list of the diagnostic orders that resulted in this imaging study being performed.)
|
protected Reference |
patient
The patient imaged in the study.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
protected Patient |
patientTarget
The actual object that is the target of the reference (The patient imaged in the study.)
|
protected List<Reference> |
procedure
Type of procedure performed.
|
protected List<Procedure> |
procedureTarget
The actual objects that are the target of the reference (Type of procedure performed.)
|
protected Reference |
referrer
The requesting/referring physician.
|
protected Practitioner |
referrerTarget
The actual object that is the target of the reference (The requesting/referring physician.)
|
protected List<ImagingStudy.ImagingStudySeriesComponent> |
series
Each study has one or more series of images or other content.
|
static ca.uhn.fhir.rest.gclient.UriClientParam |
SERIES
Fluent Client search parameter constant for series
|
static String |
SP_ACCESSION
Search parameter: accession
|
static String |
SP_BODYSITE
Search parameter: bodysite
|
static String |
SP_DICOM_CLASS
Search parameter: dicom-class
|
static String |
SP_IDENTIFIER
Search parameter: identifier
|
static String |
SP_MODALITY
Search parameter: modality
|
static String |
SP_ORDER
Search parameter: order
|
static String |
SP_PATIENT
Search parameter: patient
|
static String |
SP_SERIES
Search parameter: series
|
static String |
SP_STARTED
Search parameter: started
|
static String |
SP_STUDY
Search parameter: study
|
static String |
SP_UID
Search parameter: uid
|
protected DateTimeType |
started
Date and Time the study started.
|
static ca.uhn.fhir.rest.gclient.DateClientParam |
STARTED
Fluent Client search parameter constant for started
|
static ca.uhn.fhir.rest.gclient.UriClientParam |
STUDY
Fluent Client search parameter constant for study
|
protected OidType |
uid
Formal identifier for the study.
|
static ca.uhn.fhir.rest.gclient.UriClientParam |
UID
Fluent Client search parameter constant for uid
|
protected UriType |
url
WADO-RS resource where Study is available.
|
contained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
ImagingStudy()
Constructor
|
ImagingStudy(OidType uid,
Reference patient,
UnsignedIntType numberOfSeries,
UnsignedIntType numberOfInstances)
Constructor
|
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setTextcopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, setIdcastToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected Identifier accession
protected List<Identifier> identifier
protected Enumeration<ImagingStudy.InstanceAvailability> availability
protected List<Coding> modalityList
protected Patient patientTarget
protected DateTimeType started
protected List<Reference> order
protected List<DiagnosticOrder> orderTarget
protected Practitioner referrerTarget
protected Reference interpreter
protected Practitioner interpreterTarget
protected UnsignedIntType numberOfSeries
protected UnsignedIntType numberOfInstances
protected List<Procedure> procedureTarget
protected StringType description
protected List<ImagingStudy.ImagingStudySeriesComponent> series
public static final String SP_UID
Description: The instance unique identifier
Type: uri
Path: ImagingStudy.series.instance.uid
public static final ca.uhn.fhir.rest.gclient.UriClientParam UID
Description: The instance unique identifier
Type: uri
Path: ImagingStudy.series.instance.uid
public static final String SP_SERIES
Description: The identifier of the series of images
Type: uri
Path: ImagingStudy.series.uid
public static final ca.uhn.fhir.rest.gclient.UriClientParam SERIES
Description: The identifier of the series of images
Type: uri
Path: ImagingStudy.series.uid
public static final String SP_PATIENT
Description: Who the study is about
Type: reference
Path: ImagingStudy.patient
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Description: Who the study is about
Type: reference
Path: ImagingStudy.patient
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
public static final String SP_ORDER
Description: The order for the image
Type: reference
Path: ImagingStudy.order
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORDER
Description: The order for the image
Type: reference
Path: ImagingStudy.order
public static final ca.uhn.fhir.model.api.Include INCLUDE_ORDER
public static final String SP_BODYSITE
Description: The body site studied
Type: token
Path: ImagingStudy.series.bodySite
public static final ca.uhn.fhir.rest.gclient.TokenClientParam BODYSITE
Description: The body site studied
Type: token
Path: ImagingStudy.series.bodySite
public static final String SP_ACCESSION
Description: The accession identifier for the study
Type: token
Path: ImagingStudy.accession
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACCESSION
Description: The accession identifier for the study
Type: token
Path: ImagingStudy.accession
public static final String SP_STUDY
Description: The study identifier for the image
Type: uri
Path: ImagingStudy.uid
public static final ca.uhn.fhir.rest.gclient.UriClientParam STUDY
Description: The study identifier for the image
Type: uri
Path: ImagingStudy.uid
public static final String SP_MODALITY
Description: The modality of the series
Type: token
Path: ImagingStudy.series.modality
public static final ca.uhn.fhir.rest.gclient.TokenClientParam MODALITY
Description: The modality of the series
Type: token
Path: ImagingStudy.series.modality
public static final String SP_STARTED
Description: When the study was started
Type: date
Path: ImagingStudy.started
public static final ca.uhn.fhir.rest.gclient.DateClientParam STARTED
Description: When the study was started
Type: date
Path: ImagingStudy.started
public static final String SP_IDENTIFIER
Description: Other identifiers for the Study
Type: token
Path: ImagingStudy.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Description: Other identifiers for the Study
Type: token
Path: ImagingStudy.identifier
public static final String SP_DICOM_CLASS
Description: The type of the instance
Type: uri
Path: ImagingStudy.series.instance.sopClass
public static final ca.uhn.fhir.rest.gclient.UriClientParam DICOM_CLASS
Description: The type of the instance
Type: uri
Path: ImagingStudy.series.instance.sopClass
public ImagingStudy()
public ImagingStudy(OidType uid, Reference patient, UnsignedIntType numberOfSeries, UnsignedIntType numberOfInstances)
public OidType getUidElement()
uid (Formal identifier for the study.). This is the underlying object with id, value and extensions. The accessor "getUid" gives direct access to the valuepublic boolean hasUidElement()
public boolean hasUid()
public ImagingStudy setUidElement(OidType value)
value - uid (Formal identifier for the study.). This is the underlying object with id, value and extensions. The accessor "getUid" gives direct access to the valuepublic ImagingStudy setUid(String value)
value - Formal identifier for the study.public Identifier getAccession()
accession (Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).)public boolean hasAccession()
public ImagingStudy setAccession(Identifier value)
value - accession (Accession Number is an identifier related to some aspect of imaging workflow and data management. Usage may vary across different institutions. See for instance [IHE Radiology Technical Framework Volume 1 Appendix A](http://www.ihe.net/uploadedFiles/Documents/Radiology/IHE_RAD_TF_Rev13.0_Vol1_FT_2014-07-30.pdf).)public List<Identifier> getIdentifier()
identifier (Other identifiers for the study.)public boolean hasIdentifier()
public Identifier addIdentifier()
identifier (Other identifiers for the study.)public ImagingStudy addIdentifier(Identifier t)
public Enumeration<ImagingStudy.InstanceAvailability> getAvailabilityElement()
availability (Availability of study (online, offline or nearline).). This is the underlying object with id, value and extensions. The accessor "getAvailability" gives direct access to the valuepublic boolean hasAvailabilityElement()
public boolean hasAvailability()
public ImagingStudy setAvailabilityElement(Enumeration<ImagingStudy.InstanceAvailability> value)
value - availability (Availability of study (online, offline or nearline).). This is the underlying object with id, value and extensions. The accessor "getAvailability" gives direct access to the valuepublic ImagingStudy.InstanceAvailability getAvailability()
public ImagingStudy setAvailability(ImagingStudy.InstanceAvailability value)
value - Availability of study (online, offline or nearline).public List<Coding> getModalityList()
modalityList (A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).)public boolean hasModalityList()
public Coding addModalityList()
modalityList (A list of all the Series.ImageModality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).)public ImagingStudy addModalityList(Coding t)
public Reference getPatient()
patient (The patient imaged in the study.)public boolean hasPatient()
public ImagingStudy setPatient(Reference value)
value - patient (The patient imaged in the study.)public Patient getPatientTarget()
patient The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient imaged in the study.)public ImagingStudy setPatientTarget(Patient value)
value - patient The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient imaged in the study.)public DateTimeType getStartedElement()
started (Date and Time the study started.). This is the underlying object with id, value and extensions. The accessor "getStarted" gives direct access to the valuepublic boolean hasStartedElement()
public boolean hasStarted()
public ImagingStudy setStartedElement(DateTimeType value)
value - started (Date and Time the study started.). This is the underlying object with id, value and extensions. The accessor "getStarted" gives direct access to the valuepublic Date getStarted()
public ImagingStudy setStarted(Date value)
value - Date and Time the study started.public List<Reference> getOrder()
order (A list of the diagnostic orders that resulted in this imaging study being performed.)public boolean hasOrder()
public Reference addOrder()
order (A list of the diagnostic orders that resulted in this imaging study being performed.)public ImagingStudy addOrder(Reference t)
public List<DiagnosticOrder> getOrderTarget()
order (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. A list of the diagnostic orders that resulted in this imaging study being performed.)public DiagnosticOrder addOrderTarget()
order (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. A list of the diagnostic orders that resulted in this imaging study being performed.)public Reference getReferrer()
referrer (The requesting/referring physician.)public boolean hasReferrer()
public ImagingStudy setReferrer(Reference value)
value - referrer (The requesting/referring physician.)public Practitioner getReferrerTarget()
referrer The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The requesting/referring physician.)public ImagingStudy setReferrerTarget(Practitioner value)
value - referrer The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The requesting/referring physician.)public Reference getInterpreter()
interpreter (Who read the study and interpreted the images or other content.)public boolean hasInterpreter()
public ImagingStudy setInterpreter(Reference value)
value - interpreter (Who read the study and interpreted the images or other content.)public Practitioner getInterpreterTarget()
interpreter The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Who read the study and interpreted the images or other content.)public ImagingStudy setInterpreterTarget(Practitioner value)
value - interpreter The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Who read the study and interpreted the images or other content.)public UriType getUrlElement()
url (WADO-RS resource where Study is available.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the valuepublic boolean hasUrlElement()
public boolean hasUrl()
public ImagingStudy setUrlElement(UriType value)
value - url (WADO-RS resource where Study is available.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the valuepublic ImagingStudy setUrl(String value)
value - WADO-RS resource where Study is available.public UnsignedIntType getNumberOfSeriesElement()
numberOfSeries (Number of Series in Study.). This is the underlying object with id, value and extensions. The accessor "getNumberOfSeries" gives direct access to the valuepublic boolean hasNumberOfSeriesElement()
public boolean hasNumberOfSeries()
public ImagingStudy setNumberOfSeriesElement(UnsignedIntType value)
value - numberOfSeries (Number of Series in Study.). This is the underlying object with id, value and extensions. The accessor "getNumberOfSeries" gives direct access to the valuepublic int getNumberOfSeries()
public ImagingStudy setNumberOfSeries(int value)
value - Number of Series in Study.public UnsignedIntType getNumberOfInstancesElement()
numberOfInstances (Number of SOP Instances in Study.). This is the underlying object with id, value and extensions. The accessor "getNumberOfInstances" gives direct access to the valuepublic boolean hasNumberOfInstancesElement()
public boolean hasNumberOfInstances()
public ImagingStudy setNumberOfInstancesElement(UnsignedIntType value)
value - numberOfInstances (Number of SOP Instances in Study.). This is the underlying object with id, value and extensions. The accessor "getNumberOfInstances" gives direct access to the valuepublic int getNumberOfInstances()
public ImagingStudy setNumberOfInstances(int value)
value - Number of SOP Instances in Study.public List<Reference> getProcedure()
procedure (Type of procedure performed.)public boolean hasProcedure()
public Reference addProcedure()
procedure (Type of procedure performed.)public ImagingStudy addProcedure(Reference t)
public List<Procedure> getProcedureTarget()
procedure (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Type of procedure performed.)public Procedure addProcedureTarget()
procedure (Add an actual object that is the target of the reference. The reference library doesn't use these, but you can use this to hold the resources if you resolvethemt. Type of procedure performed.)public StringType getDescriptionElement()
description (Institution-generated description or classification of the Study performed.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the valuepublic boolean hasDescriptionElement()
public boolean hasDescription()
public ImagingStudy setDescriptionElement(StringType value)
value - description (Institution-generated description or classification of the Study performed.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the valuepublic String getDescription()
public ImagingStudy setDescription(String value)
value - Institution-generated description or classification of the Study performed.public List<ImagingStudy.ImagingStudySeriesComponent> getSeries()
series (Each study has one or more series of images or other content.)public boolean hasSeries()
public ImagingStudy.ImagingStudySeriesComponent addSeries()
series (Each study has one or more series of images or other content.)public ImagingStudy addSeries(ImagingStudy.ImagingStudySeriesComponent t)
protected void listChildren(List<Property> childrenList)
listChildren in class DomainResourcepublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in class DomainResourcepublic ImagingStudy copy()
copy in class DomainResourceprotected ImagingStudy typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2018 University Health Network. All rights reserved.