Skip to main content

HS.FHIRModel.R4.ImagingStudyX.Series

class HS.FHIRModel.R4.ImagingStudyX.Series extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ImagingStudyX.Series 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_IMAGINGSTUDYX_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 _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _number as HS.FHIRModel.R4.Element;
Extensions for number
Property methods: _numberGet(), _numberGetSwizzled(), _numberIsValid(), _numberNewObject(), _numberSet()
property _numberOfInstances as HS.FHIRModel.R4.Element;
Extensions for numberOfInstances
Property methods: _numberOfInstancesGet(), _numberOfInstancesGetSwizzled(), _numberOfInstancesIsValid(), _numberOfInstancesNewObject(), _numberOfInstancesSet()
property _started as HS.FHIRModel.R4.Element;
Extensions for started
Property methods: _startedGet(), _startedGetSwizzled(), _startedIsValid(), _startedNewObject(), _startedSet()
property _uid as HS.FHIRModel.R4.Element;
Extensions for uid
Property methods: _uidGet(), _uidGetSwizzled(), _uidIsValid(), _uidNewObject(), _uidSet()
property bodySite as HS.FHIRModel.R4.Coding;
The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality.
Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property description as %String;
A description of the series.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property endpoint as HS.FHIRModel.R4.SeqOfReference;
The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-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 element. 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;
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
A single SOP instance within the series, e.g. an image, or presentation state.
Property methods: instanceGet(), instanceGetSwizzled(), instanceIsValid(), instanceNewObject(), instanceSet()
property laterality as HS.FHIRModel.R4.Coding;
The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite.
Property methods: lateralityGet(), lateralityGetSwizzled(), lateralityIsValid(), lateralityNewObject(), lateralitySet()
property modality as HS.FHIRModel.R4.Coding [ Required ];
The modality of this series sequence.
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 element and that modifies the understanding of the element in which it is contained 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 can 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()
property number as %Integer;
The numeric identifier of this series in the study.
Property methods: numberDisplayToLogical(), numberGet(), numberIsValid(), numberLogicalToDisplay(), numberNormalize(), numberSet(), numberXSDToLogical()
property numberOfInstances as %Integer;
Number of SOP Instances in the Study. The 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()
Indicates who or what performed the series and how they were involved.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property specimen as HS.FHIRModel.R4.SeqOfReference;
The specimen imaged, e.g., for whole slide imaging of a biopsy.
Property methods: specimenGet(), specimenGetSwizzled(), specimenIsValid(), specimenNewObject(), specimenSet()
property started as %String;
The date and time the series was started.
Property methods: startedDisplayToLogical(), startedGet(), startedIsValid(), startedLogicalToDisplay(), startedLogicalToOdbc(), startedNormalize(), startedSet()
property uid as %String;
The DICOM Series Instance UID for the series.
Property methods: uidDisplayToLogical(), uidGet(), uidIsValid(), uidLogicalToDisplay(), uidLogicalToOdbc(), uidNormalize(), uidSet()

Methods

method IncludeBodySite()
method IncludeEndpoint()
method IncludeExtension()
method IncludeInstance()
method IncludeLaterality()
method IncludeModality()
method IncludeModifierExtension()
method IncludePerformer()
method IncludeSpecimen()
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