DICOM SR to FHIR Resource Mapping IG
0.1.0 - ci-build
DICOM SR to FHIR Resource Mapping IG
0.1.0 - ci-build
DICOM SR to FHIR Resource Mapping IG, published by HL7 Imaging Integration Working Group. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/dicom-sr/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/dicom-sr/StructureDefinition/volume-surface | Version: 0.1.0 | |||
| Draft as of 2023-06-13 | Computable Name: ImagingSelectionVolumeSurfaceProfile | |||
DICOM SR Image Volume Surface Mapping to ImagingSelection
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImagingSelection
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImagingSelection | 0..* | ImagingSelection | This is an abstract profile. A selection of DICOM SOP instances and/or frames | |
  subject | S | 1..1 | Reference(Patient) | Subject of the selected instances |
  Slices for basedOn | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Associated request Slice: Unordered, Open by type:reference | |
   basedOn:serviceRequestRef | S | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest |
   identifier | 0..1 | Identifier | The accession number related to the performed study | |
| type | 1..1 | CodeableConcept | Description of identifier 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/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
 display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
| value | 1..1 | string | The value that is unique | |
| code | S | 1..1 | CodeableConcept | Imaging Selection purpose text or code |
| coding | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 121231 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Volume Surface | |
| Slices for derivedFrom | 1..* | Reference(ImagingStudy | DocumentReference) | The imaging study from which the imaging selection is derived Slice: Unordered, Open by type:reference | |
| derivedFrom:imagingStudyRef | S | 1..1 | Reference(ImagingStudy) | Related ImagingStudy |
| identifier | 0..1 | Identifier | Identifier related to Study Instance UID | |
| type | 1..1 | CodeableConcept | Description of identifier 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://hl7.org/fhir/uv/dicom-sr/CodeSystem/dicom-identifier-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |
| system | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | |
| value | 1..1 | string | The value that is unique | |
| frameOfReferenceUid | S | 1..1 | id | The Frame of Reference UID for the selected images |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingSelection | 0..* | ImagingSelection | This is an abstract profile. A selection of DICOM SOP instances and/or frames | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | available | entered-in-error | unknown Binding: ImagingSelectionStatus (required): The status of the ImagingSelection. |
| subject | SΣ | 1..1 | Reference(Patient) | Subject of the selected instances |
| Slices for basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Associated request Slice: Unordered, Open by type:reference |
| basedOn:serviceRequestRef | SΣ | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest |
 reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
 identifier | ΣC | 0..1 | Identifier | The accession number related to the performed study |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 1..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. 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/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| code | SΣ | 1..1 | CodeableConcept | Imaging Selection purpose text or code Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. |
| coding | Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 121231 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Volume Surface | |
| Slices for derivedFrom | Σ | 1..* | Reference(ImagingStudy | DocumentReference) | The imaging study from which the imaging selection is derived Slice: Unordered, Open by type:reference |
| derivedFrom:imagingStudyRef | SΣ | 1..1 | Reference(ImagingStudy) | Related ImagingStudy |
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | ΣC | 0..1 | Identifier | Identifier related to Study Instance UID |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 1..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. 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://hl7.org/fhir/uv/dicom-sr/CodeSystem/dicom-identifier-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |
| system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| frameOfReferenceUid | SΣ | 1..1 | id | The Frame of Reference UID for the selected images Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.2 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ImagingSelection.status | required | ImagingSelectionStatus |
| ImagingSelection.basedOn:serviceRequestRef.identifier.use | required | IdentifierUse |
| ImagingSelection.basedOn:serviceRequestRef.identifier.type | extensible | Pattern: ACSN("Accession ID") |
| ImagingSelection.code | example | KeyObjectSelectionDocumentTitle |
| ImagingSelection.derivedFrom:imagingStudyRef.identifier.use | required | IdentifierUse |
| ImagingSelection.derivedFrom:imagingStudyRef.identifier.type | extensible | Pattern: study-instance-uid("Study Instance UID") |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingSelection | 0..* | ImagingSelection | This is an abstract profile. 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 |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| 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 |
| 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 | SΣ | 1..1 | Reference(Patient) | Subject of the selected instances |
| issued | Σ | 0..1 | instant | Date / Time when this imaging selection was created |
| performer | Σ | 0..* | BackboneElement | Selector of the instances (human or machine) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | Σ | 0..1 | CodeableConcept | Type of performer Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. |
| actor | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService) | Author (human or machine) |
| Slices for basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Associated request Slice: Unordered, Open by type:reference |
| basedOn:serviceRequestRef | SΣ | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest |
| 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 | 0..1 | Identifier | The accession number related to the performed 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 | Σ | 1..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. 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/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣC | 1..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) |
 display | ΣC | 0..1 | string | Text alternative for the resource |
| category | Σ | 0..* | CodeableConcept | Classifies the imaging selection Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. |
| code | SΣ | 1..1 | CodeableConcept | Imaging Selection purpose text or code Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
| 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://dicom.nema.org/resources/ontology/DCM | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 121231 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Volume Surface | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| 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 type:reference |
| derivedFrom:imagingStudyRef | SΣ | 1..1 | Reference(ImagingStudy) | Related ImagingStudy |
| 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 | 0..1 | Identifier | Identifier related to Study Instance UID |
| 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 | Σ | 1..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. 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://hl7.org/fhir/uv/dicom-sr/CodeSystem/dicom-identifier-type | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid |
| value | ΣC | 1..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) |
| display | ΣC | 0..1 | string | Text alternative for the resource |
| endpoint | Σ | 0..* | Reference(Endpoint) | The network service providing retrieval for the images referenced in the imaging selection |
| seriesUid | Σ | 0..1 | id | DICOM Series Instance UID Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.1 |
| seriesNumber | Σ | 0..1 | unsignedInt | DICOM Series Number |
| frameOfReferenceUid | SΣ | 1..1 | id | The Frame of Reference UID for the selected images Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.2 |
| bodySite | Σ | 0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts |
| focus | Σ | 0..* | Reference(ImagingSelection) | Related resource that is the focus for the imaging selection |
| instance | Σ | 0..* | BackboneElement | The selected instances |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| uid | Σ | 1..1 | id | DICOM SOP Instance UID Example General: 1.2.840.113747.20080222.12753225430534207568475333748793.1.1 |
| number | Σ | 0..1 | unsignedInt | DICOM Instance Number |
| sopClass | 0..1 | Coding | DICOM SOP Class UID Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): DICOM SOP Classes. Example General: 1.2.840.10008.5.1.4.1.1.2 | |
| subset | 0..* | string | The selected subset of the SOP Instance Example General: 6 | |
| imageRegion2D | 0..* | BackboneElement | A specific 2D region in a DICOM image / frame | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| regionType | 1..1 | code | point | polyline | interpolated | circle | ellipse Binding: ImagingSelection2DGraphicType (required): The type of image region. | |
| coordinate | 1..* | decimal | Specifies the coordinates that define the image region This repeating element order: The values are an ordered set of (x, y) coordinates. | |
| imageRegion3D | 0..* | BackboneElement | A specific 3D region in a DICOM frame of reference | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| regionType | 1..1 | code | point | multipoint | polyline | polygon | ellipse | ellipsoid Binding: ImagingSelection3DGraphicType (required): The type of image region. | |
| coordinate | 1..* | decimal | Specifies the coordinates that define the image region This repeating element order: The values are an ordered set of (x, y, z) coordinates. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ImagingSelection.language | required | AllLanguages |
| ImagingSelection.status | required | ImagingSelectionStatus |
| ImagingSelection.performer.function | extensible | ImagingStudySeriesPerformerFunction |
| ImagingSelection.basedOn:serviceRequestRef.type | extensible | ResourceType |
| ImagingSelection.basedOn:serviceRequestRef.identifier.use | required | IdentifierUse |
| ImagingSelection.basedOn:serviceRequestRef.identifier.type | extensible | Pattern: ACSN("Accession ID") |
| ImagingSelection.category | example | KeyObjectSelectionDocumentTitle |
| ImagingSelection.code | example | KeyObjectSelectionDocumentTitle |
| ImagingSelection.derivedFrom:imagingStudyRef.type | extensible | ResourceType |
| ImagingSelection.derivedFrom:imagingStudyRef.identifier.use | required | IdentifierUse |
| ImagingSelection.derivedFrom:imagingStudyRef.identifier.type | extensible | Pattern: study-instance-uid("Study Instance UID") |
| ImagingSelection.bodySite | example | SNOMEDCTBodyStructures |
| ImagingSelection.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
| ImagingSelection.instance.imageRegion2D.regionType | required | ImagingSelection2DGraphicType |
| ImagingSelection.instance.imageRegion3D.regionType | required | ImagingSelection3DGraphicType |
This structure is derived from ImagingSelection
Summary
Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 5 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ImagingSelection
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingSelection | 0..* | ImagingSelection | This is an abstract profile. A selection of DICOM SOP instances and/or frames | |
| subject | S | 1..1 | Reference(Patient) | Subject of the selected instances |
| Slices for basedOn | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Associated request Slice: Unordered, Open by type:reference | |
| basedOn:serviceRequestRef | S | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest |
| identifier | 0..1 | Identifier | The accession number related to the performed study | |
| type | 1..1 | CodeableConcept | Description of identifier 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/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
| value | 1..1 | string | The value that is unique | |
| code | S | 1..1 | CodeableConcept | Imaging Selection purpose text or code |
| coding | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 121231 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Volume Surface | |
| Slices for derivedFrom | 1..* | Reference(ImagingStudy | DocumentReference) | The imaging study from which the imaging selection is derived Slice: Unordered, Open by type:reference | |
| derivedFrom:imagingStudyRef | S | 1..1 | Reference(ImagingStudy) | Related ImagingStudy |
| identifier | 0..1 | Identifier | Identifier related to Study Instance UID | |
| type | 1..1 | CodeableConcept | Description of identifier 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://hl7.org/fhir/uv/dicom-sr/CodeSystem/dicom-identifier-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |
| system | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | |
| value | 1..1 | string | The value that is unique | |
| frameOfReferenceUid | S | 1..1 | id | The Frame of Reference UID for the selected images |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingSelection | 0..* | ImagingSelection | This is an abstract profile. A selection of DICOM SOP instances and/or frames | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | available | entered-in-error | unknown Binding: ImagingSelectionStatus (required): The status of the ImagingSelection. |
| subject | SΣ | 1..1 | Reference(Patient) | Subject of the selected instances |
| Slices for basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Associated request Slice: Unordered, Open by type:reference |
| basedOn:serviceRequestRef | SΣ | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest |
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | ΣC | 0..1 | Identifier | The accession number related to the performed study |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 1..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. 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/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| code | SΣ | 1..1 | CodeableConcept | Imaging Selection purpose text or code Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. |
| coding | Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 121231 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Volume Surface | |
| Slices for derivedFrom | Σ | 1..* | Reference(ImagingStudy | DocumentReference) | The imaging study from which the imaging selection is derived Slice: Unordered, Open by type:reference |
| derivedFrom:imagingStudyRef | SΣ | 1..1 | Reference(ImagingStudy) | Related ImagingStudy |
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier | ΣC | 0..1 | Identifier | Identifier related to Study Instance UID |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 1..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. 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://hl7.org/fhir/uv/dicom-sr/CodeSystem/dicom-identifier-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |
| system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid |
| value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
| frameOfReferenceUid | SΣ | 1..1 | id | The Frame of Reference UID for the selected images Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.2 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ImagingSelection.status | required | ImagingSelectionStatus |
| ImagingSelection.basedOn:serviceRequestRef.identifier.use | required | IdentifierUse |
| ImagingSelection.basedOn:serviceRequestRef.identifier.type | extensible | Pattern: ACSN("Accession ID") |
| ImagingSelection.code | example | KeyObjectSelectionDocumentTitle |
| ImagingSelection.derivedFrom:imagingStudyRef.identifier.use | required | IdentifierUse |
| ImagingSelection.derivedFrom:imagingStudyRef.identifier.type | extensible | Pattern: study-instance-uid("Study Instance UID") |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingSelection | 0..* | ImagingSelection | This is an abstract profile. 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 |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| 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 |
| 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 | SΣ | 1..1 | Reference(Patient) | Subject of the selected instances |
| issued | Σ | 0..1 | instant | Date / Time when this imaging selection was created |
| performer | Σ | 0..* | BackboneElement | Selector of the instances (human or machine) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | Σ | 0..1 | CodeableConcept | Type of performer Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. |
| actor | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam | Patient | RelatedPerson | HealthcareService) | Author (human or machine) |
| Slices for basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Associated request Slice: Unordered, Open by type:reference |
| basedOn:serviceRequestRef | SΣ | 0..1 | Reference(ServiceRequest) | Description of the related ServiceRequest |
| 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 | 0..1 | Identifier | The accession number related to the performed 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 | Σ | 1..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. 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/v2-0203 | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ACSN | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Accession ID | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣC | 1..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) |
| display | ΣC | 0..1 | string | Text alternative for the resource |
| category | Σ | 0..* | CodeableConcept | Classifies the imaging selection Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. |
| code | SΣ | 1..1 | CodeableConcept | Imaging Selection purpose text or code Binding: KeyObjectSelectionDocumentTitle (example): Key Object Selection Document Title. |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| coding | Σ | 0..* | Coding | Code defined by a terminology system Required Pattern: At least the following |
| 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://dicom.nema.org/resources/ontology/DCM | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 121231 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Volume Surface | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| 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 type:reference |
| derivedFrom:imagingStudyRef | SΣ | 1..1 | Reference(ImagingStudy) | Related ImagingStudy |
| 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 | 0..1 | Identifier | Identifier related to Study Instance UID |
| 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 | Σ | 1..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. 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://hl7.org/fhir/uv/dicom-sr/CodeSystem/dicom-identifier-type | |
| version | 0..1 | string | Version of the system - if relevant | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: study-instance-uid | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Study Instance UID | |
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
| text | 0..1 | string | Plain text representation of the concept | |
| system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid |
| value | ΣC | 1..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) |
| display | ΣC | 0..1 | string | Text alternative for the resource |
| endpoint | Σ | 0..* | Reference(Endpoint) | The network service providing retrieval for the images referenced in the imaging selection |
| seriesUid | Σ | 0..1 | id | DICOM Series Instance UID Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.1 |
| seriesNumber | Σ | 0..1 | unsignedInt | DICOM Series Number |
| frameOfReferenceUid | SΣ | 1..1 | id | The Frame of Reference UID for the selected images Example General: 1.2.840.113747.20080222.12753225430534207565993148475333748793.2 |
| bodySite | Σ | 0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts |
| focus | Σ | 0..* | Reference(ImagingSelection) | Related resource that is the focus for the imaging selection |
| instance | Σ | 0..* | BackboneElement | The selected instances |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| uid | Σ | 1..1 | id | DICOM SOP Instance UID Example General: 1.2.840.113747.20080222.12753225430534207568475333748793.1.1 |
| number | Σ | 0..1 | unsignedInt | DICOM Instance Number |
| sopClass | 0..1 | Coding | DICOM SOP Class UID Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): DICOM SOP Classes. Example General: 1.2.840.10008.5.1.4.1.1.2 | |
| subset | 0..* | string | The selected subset of the SOP Instance Example General: 6 | |
| imageRegion2D | 0..* | BackboneElement | A specific 2D region in a DICOM image / frame | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| regionType | 1..1 | code | point | polyline | interpolated | circle | ellipse Binding: ImagingSelection2DGraphicType (required): The type of image region. | |
| coordinate | 1..* | decimal | Specifies the coordinates that define the image region This repeating element order: The values are an ordered set of (x, y) coordinates. | |
| imageRegion3D | 0..* | BackboneElement | A specific 3D region in a DICOM frame of reference | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| regionType | 1..1 | code | point | multipoint | polyline | polygon | ellipse | ellipsoid Binding: ImagingSelection3DGraphicType (required): The type of image region. | |
| coordinate | 1..* | decimal | Specifies the coordinates that define the image region This repeating element order: The values are an ordered set of (x, y, z) coordinates. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ImagingSelection.language | required | AllLanguages |
| ImagingSelection.status | required | ImagingSelectionStatus |
| ImagingSelection.performer.function | extensible | ImagingStudySeriesPerformerFunction |
| ImagingSelection.basedOn:serviceRequestRef.type | extensible | ResourceType |
| ImagingSelection.basedOn:serviceRequestRef.identifier.use | required | IdentifierUse |
| ImagingSelection.basedOn:serviceRequestRef.identifier.type | extensible | Pattern: ACSN("Accession ID") |
| ImagingSelection.category | example | KeyObjectSelectionDocumentTitle |
| ImagingSelection.code | example | KeyObjectSelectionDocumentTitle |
| ImagingSelection.derivedFrom:imagingStudyRef.type | extensible | ResourceType |
| ImagingSelection.derivedFrom:imagingStudyRef.identifier.use | required | IdentifierUse |
| ImagingSelection.derivedFrom:imagingStudyRef.identifier.type | extensible | Pattern: study-instance-uid("Study Instance UID") |
| ImagingSelection.bodySite | example | SNOMEDCTBodyStructures |
| ImagingSelection.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
| ImagingSelection.instance.imageRegion2D.regionType | required | ImagingSelection2DGraphicType |
| ImagingSelection.instance.imageRegion3D.regionType | required | ImagingSelection3DGraphicType |
This structure is derived from ImagingSelection
Summary
Mandatory: 4 elements (4 nested mandatory elements)
Must-Support: 5 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 Imaging Integration Working Group. Package hl7.fhir.uv.dicom-sr#0.1.0 based on FHIR 5.0.0. Generated 2023-06-13
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change