FHIR Imaging ServiceRequest Profile IG
0.1.0 - ci-build International flag

FHIR Imaging ServiceRequest Profile IG, published by HL7 International / Imaging Integration. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/imaging-service-request-ig/ and changes regularly. See the Directory of published versions

Resource Profile: ImagingStudy - DICOM MWL Requested Procedure Mapping ( Experimental )

Official URL: http://hl7.org/fhir/uv/imaging-service-request-ig/StructureDefinition/requested-procedure-imaging-study Version: 0.1.0
Draft as of 2024-11-28 Computable Name: ImagingStudyRequestedProcedureProfile

DICOM MWL Requested Procedure Mapping to ImagingStudy

Usage:

Formal Views of Profile Content

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

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... Slices for identifier 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:studyInstanceUid 1..1 Identifier Identifiers for the whole study
..... system 1..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
... status 1..1 code registered | available | cancelled | entered-in-error | unknown
Required Pattern: registered
... subject 1..1 Reference(Patient - DICOM MWL Patient Mapping) Who or what is the subject of the study
... Slices for basedOn 1..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:reference
.... basedOn:imagingServiceRequestRef 1..1 Reference(ServiceRequest - DICOM MWL Imaging Service Request Mapping) Request fulfilled

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... 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 Identifier Identifiers for the whole study
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.


Required Pattern: registered
... subject Σ 1..1 Reference(Patient - DICOM MWL Patient Mapping) Who or what is the subject of the study
... encounter Σ 0..1 Reference(Encounter - DICOM MWL Visit Mapping) Encounter with which this imaging study is associated
... Slices for basedOn Σ 1..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:reference
.... basedOn:imagingServiceRequestRef Σ 1..1 Reference(ServiceRequest - DICOM MWL Imaging Service Request Mapping) Request fulfilled

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ImagingStudy.identifier:studyInstanceUid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
ImagingStudy.statusrequiredPattern: registered
http://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... 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
... 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 Identifier Identifiers for the whole study
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
..... value ΣC 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.


Required Pattern: registered
... 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 - DICOM MWL Patient Mapping) Who or what is the subject of the study
... encounter Σ 0..1 Reference(Encounter - DICOM MWL Visit Mapping) 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 Σ 1..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:reference
.... basedOn:imagingServiceRequestRef Σ 1..1 Reference(ServiceRequest - DICOM MWL Imaging Service Request Mapping) Request fulfilled
... partOf Σ 0..* Reference(Procedure) Part of referenced event
... referrer Σ 0..1 Reference(Practitioner | PractitionerRole) Referring physician
... endpoint Σ 0..* Reference(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
.... endpoint Σ 0..* Reference(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
.... performer Σ 0..* 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: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.

..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) Who performed the series
.... instance 0..* BackboneElement A single SOP instance from 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
..... 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.identifier:studyInstanceUid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
ImagingStudy.identifier:studyInstanceUid.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ImagingStudy.statusrequiredPattern: registered
http://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0
from the FHIR Standard
ImagingStudy.modalityextensibleModality
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html
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
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html
ImagingStudy.series.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
ImagingStudy.series.lateralityexampleLaterality
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_244.html
ImagingStudy.series.performer.functionextensibleImagingStudySeriesPerformerFunction
http://hl7.org/fhir/ValueSet/series-performer-function
from the FHIR Standard
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

This structure is derived from ImagingStudy

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImagingStudy.identifier
  • The element 1 is sliced based on the value of ImagingStudy.basedOn

Differential View

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... Slices for identifier 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:studyInstanceUid 1..1 Identifier Identifiers for the whole study
..... system 1..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
... status 1..1 code registered | available | cancelled | entered-in-error | unknown
Required Pattern: registered
... subject 1..1 Reference(Patient - DICOM MWL Patient Mapping) Who or what is the subject of the study
... Slices for basedOn 1..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:reference
.... basedOn:imagingServiceRequestRef 1..1 Reference(ServiceRequest - DICOM MWL Imaging Service Request Mapping) Request fulfilled

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... 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 Identifier Identifiers for the whole study
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.


Required Pattern: registered
... subject Σ 1..1 Reference(Patient - DICOM MWL Patient Mapping) Who or what is the subject of the study
... encounter Σ 0..1 Reference(Encounter - DICOM MWL Visit Mapping) Encounter with which this imaging study is associated
... Slices for basedOn Σ 1..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:reference
.... basedOn:imagingServiceRequestRef Σ 1..1 Reference(ServiceRequest - DICOM MWL Imaging Service Request Mapping) Request fulfilled

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ImagingStudy.identifier:studyInstanceUid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
ImagingStudy.statusrequiredPattern: registered
http://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... 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
... 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 Identifier Identifiers for the whole study
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
..... value ΣC 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.


Required Pattern: registered
... 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 - DICOM MWL Patient Mapping) Who or what is the subject of the study
... encounter Σ 0..1 Reference(Encounter - DICOM MWL Visit Mapping) 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 Σ 1..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
Slice: Unordered, Open by type:reference
.... basedOn:imagingServiceRequestRef Σ 1..1 Reference(ServiceRequest - DICOM MWL Imaging Service Request Mapping) Request fulfilled
... partOf Σ 0..* Reference(Procedure) Part of referenced event
... referrer Σ 0..1 Reference(Practitioner | PractitionerRole) Referring physician
... endpoint Σ 0..* Reference(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
.... endpoint Σ 0..* Reference(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
.... performer Σ 0..* 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: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.

..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) Who performed the series
.... instance 0..* BackboneElement A single SOP instance from 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
..... 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.identifier:studyInstanceUid.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
ImagingStudy.identifier:studyInstanceUid.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ImagingStudy.statusrequiredPattern: registered
http://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0
from the FHIR Standard
ImagingStudy.modalityextensibleModality
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html
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
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.html
ImagingStudy.series.bodySiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
ImagingStudy.series.lateralityexampleLaterality
http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_244.html
ImagingStudy.series.performer.functionextensibleImagingStudySeriesPerformerFunction
http://hl7.org/fhir/ValueSet/series-performer-function
from the FHIR Standard
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

This structure is derived from ImagingStudy

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImagingStudy.identifier
  • The element 1 is sliced based on the value of ImagingStudy.basedOn

 

Other representations of profile: CSV, Excel, Schematron