Skip to main content

HS.FHIR.vDSTU2.Model.Resource.ImagingStudy.Series

deprecated class HS.FHIR.vDSTU2.Model.Resource.ImagingStudy.Series extends HS.FHIR.vDSTU2.Model.Base.BackboneElement

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.

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 JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = ImagingStudy.Series;
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.
parameter XMLTYPE = ImagingStudy.Series;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property availability as HS.FHIR.vDSTU2.Model.Base.InstanceAvailability (XMLNAME = "availability");
Availability of series (online, offline or nearline).
Property methods: availabilityGet(), availabilityGetSwizzled(), availabilityIsValid(), availabilityNewObject(), availabilitySet()
property bodySite as HS.FHIR.vDSTU2.Model.Base.Coding (XMLNAME = "bodySite");
Body part examined. See DICOM Part 16 Annex L for the mapping from DICOM to Snomed CT.
Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property description as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "description");
A description of the series.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property instance as list of HS.FHIR.vDSTU2.Model.Resource.ImagingStudy.Instance (XMLNAME = "instance", XMLPROJECTION = "ELEMENT");
A single SOP Instance within the series, e.g. an image, or presentation state.
Property methods: instanceBuildValueArray(), instanceCollectionToDisplay(), instanceCollectionToOdbc(), instanceDisplayToCollection(), instanceGet(), instanceGetObject(), instanceGetObjectId(), instanceGetSwizzled(), instanceIsValid(), instanceOdbcToCollection(), instanceSet(), instanceSetObject(), instanceSetObjectId()
property laterality as HS.FHIR.vDSTU2.Model.Base.Coding (XMLNAME = "laterality");
Laterality if body site is paired anatomic structure and laterality is not pre-coordinated in body site code.
Property methods: lateralityGet(), lateralityGetSwizzled(), lateralityIsValid(), lateralityNewObject(), lateralitySet()
property modality as HS.FHIR.vDSTU2.Model.Base.Coding (XMLNAME = "modality") [ Required ];
The modality of this series sequence.
Property methods: modalityGet(), modalityGetSwizzled(), modalityIsValid(), modalityNewObject(), modalitySet()
property number as HS.FHIR.vDSTU2.Model.Datatype.UnsignedInt (XMLNAME = "number");
The Numeric identifier of this series in the study.
Property methods: numberGet(), numberGetSwizzled(), numberIsValid(), numberNewObject(), numberSet()
property numberOfInstances as HS.FHIR.vDSTU2.Model.Datatype.UnsignedInt (XMLNAME = "numberOfInstances") [ Required ];
Number of SOP Instances in Series.
Property methods: numberOfInstancesGet(), numberOfInstancesGetSwizzled(), numberOfInstancesIsValid(), numberOfInstancesNewObject(), numberOfInstancesSet()
property started as HS.FHIR.vDSTU2.Model.Datatype.DateTime (XMLNAME = "started");
The date and time the series was started.
Property methods: startedGet(), startedGetSwizzled(), startedIsValid(), startedNewObject(), startedSet()
property uid as HS.FHIR.vDSTU2.Model.Datatype.Oid (XMLNAME = "uid") [ Required ];
Formal identifier for this series.
Property methods: uidGet(), uidGetSwizzled(), uidIsValid(), uidNewObject(), uidSet()
property url as HS.FHIR.vDSTU2.Model.Datatype.Uri (XMLNAME = "url");
URI/URL specifying the location of the referenced series using WADO-RS.
Property methods: urlGet(), urlGetSwizzled(), urlIsValid(), urlNewObject(), urlSet()

Methods

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 SetBodySite(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.
Set method for the "bodySite" 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 SetLaterality(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.
Set method for the "laterality" property.
deprecated method SetModality(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.
Set method for the "modality" property.
deprecated method SetNumber(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 "number" 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 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.
deprecated method SetUrl(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 "url" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab