Data Model Libraries
    Preparing search index...

    Class ImagingStudy

    ImagingStudy Class

    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.

    FHIR Specification

    • Short: A set of images produced in single study (one or more series of references images)
    • Definition: 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.
    • FHIR Version: 5.0.0

    FHIR ImagingStudy

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? imagingstudyStatusEnum status modality? subject encounter? started? basedOn? partOf? referrer? endpoint? numberOfSeries? numberOfInstances? procedure? location? reason? note? description? series?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getModality setModality addModality hasModality getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getStartedElement setStartedElement hasStartedElement getStarted setStarted hasStarted getBasedOn setBasedOn addBasedOn hasBasedOn getPartOf setPartOf addPartOf hasPartOf getReferrer setReferrer hasReferrer getEndpoint setEndpoint addEndpoint hasEndpoint getNumberOfSeriesElement setNumberOfSeriesElement hasNumberOfSeriesElement getNumberOfSeries setNumberOfSeries hasNumberOfSeries getNumberOfInstancesElement setNumberOfInstancesElement hasNumberOfInstancesElement getNumberOfInstances setNumberOfInstances hasNumberOfInstances getProcedure setProcedure addProcedure hasProcedure getLocation setLocation hasLocation getReason setReason addReason hasReason getNote setNote addNote hasNote getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getSeries setSeries addSeries hasSeries 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 initModality initBasedOn initPartOf initEndpoint initProcedure initReason initNote initSeries

    Constructors

    Properties

    identifier?: Identifier[]

    ImagingStudy.identifier Element

    FHIR Specification

    • Short: Identifiers for the whole study
    • Definition: Identifiers for the ImagingStudy such as DICOM Study Instance UID.
    • Comment: See discussion under Imaging Study Implementation Notes for encoding of DICOM Study Instance UID.
    • Requirements: If one or more series elements are present in the ImagingStudy, then there shall be one DICOM Study UID identifier (see DICOM PS 3.3 C.7.2.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    imagingstudyStatusEnum: ImagingstudyStatusEnum

    FHIR CodeSystem: ImagingstudyStatus

    ImagingstudyStatusEnum

    status: null | EnumCodeType

    ImagingStudy.status Element

    FHIR Specification

    • Short: registered | available | cancelled | entered-in-error | unknown
    • Definition: The current state of the ImagingStudy resource. This is not the status of any ServiceRequest or Task resources associated with the ImagingStudy.
    • 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: ImagingstudyStatusEnum

    modality?: CodeableConcept[]

    ImagingStudy.modality Element

    FHIR Specification

    • Short: All of the distinct values for series' modalities
    • Definition: A list of all the distinct values of series.modality. This may include both acquisition and non-acquisition modalities.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    ImagingStudy.subject Element

    FHIR Specification

    encounter?: Reference

    ImagingStudy.encounter Element

    FHIR Specification

    • Short: Encounter with which this imaging study is associated
    • Definition: The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made.
    • Comment: This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission test).
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    started?: DateTimeType

    ImagingStudy.started Element

    FHIR Specification

    • Short: When the study was started
    • Definition: Date and time the study started.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    ImagingStudy.basedOn Element

    FHIR Specification

    partOf?: Reference[]

    ImagingStudy.partOf Element

    FHIR Specification

    • Short: Part of referenced event
    • Definition: A larger event of which this particular ImagingStudy is a component or step. For example, an ImagingStudy as part of a procedure.
    • Comment: To link an ImagingStudy to an Encounter use encounter.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    referrer?: Reference

    ImagingStudy.referrer Element

    FHIR Specification

    endpoint?: Reference[]

    ImagingStudy.endpoint Element

    FHIR Specification

    • Short: Study access endpoint
    • Definition: 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.
    • 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; DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer.
    • Requirements: Access methods for viewing (e.g., IHE's IID profile) or retrieving (e.g., DICOM's WADO-URI and WADO-RS) the study or the study's series or instances. The study-level baseLocation applies to each series in the study, unless overridden in series by a series-level baseLocation of the same type.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    numberOfSeries?: UnsignedIntType

    ImagingStudy.numberOfSeries Element

    FHIR Specification

    • Short: Number of Study Related Series
    • Definition: 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.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    numberOfInstances?: UnsignedIntType

    ImagingStudy.numberOfInstances Element

    FHIR Specification

    • Short: Number of Study Related Instances
    • Definition: 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.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    procedure?: CodeableReference[]

    ImagingStudy.procedure Element

    FHIR Specification

    location?: Reference

    ImagingStudy.location Element

    FHIR Specification

    • Short: Where ImagingStudy occurred
    • Definition: The principal physical location where the ImagingStudy was performed.
    • Requirements: Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting).
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    reason?: CodeableReference[]

    ImagingStudy.reason Element

    FHIR Specification

    note?: Annotation[]

    ImagingStudy.note Element

    FHIR Specification

    • Short: User-defined comments
    • Definition: 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.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: StringType

    ImagingStudy.description Element

    FHIR Specification

    • Short: Institution-generated description
    • Definition: The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    series?: ImagingStudySeriesComponent[]

    ImagingStudy.series Element

    FHIR Specification

    • Short: Each study has one or more series of instances
    • Definition: Each study has one or more series of images or other content.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ImagingStudy

      • OptionaloptSourceField: string

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

      Returns undefined | ImagingStudy

      ImagingStudy data model or undefined for ImagingStudy

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the basedOn property.

      Parameters

      • value: undefined | Reference[]

        the basedOn array value

      Returns this

      this

      @ReferenceTargets('ImagingStudy.basedOn', ['CarePlan','ServiceRequest','Appointment','AppointmentResponse','Task',])

      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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetModalitysetModalityaddModalityhasModalitygetSubjectsetSubjecthasSubjectgetEncountersetEncounterhasEncountergetStartedElementsetStartedElementhasStartedElementgetStartedsetStartedhasStartedgetBasedOnsetBasedOnaddBasedOnhasBasedOngetPartOfsetPartOfaddPartOfhasPartOfgetReferrersetReferrerhasReferrergetEndpointsetEndpointaddEndpointhasEndpointgetNumberOfSeriesElementsetNumberOfSeriesElementhasNumberOfSeriesElementgetNumberOfSeriessetNumberOfSerieshasNumberOfSeriesgetNumberOfInstancesElementsetNumberOfInstancesElementhasNumberOfInstancesElementgetNumberOfInstancessetNumberOfInstanceshasNumberOfInstancesgetProceduresetProcedureaddProcedurehasProceduregetLocationsetLocationhasLocationgetReasonsetReasonaddReasonhasReasongetNotesetNoteaddNotehasNotegetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetSeriessetSeriesaddSerieshasSeriesfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitModalityinitBasedOninitPartOfinitEndpointinitProcedureinitReasoninitNoteinitSeries