Qi-Core Implementation Guide (Release 2.1 Trial-Use Ballot)

This page is part of the Quality Improvement Core Framework (v2.1.0: STU 3 Ballot 1) based on FHIR R3. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-imagingstudy

Examples:

CT Chest Scan Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-imagingstudy

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

This profile builds on ImagingStudy.

This profile was published on Mon Aug 21 00:00:00 AEST 2017 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

Description of Profiles, Differentials, and Snapshots.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy I0..*A 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: Common Languages (extensible)
... text I0..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
... uid Σ1..1oidFormal DICOM identifier for the study
Example General': urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045
... accession Σ0..1IdentifierRelated workflow identifier ("Accession Number")
... identifier Σ0..*IdentifierOther identifiers for the study
... availability Σ0..1codeONLINE | OFFLINE | NEARLINE | UNAVAILABLE
Binding: InstanceAvailability (required)
... modalityList Σ0..*CodingAll series modality if actual acquisition modalities
Binding: Acquisition Modality Codes (extensible)
... patient SΣ1..1Reference(QICore-Patient)Who the images are of
... context Σ0..1Reference(Encounter), Reference(EpisodeOfCare)Originating context
... started SΣ0..1dateTimeWhen the study was started
Example General': 2011-01-01T19:01:20+11:00
... basedOn SΣ0..*Reference(QICore-ReferralRequest), Reference(QICore-ProcedureRequest), Reference(CarePlan)Request fulfilled
... referrer Σ0..1Reference(QICore-Practitioner)Referring physician
... interpreter Σ0..*Reference(QICore-Practitioner)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..*Reference(QICore-Procedure)The performed Procedure reference
... procedureCode Σ0..*CodeableConceptThe performed procedure code
Binding: Procedure Codes (SNOMED CT) (example)
... reason Σ0..1CodeableConceptWhy the study was requested
Binding: Procedure Reason Codes (example)
... description Σ0..1stringInstitution-generated description
... series ΣI0..*BackboneElementEach study has one or more series of instances
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... uid Σ1..1oidFormal DICOM identifier for this series
Example General': urn:oid: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: Acquisition Modality Codes (extensible)
.... description Σ0..1stringA short human readable summary of the series
Example General': CT Surview 180
.... numberOfInstances Σ0..1unsignedIntNumber of Series Related Instances
.... availability Σ0..1codeONLINE | OFFLINE | NEARLINE | UNAVAILABLE
Binding: InstanceAvailability (required)
.... endpoint Σ0..*Reference(Endpoint)Series access endpoint
.... bodySite Σ0..1CodingBody part examined
Binding: SNOMED CT Body Structures (example)
.... laterality Σ0..1CodingBody part laterality
Binding: Laterality (example)
.... started Σ0..1dateTimeWhen the series started
.... performer Σ0..*Reference(Practitioner)Who performed the series
.... instance I0..*BackboneElementA single SOP instance from the series
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... uid 1..1oidFormal DICOM identifier for this instance
Example General': urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903
..... number 0..1unsignedIntThe number of this instance in the series
Example General': 1
..... sopClass 1..1oidDICOM class type
Example General': urn:oid:1.2.840.10008.5.1.4.1.1.2
..... title 0..1stringDescription of instance

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy I0..*A 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: Common Languages (extensible)
... text I0..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
... uid Σ1..1oidFormal DICOM identifier for the study
Example General': urn:oid:2.16.124.113543.6003.1154777499.30246.19789.3503430045
... accession Σ0..1IdentifierRelated workflow identifier ("Accession Number")
... identifier Σ0..*IdentifierOther identifiers for the study
... availability Σ0..1codeONLINE | OFFLINE | NEARLINE | UNAVAILABLE
Binding: InstanceAvailability (required)
... modalityList Σ0..*CodingAll series modality if actual acquisition modalities
Binding: Acquisition Modality Codes (extensible)
... patient SΣ1..1Reference(QICore-Patient)Who the images are of
... context Σ0..1Reference(Encounter), Reference(EpisodeOfCare)Originating context
... started SΣ0..1dateTimeWhen the study was started
Example General': 2011-01-01T19:01:20+11:00
... basedOn SΣ0..*Reference(QICore-ReferralRequest), Reference(QICore-ProcedureRequest), Reference(CarePlan)Request fulfilled
... referrer Σ0..1Reference(QICore-Practitioner)Referring physician
... interpreter Σ0..*Reference(QICore-Practitioner)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..*Reference(QICore-Procedure)The performed Procedure reference
... procedureCode Σ0..*CodeableConceptThe performed procedure code
Binding: Procedure Codes (SNOMED CT) (example)
... reason Σ0..1CodeableConceptWhy the study was requested
Binding: Procedure Reason Codes (example)
... description Σ0..1stringInstitution-generated description
... series ΣI0..*BackboneElementEach study has one or more series of instances
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... uid Σ1..1oidFormal DICOM identifier for this series
Example General': urn:oid: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: Acquisition Modality Codes (extensible)
.... description Σ0..1stringA short human readable summary of the series
Example General': CT Surview 180
.... numberOfInstances Σ0..1unsignedIntNumber of Series Related Instances
.... availability Σ0..1codeONLINE | OFFLINE | NEARLINE | UNAVAILABLE
Binding: InstanceAvailability (required)
.... endpoint Σ0..*Reference(Endpoint)Series access endpoint
.... bodySite Σ0..1CodingBody part examined
Binding: SNOMED CT Body Structures (example)
.... laterality Σ0..1CodingBody part laterality
Binding: Laterality (example)
.... started Σ0..1dateTimeWhen the series started
.... performer Σ0..*Reference(Practitioner)Who performed the series
.... instance I0..*BackboneElementA single SOP instance from the series
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... uid 1..1oidFormal DICOM identifier for this instance
Example General': urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903
..... number 0..1unsignedIntThe number of this instance in the series
Example General': 1
..... sopClass 1..1oidDICOM class type
Example General': urn:oid:1.2.840.10008.5.1.4.1.1.2
..... title 0..1stringDescription of instance

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
ImagingStudy.languageCommon LanguagesextensibleCommon Languages
ImagingStudy.availabilityInstanceAvailabilityrequiredInstanceAvailability
ImagingStudy.modalityListAcquisition Modality CodesextensibleAcquisition Modality Codes
ImagingStudy.procedureCodeProcedure Codes (SNOMED CT)exampleProcedure Codes (SNOMED CT)
ImagingStudy.reasonProcedure Reason CodesexampleProcedure Reason Codes
ImagingStudy.series.modalityAcquisition Modality CodesextensibleAcquisition Modality Codes
ImagingStudy.series.availabilityInstanceAvailabilityrequiredInstanceAvailability
ImagingStudy.series.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
ImagingStudy.series.lateralityLateralityexampleLaterality

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ImagingStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1ImagingStudyIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4ImagingStudyIf 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-3ImagingStudyIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1ImagingStudy.seriesAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1ImagingStudy.series.instanceAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())