Skip to main content


class HS.FHIR.DTL.vDSTU2.Model.Resource.ImagingStudy extends HS.FHIR.DTL.vDSTU2.Model.Base.DomainResource

A set of images produced in single study (one or more series of references images)

Property Inventory


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.
parameter XMLTYPE = ImagingStudy;
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.


property accession as HS.FHIR.DTL.vDSTU2.Model.Datatype.Identifier (XMLNAME = "accession", XMLPROJECTION = "ELEMENT");

Related workflow identifier ("Accession Number")

Property methods: accessionGet(), accessionGetSwizzled(), accessionIsValid(), accessionNewObject(), accessionSet()
property availability as %String (MAXLEN = 1000000, XMLNAME = "availability", XMLPROJECTION = "ATTRIBUTE");


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 description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");

Institution-generated description.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property identifier as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.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 HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "interpreter", XMLPROJECTION = "ELEMENT");

Who interpreted images.


Property methods: interpreterGet(), interpreterGetSwizzled(), interpreterIsValid(), interpreterNewObject(), interpreterSet()
property modalityList as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.Coding (XMLNAME = "modalityList", XMLPROJECTION = "ELEMENT");

All series modality if actual acquisition modalities.

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: modalityListBuildValueArray(), modalityListCollectionToDisplay(), modalityListCollectionToOdbc(), modalityListDisplayToCollection(), modalityListGet(), modalityListGetObject(), modalityListGetObjectId(), modalityListGetSwizzled(), modalityListIsValid(), modalityListOdbcToCollection(), modalityListSet(), modalityListSetObject(), modalityListSetObjectId()
property numberOfInstances as %Integer (XMLNAME = "numberOfInstances", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Number of Study Related Instances.

Property methods: numberOfInstancesDisplayToLogical(), numberOfInstancesGet(), numberOfInstancesIsValid(), numberOfInstancesLogicalToDisplay(), numberOfInstancesNormalize(), numberOfInstancesSet(), numberOfInstancesXSDToLogical()
property numberOfSeries as %Integer (XMLNAME = "numberOfSeries", XMLPROJECTION = "ATTRIBUTE") [ Required ];

Number of Study Related Series.

Property methods: numberOfSeriesDisplayToLogical(), numberOfSeriesGet(), numberOfSeriesIsValid(), numberOfSeriesLogicalToDisplay(), numberOfSeriesNormalize(), numberOfSeriesSet(), numberOfSeriesXSDToLogical()
property order as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "order", XMLPROJECTION = "ELEMENT");

Order(s) that caused this study to be performed.


Property methods: orderBuildValueArray(), orderCollectionToDisplay(), orderCollectionToOdbc(), orderDisplayToCollection(), orderGet(), orderGetObject(), orderGetObjectId(), orderGetSwizzled(), orderIsValid(), orderOdbcToCollection(), orderSet(), orderSetObject(), orderSetObjectId()
property patient as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];

Who the images are of.


Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property procedure as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "procedure", XMLPROJECTION = "ELEMENT");

Type of procedure performed.


Property methods: procedureBuildValueArray(), procedureCollectionToDisplay(), procedureCollectionToOdbc(), procedureDisplayToCollection(), procedureGet(), procedureGetObject(), procedureGetObjectId(), procedureGetSwizzled(), procedureIsValid(), procedureOdbcToCollection(), procedureSet(), procedureSetObject(), procedureSetObjectId()
property referrer as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "referrer", XMLPROJECTION = "ELEMENT");

Referring physician (0008,0090)


Property methods: referrerGet(), referrerGetSwizzled(), referrerIsValid(), referrerNewObject(), referrerSet()
property series as list of HS.FHIR.DTL.vDSTU2.Model.Element.ImagingStudy.series (XMLNAME = "series", XMLPROJECTION = "ELEMENT");

Each study has one or more series of instances.

Property methods: seriesBuildValueArray(), seriesCollectionToDisplay(), seriesCollectionToOdbc(), seriesDisplayToCollection(), seriesGet(), seriesGetObject(), seriesGetObjectId(), seriesGetSwizzled(), seriesIsValid(), seriesOdbcToCollection(), seriesSet(), seriesSetObject(), seriesSetObjectId()
property started as %String (MAXLEN = 1000000, XMLNAME = "started", XMLPROJECTION = "ATTRIBUTE");

When the study was started.

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

Formal identifier for the study.

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

Retrieve URI.

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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab