Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Element.ImagingStudy.series

class HS.FHIR.DTL.vDSTU2.Model.Element.ImagingStudy.series extends HS.FHIR.DTL.vDSTU2.Model.Base.BackboneElement

Each study has one or more series of instances.

Property 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.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 XMLPROJECTION = ELEMENT;
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 %String (MAXLEN = 1000000, XMLNAME = "availability", XMLPROJECTION = "ATTRIBUTE");
code

ONLINE | OFFLINE | NEARLINE | UNAVAILABLE

instance-availability is the REQUIRED FHIR2 ValueSet for codes; you may NOT extend instance-availability and you may NOT use codes from other ValueSets.

Property methods: availabilityDisplayToLogical(), availabilityGet(), availabilityIsValid(), availabilityLogicalToDisplay(), availabilityLogicalToOdbc(), availabilityNormalize(), availabilitySet()
property bodySite as HS.FHIR.DTL.vDSTU2.Model.Datatype.Coding (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");
Coding

Body part examined.

any FHIR2 code may be used; body-site shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

A description of the series.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property instance as list of HS.FHIR.DTL.vDSTU2.Model.Element.ImagingStudy.series.instance (XMLNAME = "instance", XMLPROJECTION = "ELEMENT");
BackboneElement

A single SOP instance from the series.

Property methods: instanceBuildValueArray(), instanceCollectionToDisplay(), instanceCollectionToOdbc(), instanceDisplayToCollection(), instanceGet(), instanceGetObject(), instanceGetObjectId(), instanceGetSwizzled(), instanceIsValid(), instanceOdbcToCollection(), instanceSet(), instanceSetObject(), instanceSetObjectId()
property laterality as HS.FHIR.DTL.vDSTU2.Model.Datatype.Coding (XMLNAME = "laterality", XMLPROJECTION = "ELEMENT");
Coding

Body part laterality.

any FHIR2 code may be used; bodysite-laterality shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: lateralityGet(), lateralityGetSwizzled(), lateralityIsValid(), lateralityNewObject(), lateralitySet()
property modality as HS.FHIR.DTL.vDSTU2.Model.Datatype.Coding (XMLNAME = "modality", XMLPROJECTION = "ELEMENT") [ Required ];
Coding

The modality of the instances in the series.

dicom-cid29 is the REQUIRED FHIR2 ValueSet for codes, but if you need to express meanings not found in dicom-cid29, you may formally EXTEND dicom-cid29 to add codes to it.

Property methods: modalityGet(), modalityGetSwizzled(), modalityIsValid(), modalityNewObject(), modalitySet()
property number as %Integer (XMLNAME = "number", XMLPROJECTION = "ATTRIBUTE");
unsignedInt

Numeric identifier of this series.

Property methods: numberDisplayToLogical(), numberGet(), numberIsValid(), numberLogicalToDisplay(), numberNormalize(), numberOfInstancesDisplayToLogical(), numberOfInstancesGet(), numberOfInstancesIsValid(), numberOfInstancesLogicalToDisplay(), numberOfInstancesNormalize(), numberOfInstancesSet(), numberOfInstancesXSDToLogical(), numberSet(), numberXSDToLogical()
property numberOfInstances as %Integer (XMLNAME = "numberOfInstances", XMLPROJECTION = "ATTRIBUTE") [ Required ];
unsignedInt

Number of Series Related Instances.

Property methods: numberOfInstancesDisplayToLogical(), numberOfInstancesGet(), numberOfInstancesIsValid(), numberOfInstancesLogicalToDisplay(), numberOfInstancesNormalize(), numberOfInstancesSet(), numberOfInstancesXSDToLogical()
property started as %String (MAXLEN = 1000000, XMLNAME = "started", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the series started.

Property methods: startedDisplayToLogical(), startedGet(), startedIsValid(), startedLogicalToDisplay(), startedLogicalToOdbc(), startedNormalize(), startedSet()
property uid as %String (MAXLEN = 1000000, XMLNAME = "uid", XMLPROJECTION = "ATTRIBUTE") [ Required ];
oid

Formal identifier for this series.

Property methods: uidDisplayToLogical(), uidGet(), uidIsValid(), uidLogicalToDisplay(), uidLogicalToOdbc(), uidNormalize(), uidSet()
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri

Location of the referenced instance(s)

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab