Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.ImagingStudy

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

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

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 basedOn as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

Request fulfilled.

CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Institution-generated description.

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

Encounter with which this imaging study is associated.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property endpoint as list of HS.FHIR.DTL.vR4.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.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Identifiers for the whole study.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property interpreter as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "interpreter", XMLPROJECTION = "ELEMENT");
Reference

Who interpreted images.

Practitioner | PractitionerRole

Property methods: interpreterBuildValueArray(), interpreterCollectionToDisplay(), interpreterCollectionToOdbc(), interpreterDisplayToCollection(), interpreterGet(), interpreterGetObject(), interpreterGetObjectId(), interpreterGetSwizzled(), interpreterIsValid(), interpreterOdbcToCollection(), interpreterSet(), interpreterSetObject(), interpreterSetObjectId()
property location as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
Reference

Where ImagingStudy occurred.

Location

Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property modality as list of HS.FHIR.DTL.vR4.Model.Datatype.Coding (XMLNAME = "modality", XMLPROJECTION = "ELEMENT");
Coding

All series modality if actual acquisition modalities.

sect_CID_29.html is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in sect_CID_29.html, you may formally EXTEND sect_CID_29.html to add codes to it.

Property methods: modalityBuildValueArray(), modalityCollectionToDisplay(), modalityCollectionToOdbc(), modalityDisplayToCollection(), modalityGet(), modalityGetObject(), modalityGetObjectId(), modalityGetSwizzled(), modalityIsValid(), modalityOdbcToCollection(), modalitySet(), modalitySetObject(), modalitySetObjectId()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

User-defined comments.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
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 procedureCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "procedureCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

The performed procedure code.

RadLex_Playbook.aspx is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in RadLex_Playbook.aspx, you may formally EXTEND RadLex_Playbook.aspx to add codes to it.

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

The performed Procedure reference.

Procedure

Property methods: procedureReferenceGet(), procedureReferenceGetSwizzled(), procedureReferenceIsValid(), procedureReferenceNewObject(), procedureReferenceSet()
property reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why the study was requested.

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

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Why was study performed.

Condition | Observation | Media | DiagnosticReport | DocumentReference

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property referrer as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "referrer", XMLPROJECTION = "ELEMENT");
Reference

Referring physician.

Practitioner | PractitionerRole

Property methods: referrerGet(), referrerGetSwizzled(), referrerIsValid(), referrerNewObject(), referrerSet()
property series as list of HS.FHIR.DTL.vR4.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 status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

registered | available | cancelled | entered-in-error | unknown

imagingstudy-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend imagingstudy-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Who or what is the subject of the study.

Patient | Device | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab