Skip to main content

HS.FHIR.vSTU3.Model.Resource.ImagingStudy

deprecated class HS.FHIR.vSTU3.Model.Resource.ImagingStudy extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = ImagingStudy;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property accession as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "accession", XMLPROJECTION = "ELEMENT");
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).
Property methods: accessionGet(), accessionGetSwizzled(), accessionIsValid(), accessionNewObject(), accessionSet()
property availability as HS.FHIR.vSTU3.Model.Base.InstanceAvailability (XMLNAME = "availability", XMLPROJECTION = "ELEMENT");
Availability of study (online, offline, or nearline).
Property methods: availabilityGet(), availabilityGetSwizzled(), availabilityIsValid(), availabilityNewObject(), availabilitySet()
property basedOn as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
A list of the diagnostic requests that resulted in this imaging study being performed.
Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property context as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
The encounter or episode at which the request is initiated.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
Institution-generated description or classification of the Study performed.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property endpoint as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "endpoint", XMLPROJECTION = "ELEMENT");
The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.type.
Property methods: endpointBuildValueArray(), endpointCollectionToDisplay(), endpointCollectionToOdbc(), endpointDisplayToCollection(), endpointGet(), endpointGetObject(), endpointGetObjectId(), endpointGetSwizzled(), endpointIsValid(), endpointOdbcToCollection(), endpointSet(), endpointSetObject(), endpointSetObjectId()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Other identifiers for the study.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property interpreter as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "interpreter", XMLPROJECTION = "ELEMENT");
Who read the study and interpreted the images or other content.
Property methods: interpreterBuildValueArray(), interpreterCollectionToDisplay(), interpreterCollectionToOdbc(), interpreterDisplayToCollection(), interpreterGet(), interpreterGetObject(), interpreterGetObjectId(), interpreterGetSwizzled(), interpreterIsValid(), interpreterOdbcToCollection(), interpreterSet(), interpreterSetObject(), interpreterSetObjectId()
property modalityList as list of HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "modalityList", XMLPROJECTION = "ELEMENT");
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).
Property methods: modalityListBuildValueArray(), modalityListCollectionToDisplay(), modalityListCollectionToOdbc(), modalityListDisplayToCollection(), modalityListGet(), modalityListGetObject(), modalityListGetObjectId(), modalityListGetSwizzled(), modalityListIsValid(), modalityListOdbcToCollection(), modalityListSet(), modalityListSetObject(), modalityListSetObjectId()
property numberOfInstances as HS.FHIR.vSTU3.Model.Datatype.UnsignedInt (XMLNAME = "numberOfInstances", XMLPROJECTION = "ELEMENT");
Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present.
Property methods: numberOfInstancesGet(), numberOfInstancesGetSwizzled(), numberOfInstancesIsValid(), numberOfInstancesNewObject(), numberOfInstancesSet()
property numberOfSeries as HS.FHIR.vSTU3.Model.Datatype.UnsignedInt (XMLNAME = "numberOfSeries", XMLPROJECTION = "ELEMENT");
Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
Property methods: numberOfSeriesGet(), numberOfSeriesGetSwizzled(), numberOfSeriesIsValid(), numberOfSeriesNewObject(), numberOfSeriesSet()
property patient as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
The patient imaged in the study.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property procedureCode as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "procedureCode", XMLPROJECTION = "ELEMENT");
The code for the performed procedure type.
Property methods: procedureCodeBuildValueArray(), procedureCodeCollectionToDisplay(), procedureCodeCollectionToOdbc(), procedureCodeDisplayToCollection(), procedureCodeGet(), procedureCodeGetObject(), procedureCodeGetObjectId(), procedureCodeGetSwizzled(), procedureCodeIsValid(), procedureCodeOdbcToCollection(), procedureCodeSet(), procedureCodeSetObject(), procedureCodeSetObjectId()
property procedureReference as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "procedureReference", XMLPROJECTION = "ELEMENT");
A reference to the performed Procedure.
Property methods: procedureReferenceBuildValueArray(), procedureReferenceCollectionToDisplay(), procedureReferenceCollectionToOdbc(), procedureReferenceDisplayToCollection(), procedureReferenceGet(), procedureReferenceGetObject(), procedureReferenceGetObjectId(), procedureReferenceGetSwizzled(), procedureReferenceIsValid(), procedureReferenceOdbcToCollection(), procedureReferenceSet(), procedureReferenceSetObject(), procedureReferenceSetObjectId()
property reason as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
Description of clinical condition indicating why the ImagingStudy was requested.
Property methods: reasonGet(), reasonGetSwizzled(), reasonIsValid(), reasonNewObject(), reasonSet()
property referrer as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "referrer", XMLPROJECTION = "ELEMENT");
The requesting/referring physician.
Property methods: referrerGet(), referrerGetSwizzled(), referrerIsValid(), referrerNewObject(), referrerSet()
property series as list of HS.FHIR.vSTU3.Model.Resource.ImagingStudy.Series (XMLNAME = "series", XMLPROJECTION = "ELEMENT");
Each study has one or more series of images or other content.
Property methods: seriesBuildValueArray(), seriesCollectionToDisplay(), seriesCollectionToOdbc(), seriesDisplayToCollection(), seriesGet(), seriesGetObject(), seriesGetObjectId(), seriesGetSwizzled(), seriesIsValid(), seriesOdbcToCollection(), seriesSet(), seriesSetObject(), seriesSetObjectId()
property started as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "started", XMLPROJECTION = "ELEMENT");
Date and time the study started.
Property methods: startedGet(), startedGetSwizzled(), startedIsValid(), startedNewObject(), startedSet()
property uid as HS.FHIR.vSTU3.Model.Datatype.Oid (XMLNAME = "uid", XMLPROJECTION = "ELEMENT") [ Required ];
Formal identifier for the study.
Property methods: uidGet(), uidGetSwizzled(), uidIsValid(), uidNewObject(), uidSet()

Methods

deprecated method SetAccession(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "accession" property.
deprecated method SetAvailability(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "availability" property.
deprecated method SetBasedOn(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "basedOn" property.
deprecated method SetContext(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "context" property.
deprecated method SetDescription(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "description" property.
deprecated method SetEndpoint(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "endpoint" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetInterpreter(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "interpreter" property.
deprecated method SetModalityList(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "modalityList" property.
deprecated method SetNumberOfInstances(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "numberOfInstances" property.
deprecated method SetNumberOfSeries(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "numberOfSeries" property.
deprecated method SetPatient(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "patient" property.
deprecated method SetProcedureCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "procedureCode" property.
deprecated method SetProcedureReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "procedureReference" property.
deprecated method SetReason(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "reason" property.
deprecated method SetReferrer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "referrer" property.
deprecated method SetStarted(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "started" property.
deprecated method SetUid(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "uid" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab