Health eData 1 Sandbox
0.1.0 - CI Build United States of America flag

Health eData 1 Sandbox, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/argonautproject/USCDIV7/ and changes regularly. See the Directory of published versions

Resource Profile: US Core ImagingStudy Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-imagingstudy Version: 0.1.0
Active as of 2026-08-17 Maturity Level: 2 Computable Name: USCoreImagingStudyProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.78

The US Core ImagingStudy Profile inherits from the FHIR ImagingStudy resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Diagnostic Imaging Data Class and its Diagnostic Imaging Reference Data Element. It sets minimum expectations for the ImagingStudy resource to record, search, and fetch the identifiers, endpoints, and contextual information needed to access a diagnostic imaging study. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for the US Core ImagingStudy profile:

  • Query for ImagingStudy resources belonging to a Patient
  • [Record or update] a Patient ImagingStudy

Mandatory and Must Support Data Elements

The following data elements must always be present ([Mandatory] definition) or must be supported if the data is present in the sending system ([Must Support] definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The [Formal Views] below provides the formal summary, definitions, and terminology requirements.

Each ImagingStudy Must Have:

  1. one or more identifiers for the study
  2. a DICOM Study Instance UID
  3. a status
  4. one or more study modalities
  5. a subject (the patient)
  6. one or more study access endpoints (e.g., WADO-RS)
  7. a DICOM Series Instance UID for each series
  8. a modality for each series
  9. a DICOM SOP Instance UID for each instance
  10. a DICOM SOP class for each instance

Each ImagingStudy Must Support:

  1. the number of series in the study
  2. the number of instances in the study
  3. one or more series of instances
  4. a series number
  5. one or more SOP instances in each series
  6. an instance number

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

Liquid Script to Generate StructureDefinition All Nice N Pretty Like

{% include structure-table.md sd=sd source="differential" show_must_support=true show_uscdi=true %}

USCoreImagingStudyProfile — US Core ImagingStudy Profile

The US Core ImagingStudy Profile inherits from the FHIR ImagingStudy resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) Diagnostic Imaging Data Class and its Diagnostic Imaging Reference Data Element. It sets minimum expectations for the ImagingStudy resource to record, search, and fetch the identifiers, endpoints, and contextual information needed to access a diagnostic imaging study. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

  • URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-imagingstudy
  • Version: 0.1.0
  • Status: active
  • Kind: resource
  • Type: ImagingStudy
  • Base Definition: http://hl7.org/fhir/StructureDefinition/ImagingStudy
  • Derivation: constraint

Elements (differential)

Element Must Support Add'l USCDI Cardinality Type Description
ImagingStudy     0..*   A set of images produced in single study (one or more series of references images)
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.
identifier   1..* Identifier Identifiers for the whole study, including the DICOM Study Instance UID
Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
Slicing: discriminator pattern@$this — rules: open
identifier
slice: studyInstanceUID
  1..1 Identifier DICOM Study Instance UID
Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.
Pattern (Identifier): system urn:dicom:uid
status   1..1 code registered | available | cancelled | entered-in-error | unknown
The current state of the ImagingStudy.
Binding: http://hl7.org/fhir/ValueSet/imagingstudy-status (required)
modality   1..* Coding All series modality if actual acquisition modalities
A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)
subject   1..1 Reference
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient
target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device
target: http://hl7.org/fhir/StructureDefinition/Group
Who or what is the subject of the study
The subject, typically a patient, of the imaging study.
endpoint   1..* Reference
target: http://hl7.org/fhir/StructureDefinition/Endpoint|4.0.1
Study access endpoint (e.g., WADO-RS)
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.
numberOfSeries   0..1 unsignedInt Number of Study Related Series
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.
numberOfInstances   0..1 unsignedInt Number of Study Related Instances
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.
series   0..* BackboneElement Each study has one or more series of instances
Each study has one or more series of images or other content.
uid   1..1 id DICOM Series Instance UID for the series
The DICOM Series Instance UID for the series.
number   0..1 unsignedInt Numeric identifier of this series
The numeric identifier of this series in the study.
modality   1..1 Coding The modality of the instances in the series
The modality of this series sequence.
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)
instance   0..* BackboneElement A single SOP instance from the series
A single SOP instance within the series, e.g. an image, or presentation state.
uid   1..1 id DICOM SOP Instance UID
The DICOM SOP Instance UID for this image or other DICOM content.
sopClass   1..1 Coding DICOM class type
DICOM instance type.
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible)
number   0..1 unsignedInt The number of this instance in the series
The number of instance in the series.


