@medplum/fhirtypes/dist/DicomStudy.d.ts

Medplum FHIR Type Definitions

// SPDX-FileCopyrightText: Copyright Orangebot, Inc. and Medplum contributors
// SPDX-License-Identifier: Apache-2.0
/*
 * This is a generated file
 * Do not edit manually.
 */

import type { Extension } from './Extension.d.ts';
import type { Meta } from './Meta.d.ts';
import type { Narrative } from './Narrative.d.ts';
import type { Resource } from './Resource.d.ts';

/**
 * Definition of a DICOM study, which represents a collection of DICOM
 * images and related metadata.
 */
export interface DicomStudy {

  /**
   * This is a DicomStudy resource
   */
  readonly resourceType: 'DicomStudy';

  /**
   * The logical id of the resource, as used in the URL for the resource.
   * Once assigned, this value never changes.
   */
  id?: string;

  /**
   * 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.
   */
  meta?: Meta;

  /**
   * 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.
   */
  implicitRules?: string;

  /**
   * The base language in which the resource is written.
   */
  language?: string;

  /**
   * 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.
   */
  text?: Narrative;

  /**
   * 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.
   */
  contained?: Resource[];

  /**
   * 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.
   */
  extension?: Extension[];

  /**
   * 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).
   */
  modifierExtension?: Extension[];

  /**
   * Unique identifier for the study.
   */
  studyInstanceUid: string;

  /**
   * User-friendly identifier for the study.
   */
  studyId?: string;

  /**
   * Date the study started.
   */
  studyDate?: string;

  /**
   * Time the study started.
   */
  studyTime?: string;

  /**
   * The accession number for the study.
   */
  accessionNumber?: string;

  /**
   * Availability of the study instances (e.g., ONLINE, OFFLINE).
   */
  instanceAvailability?: string;

  /**
   * The modalities (e.g., CT, MR) that are present in the study.
   */
  modalitiesInStudy?: string[];

  /**
   * The name of the referring physician.
   */
  referringPhysiciansName?: string;

  /**
   * The timezone offset from UTC for the study (e.g., -0700).
   */
  timezoneOffsetFromUtc?: string;

  /**
   * The name of the patient.
   */
  patientName?: string;

  /**
   * The ID of the patient.
   */
  patientId?: string;

  /**
   * The birth date of the patient.
   */
  patientBirthDate?: string;

  /**
   * The sex of the patient.
   */
  patientSex?: string;

  /**
   * The number of series related to the study.
   */
  numberOfStudyRelatedSeries?: number;

  /**
   * The number of instances related to the study.
   */
  numberOfStudyRelatedInstances?: number;
}