Data Model Libraries
    Preparing search index...

    Class ImagingSelection

    ImagingSelection Class

    A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.

    FHIR Specification

    • Short: A selection of DICOM SOP instances and/or frames
    • Definition: A selection of DICOM SOP instances and/or frames within a single Study and Series. This might include additional specifics such as an image region, an Observation UID or a Segmentation Number, allowing linkage to an Observation Resource or transferring this information along with the ImagingStudy Resource.
    • FHIR Version: 5.0.0

    FHIR ImagingSelection

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? imagingselectionStatusEnum status subject? issued? performer? basedOn? category? code studyUid? derivedFrom? endpoint? seriesUid? seriesNumber? frameOfReferenceUid? bodySite? focus? instance_?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getSubject setSubject hasSubject getIssuedElement setIssuedElement hasIssuedElement getIssued setIssued hasIssued getPerformer setPerformer addPerformer hasPerformer getBasedOn setBasedOn addBasedOn hasBasedOn getCategory setCategory addCategory hasCategory getCode setCode hasCode getStudyUidElement setStudyUidElement hasStudyUidElement getStudyUid setStudyUid hasStudyUid getDerivedFrom setDerivedFrom addDerivedFrom hasDerivedFrom getEndpoint setEndpoint addEndpoint hasEndpoint getSeriesUidElement setSeriesUidElement hasSeriesUidElement getSeriesUid setSeriesUid hasSeriesUid getSeriesNumberElement setSeriesNumberElement hasSeriesNumberElement getSeriesNumber setSeriesNumber hasSeriesNumber getFrameOfReferenceUidElement setFrameOfReferenceUidElement hasFrameOfReferenceUidElement getFrameOfReferenceUid setFrameOfReferenceUid hasFrameOfReferenceUid getBodySite setBodySite hasBodySite getFocus setFocus addFocus hasFocus getInstance setInstance addInstance hasInstance fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initPerformer initBasedOn initCategory initDerivedFrom initEndpoint initFocus initInstance

    Constructors

    Properties

    identifier?: Identifier[]

    ImagingSelection.identifier Element

    FHIR Specification

    • Short: Business Identifier for Imaging Selection
    • Definition: A unique identifier assigned to this imaging selection.
    • Comment: This is a business identifier, not a resource identifier -- see discussion under Business Identifiers.
    • Requirements: Allows imaging selections to be distinguished and referenced.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    imagingselectionStatusEnum: ImagingselectionStatusEnum

    FHIR CodeSystem: ImagingselectionStatus

    ImagingselectionStatusEnum

    status: null | EnumCodeType

    ImagingSelection.status Element

    FHIR Specification

    • Short: available | entered-in-error | unknown
    • Definition: The current state of the ImagingSelection resource. This is not the status of any ImagingStudy, ServiceRequest, or Task resources associated with the ImagingSelection.
    • Comment: Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: ImagingselectionStatusEnum

    subject?: Reference

    ImagingSelection.subject Element

    FHIR Specification

    issued?: InstantType

    ImagingSelection.issued Element

    FHIR Specification

    • Short: Date / Time when this imaging selection was created
    • Definition: The date and time this imaging selection was created.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    performer?: ImagingSelectionPerformerComponent[]

    ImagingSelection.performer Element

    FHIR Specification

    • Short: Selector of the instances (human or machine)
    • Definition: Selector of the instances - human or machine.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    ImagingSelection.basedOn Element

    FHIR Specification

    category?: CodeableConcept[]

    ImagingSelection.category Element

    FHIR Specification

    • Short: Classifies the imaging selection
    • Definition: Classifies the imaging selection.
    • Requirements: Used for filtering what imaging selections are retrieved and displayed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    code: null | CodeableConcept

    ImagingSelection.code Element

    FHIR Specification

    • Short: Imaging Selection purpose text or code
    • Definition: Reason for referencing the selected content.
    • Comment: All code-value and, if present, component.code-component.value pairs need to be taken into account to correctly understand the meaning of the observation.
    • Requirements: Knowing what kind of observation is being made is essential to understanding the observation.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    studyUid?: IdType

    ImagingSelection.studyUid Element

    FHIR Specification

    • Short: DICOM Study Instance UID
    • Definition: The Study Instance UID for the DICOM Study from which the images were selected.
    • Comment: See DICOM PS3.3 C.7.2.
    • Requirements: DICOM Study Instance UID. Required unless frameOfReferenceUid and imageRegion are present and instance is not present.
    • FHIR Type: id
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    derivedFrom?: Reference[]

    ImagingSelection.derivedFrom Element

    FHIR Specification

    endpoint?: Reference[]

    ImagingSelection.endpoint Element

    FHIR Specification

    • Short: The network service providing retrieval for the images referenced in the imaging selection
    • Definition: The network service providing retrieval access to the selected images, frames, etc. See implementation notes for information about using DICOM endpoints.
    • Comment: Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG) formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach.
    • Requirements: Access methods for retrieving (e.g., DICOM's WADO-URI and WADO-RS) the selected images, frames, etc.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    seriesUid?: IdType

    ImagingSelection.seriesUid Element

    FHIR Specification

    • Short: DICOM Series Instance UID
    • Definition: The Series Instance UID for the DICOM Series from which the images were selected.
    • Comment: See DICOM PS3.3 C.7.3.
    • Requirements: DICOM Series Instance UID. Required unless frameOfReferenceUid and imageRegion are present and instance is not present.
    • FHIR Type: id
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    seriesNumber?: UnsignedIntType

    ImagingSelection.seriesNumber Element

    FHIR Specification

    • Short: DICOM Series Number
    • Definition: The Series Number for the DICOM Series from which the images were selected.
    • Comment: See DICOM PS3.3 C.7.3.
    • Requirements: DICOM Series Number.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    frameOfReferenceUid?: IdType

    ImagingSelection.frameOfReferenceUid Element

    FHIR Specification

    • Short: The Frame of Reference UID for the selected images
    • Definition: The Frame of Reference UID identifying the coordinate system that conveys spatial and/or temporal information for the selected images or frames.
    • Comment: See DICOM PS3.3 C.7.4.1.
    • Requirements: DICOM Frame of Reference UID. Required if studyInstanceUid and seriesInstanceUid are not present.
    • FHIR Type: id
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    bodySite?: CodeableReference

    ImagingSelection.bodySite Element

    FHIR Specification

    focus?: Reference[]

    ImagingSelection.focus Element

    FHIR Specification

    • Short: Related resource that is the focus for the imaging selection
    • Definition: The actual focus of an observation when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, fetus, or donor. For example, fetus observations in a mother's record. The focus of an observation could also be an existing condition, an intervention, the subject's diet, another observation of the subject, or a body structure such as tumor or implanted device. An example use case would be using the Observation resource to capture whether the mother is trained to change her child's tracheostomy tube. In this example, the child is the patient of record and the mother is the focus.
    • Comment: An imaging selection may reference a DICOM resource that itself references other DICOM resources. e.g. a presentation state references a set of source images or frames.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Private Optionalinstance_

    instance_?: ImagingSelectionInstanceComponent[]

    ImagingSelection.instance Element

    FHIR Specification

    • Short: The selected instances
    • Definition: Each imaging selection includes one or more selected DICOM SOP instances.
    • Requirements: Required if the the selection does not include all instances in the specified series.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided ImagingSelection JSON to instantiate the ImagingSelection data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImagingSelection

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ImagingSelection

      Returns undefined | ImagingSelection

      ImagingSelection data model or undefined for ImagingSelection

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Subject object value to the subject property.

      Parameters

      • value: undefined | Reference

        the subject object value

      Returns this

      this

      @ReferenceTargets('ImagingSelection.subject', ['Patient','Group','Device','Location','Organization','Procedure','Practitioner','Medication','Substance','Specimen',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetSubjectsetSubjecthasSubjectgetIssuedElementsetIssuedElementhasIssuedElementgetIssuedsetIssuedhasIssuedgetPerformersetPerformeraddPerformerhasPerformergetBasedOnsetBasedOnaddBasedOnhasBasedOngetCategorysetCategoryaddCategoryhasCategorygetCodesetCodehasCodegetStudyUidElementsetStudyUidElementhasStudyUidElementgetStudyUidsetStudyUidhasStudyUidgetDerivedFromsetDerivedFromaddDerivedFromhasDerivedFromgetEndpointsetEndpointaddEndpointhasEndpointgetSeriesUidElementsetSeriesUidElementhasSeriesUidElementgetSeriesUidsetSeriesUidhasSeriesUidgetSeriesNumberElementsetSeriesNumberElementhasSeriesNumberElementgetSeriesNumbersetSeriesNumberhasSeriesNumbergetFrameOfReferenceUidElementsetFrameOfReferenceUidElementhasFrameOfReferenceUidElementgetFrameOfReferenceUidsetFrameOfReferenceUidhasFrameOfReferenceUidgetBodySitesetBodySitehasBodySitegetFocussetFocusaddFocushasFocusgetInstancesetInstanceaddInstancehasInstancefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitPerformerinitBasedOninitCategoryinitDerivedFrominitEndpointinitFocusinitInstance