Manifest-based Access to DICOM Objects (MADO) Profile (FHIR-R5 elements)
0.2.1-build - ci-build 150

Manifest-based Access to DICOM Objects (MADO) Profile (FHIR-R5 elements), published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.1-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging-manifest/ and changes regularly. See the Directory of published versions

Resource Profile: ImagingSelection: Key image

Official URL: http://hl7.eu/fhir/imaging-manifest-r5/StructureDefinition/ImKeyImageImagingSelection Version: 0.2.1-build
Standards status: Draft Draft as of 2026-01-23 Maturity Level: 1 Computable Name: ImKeyImageImagingSelection

Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).

Key images represented as an ImagingSelection, it refers to minimal 1 instance.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection 0..* ImImagingSelection 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:title 0..1 markdown Key image title
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:description 0..1 string Key Image description
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
.... extension:kin-instance 0..1 (Complex) KIN
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
..... value[x] 1..1 RelatedArtifact Value of extension
...... type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: derived-from
...... resourceReference Σ 1..1 Reference(ImagingSelection) What artifact, if not a conformance resource
... status ?!Σ 1..1 code available | entered-in-error | unknown
Binding: ImagingSelectionStatus (required): The status of the ImagingSelection.
... Slices for performer Σ 0..* BackboneElement Selector of the instances (human or machine)
Slice: Unordered, Open by type:actor
.... performer:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... performer:performer Σ 0..1 BackboneElement Selector of the instances (human or machine)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 0..1 Reference(PractitionerRole | Practitioner) Author (human or machine)
.... performer:device Σ 0..1 BackboneElement Selector of the instances (human or machine)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 0..1 Reference(Device: Imaging Acquisition Device) Author (human or machine)
... Slices for category Σ 1..* CodeableConcept Classifies the imaging selection
Slice: Unordered, Open by value:$this
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.
.... category:key-image Σ 1..1 CodeableConcept Classifies the imaging selection
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 55113-5
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept Imaging Selection purpose text or code
Binding: https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html (extensible)
... 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(ImagingStudy: Manifest Imaging Study) The imaging study from which the imaging selection is derived
... seriesUid Σ 1..1 id DICOM Series Instance UID
Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.1
... instance Σ 1..* BackboneElement The selected instances
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingSelection.extension:kin-instance.​value[x].type Base required RelatedArtifactType 📍5.0.0 FHIR Std.
ImagingSelection.status Base required Imaging Selection Status 📍5.0.0 FHIR Std.
ImagingSelection.category Base example ​ KeyObjectSelectionDocumentTitle (missing link) 📦2022.4.20221006 This IG
ImagingSelection.category:key-image Base example ​ KeyObjectSelectionDocumentTitle (missing link) 📦2022.4.20221006 This IG
ImagingSelection.code Base extensible https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html Not State Unknown

Constraints

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection 0..* ImImagingSelection A selection of DICOM SOP instances and/or frames
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:title 0..1 markdown Key image title
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:description 0..1 string Key Image description
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
.... extension:kin-instance 0..1 (Complex) KIN
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... extension 0..0 Extension
..... value[x]
...... type 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Required Pattern: derived-from
...... document 0..0 What document is being referenced
...... resource 0..0 What artifact is being referenced
...... resourceReference 1..1 Reference(ImagingSelection) What artifact, if not a conformance resource
... Slices for performer 0..* BackboneElement Selector of the instances (human or machine)
Slice: Unordered, Open by type:actor
.... performer:performer 0..1 BackboneElement Selector of the instances (human or machine)
..... actor 0..1 Reference(PractitionerRole | Practitioner) Author (human or machine)
.... performer:device 0..1 BackboneElement Selector of the instances (human or machine)
..... actor 0..1 Reference(Device: Imaging Acquisition Device) Author (human or machine)
... Slices for category 1..* CodeableConcept Classifies the imaging selection
Slice: Unordered, Open by value:$this
.... category:key-image 1..1 CodeableConcept Classifies the imaging selection
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 55113-5
... seriesUid 1..1 id DICOM Series Instance UID
... instance 1..* BackboneElement The selected instances

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImagingSelection.code Base extensible https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html Not State Unknown
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection 0..* ImImagingSelection 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:title 0..1 markdown Key image title
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:description 0..1 string Key Image description
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
.... extension:kin-instance 0..1 (Complex) KIN
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
..... value[x] 1..1 RelatedArtifact Value of extension
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: derived-from
...... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
...... label Σ 0..1 string Short label
...... display Σ 0..1 string Brief description of the related artifact
...... citation Σ 0..1 markdown Bibliographic citation for the artifact
...... resourceReference Σ 1..1 Reference(ImagingSelection) What artifact, if not a conformance resource
...... publicationStatus Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): Publication status of an artifact being referred to.
...... publicationDate Σ 0..1 date Date of publication of the artifact being referred to
... 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: Imaging Patient) Subject of the selected instances
... issued Σ 0..1 instant Date / Time when this imaging selection was created
... Slices for performer Σ 0..* BackboneElement Selector of the instances (human or machine)
Slice: Unordered, Open by type:actor
.... performer:All Slices Content/Rules for all slices
..... 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)
.... performer:performer Σ 0..1 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(PractitionerRole | Practitioner) Author (human or machine)
.... performer:device Σ 0..1 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(Device: Imaging Acquisition Device) Author (human or machine)
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Associated request
... Slices for category Σ 1..* CodeableConcept Classifies the imaging selection
Slice: Unordered, Open by value:$this
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.
.... category:key-image Σ 1..1 CodeableConcept Classifies the imaging selection
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 55113-5
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept Imaging Selection purpose text or code
Binding: https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html (extensible)
... 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(ImagingStudy: Manifest 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 Σ 1..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 Σ 1..* 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

Path Status Usage ValueSet Version Source
ImagingSelection.language Base required All Languages 📍5.0.0 FHIR Std.
ImagingSelection.extension:kin-instance.​value[x].type Base required RelatedArtifactType 📍5.0.0 FHIR Std.
ImagingSelection.extension:kin-instance.​value[x].classifier Base example Citation Artifact Classifier 📍5.0.0 FHIR Std.
ImagingSelection.extension:kin-instance.​value[x].publicationStatus Base required PublicationStatus 📍5.0.0 FHIR Std.
ImagingSelection.status Base required Imaging Selection Status 📍5.0.0 FHIR Std.
ImagingSelection.performer.​function Base extensible ImagingStudy series performer function 📍5.0.0 FHIR Std.
ImagingSelection.performer:performer.​function Base extensible ImagingStudy series performer function 📍5.0.0 FHIR Std.
ImagingSelection.performer:device.​function Base extensible ImagingStudy series performer function 📍5.0.0 FHIR Std.
ImagingSelection.category Base example ​ KeyObjectSelectionDocumentTitle (missing link) 📦2022.4.20221006 This IG
ImagingSelection.category:key-image Base example ​ KeyObjectSelectionDocumentTitle (missing link) 📦2022.4.20221006 This IG
ImagingSelection.code Base extensible https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html Not State Unknown
ImagingSelection.bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
ImagingSelection.instance.​sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown
ImagingSelection.instance.​imageRegion2D.regionType Base required Imaging Selection2 D Graphic Type 📍5.0.0 FHIR Std.
ImagingSelection.instance.​imageRegion3D.regionType Base required Imaging Selection3 D Graphic Type 📍5.0.0 FHIR Std.

Constraints

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

Summary

Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection 0..* ImImagingSelection 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:title 0..1 markdown Key image title
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:description 0..1 string Key Image description
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
.... extension:kin-instance 0..1 (Complex) KIN
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
..... value[x] 1..1 RelatedArtifact Value of extension
...... type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: derived-from
...... resourceReference Σ 1..1 Reference(ImagingSelection) What artifact, if not a conformance resource
... status ?!Σ 1..1 code available | entered-in-error | unknown
Binding: ImagingSelectionStatus (required): The status of the ImagingSelection.
... Slices for performer Σ 0..* BackboneElement Selector of the instances (human or machine)
Slice: Unordered, Open by type:actor
.... performer:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... performer:performer Σ 0..1 BackboneElement Selector of the instances (human or machine)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 0..1 Reference(PractitionerRole | Practitioner) Author (human or machine)
.... performer:device Σ 0..1 BackboneElement Selector of the instances (human or machine)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 0..1 Reference(Device: Imaging Acquisition Device) Author (human or machine)
... Slices for category Σ 1..* CodeableConcept Classifies the imaging selection
Slice: Unordered, Open by value:$this
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.
.... category:key-image Σ 1..1 CodeableConcept Classifies the imaging selection
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 55113-5
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept Imaging Selection purpose text or code
Binding: https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html (extensible)
... 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(ImagingStudy: Manifest Imaging Study) The imaging study from which the imaging selection is derived
... seriesUid Σ 1..1 id DICOM Series Instance UID
Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.1
... instance Σ 1..* BackboneElement The selected instances
.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingSelection.extension:kin-instance.​value[x].type Base required RelatedArtifactType 📍5.0.0 FHIR Std.
ImagingSelection.status Base required Imaging Selection Status 📍5.0.0 FHIR Std.
ImagingSelection.category Base example ​ KeyObjectSelectionDocumentTitle (missing link) 📦2022.4.20221006 This IG
ImagingSelection.category:key-image Base example ​ KeyObjectSelectionDocumentTitle (missing link) 📦2022.4.20221006 This IG
ImagingSelection.code Base extensible https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html Not State Unknown

Constraints

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

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection 0..* ImImagingSelection A selection of DICOM SOP instances and/or frames
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:title 0..1 markdown Key image title
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:description 0..1 string Key Image description
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
.... extension:kin-instance 0..1 (Complex) KIN
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... extension 0..0 Extension
..... value[x]
...... type 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Required Pattern: derived-from
...... document 0..0 What document is being referenced
...... resource 0..0 What artifact is being referenced
...... resourceReference 1..1 Reference(ImagingSelection) What artifact, if not a conformance resource
... Slices for performer 0..* BackboneElement Selector of the instances (human or machine)
Slice: Unordered, Open by type:actor
.... performer:performer 0..1 BackboneElement Selector of the instances (human or machine)
..... actor 0..1 Reference(PractitionerRole | Practitioner) Author (human or machine)
.... performer:device 0..1 BackboneElement Selector of the instances (human or machine)
..... actor 0..1 Reference(Device: Imaging Acquisition Device) Author (human or machine)
... Slices for category 1..* CodeableConcept Classifies the imaging selection
Slice: Unordered, Open by value:$this
.... category:key-image 1..1 CodeableConcept Classifies the imaging selection
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 55113-5
... seriesUid 1..1 id DICOM Series Instance UID
... instance 1..* BackboneElement The selected instances

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImagingSelection.code Base extensible https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html Not State Unknown

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingSelection 0..* ImImagingSelection 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:title 0..1 markdown Key image title
URL: http://hl7.org/fhir/StructureDefinition/artifact-description
.... extension:description 0..1 string Key Image description
URL: http://hl7.org/fhir/StructureDefinition/artifact-title
.... extension:kin-instance 0..1 (Complex) KIN
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
..... value[x] 1..1 RelatedArtifact Value of extension
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
Required Pattern: derived-from
...... classifier Σ 0..* CodeableConcept Additional classifiers
Binding: CitationArtifactClassifier (example): Additional classifiers for the related artifact.
...... label Σ 0..1 string Short label
...... display Σ 0..1 string Brief description of the related artifact
...... citation Σ 0..1 markdown Bibliographic citation for the artifact
...... resourceReference Σ 1..1 Reference(ImagingSelection) What artifact, if not a conformance resource
...... publicationStatus Σ 0..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): Publication status of an artifact being referred to.
...... publicationDate Σ 0..1 date Date of publication of the artifact being referred to
... 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: Imaging Patient) Subject of the selected instances
... issued Σ 0..1 instant Date / Time when this imaging selection was created
... Slices for performer Σ 0..* BackboneElement Selector of the instances (human or machine)
Slice: Unordered, Open by type:actor
.... performer:All Slices Content/Rules for all slices
..... 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)
.... performer:performer Σ 0..1 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(PractitionerRole | Practitioner) Author (human or machine)
.... performer:device Σ 0..1 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(Device: Imaging Acquisition Device) Author (human or machine)
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Associated request
... Slices for category Σ 1..* CodeableConcept Classifies the imaging selection
Slice: Unordered, Open by value:$this
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.
.... category:key-image Σ 1..1 CodeableConcept Classifies the imaging selection
Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title.

Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 55113-5
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 0..1 string Plain text representation of the concept
... code Σ 1..1 CodeableConcept Imaging Selection purpose text or code
Binding: https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html (extensible)
... 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(ImagingStudy: Manifest 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 Σ 1..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 Σ 1..* 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

Path Status Usage ValueSet Version Source
ImagingSelection.language Base required All Languages 📍5.0.0 FHIR Std.
ImagingSelection.extension:kin-instance.​value[x].type Base required RelatedArtifactType 📍5.0.0 FHIR Std.
ImagingSelection.extension:kin-instance.​value[x].classifier Base example Citation Artifact Classifier 📍5.0.0 FHIR Std.
ImagingSelection.extension:kin-instance.​value[x].publicationStatus Base required PublicationStatus 📍5.0.0 FHIR Std.
ImagingSelection.status Base required Imaging Selection Status 📍5.0.0 FHIR Std.
ImagingSelection.performer.​function Base extensible ImagingStudy series performer function 📍5.0.0 FHIR Std.
ImagingSelection.performer:performer.​function Base extensible ImagingStudy series performer function 📍5.0.0 FHIR Std.
ImagingSelection.performer:device.​function Base extensible ImagingStudy series performer function 📍5.0.0 FHIR Std.
ImagingSelection.category Base example ​ KeyObjectSelectionDocumentTitle (missing link) 📦2022.4.20221006 This IG
ImagingSelection.category:key-image Base example ​ KeyObjectSelectionDocumentTitle (missing link) 📦2022.4.20221006 This IG
ImagingSelection.code Base extensible https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_7010.html Not State Unknown
ImagingSelection.bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
ImagingSelection.instance.​sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown
ImagingSelection.instance.​imageRegion2D.regionType Base required Imaging Selection2 D Graphic Type 📍5.0.0 FHIR Std.
ImagingSelection.instance.​imageRegion3D.regionType Base required Imaging Selection3 D Graphic Type 📍5.0.0 FHIR Std.

Constraints

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

Summary

Mandatory: 4 elements(1 nested mandatory element)
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron