FHIR Implementation Guide for ABDM
5.0.0 - active
India
FHIR Implementation Guide for ABDM
5.0.0 - active
India
FHIR Implementation Guide for ABDM - Local Development build (v5.0.0). See the Directory of published versions
| Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/ImagingStudy | Version: 5.0.0 | |||
| Draft as of 2020-08-17 | Computable Name: ImagingStudy | |||
This profile sets minimum expectations for the ImagingStudy resource to searching for and fetching the content produced in a DICOM imaging study.
This profile sets minimum expectations for the ImagingStudy resource to searching for and fetching a Organization associated with a patient or provider. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ImagingStudy
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImagingStudy | ImagingStudy | |||
  status | S | 1..1 | code | registered | available | cancelled | entered-in-error | unknown |
| modality | S | 0..* | Coding | All series modality if actual acquisition modalities |
 subject | S | 1..1 | Reference(Device | Group | Patient) | Who or what is the subject of the study |
| basedOn | 0..* | Reference(Appointment | AppointmentResponse | Task | ServiceRequest | CarePlan) | Request fulfilled | |
| referrer | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | |
| interpreter | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images | |
| numberOfSeries | S | 0..1 | unsignedInt | Number of Study Related Series |
| numberOfInstances | S | 0..1 | unsignedInt | Number of Study Related Instances |
| procedureReference | 0..1 | Reference(Procedure) | The performed Procedure reference | |
 procedureCode | ||||
 coding | S | 0..* | Coding | Code defined by a terminology system |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
 display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| reasonCode | ||||
| coding | S | 0..* | Coding | Code defined by a terminology system |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| reasonReference | 0..* | Reference(Condition | Observation | Media | DocumentReference | DiagnosticReportImaging | DiagnosticReportLab) | Why was study performed | |
 series | S | 0..* | BackboneElement | Each study has one or more series of instances |
 uid | S | 1..1 | id | DICOM Series Instance UID for the series |
| modality | S | 1..1 | Coding | The modality of the instances in the series |
| specimen | 0..* | Reference(Specimen) | Specimen imaged | |
| performer | ||||
| actor | 1..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | Who performed the series | |
| instance | S | 0..* | BackboneElement | A single SOP instance from the series |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingStudy | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. |
 modality | SΣ | 0..* | Coding | All series modality if actual acquisition modalities Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance. |
| subject | SΣ | 1..1 | Reference(Device | Group | Patient) | Who or what is the subject of the study |
| basedOn | Σ | 0..* | Reference(Appointment | AppointmentResponse | Task | ServiceRequest | CarePlan) | Request fulfilled |
| referrer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician |
| interpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images |
| numberOfSeries | SΣ | 0..1 | unsignedInt | Number of Study Related Series |
| numberOfInstances | SΣ | 0..1 | unsignedInt | Number of Study Related Instances |
| procedureReference | Σ | 0..1 | Reference(Procedure) | The performed Procedure reference |
| procedureCode | Σ | 0..* | CodeableConcept | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type. |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| reasonCode | Σ | 0..* | CodeableConcept | Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study. |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| reasonReference | Σ | 0..* | Reference(Condition | Observation | Media | DocumentReference | DiagnosticReportImaging | DiagnosticReportLab) | Why was study performed |
| series | SΣ | 0..* | BackboneElement | Each study has one or more series of instances |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| uid | SΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
| modality | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance. |
| specimen | Σ | 0..* | Reference(Specimen) | Specimen imaged |
| instance | S | 0..* | BackboneElement | A single SOP instance from the series |
| 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. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImagingStudy.status | required | ImagingStudyStatus |
| ImagingStudy.modality | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html |
| ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspx |
| ImagingStudy.reasonCode | example | ProcedureReasonCodes |
| ImagingStudy.series.modality | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html |
| ImagingStudy.series.instance.sopClass | extensible | http://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().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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ImagingStudy | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Identifiers for the whole study | ||||
| status | ?!SΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. | ||||
| modality | SΣ | 0..* | Coding | All series modality if actual acquisition modalities Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance. | ||||
| subject | SΣ | 1..1 | Reference(Device | Group | Patient) | Who or what is the subject of the study | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated | ||||
| started | Σ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00 | ||||
| basedOn | Σ | 0..* | Reference(Appointment | AppointmentResponse | Task | ServiceRequest | CarePlan) | Request fulfilled | ||||
| referrer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | ||||
| interpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images | ||||
| endpoint | Σ | 0..* | Reference(Endpoint) | Study access endpoint | ||||
| numberOfSeries | SΣ | 0..1 | unsignedInt | Number of Study Related Series | ||||
| numberOfInstances | SΣ | 0..1 | unsignedInt | Number of Study Related Instances | ||||
| procedureReference | Σ | 0..1 | Reference(Procedure) | The performed Procedure reference | ||||
| procedureCode | Σ | 0..* | CodeableConcept | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| location | Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | Media | DocumentReference | DiagnosticReportImaging | DiagnosticReportLab) | Why was study performed | ||||
| note | Σ | 0..* | Annotation | User-defined comments | ||||
| description | Σ | 0..1 | string | Institution-generated description | ||||
| series | SΣ | 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 | SΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 | ||||
| number | Σ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3 | ||||
| modality | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance. | ||||
| description | Σ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180 | ||||
| numberOfInstances | Σ | 0..1 | unsignedInt | Number of Series Related Instances | ||||
| endpoint | Σ | 0..* | Reference(Endpoint) | Series access endpoint | ||||
| bodySite | Σ | 0..1 | 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) | Specimen imaged | ||||
| started | Σ | 0..1 | dateTime | When the series started | ||||
| performer | Σ | 0..* | BackboneElement | Who performed the series | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. | ||||
| actor | Σ | 1..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | Who performed the series | ||||
| instance | S | 0..* | BackboneElement | A single SOP instance from the series | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| uid | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | |||||
| sopClass | 1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. | |||||
| number | 0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||
| title | 0..1 | string | Description of instance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| ImagingStudy.language | preferred | CommonLanguages
| ||||
| ImagingStudy.status | required | ImagingStudyStatus | ||||
| ImagingStudy.modality | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | ||||
| ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspx | ||||
| ImagingStudy.reasonCode | example | ProcedureReasonCodes | ||||
| ImagingStudy.series.modality | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | ||||
| ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructures | ||||
| ImagingStudy.series.laterality | example | Laterality | ||||
| ImagingStudy.series.performer.function | extensible | ImagingStudySeriesPerformerFunction | ||||
| ImagingStudy.series.instance.sopClass | extensible | http://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().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() |
This structure is derived from ImagingStudy
Summary
Mandatory: 0 element (6 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from ImagingStudy
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingStudy | ImagingStudy | |||
| status | S | 1..1 | code | registered | available | cancelled | entered-in-error | unknown |
| modality | S | 0..* | Coding | All series modality if actual acquisition modalities |
| subject | S | 1..1 | Reference(Device | Group | Patient) | Who or what is the subject of the study |
| basedOn | 0..* | Reference(Appointment | AppointmentResponse | Task | ServiceRequest | CarePlan) | Request fulfilled | |
| referrer | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | |
| interpreter | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images | |
| numberOfSeries | S | 0..1 | unsignedInt | Number of Study Related Series |
| numberOfInstances | S | 0..1 | unsignedInt | Number of Study Related Instances |
| procedureReference | 0..1 | Reference(Procedure) | The performed Procedure reference | |
| procedureCode | ||||
| coding | S | 0..* | Coding | Code defined by a terminology system |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| reasonCode | ||||
| coding | S | 0..* | Coding | Code defined by a terminology system |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| reasonReference | 0..* | Reference(Condition | Observation | Media | DocumentReference | DiagnosticReportImaging | DiagnosticReportLab) | Why was study performed | |
| series | S | 0..* | BackboneElement | Each study has one or more series of instances |
| uid | S | 1..1 | id | DICOM Series Instance UID for the series |
| modality | S | 1..1 | Coding | The modality of the instances in the series |
| specimen | 0..* | Reference(Specimen) | Specimen imaged | |
| performer | ||||
| actor | 1..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | Who performed the series | |
| instance | S | 0..* | BackboneElement | A single SOP instance from the series |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImagingStudy | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. |
| modality | SΣ | 0..* | Coding | All series modality if actual acquisition modalities Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance. |
| subject | SΣ | 1..1 | Reference(Device | Group | Patient) | Who or what is the subject of the study |
| basedOn | Σ | 0..* | Reference(Appointment | AppointmentResponse | Task | ServiceRequest | CarePlan) | Request fulfilled |
| referrer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician |
| interpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images |
| numberOfSeries | SΣ | 0..1 | unsignedInt | Number of Study Related Series |
| numberOfInstances | SΣ | 0..1 | unsignedInt | Number of Study Related Instances |
| procedureReference | Σ | 0..1 | Reference(Procedure) | The performed Procedure reference |
| procedureCode | Σ | 0..* | CodeableConcept | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type. |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| reasonCode | Σ | 0..* | CodeableConcept | Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study. |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| reasonReference | Σ | 0..* | Reference(Condition | Observation | Media | DocumentReference | DiagnosticReportImaging | DiagnosticReportLab) | Why was study performed |
| series | SΣ | 0..* | BackboneElement | Each study has one or more series of instances |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| uid | SΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
| modality | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance. |
| specimen | Σ | 0..* | Reference(Specimen) | Specimen imaged |
| instance | S | 0..* | BackboneElement | A single SOP instance from the series |
| 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. | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ImagingStudy.status | required | ImagingStudyStatus |
| ImagingStudy.modality | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html |
| ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspx |
| ImagingStudy.reasonCode | example | ProcedureReasonCodes |
| ImagingStudy.series.modality | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html |
| ImagingStudy.series.instance.sopClass | extensible | http://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().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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ImagingStudy | 0..* | ImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Identifiers for the whole study | ||||
| status | ?!SΣ | 1..1 | code | registered | available | cancelled | entered-in-error | unknown Binding: ImagingStudyStatus (required): The status of the ImagingStudy. | ||||
| modality | SΣ | 0..* | Coding | All series modality if actual acquisition modalities Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance. | ||||
| subject | SΣ | 1..1 | Reference(Device | Group | Patient) | Who or what is the subject of the study | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter with which this imaging study is associated | ||||
| started | Σ | 0..1 | dateTime | When the study was started Example General: 2011-01-01T11:01:20+03:00 | ||||
| basedOn | Σ | 0..* | Reference(Appointment | AppointmentResponse | Task | ServiceRequest | CarePlan) | Request fulfilled | ||||
| referrer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Referring physician | ||||
| interpreter | Σ | 0..* | Reference(Practitioner | PractitionerRole) | Who interpreted images | ||||
| endpoint | Σ | 0..* | Reference(Endpoint) | Study access endpoint | ||||
| numberOfSeries | SΣ | 0..1 | unsignedInt | Number of Study Related Series | ||||
| numberOfInstances | SΣ | 0..1 | unsignedInt | Number of Study Related Instances | ||||
| procedureReference | Σ | 0..1 | Reference(Procedure) | The performed Procedure reference | ||||
| procedureCode | Σ | 0..* | CodeableConcept | The performed procedure code Binding: http://www.rsna.org/RadLex_Playbook.aspx (extensible): The performed procedure type. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| location | Σ | 0..1 | Reference(Location) | Where ImagingStudy occurred | ||||
| reasonCode | Σ | 0..* | CodeableConcept | Why the study was requested Binding: ProcedureReasonCodes (example): The reason for the study. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | Media | DocumentReference | DiagnosticReportImaging | DiagnosticReportLab) | Why was study performed | ||||
| note | Σ | 0..* | Annotation | User-defined comments | ||||
| description | Σ | 0..1 | string | Institution-generated description | ||||
| series | SΣ | 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 | SΣ | 1..1 | id | DICOM Series Instance UID for the series Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630 | ||||
| number | Σ | 0..1 | unsignedInt | Numeric identifier of this series Example General: 3 | ||||
| modality | SΣ | 1..1 | Coding | The modality of the instances in the series Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible): Type of acquired data in the instance. | ||||
| description | Σ | 0..1 | string | A short human readable summary of the series Example General: CT Surview 180 | ||||
| numberOfInstances | Σ | 0..1 | unsignedInt | Number of Series Related Instances | ||||
| endpoint | Σ | 0..* | Reference(Endpoint) | Series access endpoint | ||||
| bodySite | Σ | 0..1 | 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) | Specimen imaged | ||||
| started | Σ | 0..1 | dateTime | When the series started | ||||
| performer | Σ | 0..* | BackboneElement | Who performed the series | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer. | ||||
| actor | Σ | 1..1 | Reference(CareTeam | Device | RelatedPerson | Practitioner | PractitionerRole | Organization | Patient) | Who performed the series | ||||
| instance | S | 0..* | BackboneElement | A single SOP instance from the series | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| uid | 1..1 | id | DICOM SOP Instance UID Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903 | |||||
| sopClass | 1..1 | Coding | DICOM class type Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance. | |||||
| number | 0..1 | unsignedInt | The number of this instance in the series Example General: 1 | |||||
| title | 0..1 | string | Description of instance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| ImagingStudy.language | preferred | CommonLanguages
| ||||
| ImagingStudy.status | required | ImagingStudyStatus | ||||
| ImagingStudy.modality | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | ||||
| ImagingStudy.procedureCode | extensible | http://www.rsna.org/RadLex_Playbook.aspx | ||||
| ImagingStudy.reasonCode | example | ProcedureReasonCodes | ||||
| ImagingStudy.series.modality | extensible | http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | ||||
| ImagingStudy.series.bodySite | example | SNOMEDCTBodyStructures | ||||
| ImagingStudy.series.laterality | example | Laterality | ||||
| ImagingStudy.series.performer.function | extensible | ImagingStudySeriesPerformerFunction | ||||
| ImagingStudy.series.instance.sopClass | extensible | http://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().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() |
This structure is derived from ImagingStudy
Summary
Mandatory: 0 element (6 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 2 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron