HL7 Czech Imaging Report IG
0.1.0-ballot - ci-build
HL7 Czech Imaging Report IG
0.1.0-ballot - ci-build
HL7 Czech Imaging Report IG, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/img/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7.cz/fhir/img/StructureDefinition/cz-studyImaging-obl-img | Version: 0.1.0-ballot | |||
| Standards status: Informative | Maturity Level: 0 | Computable Name: CZ_StudyImagingObligationsImg | ||
This profile defines obligations for a study imaging in FHIR for the purpose of this guide.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.status | Base | required | ImagingStudyStatus | 📍4.0.1 | FHIR Std. |
| ImagingStudy.modality | Base | required | CZ Modality | 📦0.1.0-ballot | This IG |
| ImagingStudy.procedureCode | Base | extensible | http://www.rsna.org/RadLex_Playbook.aspx | ? | Unknown |
| ImagingStudy.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
|
| 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 CZ_StudyImaging
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  ImagingStudy |
0..* | CZ_StudyImaging | A set of images produced in single study (one or more series of references images) | |||||||||||
  identifier |
O | 1..* | Identifier | Identifiers for the whole study
| ||||||||||
| status |
O | 1..1 | code | registered | available | cancelled | entered-in-error | unknown
| ||||||||||
| modality |
O | 0..* | Coding | All series modality if actual acquisition modalities
| ||||||||||
| subject |
O | 1..1 | Reference(Patient (CZ core) | Device: Performer/Observer (CZ)) | Who or what is the subject of the study
| ||||||||||
| started |
O | 0..1 | dateTime | When the study was started
| ||||||||||
| basedOn |
O | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled
| ||||||||||
  Slices for basedOn |
Content/Rules for all slices | |||||||||||||
   basedOn:orderaccession |
O | 0..1 | Reference(Service Request: Imaging Report (CZ)) | Request fulfilled
| ||||||||||
| endpoint |
O | 0..* | Reference(Endpoint) | Study access endpoint
| ||||||||||
| numberOfSeries |
O | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||||
| numberOfInstances |
O | 0..1 | unsignedInt | Number of Study Related Instances
| ||||||||||
| procedureCode |
O | 0..* | CodeableConcept | The performed procedure code
| ||||||||||
| reasonCode |
O | 0..* | CodeableConcept | Why the study was requested
| ||||||||||
| note |
O | 0..* | Annotation | User-defined comments
| ||||||||||
| description |
O | 0..1 | string | Institution-generated description
| ||||||||||
 series |
||||||||||||||
 number |
O | 0..1 | unsignedInt | Numeric identifier of this series
| ||||||||||
| description |
O | 0..1 | string | A short human readable summary of the series
| ||||||||||
| bodySite |
O | 0..1 | Coding | Body part examined
| ||||||||||
 performer |
O | 0..* | BackboneElement | Who performed the series
| ||||||||||
| Documentation for this format | ||||||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
C | 0..* | CZ_StudyImaging | A set of images produced in single study (one or more series of references images) Constraints: imagingstudy-01 | ||||||||||
 id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
| Slices for identifier |
OΣ | 1..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by value:system
| ||||||||||
| identifier:studyInstanceUid |
Σ | 1..1 | CZ_StudyInstanceUidIdentifier | 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..* | Coding | All series modality if actual acquisition modalities Binding: CZ Modality (required)
| ||||||||||
 subject |
OΣ | 1..1 | Reference(Patient (CZ core) | Device: Performer/Observer (CZ)) | Who or what is the subject of the study
| ||||||||||
| encounter |
Σ | 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:orderaccession |
OΣ | 0..1 | Reference(Service Request: Imaging Report (CZ)) | Request fulfilled
| ||||||||||
 id |
0..1 | string | 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") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||
| identifier |
Σ | 1..1 | AccessionNumberIdentifier | Logical reference, when literal reference is not known | ||||||||||
 display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||
| referrer |
Σ | 0..1 | Reference(Practitioner (CZ core) | Practitioner Role (CZ core)) | Referring physician | ||||||||||
| interpreter |
Σ | 0..* | Reference(Practitioner (CZ core) | Practitioner Role (CZ core)) | Who interpreted images | ||||||||||
| endpoint |
OΣ | 0..* | Reference(Endpoint) | Study access endpoint
| ||||||||||
| numberOfSeries |
OΣ | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||||
| numberOfInstances |
OΣ | 0..1 | unsignedInt | Number of Study Related Instances
| ||||||||||
| procedureReference |
Σ | 0..1 | Reference(Procedure: Imaging Report (CZ)) | The performed Procedure reference | ||||||||||
| procedureCode |
OΣ | 0..* | CodeableConcept | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
| ||||||||||
| location |
Σ | 0..1 | Reference(Location (CZ core)) | Where ImagingStudy occurred | ||||||||||
| reasonCode |
OΣ | 0..* | CodeableConcept | Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study.
| ||||||||||
| reasonReference |
Σ | 0..* | Reference(Condition: Imaging Report (CZ) | Observation: Imaging Report (CZ) | Media | Diagnostic Report: Imaging Report (CZ) | DocumentReference) | Why was study performed | ||||||||||
| note |
OΣ | 0..* | Annotation | User-defined comments
| ||||||||||
| description |
OΣ | 0..1 | string | Institution-generated description
| ||||||||||
| series |
Σ | 0..* | BackboneElement | Each study has one or more series of instances | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
| uid |
Σ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 | ||||||||||
| number |
OΣ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
| ||||||||||
| modality |
Σ | 1..1 | Coding | The modality of the instances in the series Binding: CZ Modality (extensible) | ||||||||||
| description |
OΣ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180
| ||||||||||
| numberOfInstances |
Σ | 0..1 | unsignedInt | Number of Series Related Instances | ||||||||||
| endpoint |
Σ | 0..* | Reference(Endpoint) | Series access endpoint | ||||||||||
| bodySite |
OΣ | 0..1 | Coding | Body part examined Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
| ||||||||||
| laterality |
Σ | 0..1 | Coding | Body part laterality Binding: Laterality (example): Codes describing body site laterality (left, right, etc.). | ||||||||||
| specimen |
Σ | 0..* | Reference(Specimen (CZ)) | Specimen imaged | ||||||||||
| started |
Σ | 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 (CZ core) | Practitioner Role (CZ core) | Organization (CZ core) | CareTeam | Patient (CZ core) | Related Person (CZ core) | Device: Performer/Observer (CZ) | Device) | Who performed the series | ||||||||||
| performer:performer |
Σ | 0..1 | BackboneElement | Who performed the series | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
 function |
Σ | 0..1 | CodeableConcept | Type of performance Binding: Imaging Study Performer Type Value Set (extensible) Required Pattern: At least the following | ||||||||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||
| actor |
Σ | 1..1 | Reference(Practitioner Role (CZ core)) | Who performed the series | ||||||||||
| performer:device |
Σ | 0..1 | BackboneElement | Who performed the series | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
| function |
Σ | 0..1 | CodeableConcept | Type of performance Binding: Imaging Study Performer Type Value Set (extensible) Required Pattern: At least the following | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||
| actor |
Σ | 1..1 | Reference(Device: Performer/Observer (CZ)) | Who performed the series | ||||||||||
| performer:custodian |
Σ | 0..1 | BackboneElement | Who performed the series | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
| function |
Σ | 0..1 | CodeableConcept | Type of performance Binding: Imaging Study Performer Type Value Set (extensible) Required Pattern: At least the following | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||
| actor |
Σ | 1..1 | Reference(Organization (CZ core)) | Who performed the series | ||||||||||
| instance |
0..* | BackboneElement | A single SOP instance from the series | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
| extension:instance-description |
0..1 | string | Instance Description URL: https://hl7.cz/fhir/img/StructureDefinition/instance-description | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
| uid |
1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | |||||||||||
| sopClass |
1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. | |||||||||||
| number |
0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||||||||
| title |
0..1 | string | Description of instance | |||||||||||
| Documentation for this format | ||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ImagingStudy.status | Base | required | ImagingStudyStatus | 📍4.0.1 | FHIR Std. |
| ImagingStudy.modality | Base | required | CZ Modality | 📦0.1.0-ballot | This IG |
| ImagingStudy.basedOn:orderaccession.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImagingStudy.procedureCode | Base | extensible | http://www.rsna.org/RadLex_Playbook.aspx | ? | Unknown |
| ImagingStudy.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| ImagingStudy.series.modality | Base | extensible | CZ Modality | 📦0.1.0-ballot | This IG |
| ImagingStudy.series.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| ImagingStudy.series.laterality | Base | example | Laterality | 📍4.0.1 | FHIR Std. |
| ImagingStudy.series.performer.function | Base | extensible | Imaging Study Performer Type Value Set | 📦0.1.0-ballot | This IG |
| ImagingStudy.series.performer:performer.function | Base | extensible | Imaging Study Performer Type Value Set | 📦0.1.0-ballot | This IG |
| ImagingStudy.series.performer:device.function | Base | extensible | Imaging Study Performer Type Value Set | 📦0.1.0-ballot | This IG |
| ImagingStudy.series.performer:custodian.function | Base | extensible | Imaging Study Performer Type Value Set | 📦0.1.0-ballot | This IG |
| ImagingStudy.series.instance.sopClass | Base | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 | ? | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
|
| 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 CZ_StudyImaging
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
C | 0..* | CZ_StudyImaging | A set of images produced in single study (one or more series of references images) Constraints: imagingstudy-01 | ||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
| Slices for identifier |
OΣ | 1..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by value:system
| ||||||||||
| identifier:studyInstanceUid |
Σ | 1..1 | CZ_StudyInstanceUidIdentifier | 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..* | Coding | All series modality if actual acquisition modalities Binding: CZ Modality (required)
| ||||||||||
| subject |
OΣ | 1..1 | Reference(Patient (CZ core) | Device: Performer/Observer (CZ)) | Who or what is the subject of the study
| ||||||||||
| 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:orderaccession |
OΣ | 0..1 | Reference(Service Request: Imaging Report (CZ)) | Request fulfilled
| ||||||||||
| identifier |
Σ | 1..1 | AccessionNumberIdentifier | Logical reference, when literal reference is not known | ||||||||||
| endpoint |
OΣ | 0..* | Reference(Endpoint) | Study access endpoint
| ||||||||||
| numberOfSeries |
OΣ | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||||
| numberOfInstances |
OΣ | 0..1 | unsignedInt | Number of Study Related Instances
| ||||||||||
| procedureCode |
OΣ | 0..* | CodeableConcept | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
| ||||||||||
| reasonCode |
OΣ | 0..* | CodeableConcept | Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study.
| ||||||||||
| note |
OΣ | 0..* | Annotation | User-defined comments
| ||||||||||
| description |
OΣ | 0..1 | string | Institution-generated description
| ||||||||||
| Documentation for this format | ||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.status | Base | required | ImagingStudyStatus | 📍4.0.1 | FHIR Std. |
| ImagingStudy.modality | Base | required | CZ Modality | 📦0.1.0-ballot | This IG |
| ImagingStudy.procedureCode | Base | extensible | http://www.rsna.org/RadLex_Playbook.aspx | ? | Unknown |
| ImagingStudy.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
|
| 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 CZ_StudyImaging
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
0..* | CZ_StudyImaging | A set of images produced in single study (one or more series of references images) | |||||||||||
| identifier |
O | 1..* | Identifier | Identifiers for the whole study
| ||||||||||
| status |
O | 1..1 | code | registered | available | cancelled | entered-in-error | unknown
| ||||||||||
| modality |
O | 0..* | Coding | All series modality if actual acquisition modalities
| ||||||||||
| subject |
O | 1..1 | Reference(Patient (CZ core) | Device: Performer/Observer (CZ)) | Who or what is the subject of the study
| ||||||||||
| started |
O | 0..1 | dateTime | When the study was started
| ||||||||||
| basedOn |
O | 0..* | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) | Request fulfilled
| ||||||||||
| Slices for basedOn |
Content/Rules for all slices | |||||||||||||
| basedOn:orderaccession |
O | 0..1 | Reference(Service Request: Imaging Report (CZ)) | Request fulfilled
| ||||||||||
| endpoint |
O | 0..* | Reference(Endpoint) | Study access endpoint
| ||||||||||
| numberOfSeries |
O | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||||
| numberOfInstances |
O | 0..1 | unsignedInt | Number of Study Related Instances
| ||||||||||
| procedureCode |
O | 0..* | CodeableConcept | The performed procedure code
| ||||||||||
| reasonCode |
O | 0..* | CodeableConcept | Why the study was requested
| ||||||||||
| note |
O | 0..* | Annotation | User-defined comments
| ||||||||||
| description |
O | 0..1 | string | Institution-generated description
| ||||||||||
| series |
||||||||||||||
| number |
O | 0..1 | unsignedInt | Numeric identifier of this series
| ||||||||||
| description |
O | 0..1 | string | A short human readable summary of the series
| ||||||||||
| bodySite |
O | 0..1 | Coding | Body part examined
| ||||||||||
| performer |
O | 0..* | BackboneElement | Who performed the series
| ||||||||||
| Documentation for this format | ||||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ImagingStudy |
C | 0..* | CZ_StudyImaging | A set of images produced in single study (one or more series of references images) Constraints: imagingstudy-01 | ||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||
| Slices for identifier |
OΣ | 1..* | Identifier | Identifiers for the whole study Slice: Unordered, Open by value:system
| ||||||||||
| identifier:studyInstanceUid |
Σ | 1..1 | CZ_StudyInstanceUidIdentifier | 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..* | Coding | All series modality if actual acquisition modalities Binding: CZ Modality (required)
| ||||||||||
| subject |
OΣ | 1..1 | Reference(Patient (CZ core) | Device: Performer/Observer (CZ)) | Who or what is the subject of the study
| ||||||||||
| encounter |
Σ | 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:orderaccession |
OΣ | 0..1 | Reference(Service Request: Imaging Report (CZ)) | Request fulfilled
| ||||||||||
| id |
0..1 | string | 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") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||
| identifier |
Σ | 1..1 | AccessionNumberIdentifier | Logical reference, when literal reference is not known | ||||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||
| referrer |
Σ | 0..1 | Reference(Practitioner (CZ core) | Practitioner Role (CZ core)) | Referring physician | ||||||||||
| interpreter |
Σ | 0..* | Reference(Practitioner (CZ core) | Practitioner Role (CZ core)) | Who interpreted images | ||||||||||
| endpoint |
OΣ | 0..* | Reference(Endpoint) | Study access endpoint
| ||||||||||
| numberOfSeries |
OΣ | 0..1 | unsignedInt | Number of Study Related Series
| ||||||||||
| numberOfInstances |
OΣ | 0..1 | unsignedInt | Number of Study Related Instances
| ||||||||||
| procedureReference |
Σ | 0..1 | Reference(Procedure: Imaging Report (CZ)) | The performed Procedure reference | ||||||||||
| procedureCode |
OΣ | 0..* | CodeableConcept | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type.
| ||||||||||
| location |
Σ | 0..1 | Reference(Location (CZ core)) | Where ImagingStudy occurred | ||||||||||
| reasonCode |
OΣ | 0..* | CodeableConcept | Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study.
| ||||||||||
| reasonReference |
Σ | 0..* | Reference(Condition: Imaging Report (CZ) | Observation: Imaging Report (CZ) | Media | Diagnostic Report: Imaging Report (CZ) | DocumentReference) | Why was study performed | ||||||||||
| note |
OΣ | 0..* | Annotation | User-defined comments
| ||||||||||
| description |
OΣ | 0..1 | string | Institution-generated description
| ||||||||||
| series |
Σ | 0..* | BackboneElement | Each study has one or more series of instances | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
| uid |
Σ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 | ||||||||||
| number |
OΣ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3
| ||||||||||
| modality |
Σ | 1..1 | Coding | The modality of the instances in the series Binding: CZ Modality (extensible) | ||||||||||
| description |
OΣ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180
| ||||||||||
| numberOfInstances |
Σ | 0..1 | unsignedInt | Number of Series Related Instances | ||||||||||
| endpoint |
Σ | 0..* | Reference(Endpoint) | Series access endpoint | ||||||||||
| bodySite |
OΣ | 0..1 | Coding | Body part examined Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
| ||||||||||
| laterality |
Σ | 0..1 | Coding | Body part laterality Binding: Laterality (example): Codes describing body site laterality (left, right, etc.). | ||||||||||
| specimen |
Σ | 0..* | Reference(Specimen (CZ)) | Specimen imaged | ||||||||||
| started |
Σ | 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 (CZ core) | Practitioner Role (CZ core) | Organization (CZ core) | CareTeam | Patient (CZ core) | Related Person (CZ core) | Device: Performer/Observer (CZ) | Device) | Who performed the series | ||||||||||
| performer:performer |
Σ | 0..1 | BackboneElement | Who performed the series | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
| function |
Σ | 0..1 | CodeableConcept | Type of performance Binding: Imaging Study Performer Type Value Set (extensible) Required Pattern: At least the following | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRF | |||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||
| actor |
Σ | 1..1 | Reference(Practitioner Role (CZ core)) | Who performed the series | ||||||||||
| performer:device |
Σ | 0..1 | BackboneElement | Who performed the series | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
| function |
Σ | 0..1 | CodeableConcept | Type of performance Binding: Imaging Study Performer Type Value Set (extensible) Required Pattern: At least the following | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: DEV | |||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||
| actor |
Σ | 1..1 | Reference(Device: Performer/Observer (CZ)) | Who performed the series | ||||||||||
| performer:custodian |
Σ | 0..1 | BackboneElement | Who performed the series | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
| function |
Σ | 0..1 | CodeableConcept | Type of performance Binding: Imaging Study Performer Type Value Set (extensible) Required Pattern: At least the following | ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: CST | |||||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||||
| actor |
Σ | 1..1 | Reference(Organization (CZ core)) | Who performed the series | ||||||||||
| instance |
0..* | BackboneElement | A single SOP instance from the series | |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
| extension:instance-description |
0..1 | string | Instance Description URL: https://hl7.cz/fhir/img/StructureDefinition/instance-description | |||||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||
| uid |
1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | |||||||||||
| sopClass |
1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. | |||||||||||
| number |
0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||||||||
| title |
0..1 | string | Description of instance | |||||||||||
| Documentation for this format | ||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| ImagingStudy.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| ImagingStudy.status | Base | required | ImagingStudyStatus | 📍4.0.1 | FHIR Std. |
| ImagingStudy.modality | Base | required | CZ Modality | 📦0.1.0-ballot | This IG |
| ImagingStudy.basedOn:orderaccession.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| ImagingStudy.procedureCode | Base | extensible | http://www.rsna.org/RadLex_Playbook.aspx | ? | Unknown |
| ImagingStudy.reasonCode | Base | example | Procedure Reason Codes | 📍4.0.1 | FHIR Std. |
| ImagingStudy.series.modality | Base | extensible | CZ Modality | 📦0.1.0-ballot | This IG |
| ImagingStudy.series.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| ImagingStudy.series.laterality | Base | example | Laterality | 📍4.0.1 | FHIR Std. |
| ImagingStudy.series.performer.function | Base | extensible | Imaging Study Performer Type Value Set | 📦0.1.0-ballot | This IG |
| ImagingStudy.series.performer:performer.function | Base | extensible | Imaging Study Performer Type Value Set | 📦0.1.0-ballot | This IG |
| ImagingStudy.series.performer:device.function | Base | extensible | Imaging Study Performer Type Value Set | 📦0.1.0-ballot | This IG |
| ImagingStudy.series.performer:custodian.function | Base | extensible | Imaging Study Performer Type Value Set | 📦0.1.0-ballot | This IG |
| ImagingStudy.series.instance.sopClass | Base | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 | ? | Unknown |
| Id | Grade | Path(s) | Description | Expression |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
|
| 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 CZ_StudyImaging
Other representations of profile: CSV, Excel, Schematron