Skip to main content

HS.FHIR.vSTU3.Model.Resource.ImagingStudy.Series

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

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.

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.vSTU3.Model.Base.InstanceAvailability (XMLNAME = "availability", XMLPROJECTION = "ELEMENT");
Availability of series (online, offline or nearline).
Property methods: availabilityGet(), availabilityGetSwizzled(), availabilityIsValid(), availabilityNewObject(), availabilitySet()
property bodySite as HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");
The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.
Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
A description of the series.
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 this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.type.
Property methods: endpointBuildValueArray(), endpointCollectionToDisplay(), endpointCollectionToOdbc(), endpointDisplayToCollection(), endpointGet(), endpointGetObject(), endpointGetObjectId(), endpointGetSwizzled(), endpointIsValid(), endpointOdbcToCollection(), endpointSet(), endpointSetObject(), endpointSetObjectId()
property instance as list of HS.FHIR.vSTU3.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.vSTU3.Model.Base.Coding (XMLNAME = "laterality", XMLPROJECTION = "ELEMENT");
The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.
Property methods: lateralityGet(), lateralityGetSwizzled(), lateralityIsValid(), lateralityNewObject(), lateralitySet()
property modality as HS.FHIR.vSTU3.Model.Base.Coding (XMLNAME = "modality", XMLPROJECTION = "ELEMENT") [ Required ];
The modality of this series sequence.
Property methods: modalityGet(), modalityGetSwizzled(), modalityIsValid(), modalityNewObject(), modalitySet()
property number as HS.FHIR.vSTU3.Model.Datatype.UnsignedInt (XMLNAME = "number", XMLPROJECTION = "ELEMENT");
The numeric identifier of this series in the study.
Property methods: numberGet(), numberGetSwizzled(), numberIsValid(), numberNewObject(), numberOfInstancesGet(), numberOfInstancesGetSwizzled(), numberOfInstancesIsValid(), numberOfInstancesNewObject(), numberOfInstancesSet(), numberSet()
property numberOfInstances as HS.FHIR.vSTU3.Model.Datatype.UnsignedInt (XMLNAME = "numberOfInstances", XMLPROJECTION = "ELEMENT");
Number of SOP Instances in the Study. The 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 performer as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
The physician or operator (often the radiology technician) who performed the series. The performer is recorded at the series level, since each series in a study may be performed by a different practitioner, at different times, and using different devices. A series may be performed by multiple practitioners.
Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property started as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "started", XMLPROJECTION = "ELEMENT");
The date and time the series was 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 this series.
Property methods: uidGet(), uidGetSwizzled(), uidIsValid(), uidNewObject(), uidSet()

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 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 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 SetPerformer(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 "performer" 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