HL7 Europe Imaging Study Report
0.1.0-build - ci-build
150
HL7 Europe Imaging Study Report
0.1.0-build - 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-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/oijauregui/ehdsimaging/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/Report-ImImagingStudy | Version: 0.1.0-build | |||
| Draft as of 2025-09-08 | Computable Name: Report_ImImagingStudy | |||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
||||
Report obligations for ImImagingStudy
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  ImagingStudy |
C | 0..* | ImImagingStudy | 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 | ||||||||
| language |
O | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||||
 text |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||
   extension:status-reason |
O | 0..1 | (Complex) | Why was the status changed? URL: http://hl7.org/fhir/StructureDefinition/workflow-statusReason
| ||||||||
   extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-statusReason" | |||||||||
 value[x] |
1..1 | CodeableConcept | Value of extension Binding: StatusReasonValueSet (example) | |||||||||
 text |
OΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
 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 |
OΣ | 1..1 | ImStudyInstanceUidIdentifier | Identifiers for the whole study
| ||||||||
| status |
?!OΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
| ||||||||
| modality |
OΣ | 0..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
 subject |
OΣ | 1..1 | Reference(Patient (EU base) | Device) | Who or what is the subject of the study
| ||||||||
| encounter |
OΣ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
| ||||||||
| Slices for basedOn |
OΣ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by type:$this
| ||||||||
| basedOn:imorderaccession |
Σ | 0..1 | Reference(ServiceRequest: 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(Endpoint: WADO-RS) | Study access endpoint | ||||||||
| endpoint:iid |
Σ | 0..1 | Reference(Endpoint: IHE IID Image Viewer) | Study access endpoint | ||||||||
| numberOfSeries |
OΣ | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||
| numberOfInstances |
OΣ | 0..1 | unsignedInt | Number of Study Related Instances
| ||||||||
| description |
OΣ | 0..1 | string | Institution-generated description
| ||||||||
 series |
OΣ | 0..* | BackboneElement | Each study has one or more series of instances
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| uid |
OΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
| ||||||||
| number |
OΣ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
| ||||||||
| modality |
OΣ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| description |
OΣ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180
| ||||||||
| numberOfInstances |
OΣ | 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(Endpoint: WADO-RS) | Series access endpoint | ||||||||
| endpoint:iid |
Σ | 0..1 | Reference(Endpoint: IHE IID Image Viewer) | Series access endpoint | ||||||||
| bodySite |
OΣ | 0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
| ||||||||
| specimen |
OΣ | 0..* | Reference(Specimen) | Specimen imaged
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the series started
| ||||||||
| Slices for performer |
OΣ | 0..* | BackboneElement | Who performed the series Slice: Unordered, Open by type:actor
| ||||||||
  performer:All Slices |
Content/Rules for all slices | |||||||||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) | Who performed the series | ||||||||
| performer:performer |
OΣ | 0..1 | BackboneElement | Who performed the series
| ||||||||
| 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 |
OΣ | 0..1 | BackboneElement | Who performed the series
| ||||||||
| 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(Device: Imaging Device) | Who performed the series | ||||||||
| performer:custodian |
OΣ | 0..1 | BackboneElement | Who performed the series
| ||||||||
| 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 | ||||||||
| performer:organization |
Σ | 0..1 | BackboneElement | Who performed the series | ||||||||
| 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(Organization (EU base)) | Who performed the series | ||||||||
| instance |
O | 0..* | BackboneElement | A single SOP instance from the series
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:instance-description |
O | 0..1 | string | Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/instance-description
| ||||||||
| extension:number-of-frames |
O | 0..1 | integer | Number of Frames URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/number-of-frames
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| uid |
O | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
| ||||||||
| sopClass |
O | 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 |
O | 0..1 | unsignedInt | The number of this instance in the series Example General: 1
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| ImagingStudy.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| ImagingStudy.extension:status-reason.value[x] | example | StatusReasonValueSethttp://hl7.org/fhir/ValueSet/status-reason | |
| ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0From the FHIR Standard | |
| ImagingStudy.modality | extensible | Modality (missing link)http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.htmlFrom this IG | |
| ImagingStudy.series.modality | extensible | Modality (missing link)http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.htmlFrom this IG | |
| ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | |
| ImagingStudy.series.performer:performer.function | extensible | Pattern Value: PRFhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:device.function | extensible | Pattern Value: DEVhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:custodian.function | extensible | Pattern Value: CSThttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:organization.function | extensible | Pattern Value: DEVhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImagingStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImagingStudy | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImagingStudy | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| im-imagingstudy-01 | warning | ImagingStudy | A DICOM instance UID must start with 'urn:oid:' : identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:') |
This structure is derived from ImImagingStudy
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
0..* | ImImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| meta |
||||||||
| versionId |
O | 0..1 | id | Version specific identifier
| ||||
| lastUpdated |
O | 0..1 | instant | When the resource version last changed
| ||||
| language |
O | 0..1 | code | Language of the resource content
| ||||
| text |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation
| ||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:status-reason |
O | 0..1 | WorkflowStatusReason | Why was the status changed?
| ||||
| value[x] |
||||||||
| text |
O | 0..1 | string | Plain text representation of the concept
| ||||
| Slices for identifier |
Content/Rules for all slices | |||||||
| identifier:studyInstanceUid |
O | 1..1 | ImStudyInstanceUidIdentifier | Identifiers for the whole study
| ||||
| status |
O | 1..1 | code | registered | available | cancelled | entered-in-error | unknown
| ||||
| modality |
O | 0..* | CodeableConcept | All of the distinct values for series' modalities
| ||||
| subject |
O | 1..1 | Reference(Patient (EU base) | Device) | Who or what is the subject of the study
| ||||
| encounter |
O | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
| ||||
| started |
O | 0..1 | dateTime | When the study was started
| ||||
| basedOn |
O | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled
| ||||
| numberOfSeries |
O | 0..1 | unsignedInt | Number of Study Related Series
| ||||
| numberOfInstances |
O | 0..1 | unsignedInt | Number of Study Related Instances
| ||||
| description |
O | 0..1 | string | Institution-generated description
| ||||
| series |
O | 0..* | BackboneElement | Each study has one or more series of instances
| ||||
| uid |
O | 1..1 | id | DICOM Series Instance UID for the series
| ||||
| number |
O | 0..1 | unsignedInt | Numeric identifier of this series
| ||||
| modality |
O | 1..1 | CodeableConcept | The modality used for this series
| ||||
| description |
O | 0..1 | string | A short human readable summary of the series
| ||||
| numberOfInstances |
O | 0..1 | unsignedInt | Number of Series Related Instances
| ||||
| bodySite |
O | 0..1 | CodeableReference(BodyStructure) | Body part examined
| ||||
| specimen |
O | 0..* | Reference(Specimen) | Specimen imaged
| ||||
| started |
O | 0..1 | dateTime | When the series started
| ||||
| performer |
O | 0..* | BackboneElement | Who performed the series
| ||||
| Slices for performer |
Content/Rules for all slices | |||||||
| performer:performer |
O | 0..1 | BackboneElement | Who performed the series
| ||||
| performer:device |
O | 0..1 | BackboneElement | Who performed the series
| ||||
| performer:custodian |
O | 0..1 | BackboneElement | Who performed the series
| ||||
| instance |
O | 0..* | BackboneElement | A single SOP instance from the series
| ||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:instance-description |
O | 0..1 | ImImagingStudyInstanceDescription | Instance Description
| ||||
| extension:number-of-frames |
O | 0..1 | NumberOfFrames | Number of Frames
| ||||
| uid |
O | 1..1 | id | DICOM SOP Instance UID
| ||||
| sopClass |
O | 1..1 | Coding | DICOM class type
| ||||
| number |
O | 0..1 | unsignedInt | The number of this instance in the series
| ||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
C | 0..* | ImImagingStudy | 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 | ||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| versionId |
OΣ | 0..1 | id | Version specific identifier
| ||||||||
| lastUpdated |
OΣ | 0..1 | instant | When the resource version last changed
| ||||||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| language |
O | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||||
| text |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| extension:status-reason |
O | 0..1 | (Complex) | Why was the status changed? URL: http://hl7.org/fhir/StructureDefinition/workflow-statusReason
| ||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-statusReason" | |||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: StatusReasonValueSet (example) | |||||||||
| 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 | ||||||||
| text |
OΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| 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 |
OΣ | 1..1 | ImStudyInstanceUidIdentifier | Identifiers for the whole study
| ||||||||
| status |
?!OΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
| ||||||||
| modality |
OΣ | 0..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| subject |
OΣ | 1..1 | Reference(Patient (EU base) | Device) | Who or what is the subject of the study
| ||||||||
| encounter |
OΣ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
| ||||||||
| Slices for basedOn |
OΣ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by type:$this
| ||||||||
| basedOn:imorderaccession |
Σ | 0..1 | Reference(ServiceRequest: 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(Endpoint: WADO-RS) | Study access endpoint | ||||||||
| endpoint:iid |
Σ | 0..1 | Reference(Endpoint: IHE IID Image Viewer) | Study access endpoint | ||||||||
| numberOfSeries |
OΣ | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||
| numberOfInstances |
OΣ | 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 |
OΣ | 0..1 | string | Institution-generated description
| ||||||||
| series |
OΣ | 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 |
OΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
| ||||||||
| number |
OΣ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
| ||||||||
| modality |
OΣ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| description |
OΣ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180
| ||||||||
| numberOfInstances |
OΣ | 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(Endpoint: WADO-RS) | Series access endpoint | ||||||||
| endpoint:iid |
Σ | 0..1 | Reference(Endpoint: IHE IID Image Viewer) | Series access endpoint | ||||||||
| bodySite |
OΣ | 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 |
OΣ | 0..* | Reference(Specimen) | Specimen imaged
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the series started
| ||||||||
| Slices for performer |
OΣ | 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 |
OΣ | 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 |
OΣ | 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(Device: Imaging Device) | Who performed the series | ||||||||
| performer:custodian |
OΣ | 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 | ||||||||
| performer:organization |
Σ | 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(Organization (EU base)) | Who performed the series | ||||||||
| instance |
O | 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 |
O | 0..1 | string | Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/instance-description
| ||||||||
| extension:number-of-frames |
O | 0..1 | integer | Number of Frames URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/number-of-frames
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| uid |
O | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
| ||||||||
| sopClass |
O | 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 |
O | 0..1 | unsignedInt | The number of this instance in the series Example General: 1
| ||||||||
| title |
0..1 | string | Description of instance | |||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| ImagingStudy.meta.security | extensible | AllSecurityLabelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | |
| ImagingStudy.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | |
| ImagingStudy.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| ImagingStudy.extension:status-reason.value[x] | example | StatusReasonValueSethttp://hl7.org/fhir/ValueSet/status-reason | |
| ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0From the FHIR Standard | |
| ImagingStudy.modality | extensible | Modality (missing link)http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.htmlFrom this IG | |
| ImagingStudy.basedOn:imorderaccession.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| ImagingStudy.procedure | preferred | LOINC loinc-rsna-radiology-playbookhttp://loinc.org/vs/loinc-rsna-radiology-playbook | |
| ImagingStudy.reason | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonFrom the FHIR Standard | |
| ImagingStudy.series.modality | extensible | Modality (missing link)http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.htmlFrom this IG | |
| ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | |
| ImagingStudy.series.laterality | example | Laterality (missing link)http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_244.htmlFrom this IG | |
| ImagingStudy.series.performer.function | extensible | ImImagingStudyPerformerTypeVShttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:performer.function | extensible | Pattern Value: PRFhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:device.function | extensible | Pattern Value: DEVhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:custodian.function | extensible | Pattern Value: CSThttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:organization.function | extensible | Pattern Value: DEVhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImagingStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImagingStudy | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImagingStudy | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| im-imagingstudy-01 | warning | ImagingStudy | A DICOM instance UID must start with 'urn:oid:' : identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:') |
This structure is derived from ImImagingStudy
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
C | 0..* | ImImagingStudy | 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 | ||||||||
| language |
O | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||||
| text |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:status-reason |
O | 0..1 | (Complex) | Why was the status changed? URL: http://hl7.org/fhir/StructureDefinition/workflow-statusReason
| ||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-statusReason" | |||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: StatusReasonValueSet (example) | |||||||||
| text |
OΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| 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 |
OΣ | 1..1 | ImStudyInstanceUidIdentifier | Identifiers for the whole study
| ||||||||
| status |
?!OΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
| ||||||||
| modality |
OΣ | 0..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| subject |
OΣ | 1..1 | Reference(Patient (EU base) | Device) | Who or what is the subject of the study
| ||||||||
| encounter |
OΣ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
| ||||||||
| Slices for basedOn |
OΣ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by type:$this
| ||||||||
| basedOn:imorderaccession |
Σ | 0..1 | Reference(ServiceRequest: 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(Endpoint: WADO-RS) | Study access endpoint | ||||||||
| endpoint:iid |
Σ | 0..1 | Reference(Endpoint: IHE IID Image Viewer) | Study access endpoint | ||||||||
| numberOfSeries |
OΣ | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||
| numberOfInstances |
OΣ | 0..1 | unsignedInt | Number of Study Related Instances
| ||||||||
| description |
OΣ | 0..1 | string | Institution-generated description
| ||||||||
| series |
OΣ | 0..* | BackboneElement | Each study has one or more series of instances
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| uid |
OΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
| ||||||||
| number |
OΣ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
| ||||||||
| modality |
OΣ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| description |
OΣ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180
| ||||||||
| numberOfInstances |
OΣ | 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(Endpoint: WADO-RS) | Series access endpoint | ||||||||
| endpoint:iid |
Σ | 0..1 | Reference(Endpoint: IHE IID Image Viewer) | Series access endpoint | ||||||||
| bodySite |
OΣ | 0..1 | CodeableReference(BodyStructure) | Body part examined Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
| ||||||||
| specimen |
OΣ | 0..* | Reference(Specimen) | Specimen imaged
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the series started
| ||||||||
| Slices for performer |
OΣ | 0..* | BackboneElement | Who performed the series Slice: Unordered, Open by type:actor
| ||||||||
| performer:All Slices |
Content/Rules for all slices | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson | HealthcareService) | Who performed the series | ||||||||
| performer:performer |
OΣ | 0..1 | BackboneElement | Who performed the series
| ||||||||
| 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 |
OΣ | 0..1 | BackboneElement | Who performed the series
| ||||||||
| 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(Device: Imaging Device) | Who performed the series | ||||||||
| performer:custodian |
OΣ | 0..1 | BackboneElement | Who performed the series
| ||||||||
| 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 | ||||||||
| performer:organization |
Σ | 0..1 | BackboneElement | Who performed the series | ||||||||
| 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(Organization (EU base)) | Who performed the series | ||||||||
| instance |
O | 0..* | BackboneElement | A single SOP instance from the series
| ||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:instance-description |
O | 0..1 | string | Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/instance-description
| ||||||||
| extension:number-of-frames |
O | 0..1 | integer | Number of Frames URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/number-of-frames
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| uid |
O | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
| ||||||||
| sopClass |
O | 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 |
O | 0..1 | unsignedInt | The number of this instance in the series Example General: 1
| ||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| ImagingStudy.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| ImagingStudy.extension:status-reason.value[x] | example | StatusReasonValueSethttp://hl7.org/fhir/ValueSet/status-reason | |
| ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0From the FHIR Standard | |
| ImagingStudy.modality | extensible | Modality (missing link)http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.htmlFrom this IG | |
| ImagingStudy.series.modality | extensible | Modality (missing link)http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.htmlFrom this IG | |
| ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | |
| ImagingStudy.series.performer:performer.function | extensible | Pattern Value: PRFhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:device.function | extensible | Pattern Value: DEVhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:custodian.function | extensible | Pattern Value: CSThttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:organization.function | extensible | Pattern Value: DEVhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImagingStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImagingStudy | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImagingStudy | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| im-imagingstudy-01 | warning | ImagingStudy | A 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 ImImagingStudy
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
0..* | ImImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| meta |
||||||||
| versionId |
O | 0..1 | id | Version specific identifier
| ||||
| lastUpdated |
O | 0..1 | instant | When the resource version last changed
| ||||
| language |
O | 0..1 | code | Language of the resource content
| ||||
| text |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation
| ||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:status-reason |
O | 0..1 | WorkflowStatusReason | Why was the status changed?
| ||||
| value[x] |
||||||||
| text |
O | 0..1 | string | Plain text representation of the concept
| ||||
| Slices for identifier |
Content/Rules for all slices | |||||||
| identifier:studyInstanceUid |
O | 1..1 | ImStudyInstanceUidIdentifier | Identifiers for the whole study
| ||||
| status |
O | 1..1 | code | registered | available | cancelled | entered-in-error | unknown
| ||||
| modality |
O | 0..* | CodeableConcept | All of the distinct values for series' modalities
| ||||
| subject |
O | 1..1 | Reference(Patient (EU base) | Device) | Who or what is the subject of the study
| ||||
| encounter |
O | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
| ||||
| started |
O | 0..1 | dateTime | When the study was started
| ||||
| basedOn |
O | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled
| ||||
| numberOfSeries |
O | 0..1 | unsignedInt | Number of Study Related Series
| ||||
| numberOfInstances |
O | 0..1 | unsignedInt | Number of Study Related Instances
| ||||
| description |
O | 0..1 | string | Institution-generated description
| ||||
| series |
O | 0..* | BackboneElement | Each study has one or more series of instances
| ||||
| uid |
O | 1..1 | id | DICOM Series Instance UID for the series
| ||||
| number |
O | 0..1 | unsignedInt | Numeric identifier of this series
| ||||
| modality |
O | 1..1 | CodeableConcept | The modality used for this series
| ||||
| description |
O | 0..1 | string | A short human readable summary of the series
| ||||
| numberOfInstances |
O | 0..1 | unsignedInt | Number of Series Related Instances
| ||||
| bodySite |
O | 0..1 | CodeableReference(BodyStructure) | Body part examined
| ||||
| specimen |
O | 0..* | Reference(Specimen) | Specimen imaged
| ||||
| started |
O | 0..1 | dateTime | When the series started
| ||||
| performer |
O | 0..* | BackboneElement | Who performed the series
| ||||
| Slices for performer |
Content/Rules for all slices | |||||||
| performer:performer |
O | 0..1 | BackboneElement | Who performed the series
| ||||
| performer:device |
O | 0..1 | BackboneElement | Who performed the series
| ||||
| performer:custodian |
O | 0..1 | BackboneElement | Who performed the series
| ||||
| instance |
O | 0..* | BackboneElement | A single SOP instance from the series
| ||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:instance-description |
O | 0..1 | ImImagingStudyInstanceDescription | Instance Description
| ||||
| extension:number-of-frames |
O | 0..1 | NumberOfFrames | Number of Frames
| ||||
| uid |
O | 1..1 | id | DICOM SOP Instance UID
| ||||
| sopClass |
O | 1..1 | Coding | DICOM class type
| ||||
| number |
O | 0..1 | unsignedInt | The number of this instance in the series
| ||||
| Documentation for this format | ||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
C | 0..* | ImImagingStudy | 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 | ||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| versionId |
OΣ | 0..1 | id | Version specific identifier
| ||||||||
| lastUpdated |
OΣ | 0..1 | instant | When the resource version last changed
| ||||||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| language |
O | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||||||
| text |
O | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| extension:status-reason |
O | 0..1 | (Complex) | Why was the status changed? URL: http://hl7.org/fhir/StructureDefinition/workflow-statusReason
| ||||||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | |||||||||||
| url |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/workflow-statusReason" | |||||||||
| value[x] |
1..1 | CodeableConcept | Value of extension Binding: StatusReasonValueSet (example) | |||||||||
| 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 | ||||||||
| text |
OΣ | 0..1 | string | Plain text representation of the concept
| ||||||||
| 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 |
OΣ | 1..1 | ImStudyInstanceUidIdentifier | Identifiers for the whole study
| ||||||||
| status |
?!OΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
| ||||||||
| modality |
OΣ | 0..* | CodeableConcept | All of the distinct values for series' modalities Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| subject |
OΣ | 1..1 | Reference(Patient (EU base) | Device) | Who or what is the subject of the study
| ||||||||
| encounter |
OΣ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00
| ||||||||
| Slices for basedOn |
OΣ | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled Slice: Unordered, Open by type:$this
| ||||||||
| basedOn:imorderaccession |
Σ | 0..1 | Reference(ServiceRequest: 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(Endpoint: WADO-RS) | Study access endpoint | ||||||||
| endpoint:iid |
Σ | 0..1 | Reference(Endpoint: IHE IID Image Viewer) | Study access endpoint | ||||||||
| numberOfSeries |
OΣ | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||
| numberOfInstances |
OΣ | 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 |
OΣ | 0..1 | string | Institution-generated description
| ||||||||
| series |
OΣ | 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 |
OΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
| ||||||||
| number |
OΣ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
| ||||||||
| modality |
OΣ | 1..1 | CodeableConcept | The modality used for this series Binding: Modality (extensible): Type of acquired data in the instance.
| ||||||||
| description |
OΣ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180
| ||||||||
| numberOfInstances |
OΣ | 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(Endpoint: WADO-RS) | Series access endpoint | ||||||||
| endpoint:iid |
Σ | 0..1 | Reference(Endpoint: IHE IID Image Viewer) | Series access endpoint | ||||||||
| bodySite |
OΣ | 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 |
OΣ | 0..* | Reference(Specimen) | Specimen imaged
| ||||||||
| started |
OΣ | 0..1 | dateTime | When the series started
| ||||||||
| Slices for performer |
OΣ | 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 |
OΣ | 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 |
OΣ | 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(Device: Imaging Device) | Who performed the series | ||||||||
| performer:custodian |
OΣ | 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 | ||||||||
| performer:organization |
Σ | 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(Organization (EU base)) | Who performed the series | ||||||||
| instance |
O | 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 |
O | 0..1 | string | Instance Description URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/instance-description
| ||||||||
| extension:number-of-frames |
O | 0..1 | integer | Number of Frames URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/number-of-frames
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| uid |
O | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
| ||||||||
| sopClass |
O | 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 |
O | 0..1 | unsignedInt | The number of this instance in the series Example General: 1
| ||||||||
| title |
0..1 | string | Description of instance | |||||||||
| Documentation for this format | ||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| ImagingStudy.meta.security | extensible | AllSecurityLabelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | |
| ImagingStudy.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | |
| ImagingStudy.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| ImagingStudy.extension:status-reason.value[x] | example | StatusReasonValueSethttp://hl7.org/fhir/ValueSet/status-reason | |
| ImagingStudy.status | required | ImagingStudyStatushttp://hl7.org/fhir/ValueSet/imagingstudy-status|5.0.0From the FHIR Standard | |
| ImagingStudy.modality | extensible | Modality (missing link)http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.htmlFrom this IG | |
| ImagingStudy.basedOn:imorderaccession.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| ImagingStudy.procedure | preferred | LOINC loinc-rsna-radiology-playbookhttp://loinc.org/vs/loinc-rsna-radiology-playbook | |
| ImagingStudy.reason | example | ProcedureReasonCodeshttp://hl7.org/fhir/ValueSet/procedure-reasonFrom the FHIR Standard | |
| ImagingStudy.series.modality | extensible | Modality (missing link)http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_33.htmlFrom this IG | |
| ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-siteFrom the FHIR Standard | |
| ImagingStudy.series.laterality | example | Laterality (missing link)http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_244.htmlFrom this IG | |
| ImagingStudy.series.performer.function | extensible | ImImagingStudyPerformerTypeVShttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:performer.function | extensible | Pattern Value: PRFhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:device.function | extensible | Pattern Value: DEVhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:custodian.function | extensible | Pattern Value: CSThttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.performer:organization.function | extensible | Pattern Value: DEVhttp://hl7.eu/fhir/imaging-r5/ValueSet/im-imaging-study-performer-typeFrom this IG | |
| ImagingStudy.series.instance.sopClass | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImagingStudy | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImagingStudy | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ImagingStudy | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImagingStudy | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| im-imagingstudy-01 | warning | ImagingStudy | A DICOM instance UID must start with 'urn:oid:' : identifier.where(system='urn:dicom:uid').value.startsWith('urn:oid:') |
This structure is derived from ImImagingStudy
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 Europe. Package hl7.fhir.eu.imaging-r5#0.1.0-build based on FHIR 5.0.0. Generated 2025-09-08
