Data Model Libraries
    Preparing search index...

    ImagingStudySeriesInstanceComponent Class

    FHIR Specification

    • Short: A single SOP instance from the series
    • Definition: A single SOP instance within the series, e.g. an image, or presentation state.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    uid: null | IdType

    ImagingStudy.series.instance.uid Element

    FHIR Specification

    • Short: DICOM SOP Instance UID
    • Definition: The DICOM SOP Instance UID for this image or other DICOM content.
    • Comment: See DICOM PS3.3 C.12.1.
    • Requirements: DICOM SOP Instance UID.
    • FHIR Type: id
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    sopClass: null | Coding

    ImagingStudy.series.instance.sopClass Element

    FHIR Specification

    • Short: DICOM class type
    • Definition: DICOM instance type.
    • FHIR Type: Coding
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    ImagingStudy.series.instance.number Element

    FHIR Specification

    • Short: The number of this instance in the series
    • Definition: The number of instance in the series.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    title?: StringType

    ImagingStudy.series.instance.title Element

    FHIR Specification

    • Short: Description of instance
    • Definition: The description of the instance.
    • Comment: Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImagingStudySeriesInstanceComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ImagingStudySeriesInstanceComponent

      ImagingStudySeriesInstanceComponent data model or undefined for ImagingStudySeriesInstanceComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 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

    • Returns boolean

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