DicomInstance | Medplum

Definition of a DICOM instance

A DICOM instance represents a single DICOM image and related metadata that are part of a DICOM series.

Elements

Name Required Type Description
sopClassUid id SOP Class UID
Details
The SOP Class UID of the DICOM instance.
sopInstanceUid id SOP Instance UID
Details
The SOP Instance UID of the DICOM instance.
instanceAvailability code Instance Availability
Details
The availability of the DICOM instance.
timezoneOffsetFromUtc string Timezone Offset From UTC
Details
The timezone offset from UTC for the study (e.g., -0700).
instanceNumber string Instance Number
Details
The number of the instance in the study.
rows unsignedInt Rows
Details
The number of rows in the image.
columns unsignedInt Columns
Details
The number of columns in the image.
bitsAllocated unsignedInt Bits Allocated
Details
The number of bits allocated for each pixel.
numberOfFrames string Number of Frames
Details
The number of frames in the image.

Search Parameters

Name Type Description Expression
sop-class-uid string The SOP Class UID of the DICOM instance DicomInstance.sopClassUid
sop-instance-uid string The SOP Instance UID of the DICOM instance DicomInstance.sopInstanceUid
instance-number string The instance number of the DICOM instance DicomInstance.instanceNumber

Inherited Elements

Name Required Type Description
id string Logical id of this artifact
Details
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta Meta Details
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.
implicitRules uri Details
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.
language code Details
The base language in which the resource is written.
text Narrative Text summary of the resource, for human interpretation
Details
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.
contained Resource[] Details
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.
extension Extension[] Additional content defined by implementations
Details
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.
modifierExtension Extension[] Extensions that cannot be ignored
Details
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).