STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 7.0.2. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-imagingstudy

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

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

This profile was published on Fri Feb 27 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy I0..*A set of images produced in single study (one or more series of references images)
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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
... imagingstudy-radiationDose I0..1RangeExtension
URL: http://hl7.org/fhir/StructureDefinition/imagingstudy-radiationDose
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... imagingstudy-radiationDuration I0..1DurationExtension
URL: http://hl7.org/fhir/StructureDefinition/imagingstudy-radiationDuration
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... uid ∑1..1oidFormal DICOM identifier for the study
Example: 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 S1..1Reference(Profile qicore-patient)Who the images are of
... context ∑0..1Reference(Encounter | EpisodeOfCare)Originating context
... started S0..1dateTimeWhen the study was started
Example: 2011-01-01T11:01:20+03:00
... basedOn S0..*Reference(Profile qicore-diagnosticrequest)A request for a diagnostic service
... referrer 0..1Reference(Profile qicore-practitioner)Referring physician
... interpreter 0..1Reference(Profile qicore-practitioner)Who interpreted images
... baseLocation ∑0..*BackboneElementStudy access service endpoint
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type ∑1..1CodingWADO-RS | WADO-URI | IID
Binding: dWebType (extensible)
.... url ∑1..1uriStudy access URL
... numberOfSeries ∑1..1unsignedIntNumber of Study Related Series
... numberOfInstances ∑1..1unsignedIntNumber of Study Related Instances
... procedure S0..*Reference(Procedure)Type of procedure performed
... reason ∑0..1CodeableConceptReason for study
Binding: (unbound) (example)
... description ∑0..1stringInstitution-generated description
... series ∑0..*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: urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number ∑0..1unsignedIntNumeric identifier of this series
Example: 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: CT Surview 180
.... numberOfInstances ∑1..1unsignedIntNumber of Series Related Instances
.... availability ∑0..1codeONLINE | OFFLINE | NEARLINE | UNAVAILABLE
Binding: InstanceAvailability (required)
.... baseLocation ∑0..*BackboneElementSeries access endpoint
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... type ∑1..1CodingWADO-RS | WADO-URI | IID
Binding: dWebType (extensible)
..... url ∑1..1uriSeries access URL
.... 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
.... instance 0..*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: urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903
..... number 0..1unsignedIntThe number of this instance in the series
Example: 1
..... sopClass 1..1oidDICOM class type
Example: urn:oid:1.2.840.10008.5.1.4.1.1.2
..... title 0..1stringDescription of instance

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy I0..*A set of images produced in single study (one or more series of references images)
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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
... imagingstudy-radiationDose I0..1RangeExtension
URL: http://hl7.org/fhir/StructureDefinition/imagingstudy-radiationDose
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... imagingstudy-radiationDuration I0..1DurationExtension
URL: http://hl7.org/fhir/StructureDefinition/imagingstudy-radiationDuration
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... uid ∑1..1oidFormal DICOM identifier for the study
Example: 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 S1..1Reference(Profile qicore-patient)Who the images are of
... context ∑0..1Reference(Encounter | EpisodeOfCare)Originating context
... started S0..1dateTimeWhen the study was started
Example: 2011-01-01T11:01:20+03:00
... basedOn S0..*Reference(Profile qicore-diagnosticrequest)A request for a diagnostic service
... referrer 0..1Reference(Profile qicore-practitioner)Referring physician
... interpreter 0..1Reference(Profile qicore-practitioner)Who interpreted images
... baseLocation ∑0..*BackboneElementStudy access service endpoint
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... type ∑1..1CodingWADO-RS | WADO-URI | IID
Binding: dWebType (extensible)
.... url ∑1..1uriStudy access URL
... numberOfSeries ∑1..1unsignedIntNumber of Study Related Series
... numberOfInstances ∑1..1unsignedIntNumber of Study Related Instances
... procedure S0..*Reference(Procedure)Type of procedure performed
... reason ∑0..1CodeableConceptReason for study
Binding: (unbound) (example)
... description ∑0..1stringInstitution-generated description
... series ∑0..*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: urn:oid:2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number ∑0..1unsignedIntNumeric identifier of this series
Example: 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: CT Surview 180
.... numberOfInstances ∑1..1unsignedIntNumber of Series Related Instances
.... availability ∑0..1codeONLINE | OFFLINE | NEARLINE | UNAVAILABLE
Binding: InstanceAvailability (required)
.... baseLocation ∑0..*BackboneElementSeries access endpoint
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... type ∑1..1CodingWADO-RS | WADO-URI | IID
Binding: dWebType (extensible)
..... url ∑1..1uriSeries access URL
.... 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
.... instance 0..*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: urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092903
..... number 0..1unsignedIntThe number of this instance in the series
Example: 1
..... sopClass 1..1oidDICOM class type
Example: urn:oid:1.2.840.10008.5.1.4.1.1.2
..... title 0..1stringDescription of instance

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
ImagingStudy.languageCommon LanguagesextensibleCommon Languages
ImagingStudy.availabilityInstanceAvailabilityrequiredInstanceAvailability
ImagingStudy.modalityListAcquisition Modality CodesextensibleAcquisition Modality Codes
ImagingStudy.baseLocation.typedWebTypeextensibledWebType
ImagingStudy.reason?extexample
ImagingStudy.series.modalityAcquisition Modality CodesextensibleAcquisition Modality Codes
ImagingStudy.series.availabilityInstanceAvailabilityrequiredInstanceAvailability
ImagingStudy.series.baseLocation.typedWebTypeextensibledWebType
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
XPath: not(parent::f:contained and f:contained)
dom-1ImagingStudyIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4ImagingStudyIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3ImagingStudyIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
ele-1ImagingStudy.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1ImagingStudy.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1ImagingStudy.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1ImagingStudy.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1ImagingStudy.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1ImagingStudy.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
.