| Left: | ImagingStudy (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips) |
| Right: | US Core ImagingStudy Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-imagingstudy) |
| Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips' vs 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-imagingstudy' |
| Error | StructureDefinition.version | Values for version differ: '2.0.1' vs '10.0.0-ballot' |
| Information | StructureDefinition.name | Values for name differ: 'ImagingStudyUvIps' vs 'USCoreImagingStudyProfile' |
| Information | StructureDefinition.title | Values for title differ: 'ImagingStudy (IPS)' vs 'US Core ImagingStudy Profile' |
| Information | StructureDefinition.date | Values for date differ: '2024-06-19T10:50:07-05:00' vs '2026-10-19' |
| Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Patient Care' vs 'HL7 International / Cross-Group Projects' |
| Information | StructureDefinition.jurisdiction | Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001' |
| Information | StructureDefinition.jurisdiction | Added the item 'urn:iso:std:iso:3166#US' |
| Error | StructureDefinition.baseDefinition | Values for baseDefinition differ: 'http://hl7.org/fhir/StructureDefinition/ImagingStudy|4.0.1' vs 'http://hl7.org/fhir/StructureDefinition/ImagingStudy' |
| Warning | ImagingStudy.status | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Warning | ImagingStudy.started | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Information | StructureDefinition.short | Values for short differ: 'Study access endpoint' vs 'The network service providing access to the study' |
| Information | StructureDefinition.comment | Values for comment differ: 'Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG), formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer.' vs 'The network service providing access (for example, query, view, or retrieval) for the study. A study can list more than one endpoint when different use cases are served by different services. The presence of an endpoint does not guarantee access to the images. See the profile introduction for endpoint guidance.' |
| Warning | ImagingStudy.endpoint | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Warning | ImagingStudy.procedureCode | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Warning | ImagingStudy.reasonCode | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Warning | ImagingStudy.series | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Warning | ImagingStudy.series.uid | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Warning | ImagingStudy.series.modality | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Warning | ImagingStudy.series.instance | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Warning | ImagingStudy.series.instance.uid | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Warning | ImagingStudy.series.instance.sopClass | Elements differ in definition for mustSupport: 'true' vs 'false' |
| Name | Value | Comments | |
|---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/ImagingStudy|4.0.1 | http://hl7.org/fhir/StructureDefinition/ImagingStudy |
|
copyright | |||
date | 2024-06-19T10:50:07-05:00 | 2026-10-19 |
|
description | This profile represents the constraints applied to the ImagingStudy resource by the IPS project, which specifies the information on a DICOM imaging study this imaging result is part of. | 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. Along with the US Core DiagnosticReport Profile for Report and Note Exchange and US Core ServiceRequest Profile, this profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) *Diagnostic Imaging Reference Data Element of the Diagnostic Imaging Data Class*. It sets minimum expectations for the ImagingStudy resource to record, search, and fetch the identifiers and endpoints needed to locate or 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. |
|
experimental | false |
| |
fhirVersion | 4.0.1 | ||
jurisdiction | |||
![]() jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 |
| |
![]() jurisdiction[1] | urn:iso:std:iso:3166#US |
| |
kind | resource | ||
name | ImagingStudyUvIps | USCoreImagingStudyProfile |
|
publisher | HL7 International / Patient Care | HL7 International / Cross-Group Projects |
|
purpose | |||
status | active | ||
title | ImagingStudy (IPS) | US Core ImagingStudy Profile |
|
type | ImagingStudy | ||
url | http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips | http://hl7.org/fhir/us/core/StructureDefinition/us-core-imagingstudy |
|
version | 2.0.1 | 10.0.0-ballot |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | 0..* | ImagingStudy(4.0.1) | A set of images produced in single study (one or more series of references images) | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |||||||||||||||
![]() ![]() | 0..1 | id | Logical id of this artifact | 0..1 | id | Logical id of this artifact | |||||||||||||||
![]() ![]() | 0..1 | Meta | Metadata about the resource | 0..1 | Meta | Metadata about the resource | |||||||||||||||
![]() ![]() | 0..1 | uri | A set of rules under which this content was created | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||||||
![]() ![]() | 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 | 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 | |||||||||||||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||||||
![]() ![]() | 0..* | Extension | Extensions that cannot be ignored | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||
![]() ![]() | 0..* | Identifier | Identifiers for the whole study
| 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 | |||||||||||||||
![]() ![]() | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ?? (required) | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ?? (required) |
| ||||||||||||||
![]() ![]() | 0..* | Coding | All series modality if actual acquisition modalities Binding: ?? (extensible): Type of acquired data in the instance. | 0..* | Coding | All series modality if actual acquisition modalities Binding: ?? (extensible): Type of acquired data in the instance. | |||||||||||||||
![]() ![]() | 1..1 | Reference(Patient (IPS)(2.0.1) | Group) | Who or what is the subject of the study
| 1..1 | Reference(US Core Patient Profile | US Core Device Profile | Group) | Who or what is the subject of the study | |||||||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||||||
![]() ![]() ![]() | C | 1..1 | string | Literal reference, Relative, internal or absolute URL
|
| ||||||||||||||||
![]() ![]() ![]() | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| |||||||||||||||||
![]() ![]() ![]() | 0..1 | Identifier | Logical reference, when literal reference is not known |
| |||||||||||||||||
![]() ![]() ![]() | 0..1 | string | Text alternative for the resource |
| |||||||||||||||||
![]() ![]() | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated | |||||||||||||||
![]() ![]() | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
| 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00 |
| ||||||||||||||
![]() ![]() | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled | |||||||||||||||
![]() ![]() | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | |||||||||||||||
![]() ![]() | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images | |||||||||||||||
![]() ![]() | 0..* | Reference(Endpoint) | Study access endpoint | 0..* | Reference(Endpoint) | The network service providing access to the study |
| ||||||||||||||
![]() ![]() | 0..1 | unsignedInt | Number of Study Related Series | 0..1 | unsignedInt | Number of Study Related Series | |||||||||||||||
![]() ![]() | 0..1 | unsignedInt | Number of Study Related Instances | 0..1 | unsignedInt | Number of Study Related Instances | |||||||||||||||
![]() ![]() | 0..1 | Reference(Procedure) | The performed Procedure reference | 0..1 | Reference(Procedure) | The performed Procedure reference | |||||||||||||||
![]() ![]() | 0..* | ?? | The performed procedure code Binding: ?? (extensible): The performed procedure type.
| 0..* | CodeableConcept | The performed procedure code Binding: ?? (extensible): The performed procedure type. |
| ||||||||||||||
![]() ![]() | 0..1 | Reference(Location) | Where ImagingStudy occurred | 0..1 | Reference(Location) | Where ImagingStudy occurred | |||||||||||||||
![]() ![]() | 0..* | ?? | Why the study was requested Binding: ?? (example): The reason for the study.
| 0..* | CodeableConcept | Why the study was requested Binding: ?? (example): The reason for the study. |
| ||||||||||||||
![]() ![]() | 0..* | Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) | Why was study performed | 0..* | Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) | Why was study performed | |||||||||||||||
![]() ![]() | 0..* | Annotation | User-defined comments | 0..* | Annotation | User-defined comments | |||||||||||||||
![]() ![]() | 0..1 | string | Institution-generated description | 0..1 | string | Institution-generated description | |||||||||||||||
![]() ![]() | 0..* | BackboneElement | Each study has one or more series of instances
| 0..* | BackboneElement | Each study has one or more series of instances |
| ||||||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||||||
![]() ![]() ![]() | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||
![]() ![]() ![]() | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
| 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
| ||||||||||||||
![]() ![]() ![]() | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3 | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3 | |||||||||||||||
![]() ![]() ![]() | 1..1 | Coding | The modality of the instances in the series Binding: ?? (extensible): Type of acquired data in the instance.
| 1..1 | Coding | The modality of the instances in the series Binding: ?? (extensible): Type of acquired data in the instance. |
| ||||||||||||||
![]() ![]() ![]() | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180 | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180 | |||||||||||||||
![]() ![]() ![]() | 0..1 | unsignedInt | Number of Series Related Instances | 0..1 | unsignedInt | Number of Series Related Instances | |||||||||||||||
![]() ![]() ![]() | 0..* | Reference(Endpoint) | Series access endpoint | 0..* | Reference(Endpoint) | Series access endpoint | |||||||||||||||
![]() ![]() ![]() | 0..1 | Coding | Body part examined Binding: ?? (example): Codes describing anatomical locations. May include laterality. | 0..1 | Coding | Body part examined Binding: ?? (example): Codes describing anatomical locations. May include laterality. | |||||||||||||||
![]() ![]() ![]() | 0..1 | Coding | Body part laterality Binding: ?? (example): Codes describing body site laterality (left, right, etc.). | 0..1 | Coding | Body part laterality Binding: ?? (example): Codes describing body site laterality (left, right, etc.). | |||||||||||||||
![]() ![]() ![]() | 0..* | Reference(Specimen) | Specimen imaged | 0..* | Reference(Specimen) | Specimen imaged | |||||||||||||||
![]() ![]() ![]() | 0..1 | dateTime | When the series started | 0..1 | dateTime | When the series started | |||||||||||||||
![]() ![]() ![]() | 0..* | BackboneElement | Who performed the series | 0..* | BackboneElement | Who performed the series | |||||||||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||
![]() ![]() ![]() ![]() | 0..1 | CodeableConcept | Type of performance Binding: ?? (extensible): The type of involvement of the performer. | 0..1 | CodeableConcept | Type of performance Binding: ?? (extensible): The type of involvement of the performer. | |||||||||||||||
![]() ![]() ![]() ![]() | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Who performed the series | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) | Who performed the series | |||||||||||||||
![]() ![]() ![]() | 0..* | BackboneElement | A single SOP instance from the series
| 0..* | BackboneElement | A single SOP instance from the series |
| ||||||||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||||||
![]() ![]() ![]() ![]() | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||
![]() ![]() ![]() ![]() | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
| 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 |
| ||||||||||||||
![]() ![]() ![]() ![]() | 1..1 | Coding | DICOM class type Binding: ?? (extensible): The sopClass for the instance.
| 1..1 | Coding | DICOM class type Binding: ?? (extensible): The sopClass for the instance. |
| ||||||||||||||
![]() ![]() ![]() ![]() | 0..1 | unsignedInt | The number of this instance in the series Example General: 1 | 0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||||||||||||
![]() ![]() ![]() ![]() | 0..1 | string | Description of instance | 0..1 | string | Description of instance | |||||||||||||||
Documentation for this format | |||||||||||||||||||||