International Patient Summary Implementation Guide
2.0.0 - STU 2

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions

## Resource Profile: ImagingStudy (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips | Version: 2.0.0
Standards status: Trial-use | Maturity Level: 2 | Computable Name: ImagingStudyUvIps

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.

Usages:

- Use this Profile: Bundle (IPS)
- Refer to this Profile: Observation Results - Radiology (IPS)
- Examples for this Profile: ImagingStudy/TII-ImagingStudy-5-1
- CapabilityStatements using this Profile: IPS Server Capability Statement

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
identifier | SO Σ | 0..* | Identifier | Identifiers for the whole study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
status | ?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: Imaging Study Status Codes - IPS (required)
subject | SO Σ | 1..1 | Reference(Patient (IPS) | Group) | Who or what is the subject of the study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
started | SO Σ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
procedureCode | SO Σ | 0..* | CodeableConceptIPS | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
Additional Bindings | Purpose
Results Radiology Observation - IPS | candidate
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reasonCode | SO Σ | 0..* | CodeableConceptIPS | Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
series | SO Σ | 0..* | BackboneElement | Each study has one or more series of instances
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
uid | SO Σ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modality | SO Σ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
instance | SO | 0..* | BackboneElement | A single SOP instance from the series
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
uid | SO | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
sopClass | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ImagingStudy.status | required | ImagingStudyStatusUvIps `http://hl7.org/fhir/uv/ips/ValueSet/imaging-study-status-uv-ips` From this IG
ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspx `http://www.rsna.org/RadLex_Playbook.aspx`
ImagingStudy.reasonCode | example | ProcedureReasonCodes `http://hl7.org/fhir/ValueSet/procedure-reason` From the FHIR Standard
ImagingStudy.series.modality | extensible | AcquisitionModality `http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html` From http://tx.fhir.org/r4
ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 `http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImagingStudy |  |  | ImagingStudy |
identifier | SO | 0..* | Identifier | Identifiers for the whole study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
status |  | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: Imaging Study Status Codes - IPS (required)
subject | SO | 1..1 | Reference(Patient (IPS) | Group) | Who or what is the subject of the study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
started | SO | 0..1 | dateTime | When the study was started
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
procedureCode | SO | 0..* | CodeableConceptIPS | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
Additional Bindings | Purpose
Results Radiology Observation - IPS | candidate
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reasonCode | SO | 0..* | CodeableConceptIPS | Why the study was requested
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
series | SO | 0..* | BackboneElement | Each study has one or more series of instances
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
uid | SO | 1..1 | id | DICOM Series Instance UID for the series
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modality | SO | 1..1 | Coding | The modality of the instances in the series
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
instance | SO | 0..* | BackboneElement | A single SOP instance from the series
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
uid | SO | 1..1 | id | DICOM SOP Instance UID
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
sopClass | SO | 1..1 | Coding | DICOM class type
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
ImagingStudy.status | required | ImagingStudyStatusUvIps `http://hl7.org/fhir/uv/ips/ValueSet/imaging-study-status-uv-ips` From this IG
ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspx `http://www.rsna.org/RadLex_Playbook.aspx`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 Bindings | Purpose
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
identifier | SO Σ | 0..* | Identifier | Identifiers for the whole study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
status | ?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: Imaging Study Status Codes - IPS (required)
modality | Σ | 0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
subject | SO Σ | 1..1 | Reference(Patient (IPS) | Group) | Who or what is the subject of the study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
encounter | Σ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
started | SO Σ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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) | Study access endpoint
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 | SO Σ | 0..* | CodeableConceptIPS | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
Additional Bindings | Purpose
Results Radiology Observation - IPS | candidate
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
location | Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred
reasonCode | SO Σ | 0..* | CodeableConceptIPS | Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 0..* | BackboneElement | Each study has one or more series of instances
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
number | Σ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
modality | SO Σ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO | 0..* | BackboneElement | A single SOP instance from the series
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
sopClass | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ImagingStudy.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
ImagingStudy.status | required | ImagingStudyStatusUvIps `http://hl7.org/fhir/uv/ips/ValueSet/imaging-study-status-uv-ips` From this IG
ImagingStudy.modality | extensible | AcquisitionModality `http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html` From http://tx.fhir.org/r4
ImagingStudy.subject.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` From the FHIR Standard
ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspx `http://www.rsna.org/RadLex_Playbook.aspx`
ImagingStudy.reasonCode | example | ProcedureReasonCodes `http://hl7.org/fhir/ValueSet/procedure-reason` From the FHIR Standard
ImagingStudy.series.modality | extensible | AcquisitionModality `http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html` From http://tx.fhir.org/r4
ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructures `http://hl7.org/fhir/ValueSet/body-site` From the FHIR Standard
ImagingStudy.series.laterality | example | Laterality `http://hl7.org/fhir/ValueSet/bodysite-laterality` From the FHIR Standard
ImagingStudy.series.performer.function | extensible | ImagingStudySeriesPerformerFunction `http://hl7.org/fhir/ValueSet/series-performer-function` From the FHIR Standard
ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 `http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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: 1 element
Must-Support: 12 elements

Structures

This structure refers to these other structures:

- Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)
- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
identifier | SO Σ | 0..* | Identifier | Identifiers for the whole study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
status | ?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: Imaging Study Status Codes - IPS (required)
subject | SO Σ | 1..1 | Reference(Patient (IPS) | Group) | Who or what is the subject of the study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
started | SO Σ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
procedureCode | SO Σ | 0..* | CodeableConceptIPS | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
Additional Bindings | Purpose
Results Radiology Observation - IPS | candidate
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reasonCode | SO Σ | 0..* | CodeableConceptIPS | Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
series | SO Σ | 0..* | BackboneElement | Each study has one or more series of instances
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
uid | SO Σ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modality | SO Σ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
instance | SO | 0..* | BackboneElement | A single SOP instance from the series
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
uid | SO | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
sopClass | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ImagingStudy.status | required | ImagingStudyStatusUvIps `http://hl7.org/fhir/uv/ips/ValueSet/imaging-study-status-uv-ips` From this IG
ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspx `http://www.rsna.org/RadLex_Playbook.aspx`
ImagingStudy.reasonCode | example | ProcedureReasonCodes `http://hl7.org/fhir/ValueSet/procedure-reason` From the FHIR Standard
ImagingStudy.series.modality | extensible | AcquisitionModality `http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html` From http://tx.fhir.org/r4
ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 `http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ImagingStudy |  |  | ImagingStudy |
identifier | SO | 0..* | Identifier | Identifiers for the whole study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
status |  | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: Imaging Study Status Codes - IPS (required)
subject | SO | 1..1 | Reference(Patient (IPS) | Group) | Who or what is the subject of the study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
started | SO | 0..1 | dateTime | When the study was started
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
procedureCode | SO | 0..* | CodeableConceptIPS | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
Additional Bindings | Purpose
Results Radiology Observation - IPS | candidate
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reasonCode | SO | 0..* | CodeableConceptIPS | Why the study was requested
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
series | SO | 0..* | BackboneElement | Each study has one or more series of instances
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
uid | SO | 1..1 | id | DICOM Series Instance UID for the series
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
modality | SO | 1..1 | Coding | The modality of the instances in the series
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
instance | SO | 0..* | BackboneElement | A single SOP instance from the series
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
uid | SO | 1..1 | id | DICOM SOP Instance UID
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
sopClass | SO | 1..1 | Coding | DICOM class type
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
ImagingStudy.status | required | ImagingStudyStatusUvIps `http://hl7.org/fhir/uv/ips/ValueSet/imaging-study-status-uv-ips` From this IG
ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspx `http://www.rsna.org/RadLex_Playbook.aspx`

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 Bindings | Purpose
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
identifier | SO Σ | 0..* | Identifier | Identifiers for the whole study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
status | ?!Σ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: Imaging Study Status Codes - IPS (required)
modality | Σ | 0..* | Coding | All series modality if actual acquisition modalities Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
subject | SO Σ | 1..1 | Reference(Patient (IPS) | Group) | Who or what is the subject of the study
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
encounter | Σ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
started | SO Σ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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) | Study access endpoint
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 | SO Σ | 0..* | CodeableConceptIPS | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
Additional Bindings | Purpose
Results Radiology Observation - IPS | candidate
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
location | Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred
reasonCode | SO Σ | 0..* | CodeableConceptIPS | Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 0..* | BackboneElement | Each study has one or more series of instances
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO Σ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
number | Σ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
modality | SO Σ | 1..1 | Coding | The modality of the instances in the series Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO | 0..* | BackboneElement | A single SOP instance from the series
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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 | SO | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
sopClass | SO | 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.
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
ImagingStudy.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
ImagingStudy.status | required | ImagingStudyStatusUvIps `http://hl7.org/fhir/uv/ips/ValueSet/imaging-study-status-uv-ips` From this IG
ImagingStudy.modality | extensible | AcquisitionModality `http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html` From http://tx.fhir.org/r4
ImagingStudy.subject.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` From the FHIR Standard
ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspx `http://www.rsna.org/RadLex_Playbook.aspx`
ImagingStudy.reasonCode | example | ProcedureReasonCodes `http://hl7.org/fhir/ValueSet/procedure-reason` From the FHIR Standard
ImagingStudy.series.modality | extensible | AcquisitionModality `http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html` From http://tx.fhir.org/r4
ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructures `http://hl7.org/fhir/ValueSet/body-site` From the FHIR Standard
ImagingStudy.series.laterality | example | Laterality `http://hl7.org/fhir/ValueSet/bodysite-laterality` From the FHIR Standard
ImagingStudy.series.performer.function | extensible | ImagingStudySeriesPerformerFunction `http://hl7.org/fhir/ValueSet/series-performer-function` From the FHIR Standard
ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 `http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1`

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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: 1 element
Must-Support: 12 elements

Structures

This structure refers to these other structures:

- Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)
- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)

Maturity: 2

Other representations of profile: CSV, Excel, Schematron