## USCoreImagingStudyProfile — US Core ImagingStudy Profile

The US Core ImagingStudy Profile inherits from the FHIR [ImagingStudy](https://hl7.org/fhir/R4/imagingstudy.html) resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) *Diagnostic Imaging Data Class* and its *Diagnostic Imaging Reference* Data Element. It sets minimum expectations for the ImagingStudy resource to record, search, and fetch the identifiers, endpoints, and contextual information needed to access a diagnostic imaging study. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

- **URL:** `http://hl7.org/fhir/us/core/StructureDefinition/us-core-imagingstudy`
- **Version:** 0.1.0
- **Status:** active
- **Kind:** resource
- **Type:** `ImagingStudy`
- **Base Definition:** `http://hl7.org/fhir/StructureDefinition/ImagingStudy`
- **Derivation:** constraint


### Elements (differential)

| Element | Must Support | Add'l USCDI | Cardinality | Type | Description |
|---|:---:|:---:|---|---|---|
| `ImagingStudy` |  |  | 0..* |  | **A set of images produced in single study (one or more series of references images)**<br/>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. |
| <span style="padding-left: 1.5em;">↳</span>`identifier` | ✅ |  | 1..* | `Identifier` | **Identifiers for the whole study, including the DICOM Study Instance UID**<br/>Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.<br/><span style="font-size: 0.85em;">**Slicing:** discriminator `pattern@$this` — rules: open</span> |
| <span style="padding-left: 1.5em;">↳</span>`identifier`<br/><span style="font-size: 0.85em;">slice: `studyInstanceUID`</span> | ✅ |  | 1..1 | `Identifier` | **DICOM Study Instance UID**<br/>Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.<br/><span style="font-size: 0.85em;">**Pattern (Identifier):** system `urn:dicom:uid`</span> |
| <span style="padding-left: 1.5em;">↳</span>`status` | ✅ |  | 1..1 | `code` | **registered \| available \| cancelled \| entered-in-error \| unknown**<br/>The current state of the ImagingStudy.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/imagingstudy-status` (required)</span> |
| <span style="padding-left: 1.5em;">↳</span>`modality` | ✅ |  | 1..* | `Coding` | **All series modality if actual acquisition modalities**<br/>A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19).<br/><span style="font-size: 0.85em;">**Binding:** `http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html` (extensible)</span> |
| <span style="padding-left: 1.5em;">↳</span>`subject` | ✅ |  | 1..1 | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/StructureDefinition/Group</span> | **Who or what is the subject of the study**<br/>The subject, typically a patient, of the imaging study. |
| <span style="padding-left: 1.5em;">↳</span>`endpoint` | ✅ |  | 1..* | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/StructureDefinition/Endpoint\|4.0.1</span> | **Study access endpoint (e.g., WADO-RS)**<br/>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. |
| <span style="padding-left: 1.5em;">↳</span>`numberOfSeries` | ✅ |  | 0..1 | `unsignedInt` | **Number of Study Related Series**<br/>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. |
| <span style="padding-left: 1.5em;">↳</span>`numberOfInstances` | ✅ |  | 0..1 | `unsignedInt` | **Number of Study Related Instances**<br/>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. |
| <span style="padding-left: 1.5em;">↳</span>`series` | ✅ |  | 0..* | `BackboneElement` | **Each study has one or more series of instances**<br/>Each study has one or more series of images or other content. |
| <span style="padding-left: 3.0em;">↳</span>`uid` | ✅ |  | 1..1 | `id` | **DICOM Series Instance UID for the series**<br/>The DICOM Series Instance UID for the series. |
| <span style="padding-left: 3.0em;">↳</span>`number` | ✅ |  | 0..1 | `unsignedInt` | **Numeric identifier of this series**<br/>The numeric identifier of this series in the study. |
| <span style="padding-left: 3.0em;">↳</span>`modality` | ✅ |  | 1..1 | `Coding` | **The modality of the instances in the series**<br/>The modality of this series sequence.<br/><span style="font-size: 0.85em;">**Binding:** `http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html` (extensible)</span> |
| <span style="padding-left: 3.0em;">↳</span>`instance` | ✅ |  | 0..* | `BackboneElement` | **A single SOP instance from the series**<br/>A single SOP instance within the series, e.g. an image, or presentation state. |
| <span style="padding-left: 4.5em;">↳</span>`uid` | ✅ |  | 1..1 | `id` | **DICOM SOP Instance UID**<br/>The DICOM SOP Instance UID for this image or other DICOM content. |
| <span style="padding-left: 4.5em;">↳</span>`sopClass` | ✅ |  | 1..1 | `Coding` | **DICOM class type**<br/>DICOM instance  type.<br/><span style="font-size: 0.85em;">**Binding:** `http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1` (extensible)</span> |
| <span style="padding-left: 4.5em;">↳</span>`number` | ✅ |  | 0..1 | `unsignedInt` | **The number of this instance in the series**<br/>The number of instance in the series. |




Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Identifiers for the whole study, including the DICOM Study Instance UID
Slice: Unordered, Open by pattern:$this
.... identifier:studyInstanceUID SΣ 1..1 Identifier DICOM Study Instance UID

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:dicom:uid
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... modality SΣ 1..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible)
... subject SΣ 1..1 Reference(US Core Patient Profile(9.0.0) S | US Core Device Profile | Group) Who or what is the subject of the study
... endpoint SΣ 1..* Reference(Endpoint) Study access endpoint (e.g., WADO-RS)
... numberOfSeries SΣ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances SΣ 0..1 unsignedInt Number of Study Related Instances
... series SΣ 0..* BackboneElement Each study has one or more series of instances
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uid SΣ 1..1 id DICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number SΣ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality SΣ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality . (extensible)
.... instance S 0..* BackboneElement A single SOP instance from the series
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid S 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass S 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible)
..... number S 0..1 unsignedInt The number of this instance in the series
Example General: 1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.status Base required ImagingStudyStatus 📦4.0.1 FHIR Std.
ImagingStudy.modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... Slices for identifier S 1..* Identifier Identifiers for the whole study, including the DICOM Study Instance UID
Slice: Unordered, Open by pattern:$this
.... identifier:studyInstanceUID S 1..1 Identifier DICOM Study Instance UID
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:dicom:uid
... status S 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required)
... modality S 1..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible)
... endpoint S 1..* Reference(Endpoint) Study access endpoint (e.g., WADO-RS)
... numberOfSeries S 0..1 unsignedInt Number of Study Related Series
... numberOfInstances S 0..1 unsignedInt Number of Study Related Instances
... series S 0..* BackboneElement Each study has one or more series of instances
.... uid S 1..1 id DICOM Series Instance UID for the series
.... number S 0..1 unsignedInt Numeric identifier of this series
.... modality S 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality . (extensible)
.... instance S 0..* BackboneElement A single SOP instance from the series
..... uid S 1..1 id DICOM SOP Instance UID
..... sopClass S 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible)
..... number S 0..1 unsignedInt The number of this instance in the series

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImagingStudy.status Base required ImagingStudyStatus 📦4.0.1 FHIR Std.
ImagingStudy.modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Identifiers for the whole study, including the DICOM Study Instance UID
Slice: Unordered, Open by pattern:$this
.... identifier:studyInstanceUID SΣ 1..1 Identifier DICOM Study Instance UID

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:dicom:uid
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required)
... modality SΣ 1..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible)
... subject SΣ 1..1 Reference(US Core Patient Profile(9.0.0) S | US Core Device Profile | Group) Who or what is the subject of the study
... encounter Σ 0..1 Reference(Encounter) Encounter with which this imaging study is associated
... started Σ 0..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
... referrer Σ 0..1 Reference(Practitioner | PractitionerRole) Referring physician
... interpreter Σ 0..* Reference(Practitioner | PractitionerRole) Who interpreted images
... endpoint SΣ 1..* Reference(Endpoint) Study access endpoint (e.g., WADO-RS)
... numberOfSeries SΣ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances SΣ 0..1 unsignedInt Number of Study Related Instances
... procedureReference Σ 0..1 Reference(Procedure) The performed Procedure reference
... procedureCode Σ 0..* CodeableConcept The performed procedure code
Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
... location Σ 0..1 Reference(Location) Where ImagingStudy occurred
... reasonCode Σ 0..* CodeableConcept Why the study was requested
Binding: ProcedureReasonCodes (example): The reason for the study.
... reasonReference Σ 0..* Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) Why was study performed
... note Σ 0..* Annotation User-defined comments
... description Σ 0..1 string Institution-generated description
... series SΣ 0..* BackboneElement Each study has one or more series of instances
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uid SΣ 1..1 id DICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number SΣ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality SΣ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality . (extensible)
.... description Σ 0..1 string A short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ 0..1 unsignedInt Number of Series Related Instances
.... endpoint Σ 0..* Reference(Endpoint) Series access endpoint
.... bodySite Σ 0..1 Coding Body part examined
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
.... laterality Σ 0..1 Coding Body part laterality
Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).
.... specimen Σ 0..* Reference(Specimen) Specimen imaged
.... started Σ 0..1 dateTime When the series started
.... performer Σ 0..* BackboneElement Who performed the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 0..1 CodeableConcept Type of performance
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Who performed the series
.... instance S 0..* BackboneElement A single SOP instance from the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid S 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass S 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible)
..... number S 0..1 unsignedInt The number of this instance in the series
Example General: 1
..... title 0..1 string Description of instance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImagingStudy.status Base required ImagingStudyStatus 📦4.0.1 FHIR Std.
ImagingStudy.modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.procedureCode Base extensible http://www.rsna.org/RadLex_Playbook.aspx Not State Unknown
ImagingStudy.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
ImagingStudy.series.​laterality Base example Laterality 📍4.0.1 FHIR Std.
ImagingStudy.series.​performer.function Base extensible ImagingStudy series performer function 📍4.0.1 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ImagingStudy

Summary

Mandatory: 4 elements
Must-Support: 16 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImagingStudy.identifier

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Identifiers for the whole study, including the DICOM Study Instance UID
Slice: Unordered, Open by pattern:$this
.... identifier:studyInstanceUID SΣ 1..1 Identifier DICOM Study Instance UID

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:dicom:uid
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... modality SΣ 1..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible)
... subject SΣ 1..1 Reference(US Core Patient Profile(9.0.0) S | US Core Device Profile | Group) Who or what is the subject of the study
... endpoint SΣ 1..* Reference(Endpoint) Study access endpoint (e.g., WADO-RS)
... numberOfSeries SΣ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances SΣ 0..1 unsignedInt Number of Study Related Instances
... series SΣ 0..* BackboneElement Each study has one or more series of instances
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uid SΣ 1..1 id DICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number SΣ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality SΣ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality . (extensible)
.... instance S 0..* BackboneElement A single SOP instance from the series
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid S 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass S 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible)
..... number S 0..1 unsignedInt The number of this instance in the series
Example General: 1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.status Base required ImagingStudyStatus 📦4.0.1 FHIR Std.
ImagingStudy.modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... Slices for identifier S 1..* Identifier Identifiers for the whole study, including the DICOM Study Instance UID
Slice: Unordered, Open by pattern:$this
.... identifier:studyInstanceUID S 1..1 Identifier DICOM Study Instance UID
Required Pattern: At least the following
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:dicom:uid
... status S 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required)
... modality S 1..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible)
... endpoint S 1..* Reference(Endpoint) Study access endpoint (e.g., WADO-RS)
... numberOfSeries S 0..1 unsignedInt Number of Study Related Series
... numberOfInstances S 0..1 unsignedInt Number of Study Related Instances
... series S 0..* BackboneElement Each study has one or more series of instances
.... uid S 1..1 id DICOM Series Instance UID for the series
.... number S 0..1 unsignedInt Numeric identifier of this series
.... modality S 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality . (extensible)
.... instance S 0..* BackboneElement A single SOP instance from the series
..... uid S 1..1 id DICOM SOP Instance UID
..... sopClass S 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible)
..... number S 0..1 unsignedInt The number of this instance in the series

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImagingStudy.status Base required ImagingStudyStatus 📦4.0.1 FHIR Std.
ImagingStudy.modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Identifiers for the whole study, including the DICOM Study Instance UID
Slice: Unordered, Open by pattern:$this
.... identifier:studyInstanceUID SΣ 1..1 Identifier DICOM Study Instance UID

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... use 0..1 code usual | official | temp | secondary | old (If known)
..... type 0..1 CodeableConcept Description of identifier
..... system 1..1 uri The namespace for the identifier value
Fixed Value: urn:dicom:uid
..... value 0..1 string The value that is unique
..... period 0..1 Period Time period when id is/was valid for use
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required)
... modality SΣ 1..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible)
... subject SΣ 1..1 Reference(US Core Patient Profile(9.0.0) S | US Core Device Profile | Group) Who or what is the subject of the study
... encounter Σ 0..1 Reference(Encounter) Encounter with which this imaging study is associated
... started Σ 0..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
... referrer Σ 0..1 Reference(Practitioner | PractitionerRole) Referring physician
... interpreter Σ 0..* Reference(Practitioner | PractitionerRole) Who interpreted images
... endpoint SΣ 1..* Reference(Endpoint) Study access endpoint (e.g., WADO-RS)
... numberOfSeries SΣ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances SΣ 0..1 unsignedInt Number of Study Related Instances
... procedureReference Σ 0..1 Reference(Procedure) The performed Procedure reference
... procedureCode Σ 0..* CodeableConcept The performed procedure code
Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
... location Σ 0..1 Reference(Location) Where ImagingStudy occurred
... reasonCode Σ 0..* CodeableConcept Why the study was requested
Binding: ProcedureReasonCodes (example): The reason for the study.
... reasonReference Σ 0..* Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) Why was study performed
... note Σ 0..* Annotation User-defined comments
... description Σ 0..1 string Institution-generated description
... series SΣ 0..* BackboneElement Each study has one or more series of instances
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uid SΣ 1..1 id DICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number SΣ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality SΣ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality . (extensible)
.... description Σ 0..1 string A short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ 0..1 unsignedInt Number of Series Related Instances
.... endpoint Σ 0..* Reference(Endpoint) Series access endpoint
.... bodySite Σ 0..1 Coding Body part examined
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
.... laterality Σ 0..1 Coding Body part laterality
Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).
.... specimen Σ 0..* Reference(Specimen) Specimen imaged
.... started Σ 0..1 dateTime When the series started
.... performer Σ 0..* BackboneElement Who performed the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 0..1 CodeableConcept Type of performance
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Who performed the series
.... instance S 0..* BackboneElement A single SOP instance from the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid S 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass S 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible)
..... number S 0..1 unsignedInt The number of this instance in the series
Example General: 1
..... title 0..1 string Description of instance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImagingStudy.status Base required ImagingStudyStatus 📦4.0.1 FHIR Std.
ImagingStudy.modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.procedureCode Base extensible http://www.rsna.org/RadLex_Playbook.aspx Not State Unknown
ImagingStudy.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​bodySite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
ImagingStudy.series.​laterality Base example Laterality 📍4.0.1 FHIR Std.
ImagingStudy.series.​performer.function Base extensible ImagingStudy series performer function 📍4.0.1 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ImagingStudy

Summary

Mandatory: 4 elements
Must-Support: 16 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImagingStudy.identifier

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron