Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.ImagingStudy

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

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

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 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;
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 accession as HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "accession", XMLPROJECTION = "ELEMENT");
Identifier

Related workflow identifier ("Accession Number")

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

ONLINE | OFFLINE | NEARLINE | UNAVAILABLE

instance-availability is the REQUIRED FHIR3 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 basedOn as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

Request fulfilled.

ReferralRequest | CarePlan | ProcedureRequest

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property context as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
Reference

Originating context.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Institution-generated description.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property endpoint as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "endpoint", XMLPROJECTION = "ELEMENT");
Reference

Study access endpoint.

Endpoint

Property methods: endpointBuildValueArray(), endpointCollectionToDisplay(), endpointCollectionToOdbc(), endpointDisplayToCollection(), endpointGet(), endpointGetObject(), endpointGetObjectId(), endpointGetSwizzled(), endpointIsValid(), endpointOdbcToCollection(), endpointSet(), endpointSetObject(), endpointSetObjectId()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

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.DTL.vSTU3.Model.Base.Reference (XMLNAME = "interpreter", XMLPROJECTION = "ELEMENT");
Reference

Who interpreted images.

Practitioner

Property methods: interpreterBuildValueArray(), interpreterCollectionToDisplay(), interpreterCollectionToOdbc(), interpreterDisplayToCollection(), interpreterGet(), interpreterGetObject(), interpreterGetObjectId(), interpreterGetSwizzled(), interpreterIsValid(), interpreterOdbcToCollection(), interpreterSet(), interpreterSetObject(), interpreterSetObjectId()
property modalityList as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Coding (XMLNAME = "modalityList", XMLPROJECTION = "ELEMENT");
Coding

All series modality if actual acquisition modalities.

dicom-cid29 is the REQUIRED FHIR3 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");
unsignedInt

Number of Study Related Instances.

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

Number of Study Related Series.

Property methods: numberOfSeriesDisplayToLogical(), numberOfSeriesGet(), numberOfSeriesIsValid(), numberOfSeriesLogicalToDisplay(), numberOfSeriesNormalize(), numberOfSeriesSet(), numberOfSeriesXSDToLogical()
property patient as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Who the images are of.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property procedureCode as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "procedureCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

The performed procedure code.

any FHIR3 code may be used; procedure-code shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: procedureCodeBuildValueArray(), procedureCodeCollectionToDisplay(), procedureCodeCollectionToOdbc(), procedureCodeDisplayToCollection(), procedureCodeGet(), procedureCodeGetObject(), procedureCodeGetObjectId(), procedureCodeGetSwizzled(), procedureCodeIsValid(), procedureCodeOdbcToCollection(), procedureCodeSet(), procedureCodeSetObject(), procedureCodeSetObjectId()
property procedureReference as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "procedureReference", XMLPROJECTION = "ELEMENT");
Reference

The performed Procedure reference.

Procedure

Property methods: procedureReferenceBuildValueArray(), procedureReferenceCollectionToDisplay(), procedureReferenceCollectionToOdbc(), procedureReferenceDisplayToCollection(), procedureReferenceGet(), procedureReferenceGetObject(), procedureReferenceGetObjectId(), procedureReferenceGetSwizzled(), procedureReferenceIsValid(), procedureReferenceOdbcToCollection(), procedureReferenceSet(), procedureReferenceSetObject(), procedureReferenceSetObjectId()
property reason as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why the study was requested.

any FHIR3 code may be used; procedure-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonGet(), reasonGetSwizzled(), reasonIsValid(), reasonNewObject(), reasonSet()
property referrer as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "referrer", XMLPROJECTION = "ELEMENT");
Reference

Referring physician.

Practitioner

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

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");
dateTime

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 ];
oid

Formal DICOM identifier for the study.

Property methods: uidDisplayToLogical(), uidGet(), uidIsValid(), uidLogicalToDisplay(), uidLogicalToOdbc(), uidNormalize(), uidSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab