Health eData 1 Sandbox
0.1.0 - CI Build
Health eData 1 Sandbox
0.1.0 - CI Build
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
| 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:
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:
Each ImagingStudy Must Support:
This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.
{% include structure-table.md sd=sd source="differential" show_must_support=true show_uscdi=true %}
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.
http://hl7.org/fhir/us/core/StructureDefinition/us-core-imagingstudyImagingStudyhttp://hl7.org/fhir/StructureDefinition/ImagingStudy| 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 |
✅ | 0..* | Identifier |
Identifiers for the whole study Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. Slicing: discriminator pattern@$this — rules: open |
|
↳identifierslice: studyInstanceUID |
0..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 |
||
↳identifierslice: accessionNumber |
✅ | 0..1 | Identifier |
Accession Number Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. Pattern (Identifier): system `` |
|
↳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 |
0..* | 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 | Referencetarget: 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 |
✅ | 0..* | Referencetarget: http://hl7.org/fhir/StructureDefinition/Endpoint|4.0.1 |
The network service providing access to the study 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. |
## 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` | ✅ | | 0..* | `Identifier` | **Identifiers for the whole study**<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> | | | 0..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>`identifier`<br/><span style="font-size: 0.85em;">slice: `accessionNumber`</span> | ✅ | | 0..1 | `Identifier` | **Accession Number**<br/>Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number.<br/><span style="font-size: 0.85em;">**Pattern (Identifier):** system ``</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` | | | 0..* | `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` | ✅ | | 0..* | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/StructureDefinition/Endpoint\|4.0.1</span> | **The network service providing access to the study**<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. |
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  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 |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   identifier:studyInstanceUID |
0..1 | Identifier | DICOM Study Instance UID Required Pattern: | |
 identifier:accessionNumber |
0..1 | Identifier | Accession Number Required Pattern: | |
| status |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required) | |
 modality |
0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality  (extensible) | |
 subject |
1..1 | Reference(US Core Patient Profile(9.0.0) | US Core Device Profile | Group) | Who or what is the subject of the study | |
 endpoint |
0..* | Reference(Endpoint) | The network service providing access to the study | |
| Documentation for this format | ||||
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImagingStudy |
0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |
| Slices for identifier |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:studyInstanceUID |
0..1 | Identifier | DICOM Study Instance UID Required Pattern: | |
| identifier:accessionNumber |
0..1 | Identifier | Accession Number Required Pattern: | |
 status |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required) | |
| modality |
0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible) | |
| subject |
1..1 | Reference(US Core Patient Profile(9.0.0) | US Core Device Profile | Group) | Who or what is the subject of the study | |
| endpoint |
0..* | Reference(Endpoint) | The network service providing access to the study | |
| Documentation for this format | ||||
| 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 |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:studyInstanceUID |
0..1 | Identifier | DICOM Study Instance UID Required Pattern: | |||||
| identifier:accessionNumber |
0..1 | Identifier | Accession Number Required Pattern: | |||||
| status |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required) | |||||
| modality |
0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible) | |||||
| subject |
1..1 | Reference(US Core Patient Profile(9.0.0) | 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 |
0..* | Reference(Endpoint) | The network service providing access to the study | |||||
| numberOfSeries |
0..1 | unsignedInt | Number of Study Related Series | |||||
| numberOfInstances |
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 |
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 |
1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 | |||||
| number |
0..1 | unsignedInt | Numeric identifier of this series Example General: 3 | |||||
| modality |
1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance. | |||||
| 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 |
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 |
1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | |||||
| sopClass |
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): The sopClass for the instance. | |||||
| number |
0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||
| title |
0..1 | string | Description of instance | |||||
| Documentation for this format | ||||||||
| 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 |
| 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
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:studyInstanceUID |
0..1 | Identifier | DICOM Study Instance UID Required Pattern: | |
| identifier:accessionNumber |
0..1 | Identifier | Accession Number Required Pattern: | |
| status |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required) | |
| modality |
0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible) | |
| subject |
1..1 | Reference(US Core Patient Profile(9.0.0) | US Core Device Profile | Group) | Who or what is the subject of the study | |
| endpoint |
0..* | Reference(Endpoint) | The network service providing access to the study | |
| Documentation for this format | ||||
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImagingStudy |
0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |
| Slices for identifier |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| identifier:studyInstanceUID |
0..1 | Identifier | DICOM Study Instance UID Required Pattern: | |
| identifier:accessionNumber |
0..1 | Identifier | Accession Number Required Pattern: | |
| status |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required) | |
| modality |
0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible) | |
| subject |
1..1 | Reference(US Core Patient Profile(9.0.0) | US Core Device Profile | Group) | Who or what is the subject of the study | |
| endpoint |
0..* | Reference(Endpoint) | The network service providing access to the study | |
| Documentation for this format | ||||
| 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 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 |
0..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| identifier:studyInstanceUID |
0..1 | Identifier | DICOM Study Instance UID Required Pattern: | |||||
| identifier:accessionNumber |
0..1 | Identifier | Accession Number Required Pattern: | |||||
| status |
1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required) | |||||
| modality |
0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible) | |||||
| subject |
1..1 | Reference(US Core Patient Profile(9.0.0) | 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 |
0..* | Reference(Endpoint) | The network service providing access to the study | |||||
| numberOfSeries |
0..1 | unsignedInt | Number of Study Related Series | |||||
| numberOfInstances |
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 |
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 |
1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 | |||||
| number |
0..1 | unsignedInt | Numeric identifier of this series Example General: 3 | |||||
| modality |
1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance. | |||||
| 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 |
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 |
1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | |||||
| sopClass |
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): The sopClass for the instance. | |||||
| number |
0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||
| title |
0..1 | string | Description of instance | |||||
| Documentation for this format | ||||||||
| 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 |
| 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
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Cross-Group Projects. Package hl7.fhir.us.healthedata1-sandbox#0.1.0 based on FHIR 4.0.1. Generated 2026-10-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change