HL7 Europe Imaging Study Report
0.1.0-ballot - ci-build 150

HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/oijauregui/ehdsimaging/tree/master and changes regularly. See the Directory of published versions

Resource Profile: Imaging Selection

Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/ImImagingSelection Version: 0.1.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: ImImagingSelection

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

Imaging Selection

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection 0..* ImagingSelection A selection of DICOM SOP instances and/or frames
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... subject Σ 0..1 Reference(Patient (EU base)) Subject of the selected instances
... code Σ 1..1 CodeableConcept Imaging Selection purpose text or code
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.
... Slices for derivedFrom Σ 1..* Reference(ImagingStudy | DocumentReference) The imaging study from which the imaging selection is derived
Slice: Unordered, Open by profile:$this
.... derivedFrom:study Σ 1..1 Reference(IM Imaging Study) The imaging study from which the imaging selection is derived

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImagingSelection.statusrequiredImagingSelectionStatus
http://hl7.org/fhir/ValueSet/imagingselection-status|5.0.0
From the FHIR Standard
ImagingSelection.codeexampleKeyObjectSelectionDocumentTitle (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingSelectionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingSelectionIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImagingSelectionIf 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-5errorImagingSelectionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingSelectionA 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()

This structure is derived from ImagingSelection

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection ImagingSelection
... subject 0..1 Reference(Patient (EU base)) Subject of the selected instances
... Slices for derivedFrom 1..* Reference(ImagingStudy | DocumentReference) The imaging study from which the imaging selection is derived
Slice: Unordered, Open by profile:$this
.... derivedFrom:study 1..1 Reference(IM Imaging Study) The imaging study from which the imaging selection is derived

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection 0..* ImagingSelection A selection of DICOM SOP instances and/or frames
... 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
... 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 Σ 0..* Identifier Business Identifier for Imaging Selection
... status ?!Σ 1..1 code available | entered-in-error | unknown
Binding: ImagingSelectionStatus (required): The status of the ImagingSelection.
... subject Σ 0..1 Reference(Patient (EU base)) Subject of the selected instances
... issued Σ 0..1 instant Date / Time when this imaging selection was created
... performer Σ 0..* BackboneElement Selector of the instances (human or machine)
.... 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 performer
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.
.... actor Σ 0..1 Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService) Author (human or machine)
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Associated request
... category Σ 0..* CodeableConcept Classifies the imaging selection
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.
... code Σ 1..1 CodeableConcept Imaging Selection purpose text or code
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.
... studyUid Σ 0..1 id DICOM Study Instance UID
Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793
... Slices for derivedFrom Σ 1..* Reference(ImagingStudy | DocumentReference) The imaging study from which the imaging selection is derived
Slice: Unordered, Open by profile:$this
.... derivedFrom:study Σ 1..1 Reference(IM Imaging Study) The imaging study from which the imaging selection is derived
... endpoint Σ 0..* Reference(Endpoint) The network service providing retrieval for the images referenced in the imaging selection
... seriesUid Σ 0..1 id DICOM Series Instance UID
Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.1
... seriesNumber Σ 0..1 unsignedInt DICOM Series Number
... frameOfReferenceUid Σ 0..1 id The Frame of Reference UID for the selected images
Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.2
... bodySite Σ 0..1 CodeableReference(BodyStructure) Body part examined
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
... focus Σ 0..* Reference(ImagingSelection) Related resource that is the focus for the imaging selection
... instance Σ 0..* BackboneElement The selected instances
.... 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 Σ 1..1 id DICOM SOP Instance UID
Example General: 1.2.840.113747.20080222.12753225430534207568475333748793.1.1
.... number Σ 0..1 unsignedInt DICOM Instance Number
.... sopClass 0..1 Coding DICOM SOP Class UID
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): DICOM SOP Classes.
Example General: 1.2.840.10008.5.1.4.1.1.2
.... subset 0..* string The selected subset of the SOP Instance

Example General: 6
.... imageRegion2D 0..* BackboneElement A specific 2D region in a DICOM image / frame
..... 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
..... regionType 1..1 code point | polyline | interpolated | circle | ellipse
Binding: ImagingSelection2DGraphicType (required): The type of image region.
..... coordinate 1..* decimal Specifies the coordinates that define the image region
This repeating element order: The values are an ordered set of (x, y) coordinates.
.... imageRegion3D 0..* BackboneElement A specific 3D region in a DICOM frame of reference
..... 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
..... regionType 1..1 code point | multipoint | polyline | polygon | ellipse | ellipsoid
Binding: ImagingSelection3DGraphicType (required): The type of image region.
..... coordinate 1..* decimal Specifies the coordinates that define the image region
This repeating element order: The values are an ordered set of (x, y, z) coordinates.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImagingSelection.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ImagingSelection.statusrequiredImagingSelectionStatus
http://hl7.org/fhir/ValueSet/imagingselection-status|5.0.0
From the FHIR Standard
ImagingSelection.performer.functionextensibleImagingStudySeriesPerformerFunction
http://hl7.org/fhir/ValueSet/series-performer-function
From the FHIR Standard
ImagingSelection.categoryexampleKeyObjectSelectionDocumentTitle (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html
From this IG
ImagingSelection.codeexampleKeyObjectSelectionDocumentTitle (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html
From this IG
ImagingSelection.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
ImagingSelection.instance.sopClassextensiblehttp://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
ImagingSelection.instance.imageRegion2D.regionTyperequiredImagingSelection2DGraphicType
http://hl7.org/fhir/ValueSet/imagingselection-2dgraphictype|5.0.0
From the FHIR Standard
ImagingSelection.instance.imageRegion3D.regionTyperequiredImagingSelection3DGraphicType
http://hl7.org/fhir/ValueSet/imagingselection-3dgraphictype|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingSelectionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingSelectionIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImagingSelectionIf 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-5errorImagingSelectionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingSelectionA 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()

This structure is derived from ImagingSelection

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImagingSelection.derivedFrom

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection 0..* ImagingSelection A selection of DICOM SOP instances and/or frames
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... subject Σ 0..1 Reference(Patient (EU base)) Subject of the selected instances
... code Σ 1..1 CodeableConcept Imaging Selection purpose text or code
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.
... Slices for derivedFrom Σ 1..* Reference(ImagingStudy | DocumentReference) The imaging study from which the imaging selection is derived
Slice: Unordered, Open by profile:$this
.... derivedFrom:study Σ 1..1 Reference(IM Imaging Study) The imaging study from which the imaging selection is derived

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImagingSelection.statusrequiredImagingSelectionStatus
http://hl7.org/fhir/ValueSet/imagingselection-status|5.0.0
From the FHIR Standard
ImagingSelection.codeexampleKeyObjectSelectionDocumentTitle (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingSelectionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingSelectionIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImagingSelectionIf 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-5errorImagingSelectionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingSelectionA 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()

Differential View

This structure is derived from ImagingSelection

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection ImagingSelection
... subject 0..1 Reference(Patient (EU base)) Subject of the selected instances
... Slices for derivedFrom 1..* Reference(ImagingStudy | DocumentReference) The imaging study from which the imaging selection is derived
Slice: Unordered, Open by profile:$this
.... derivedFrom:study 1..1 Reference(IM Imaging Study) The imaging study from which the imaging selection is derived

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection 0..* ImagingSelection A selection of DICOM SOP instances and/or frames
... 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
... 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 Σ 0..* Identifier Business Identifier for Imaging Selection
... status ?!Σ 1..1 code available | entered-in-error | unknown
Binding: ImagingSelectionStatus (required): The status of the ImagingSelection.
... subject Σ 0..1 Reference(Patient (EU base)) Subject of the selected instances
... issued Σ 0..1 instant Date / Time when this imaging selection was created
... performer Σ 0..* BackboneElement Selector of the instances (human or machine)
.... 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 performer
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.
.... actor Σ 0..1 Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService) Author (human or machine)
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Associated request
... category Σ 0..* CodeableConcept Classifies the imaging selection
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.
... code Σ 1..1 CodeableConcept Imaging Selection purpose text or code
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.
... studyUid Σ 0..1 id DICOM Study Instance UID
Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793
... Slices for derivedFrom Σ 1..* Reference(ImagingStudy | DocumentReference) The imaging study from which the imaging selection is derived
Slice: Unordered, Open by profile:$this
.... derivedFrom:study Σ 1..1 Reference(IM Imaging Study) The imaging study from which the imaging selection is derived
... endpoint Σ 0..* Reference(Endpoint) The network service providing retrieval for the images referenced in the imaging selection
... seriesUid Σ 0..1 id DICOM Series Instance UID
Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.1
... seriesNumber Σ 0..1 unsignedInt DICOM Series Number
... frameOfReferenceUid Σ 0..1 id The Frame of Reference UID for the selected images
Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.2
... bodySite Σ 0..1 CodeableReference(BodyStructure) Body part examined
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
... focus Σ 0..* Reference(ImagingSelection) Related resource that is the focus for the imaging selection
... instance Σ 0..* BackboneElement The selected instances
.... 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 Σ 1..1 id DICOM SOP Instance UID
Example General: 1.2.840.113747.20080222.12753225430534207568475333748793.1.1
.... number Σ 0..1 unsignedInt DICOM Instance Number
.... sopClass 0..1 Coding DICOM SOP Class UID
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): DICOM SOP Classes.
Example General: 1.2.840.10008.5.1.4.1.1.2
.... subset 0..* string The selected subset of the SOP Instance

Example General: 6
.... imageRegion2D 0..* BackboneElement A specific 2D region in a DICOM image / frame
..... 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
..... regionType 1..1 code point | polyline | interpolated | circle | ellipse
Binding: ImagingSelection2DGraphicType (required): The type of image region.
..... coordinate 1..* decimal Specifies the coordinates that define the image region
This repeating element order: The values are an ordered set of (x, y) coordinates.
.... imageRegion3D 0..* BackboneElement A specific 3D region in a DICOM frame of reference
..... 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
..... regionType 1..1 code point | multipoint | polyline | polygon | ellipse | ellipsoid
Binding: ImagingSelection3DGraphicType (required): The type of image region.
..... coordinate 1..* decimal Specifies the coordinates that define the image region
This repeating element order: The values are an ordered set of (x, y, z) coordinates.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImagingSelection.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ImagingSelection.statusrequiredImagingSelectionStatus
http://hl7.org/fhir/ValueSet/imagingselection-status|5.0.0
From the FHIR Standard
ImagingSelection.performer.functionextensibleImagingStudySeriesPerformerFunction
http://hl7.org/fhir/ValueSet/series-performer-function
From the FHIR Standard
ImagingSelection.categoryexampleKeyObjectSelectionDocumentTitle (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html
From this IG
ImagingSelection.codeexampleKeyObjectSelectionDocumentTitle (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html
From this IG
ImagingSelection.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
ImagingSelection.instance.sopClassextensiblehttp://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
ImagingSelection.instance.imageRegion2D.regionTyperequiredImagingSelection2DGraphicType
http://hl7.org/fhir/ValueSet/imagingselection-2dgraphictype|5.0.0
From the FHIR Standard
ImagingSelection.instance.imageRegion3D.regionTyperequiredImagingSelection3DGraphicType
http://hl7.org/fhir/ValueSet/imagingselection-3dgraphictype|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingSelectionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingSelectionIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImagingSelectionIf 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-5errorImagingSelectionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingSelectionA 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()

This structure is derived from ImagingSelection

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImagingSelection.derivedFrom

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron