QI-Core Implementation Guide
6.0.0-ballot - ballot United States of America flag

This page is part of the Quality Improvement Core Framework (v6.0.0-ballot: STU6 (v6.0.0) Ballot 1) based on FHIR R4. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: QICore ImagingStudy

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-imagingstudy Version: 6.0.0-ballot
Active as of 2018-08-22 Computable Name: QICoreImagingStudy

Profile of ImagingStudy for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

Usage

See the patterns page for implementation and usage patterns.

Examples

Chest CT

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..*ImagingStudyA set of images produced in single study (one or more series of references images)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderegistered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.

... encounter Σ0..1Reference(QICore Encounter)Encounter with which this imaging study is associated
... started SΣ0..1dateTimeWhen the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn SΣ0..*Reference(QICore ServiceRequest | QICore CarePlan)Request fulfilled
... referrer Σ0..1Reference(QICore Practitioner | QICore PractitionerRole)Referring physician
... interpreter Σ0..*Reference(QICore Practitioner | QICore PractitionerRole)Who interpreted images
... procedureReference SΣ0..1Reference(QICore Procedure)The performed Procedure reference
... location Σ0..1Reference(QICore Location)Where ImagingStudy occurred
... reasonReference Σ0..*Reference(QICore Condition Problems Health Concerns | QICore Simple Observation | Media | QICore DiagnosticReport Profile for Report and Note Exchange | DocumentReference)Why was study performed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImagingStudy.statusrequiredImagingStudyStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingStudyIf 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-4errorImagingStudyIf 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-5errorImagingStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingStudyA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..*ImagingStudyA set of images produced in single study (one or more series of references images)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers for the whole study
... status ?!Σ1..1coderegistered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.

... modality Σ0..*CodingAll series modality if actual acquisition modalities
Binding: AcquisitionModality (extensible): Type of acquired data in the instance.


... subject SΣ1..1Reference(QICore Patient)Who or what is the subject of the study
... encounter Σ0..1Reference(QICore Encounter)Encounter with which this imaging study is associated
... started SΣ0..1dateTimeWhen the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn SΣ0..*Reference(QICore ServiceRequest | QICore CarePlan)Request fulfilled
... referrer Σ0..1Reference(QICore Practitioner | QICore PractitionerRole)Referring physician
... interpreter Σ0..*Reference(QICore Practitioner | QICore PractitionerRole)Who interpreted images
... endpoint Σ0..*Reference(Endpoint)Study access endpoint
... numberOfSeries Σ0..1unsignedIntNumber of Study Related Series
... numberOfInstances Σ0..1unsignedIntNumber of Study Related Instances
... procedureReference SΣ0..1Reference(QICore Procedure)The performed Procedure reference
... procedureCode Σ0..*CodeableConceptThe performed procedure code
Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.


... location Σ0..1Reference(QICore Location)Where ImagingStudy occurred
... reasonCode Σ0..*CodeableConceptWhy the study was requested
Binding: ProcedureReasonCodes (example): The reason for the study.


... reasonReference Σ0..*Reference(QICore Condition Problems Health Concerns | QICore Simple Observation | Media | QICore DiagnosticReport Profile for Report and Note Exchange | DocumentReference)Why was study performed
... note Σ0..*AnnotationUser-defined comments
... description Σ0..1stringInstitution-generated description
... series Σ0..*BackboneElementEach study has one or more series of instances
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uid Σ1..1idDICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ0..1unsignedIntNumeric identifier of this series
Example General: 3
.... modality Σ1..1CodingThe modality of the instances in the series
Binding: AcquisitionModality (extensible): Type of acquired data in the instance.

.... description Σ0..1stringA short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ0..1unsignedIntNumber of Series Related Instances
.... endpoint Σ0..*Reference(Endpoint)Series access endpoint
.... bodySite Σ0..1CodingBody part examined
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

.... laterality Σ0..1CodingBody part laterality
Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).

.... specimen Σ0..*Reference(Specimen)Specimen imaged
.... started Σ0..1dateTimeWhen the series started
.... performer Σ0..*BackboneElementWho performed the series
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ0..1CodeableConceptType of performance
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.

..... actor Σ1..1Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization | QICore CareTeam | QICore Patient | QICore Device | US Core Implantable Device Profile | QICore RelatedPerson)Who performed the series
.... instance 0..*BackboneElementA single SOP instance from the series
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... uid 1..1idDICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass 1..1CodingDICOM 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..1unsignedIntThe number of this instance in the series
Example General: 1
..... title 0..1stringDescription of instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImagingStudy.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ImagingStudy.statusrequiredImagingStudyStatus
ImagingStudy.modalityextensibleAcquisitionModality
ImagingStudy.procedureCodeextensiblehttp://www.rsna.org/RadLex_Playbook.aspx
ImagingStudy.reasonCodeexampleProcedureReasonCodes
ImagingStudy.series.modalityextensibleAcquisitionModality
ImagingStudy.series.bodySiteexampleSNOMEDCTBodyStructures
ImagingStudy.series.lateralityexampleLaterality
ImagingStudy.series.performer.functionextensibleImagingStudySeriesPerformerFunction
ImagingStudy.series.instance.sopClassextensiblehttp://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ImagingStudy

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from ImagingStudy

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..*ImagingStudyA set of images produced in single study (one or more series of references images)
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1coderegistered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.

... encounter Σ0..1Reference(QICore Encounter)Encounter with which this imaging study is associated
... started SΣ0..1dateTimeWhen the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn SΣ0..*Reference(QICore ServiceRequest | QICore CarePlan)Request fulfilled
... referrer Σ0..1Reference(QICore Practitioner | QICore PractitionerRole)Referring physician
... interpreter Σ0..*Reference(QICore Practitioner | QICore PractitionerRole)Who interpreted images
... procedureReference SΣ0..1Reference(QICore Procedure)The performed Procedure reference
... location Σ0..1Reference(QICore Location)Where ImagingStudy occurred
... reasonReference Σ0..*Reference(QICore Condition Problems Health Concerns | QICore Simple Observation | Media | QICore DiagnosticReport Profile for Report and Note Exchange | DocumentReference)Why was study performed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImagingStudy.statusrequiredImagingStudyStatus

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingStudyIf 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-4errorImagingStudyIf 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-5errorImagingStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingStudyA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..*ImagingStudyA set of images produced in single study (one or more series of references images)
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifiers for the whole study
... status ?!Σ1..1coderegistered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.

... modality Σ0..*CodingAll series modality if actual acquisition modalities
Binding: AcquisitionModality (extensible): Type of acquired data in the instance.


... subject SΣ1..1Reference(QICore Patient)Who or what is the subject of the study
... encounter Σ0..1Reference(QICore Encounter)Encounter with which this imaging study is associated
... started SΣ0..1dateTimeWhen the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn SΣ0..*Reference(QICore ServiceRequest | QICore CarePlan)Request fulfilled
... referrer Σ0..1Reference(QICore Practitioner | QICore PractitionerRole)Referring physician
... interpreter Σ0..*Reference(QICore Practitioner | QICore PractitionerRole)Who interpreted images
... endpoint Σ0..*Reference(Endpoint)Study access endpoint
... numberOfSeries Σ0..1unsignedIntNumber of Study Related Series
... numberOfInstances Σ0..1unsignedIntNumber of Study Related Instances
... procedureReference SΣ0..1Reference(QICore Procedure)The performed Procedure reference
... procedureCode Σ0..*CodeableConceptThe performed procedure code
Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.


... location Σ0..1Reference(QICore Location)Where ImagingStudy occurred
... reasonCode Σ0..*CodeableConceptWhy the study was requested
Binding: ProcedureReasonCodes (example): The reason for the study.


... reasonReference Σ0..*Reference(QICore Condition Problems Health Concerns | QICore Simple Observation | Media | QICore DiagnosticReport Profile for Report and Note Exchange | DocumentReference)Why was study performed
... note Σ0..*AnnotationUser-defined comments
... description Σ0..1stringInstitution-generated description
... series Σ0..*BackboneElementEach study has one or more series of instances
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uid Σ1..1idDICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ0..1unsignedIntNumeric identifier of this series
Example General: 3
.... modality Σ1..1CodingThe modality of the instances in the series
Binding: AcquisitionModality (extensible): Type of acquired data in the instance.

.... description Σ0..1stringA short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ0..1unsignedIntNumber of Series Related Instances
.... endpoint Σ0..*Reference(Endpoint)Series access endpoint
.... bodySite Σ0..1CodingBody part examined
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

.... laterality Σ0..1CodingBody part laterality
Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).

.... specimen Σ0..*Reference(Specimen)Specimen imaged
.... started Σ0..1dateTimeWhen the series started
.... performer Σ0..*BackboneElementWho performed the series
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... function Σ0..1CodeableConceptType of performance
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.

..... actor Σ1..1Reference(QICore Practitioner | QICore PractitionerRole | QICore Organization | QICore CareTeam | QICore Patient | QICore Device | US Core Implantable Device Profile | QICore RelatedPerson)Who performed the series
.... instance 0..*BackboneElementA single SOP instance from the series
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... uid 1..1idDICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass 1..1CodingDICOM 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..1unsignedIntThe number of this instance in the series
Example General: 1
..... title 0..1stringDescription of instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ImagingStudy.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ImagingStudy.statusrequiredImagingStudyStatus
ImagingStudy.modalityextensibleAcquisitionModality
ImagingStudy.procedureCodeextensiblehttp://www.rsna.org/RadLex_Playbook.aspx
ImagingStudy.reasonCodeexampleProcedureReasonCodes
ImagingStudy.series.modalityextensibleAcquisitionModality
ImagingStudy.series.bodySiteexampleSNOMEDCTBodyStructures
ImagingStudy.series.lateralityexampleLaterality
ImagingStudy.series.performer.functionextensibleImagingStudySeriesPerformerFunction
ImagingStudy.series.instance.sopClassextensiblehttp://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ImagingStudy

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron