QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.0)

QI-Core Implementation Guide, Clinical Quality Improvement WG - CI build for vesion 4.0.0). This version is based on the current content of https://github.com/cqframework/qi-core/ and changes regularly. See the Directory of published versions

D.4.1 StructureDefinition-qicore-imagingstudy

Introduction:

See the patterns page for implementation and usage patterns.

Examples:

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 Wed Aug 22 00:00:00 UTC 2018 as a draft by Health Level Seven, Inc. - CQI WG.

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: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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)
... modality Σ0..*CodingAll series modality if actual acquisition modalities
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)
... subject SΣ1..1Reference(QICorePatient)Who or what is the subject of the study
... encounter Σ0..1Reference(Encounter)Encounter with which this imaging study is associated
... started SΣ0..1dateTimeWhen the study was started
Example General': 2011-01-01T08:01:20+00:00
... basedOn SΣ0..*Reference(QICoreServiceRequest | CarePlan)Request fulfilled
... referrer Σ0..1Reference(QICorePractitioner)Referring physician
... interpreter Σ0..*Reference(QICorePractitioner)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(QICoreProcedure)The performed Procedure reference
... procedureCode Σ0..*CodeableConceptThe performed procedure code
Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible)
... location Σ0..1Reference(Location)Where ImagingStudy occurred
... reasonCode Σ0..*CodeableConceptWhy the study was requested
Binding: ProcedureReasonCodes (example)
... reasonReference Σ0..*Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference)Why was study performed
... note Σ0..*AnnotationUser-defined comments
... description Σ0..1stringInstitution-generated description
... series ΣI0..*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: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)
.... 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)
.... laterality Σ0..1CodingBody part laterality
Binding: Laterality (example)
.... specimen Σ0..*Reference(Specimen)Specimen imaged
.... started Σ0..1dateTimeWhen the series started
.... performer ΣI0..*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)
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)Who performed the series
.... instance I0..*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)
..... number 0..1unsignedIntThe number of this instance in the series
Example General': 1
..... 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: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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)
... modality Σ0..*CodingAll series modality if actual acquisition modalities
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)
... subject SΣ1..1Reference(QICorePatient)Who or what is the subject of the study
... encounter Σ0..1Reference(Encounter)Encounter with which this imaging study is associated
... started SΣ0..1dateTimeWhen the study was started
Example General': 2011-01-01T08:01:20+00:00
... basedOn SΣ0..*Reference(QICoreServiceRequest | CarePlan)Request fulfilled
... referrer Σ0..1Reference(QICorePractitioner)Referring physician
... interpreter Σ0..*Reference(QICorePractitioner)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(QICoreProcedure)The performed Procedure reference
... procedureCode Σ0..*CodeableConceptThe performed procedure code
Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible)
... location Σ0..1Reference(Location)Where ImagingStudy occurred
... reasonCode Σ0..*CodeableConceptWhy the study was requested
Binding: ProcedureReasonCodes (example)
... reasonReference Σ0..*Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference)Why was study performed
... note Σ0..*AnnotationUser-defined comments
... description Σ0..1stringInstitution-generated description
... series ΣI0..*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: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible)
.... 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)
.... laterality Σ0..1CodingBody part laterality
Binding: Laterality (example)
.... specimen Σ0..*Reference(Specimen)Specimen imaged
.... started Σ0..1dateTimeWhen the series started
.... performer ΣI0..*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)
..... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)Who performed the series
.... instance I0..*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)
..... number 0..1unsignedIntThe number of this instance in the series
Example General': 1
..... title 0..1stringDescription of instance

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
ImagingStudy.languagepreferredCommonLanguages
Max Binding: AllLanguages
ImagingStudy.statusrequiredImagingStudyStatus
ImagingStudy.modalityextensiblehttp://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html
ImagingStudy.procedureCodeextensiblehttp://www.rsna.org/RadLex_Playbook.aspx
ImagingStudy.reasonCodeexampleProcedureReasonCodes
ImagingStudy.series.modalityextensiblehttp://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html
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

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-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 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-6ImagingStudyA resource should have narrative for robust management
: text.div.exists()
dom-5ImagingStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1ImagingStudy.seriesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1ImagingStudy.series.instanceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())