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: IM Imaging Study

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

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

This profile represents an imaging study instance.

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy C 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
Constraints: im-imagingstudy-01
... 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
.... identifier:studyInstanceUid Σ 1..1 ImStudyInstanceUidIdentifier Identifiers for the whole study
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... subject Σ 1..1 Reference(Patient (EU base) | Device) Who or what is the subject of the study
... Slices for basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession Σ 0..1 Reference(IM Imaging Order) Request fulfilled
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier ΣC 1..1 ImAccessionNumberIdentifier Logical reference, when literal reference is not known
... Slices for endpoint Σ 0..* Reference(Endpoint) Study access endpoint
Slice: Unordered, Open by profile:$this
.... endpoint:wado Σ 0..1 Reference(IM WADO Endpoint) Study access endpoint
.... endpoint:iid Σ 0..1 Reference(IM Image Viewer Endpoint) Study access endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImagingStudy.statusrequiredImagingStudyStatus
http://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingStudyIf 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-4errorImagingStudyIf 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-5errorImagingStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingStudyA 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()
im-imagingstudy-01warningImagingStudyA DICOM instance UID must start with 'urn:oid:'
: identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy C 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
Constraints: im-imagingstudy-01
... Slices for identifier 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:studyInstanceUid 1..1 ImStudyInstanceUidIdentifier Identifiers for the whole study
... subject 1..1 Reference(Patient (EU base) | Device) Who or what is the subject of the study
... Slices for basedOn 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession 0..1 Reference(IM Imaging Order) Request fulfilled
..... identifier 1..1 ImAccessionNumberIdentifier Logical reference, when literal reference is not known
.... endpoint:wado 0..1 Reference(IM WADO Endpoint) Study access endpoint
.... endpoint:iid 0..1 Reference(IM Image Viewer Endpoint) Study access endpoint
... series
.... Slices for endpoint 0..* Reference(Endpoint) Series access endpoint
Slice: Unordered, Open by profile:$this
..... endpoint:wado 0..1 Reference(IM WADO Endpoint) Series access endpoint
..... endpoint:iid 0..1 Reference(IM Image Viewer Endpoint) Series access endpoint
.... Slices for performer 0..* BackboneElement Who performed the series
Slice: Unordered, Open by type:actor
..... performer:All Slices Content/Rules for all slices
...... function 0..1 CodeableConcept Type of performance
Binding: Imaging Study Performer Type Value Set (extensible)
..... performer:performer 0..1 BackboneElement Who performed the series
...... function 0..1 CodeableConcept Type of performance
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRF
...... actor 1..1 Reference(PractitionerRole (EU base)) Who performed the series
..... performer:device 0..1 BackboneElement Who performed the series
...... function 0..1 CodeableConcept Type of performance
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: DEV
...... actor 1..1 Reference(Im Imaging Device) Who performed the series
..... performer:custodian 0..1 BackboneElement Who performed the series
...... function 0..1 CodeableConcept Type of performance
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: CST
...... actor 1..1 Reference(Organization (EU base)) Who performed the series
.... instance
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:instance-description 0..1 string Instance Description
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/instance-description

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ImagingStudy.series.performer.functionextensibleImImagingStudyPerformerTypeVS
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
im-imagingstudy-01warningImagingStudyA DICOM instance UID must start with 'urn:oid:'
: identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy C 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
Constraints: im-imagingstudy-01
... 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
... Slices for identifier Σ 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:studyInstanceUid Σ 1..1 ImStudyInstanceUidIdentifier Identifiers for the whole study
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality Σ 0..* CodeableConcept All of the distinct values for series' modalities
Binding: Modality (extensible): Type of acquired data in the instance.
... subject Σ 1..1 Reference(Patient (EU base) | Device) Who or what is the subject of the study
... encounter Σ 0..1 Reference(Encounter) Encounter with which this imaging study is associated
... started Σ 0..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... Slices for basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession Σ 0..1 Reference(IM Imaging Order) Request fulfilled
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 1..1 ImAccessionNumberIdentifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
... partOf Σ 0..* Reference(Procedure) Part of referenced event
... referrer Σ 0..1 Reference(Practitioner | PractitionerRole) Referring physician
... Slices for endpoint Σ 0..* Reference(Endpoint) Study access endpoint
Slice: Unordered, Open by profile:$this
.... endpoint:wado Σ 0..1 Reference(IM WADO Endpoint) Study access endpoint
.... endpoint:iid Σ 0..1 Reference(IM Image Viewer Endpoint) Study access endpoint
... numberOfSeries Σ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances Σ 0..1 unsignedInt Number of Study Related Instances
... procedure Σ 0..* CodeableReference(PlanDefinition | ActivityDefinition) The performed procedure or code
Binding: LOINC loinc-rsna-radiology-playbook (preferred): Use of RadLex is preferred
... location Σ 0..1 Reference(Location) Where ImagingStudy occurred
... reason Σ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) Why the study was requested / performed
Binding: ProcedureReasonCodes (example): The reason for the study.
... note Σ 0..* Annotation User-defined comments
... description Σ 0..1 string Institution-generated description
... series Σ 0..* BackboneElement Each study has one or more series of 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 Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality Σ 1..1 CodeableConcept The modality used for this series
Binding: Modality (extensible): Type of acquired data in the instance.
.... description Σ 0..1 string A short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ 0..1 unsignedInt Number of Series Related Instances
.... Slices for endpoint Σ 0..* Reference(Endpoint) Series access endpoint
Slice: Unordered, Open by profile:$this
..... endpoint:wado Σ 0..1 Reference(IM WADO Endpoint) Series access endpoint
..... endpoint:iid Σ 0..1 Reference(IM Image Viewer Endpoint) Series access endpoint
.... bodySite Σ 0..1 CodeableReference(BodyStructure) Body part examined
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
.... laterality Σ 0..1 CodeableConcept Body part laterality
Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).
.... specimen Σ 0..* Reference(Specimen) Specimen imaged
.... started Σ 0..1 dateTime When the series started
.... Slices for performer Σ 0..* BackboneElement Who performed the series
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 performance
Binding: Imaging Study Performer Type Value Set (extensible)
...... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) Who performed the series
..... performer:performer Σ 0..1 BackboneElement Who performed the series
...... 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 performance
Binding: Imaging Study Performer Type Value Set (extensible)
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRF
........ 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
...... actor Σ 1..1 Reference(PractitionerRole (EU base)) Who performed the series
..... performer:device Σ 0..1 BackboneElement Who performed the series
...... 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 performance
Binding: Imaging Study Performer Type Value Set (extensible)
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: DEV
........ 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
...... actor Σ 1..1 Reference(Im Imaging Device) Who performed the series
..... performer:custodian Σ 0..1 BackboneElement Who performed the series
...... 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 performance
Binding: Imaging Study Performer Type Value Set (extensible)
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: CST
........ 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
...... actor Σ 1..1 Reference(Organization (EU base)) Who performed the series
.... instance 0..* BackboneElement A single SOP instance from the series
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:instance-description 0..1 string Instance Description
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/instance-description
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance.
..... number 0..1 unsignedInt The number of this instance in the series
Example General: 1
..... title 0..1 string Description of instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ImagingStudy.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ImagingStudy.statusrequiredImagingStudyStatus
http://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0
From the FHIR Standard
ImagingStudy.modalityextensibleModality (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html
From this IG
ImagingStudy.basedOn:imorderaccession.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ImagingStudy.procedurepreferredLOINC loinc-rsna-radiology-playbook
http://loinc.org/vs/loinc-rsna-radiology-playbook
ImagingStudy.reasonexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
ImagingStudy.series.modalityextensibleModality (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html
From this IG
ImagingStudy.series.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
ImagingStudy.series.lateralityexampleLaterality (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_244.html
From this IG
ImagingStudy.series.performer.functionextensibleImImagingStudyPerformerTypeVS
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-type
From this IG
ImagingStudy.series.performer:performer.functionextensiblePattern Value: PRF
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-type
From this IG
ImagingStudy.series.performer:device.functionextensiblePattern Value: DEV
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-type
From this IG
ImagingStudy.series.performer:custodian.functionextensiblePattern Value: CST
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-type
From this IG
ImagingStudy.series.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

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingStudyIf 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-4errorImagingStudyIf 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-5errorImagingStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingStudyA 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()
im-imagingstudy-01warningImagingStudyA DICOM instance UID must start with 'urn:oid:'
: identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')

This structure is derived from ImagingStudy

Summary

Mandatory: 2 elements(1 nested mandatory element)

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 ImagingStudy.identifier
  • The element 1 is sliced based on the value of ImagingStudy.basedOn
  • The element 1 is sliced based on the value of ImagingStudy.endpoint
  • The element 1 is sliced based on the value of ImagingStudy.series.endpoint
  • The element 1 is sliced based on the value of ImagingStudy.series.performer

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy C 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
Constraints: im-imagingstudy-01
... 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
.... identifier:studyInstanceUid Σ 1..1 ImStudyInstanceUidIdentifier Identifiers for the whole study
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... subject Σ 1..1 Reference(Patient (EU base) | Device) Who or what is the subject of the study
... Slices for basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession Σ 0..1 Reference(IM Imaging Order) Request fulfilled
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier ΣC 1..1 ImAccessionNumberIdentifier Logical reference, when literal reference is not known
... Slices for endpoint Σ 0..* Reference(Endpoint) Study access endpoint
Slice: Unordered, Open by profile:$this
.... endpoint:wado Σ 0..1 Reference(IM WADO Endpoint) Study access endpoint
.... endpoint:iid Σ 0..1 Reference(IM Image Viewer Endpoint) Study access endpoint

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ImagingStudy.statusrequiredImagingStudyStatus
http://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingStudyIf 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-4errorImagingStudyIf 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-5errorImagingStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingStudyA 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()
im-imagingstudy-01warningImagingStudyA DICOM instance UID must start with 'urn:oid:'
: identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')

Differential View

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy C 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
Constraints: im-imagingstudy-01
... Slices for identifier 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:studyInstanceUid 1..1 ImStudyInstanceUidIdentifier Identifiers for the whole study
... subject 1..1 Reference(Patient (EU base) | Device) Who or what is the subject of the study
... Slices for basedOn 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession 0..1 Reference(IM Imaging Order) Request fulfilled
..... identifier 1..1 ImAccessionNumberIdentifier Logical reference, when literal reference is not known
.... endpoint:wado 0..1 Reference(IM WADO Endpoint) Study access endpoint
.... endpoint:iid 0..1 Reference(IM Image Viewer Endpoint) Study access endpoint
... series
.... Slices for endpoint 0..* Reference(Endpoint) Series access endpoint
Slice: Unordered, Open by profile:$this
..... endpoint:wado 0..1 Reference(IM WADO Endpoint) Series access endpoint
..... endpoint:iid 0..1 Reference(IM Image Viewer Endpoint) Series access endpoint
.... Slices for performer 0..* BackboneElement Who performed the series
Slice: Unordered, Open by type:actor
..... performer:All Slices Content/Rules for all slices
...... function 0..1 CodeableConcept Type of performance
Binding: Imaging Study Performer Type Value Set (extensible)
..... performer:performer 0..1 BackboneElement Who performed the series
...... function 0..1 CodeableConcept Type of performance
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRF
...... actor 1..1 Reference(PractitionerRole (EU base)) Who performed the series
..... performer:device 0..1 BackboneElement Who performed the series
...... function 0..1 CodeableConcept Type of performance
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: DEV
...... actor 1..1 Reference(Im Imaging Device) Who performed the series
..... performer:custodian 0..1 BackboneElement Who performed the series
...... function 0..1 CodeableConcept Type of performance
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: CST
...... actor 1..1 Reference(Organization (EU base)) Who performed the series
.... instance
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:instance-description 0..1 string Instance Description
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/instance-description

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ImagingStudy.series.performer.functionextensibleImImagingStudyPerformerTypeVS
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-type
From this IG

Constraints

IdGradePath(s)DetailsRequirements
im-imagingstudy-01warningImagingStudyA DICOM instance UID must start with 'urn:oid:'
: identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy C 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
Constraints: im-imagingstudy-01
... 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
... Slices for identifier Σ 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:studyInstanceUid Σ 1..1 ImStudyInstanceUidIdentifier Identifiers for the whole study
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality Σ 0..* CodeableConcept All of the distinct values for series' modalities
Binding: Modality (extensible): Type of acquired data in the instance.
... subject Σ 1..1 Reference(Patient (EU base) | Device) Who or what is the subject of the study
... encounter Σ 0..1 Reference(Encounter) Encounter with which this imaging study is associated
... started Σ 0..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... Slices for basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:$this
.... basedOn:imorderaccession Σ 0..1 Reference(IM Imaging Order) Request fulfilled
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier ΣC 1..1 ImAccessionNumberIdentifier Logical reference, when literal reference is not known
..... display ΣC 0..1 string Text alternative for the resource
... partOf Σ 0..* Reference(Procedure) Part of referenced event
... referrer Σ 0..1 Reference(Practitioner | PractitionerRole) Referring physician
... Slices for endpoint Σ 0..* Reference(Endpoint) Study access endpoint
Slice: Unordered, Open by profile:$this
.... endpoint:wado Σ 0..1 Reference(IM WADO Endpoint) Study access endpoint
.... endpoint:iid Σ 0..1 Reference(IM Image Viewer Endpoint) Study access endpoint
... numberOfSeries Σ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances Σ 0..1 unsignedInt Number of Study Related Instances
... procedure Σ 0..* CodeableReference(PlanDefinition | ActivityDefinition) The performed procedure or code
Binding: LOINC loinc-rsna-radiology-playbook (preferred): Use of RadLex is preferred
... location Σ 0..1 Reference(Location) Where ImagingStudy occurred
... reason Σ 0..* CodeableReference(Condition | Observation | DiagnosticReport | DocumentReference) Why the study was requested / performed
Binding: ProcedureReasonCodes (example): The reason for the study.
... note Σ 0..* Annotation User-defined comments
... description Σ 0..1 string Institution-generated description
... series Σ 0..* BackboneElement Each study has one or more series of 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 Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality Σ 1..1 CodeableConcept The modality used for this series
Binding: Modality (extensible): Type of acquired data in the instance.
.... description Σ 0..1 string A short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ 0..1 unsignedInt Number of Series Related Instances
.... Slices for endpoint Σ 0..* Reference(Endpoint) Series access endpoint
Slice: Unordered, Open by profile:$this
..... endpoint:wado Σ 0..1 Reference(IM WADO Endpoint) Series access endpoint
..... endpoint:iid Σ 0..1 Reference(IM Image Viewer Endpoint) Series access endpoint
.... bodySite Σ 0..1 CodeableReference(BodyStructure) Body part examined
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
.... laterality Σ 0..1 CodeableConcept Body part laterality
Binding: Laterality (example): Codes describing body site laterality (left, right, etc.).
.... specimen Σ 0..* Reference(Specimen) Specimen imaged
.... started Σ 0..1 dateTime When the series started
.... Slices for performer Σ 0..* BackboneElement Who performed the series
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 performance
Binding: Imaging Study Performer Type Value Set (extensible)
...... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) Who performed the series
..... performer:performer Σ 0..1 BackboneElement Who performed the series
...... 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 performance
Binding: Imaging Study Performer Type Value Set (extensible)
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: PRF
........ 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
...... actor Σ 1..1 Reference(PractitionerRole (EU base)) Who performed the series
..... performer:device Σ 0..1 BackboneElement Who performed the series
...... 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 performance
Binding: Imaging Study Performer Type Value Set (extensible)
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: DEV
........ 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
...... actor Σ 1..1 Reference(Im Imaging Device) Who performed the series
..... performer:custodian Σ 0..1 BackboneElement Who performed the series
...... 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 performance
Binding: Imaging Study Performer Type Value Set (extensible)
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://terminology.hl7.org/CodeSystem/v3-ParticipationType
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: CST
........ 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
...... actor Σ 1..1 Reference(Organization (EU base)) Who performed the series
.... instance 0..* BackboneElement A single SOP instance from the series
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:instance-description 0..1 string Instance Description
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/instance-description
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance.
..... number 0..1 unsignedInt The number of this instance in the series
Example General: 1
..... title 0..1 string Description of instance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ImagingStudy.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ImagingStudy.statusrequiredImagingStudyStatus
http://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0
From the FHIR Standard
ImagingStudy.modalityextensibleModality (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html
From this IG
ImagingStudy.basedOn:imorderaccession.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ImagingStudy.procedurepreferredLOINC loinc-rsna-radiology-playbook
http://loinc.org/vs/loinc-rsna-radiology-playbook
ImagingStudy.reasonexampleProcedureReasonCodes
http://hl7.org/fhir/ValueSet/procedure-reason
From the FHIR Standard
ImagingStudy.series.modalityextensibleModality (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html
From this IG
ImagingStudy.series.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
From the FHIR Standard
ImagingStudy.series.lateralityexampleLaterality (missing link)
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_244.html
From this IG
ImagingStudy.series.performer.functionextensibleImImagingStudyPerformerTypeVS
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-type
From this IG
ImagingStudy.series.performer:performer.functionextensiblePattern Value: PRF
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-type
From this IG
ImagingStudy.series.performer:device.functionextensiblePattern Value: DEV
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-type
From this IG
ImagingStudy.series.performer:custodian.functionextensiblePattern Value: CST
http://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-type
From this IG
ImagingStudy.series.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

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImagingStudyIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImagingStudyIf 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-4errorImagingStudyIf 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-5errorImagingStudyIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImagingStudyA 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()
im-imagingstudy-01warningImagingStudyA DICOM instance UID must start with 'urn:oid:'
: identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:')

This structure is derived from ImagingStudy

Summary

Mandatory: 2 elements(1 nested mandatory element)

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 ImagingStudy.identifier
  • The element 1 is sliced based on the value of ImagingStudy.basedOn
  • The element 1 is sliced based on the value of ImagingStudy.endpoint
  • The element 1 is sliced based on the value of ImagingStudy.series.endpoint
  • The element 1 is sliced based on the value of ImagingStudy.series.performer

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron