Skip to main content

HS.FHIRModel.R4.ImagingStudy

class HS.FHIRModel.R4.ImagingStudy extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ImagingStudy generated class schema
*****************************************
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 XMLTYPE = R4_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 _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _numberOfInstances as HS.FHIRModel.R4.Element;
Extensions for numberOfInstances
Property methods: _numberOfInstancesGet(), _numberOfInstancesGetSwizzled(), _numberOfInstancesIsValid(), _numberOfInstancesNewObject(), _numberOfInstancesSet()
property _numberOfSeries as HS.FHIRModel.R4.Element;
Extensions for numberOfSeries
Property methods: _numberOfSeriesGet(), _numberOfSeriesGetSwizzled(), _numberOfSeriesIsValid(), _numberOfSeriesNewObject(), _numberOfSeriesSet()
property _started as HS.FHIRModel.R4.Element;
Extensions for started
Property methods: _startedGet(), _startedGetSwizzled(), _startedIsValid(), _startedNewObject(), _startedSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
A list of the diagnostic requests that resulted in this imaging study being performed.
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property description as %String;
The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property encounter as HS.FHIRModel.R4.Reference;
The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property endpoint as HS.FHIRModel.R4.SeqOfReference;
The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType.
Property methods: endpointGet(), endpointGetSwizzled(), endpointIsValid(), endpointNewObject(), endpointSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property interpreter as HS.FHIRModel.R4.SeqOfReference;
Who read the study and interpreted the images or other content.
Property methods: interpreterGet(), interpreterGetSwizzled(), interpreterIsValid(), interpreterNewObject(), interpreterSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property location as HS.FHIRModel.R4.Reference;
The principal physical location where the ImagingStudy was performed.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modality as HS.FHIRModel.R4.SeqOfCoding;
A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
Property methods: modalityGet(), modalityGetSwizzled(), modalityIsValid(), modalityNewObject(), modalitySet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property numberOfInstances as %Integer;
Number of SOP Instances in Study. This 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: numberOfInstancesDisplayToLogical(), numberOfInstancesGet(), numberOfInstancesIsValid(), numberOfInstancesLogicalToDisplay(), numberOfInstancesNormalize(), numberOfInstancesSet(), numberOfInstancesXSDToLogical()
property numberOfSeries as %Integer;
Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present.
Property methods: numberOfSeriesDisplayToLogical(), numberOfSeriesGet(), numberOfSeriesIsValid(), numberOfSeriesLogicalToDisplay(), numberOfSeriesNormalize(), numberOfSeriesSet(), numberOfSeriesXSDToLogical()
property procedureCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
The code for the performed procedure type.
Property methods: procedureCodeGet(), procedureCodeGetSwizzled(), procedureCodeIsValid(), procedureCodeNewObject(), procedureCodeSet()
property procedureReference as HS.FHIRModel.R4.Reference;
The procedure which this ImagingStudy was part of.
Property methods: procedureReferenceGet(), procedureReferenceGetSwizzled(), procedureReferenceIsValid(), procedureReferenceNewObject(), procedureReferenceSet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
Description of clinical condition indicating why the ImagingStudy was requested.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
Indicates another resource whose existence justifies this Study.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property referrer as HS.FHIRModel.R4.Reference;
The requesting/referring physician.
Property methods: referrerGet(), referrerGetSwizzled(), referrerIsValid(), referrerNewObject(), referrerSet()
property resourceType as %String [ InitialExpression = "ImagingStudy" , Required ];
This is a ImagingStudy resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
Each study has one or more series of images or other content.
Property methods: seriesGet(), seriesGetSwizzled(), seriesIsValid(), seriesNewObject(), seriesSet()
property started as %String;
Date and time the study started.
Property methods: startedDisplayToLogical(), startedGet(), startedIsValid(), startedLogicalToDisplay(), startedLogicalToOdbc(), startedNormalize(), startedSet()
property status as %String (VALUELIST = ",registered,available,cancelled,entered-in-error,unknown");
The current state of the ImagingStudy.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIRModel.R4.Reference [ Required ];
The subject, typically a patient, of the imaging study.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeBasedOn()
method IncludeContained()
method IncludeEncounter()
method IncludeEndpoint()
method IncludeExtension()
method IncludeIdentifier()
method IncludeInterpreter()
method IncludeLocation()
method IncludeMeta()
method IncludeModality()
method IncludeModifierExtension()
method IncludeNote()
method IncludeProcedureCode()
method IncludeProcedureReference()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeReferrer()
method IncludeSeries()
method IncludeSubject()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab