- This is an Implementation Guide for UK Core FHIR Assets in Development.
- There will be disruption as the content will be updated on an ad-hoc basis and with links not working.
- Therefore this Implementation Guide must not be implemented.
- Please follow the guidance on the "Contact Us" page if you need any assistance.
StructureDefinition-UKCore-ImagingStudy
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-ImagingStudy | draft | 1.1.0 | 2023-12-12 | This profile defines the UK constraints and extensions on the International FHIR resource ImagingStudy |
Profile_Purpose |
---|
This profile allows exchange of the content produced in a DICOM imaging study. |
Detailed Descriptions
ImagingStudy | |
Definition | Representation of the content produced in a DICOM imaging study. A study comprises a set of series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A series is of only one modality (e.g. X-ray, CT, MR, ultrasound), but a study may have multiple series of different modalities. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
ImagingStudy.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | System.String |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
ImagingStudy.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
ImagingStudy.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
ImagingStudy.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. CommonLanguages (preferred) |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Mappings |
|
ImagingStudy.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
ImagingStudy.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
ImagingStudy.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ImagingStudy.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ImagingStudy.identifier | |
Definition | Identifiers for the ImagingStudy such as DICOM Study Instance UID, and Accession Number. |
Cardinality | 0...* |
Type | Identifier |
Summary | True |
Alias | StudyInstanceUID, AccessionNumber |
Requirements | If one or more series elements are present in the ImagingStudy, then there shall be one DICOM Study UID identifier (see DICOM PS 3.3 C.7.2. |
Comments | See discussion under Imaging Study Implementation Notes for encoding of DICOM Study Instance UID. Accession Number should use ACSN Identifier type. |
Invariants |
|
Mappings |
|
ImagingStudy.status | |
Definition | The current state of the ImagingStudy. |
Cardinality | 1...1 |
Type | code |
Binding | The status of the ImagingStudy. ImagingStudyStatus (required) |
Must Support | True |
Modifier | True |
Summary | True |
Comments | Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is. |
Invariants |
|
Mappings |
|
ImagingStudy.modality | |
Definition | A list of all the series.modality values that are actual acquisition modalities, i.e. those in the DICOM Context Group 29 (value set OID 1.2.840.10008.6.1.19). |
Cardinality | 0...* |
Type | Coding |
Binding | Type of acquired data in the instance. http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible) |
Must Support | True |
Summary | True |
Alias | ModalitiesInStudy |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
ImagingStudy.subject | |
Definition | The subject, typically a patient, of the imaging study. |
Cardinality | 1...1 |
Type | Reference(Patient | Device | Group) |
Must Support | True |
Summary | True |
Comments | QA phantoms can be recorded with a Device; multiple subjects (such as mice) can be recorded with a Group. |
Invariants |
|
Mappings |
|
ImagingStudy.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this ImagingStudy is made. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Must Support | True |
Summary | True |
Comments | This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. pre-admission test). |
Invariants |
|
Mappings |
|
ImagingStudy.started | |
Definition | Date and time the study started. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Alias | StudyDate, StudyTime |
Invariants |
|
Examples | General 2011-01-01T11:01:20+03:00 |
Mappings |
|
ImagingStudy.basedOn | |
Definition | A list of the diagnostic requests that resulted in this imaging study being performed. |
Cardinality | 0...* |
Type | Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) |
Summary | True |
Requirements | To support grouped procedures (one imaging study supporting multiple ordered procedures, e.g. chest/abdomen/pelvis CT). |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ImagingStudy.referrer | |
Definition | The requesting/referring physician. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole) |
Summary | True |
Alias | ReferringPhysiciansName |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ImagingStudy.interpreter | |
Definition | Who read the study and interpreted the images or other content. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole) |
Summary | True |
Alias | Name of Physician(s) Reading Study |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ImagingStudy.endpoint | |
Definition | The network service providing access (e.g., query, view, or retrieval) for the study. See implementation notes for information about using DICOM endpoints. A study-level endpoint applies to each series in the study, unless overridden by a series-level endpoint with the same Endpoint.connectionType. |
Cardinality | 0...* |
Type | Reference(Endpoint) |
Summary | True |
Requirements | Access methods for viewing (e.g., IHE’s IID profile) or retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the study or the study’s series or instances. The study-level baseLocation applies to each series in the study, unless overridden in series by a series-level baseLocation of the same type. |
Comments | Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG), formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances; or IHE Invoke Image Display (IID), which provides standard invocation of an imaging web viewer. |
Invariants |
|
Mappings |
|
ImagingStudy.numberOfSeries | |
Definition | Number of Series in the Study. This value given may be larger than the number of series elements this Resource contains due to resource availability, security, or other factors. This element should be present if any series elements are present. |
Cardinality | 0...1 |
Type | unsignedInt |
Summary | True |
Alias | NumberOfStudyRelatedSeries |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
ImagingStudy.numberOfInstances | |
Definition | Number of SOP Instances in Study. This value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present. |
Cardinality | 0...1 |
Type | unsignedInt |
Summary | True |
Alias | NumberOfStudyRelatedInstances |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
ImagingStudy.procedureReference | |
Definition | The procedure which this ImagingStudy was part of. |
Cardinality | 0...1 |
Type | Reference(Procedure) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ImagingStudy.procedureCode | |
Definition | The code for the performed procedure type. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The performed procedure type. http://www.rsna.org/RadLex_Playbook.aspx (extensible) |
Summary | True |
Alias | ProcedureCodeSequence |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
ImagingStudy.location | |
Definition | The principal physical location where the ImagingStudy was performed. |
Cardinality | 0...1 |
Type | Reference(Location) |
Summary | True |
Requirements | Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ImagingStudy.reasonCode | |
Definition | Description of clinical condition indicating why the ImagingStudy was requested. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The reason for the study. ProcedureReasonCodes (example) |
Summary | True |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
ImagingStudy.reasonReference | |
Definition | Indicates another resource whose existence justifies this Study. |
Cardinality | 0...* |
Type | Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ImagingStudy.note | |
Definition | Per the recommended DICOM mapping, this element is derived from the Study Description attribute (0008,1030). Observations or findings about the imaging study should be recorded in another resource, e.g. Observation, and not in this element. |
Cardinality | 0...* |
Type | Annotation |
Summary | True |
Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
Invariants |
|
Mappings |
|
ImagingStudy.description | |
Definition | The Imaging Manager description of the study. Institution-generated description or classification of the Study (component) performed. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | StudyDescription |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
ImagingStudy.series | |
Definition | Each study has one or more series of images or other content. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
ImagingStudy.series.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
ImagingStudy.series.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ImagingStudy.series.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
ImagingStudy.series.uid | |
Definition | The DICOM Series Instance UID for the series. |
Cardinality | 1...1 |
Type | id |
Summary | True |
Alias | SeriesInstanceUID |
Requirements | DICOM Series Instance UID. |
Comments | See DICOM PS3.3 C.7.3. |
Invariants |
|
Examples | General 2.16.124.113543.6003.2588828330.45298.17418.2723805630 |
Mappings |
|
ImagingStudy.series.number | |
Definition | The numeric identifier of this series in the study. |
Cardinality | 0...1 |
Type | unsignedInt |
Summary | True |
Alias | SeriesNumber |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Examples | General 3 |
Mappings |
|
ImagingStudy.series.modality | |
Definition | The modality of this series sequence. |
Cardinality | 1...1 |
Type | Coding |
Binding | Type of acquired data in the instance. http://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (extensible) |
Summary | True |
Alias | Modality |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
ImagingStudy.series.description | |
Definition | A description of the series. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | SeriesDescription |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Examples | General CT Surview 180 |
Mappings |
|
ImagingStudy.series.numberOfInstances | |
Definition | Number of SOP Instances in the Study. The value given may be larger than the number of instance elements this resource contains due to resource availability, security, or other factors. This element should be present if any instance elements are present. |
Cardinality | 0...1 |
Type | unsignedInt |
Summary | True |
Alias | NumberOfSeriesRelatedInstances |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
ImagingStudy.series.endpoint | |
Definition | The network service providing access (e.g., query, view, or retrieval) for this series. See implementation notes for information about using DICOM endpoints. A series-level endpoint, if present, has precedence over a study-level endpoint with the same Endpoint.connectionType. |
Cardinality | 0...* |
Type | Reference(Endpoint) |
Summary | True |
Requirements | Access methods for retrieving (e.g., DICOM’s WADO-URI and WADO-RS) the series or the series’ instances. A baseLocation specified at the series level has precedence over a baseLocation of the same type specified at the study level. |
Comments | Typical endpoint types include DICOM WADO-RS, which is used to retrieve DICOM instances in native or rendered (e.g., JPG, PNG) formats using a RESTful API; DICOM WADO-URI, which can similarly retrieve native or rendered instances, except using an HTTP query-based approach; and DICOM QIDO-RS, which allows RESTful query for DICOM information without retrieving the actual instances. |
Invariants |
|
Mappings |
|
ImagingStudy.series.bodySite | |
Definition | The anatomic structures examined. See DICOM Part 16 Annex L (http://dicom.nema.org/medical/dicom/current/output/chtml/part16/chapter_L.html) for DICOM to SNOMED-CT mappings. The bodySite may indicate the laterality of body part imaged; if so, it shall be consistent with any content of ImagingStudy.series.laterality. |
Cardinality | 0...1 |
Type | Coding |
Binding | Codes describing anatomical locations. May include laterality. SNOMEDCTBodyStructures (example) |
Summary | True |
Alias | BodyPartExamined |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
ImagingStudy.series.laterality | |
Definition | The laterality of the (possibly paired) anatomic structures examined. E.g., the left knee, both lungs, or unpaired abdomen. If present, shall be consistent with any laterality information indicated in ImagingStudy.series.bodySite. |
Cardinality | 0...1 |
Type | Coding |
Binding | Codes describing body site laterality (left, right, etc.). Laterality (example) |
Summary | True |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
ImagingStudy.series.specimen | |
Definition | The specimen imaged, e.g., for whole slide imaging of a biopsy. |
Cardinality | 0...* |
Type | Reference(Specimen) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ImagingStudy.series.started | |
Definition | The date and time the series was started. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Invariants |
|
Mappings |
|
ImagingStudy.series.performer | |
Definition | Indicates who or what performed the series and how they were involved. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Alias | PerformingPhysicianName, OperatorName |
Requirements | The performer is recorded at the series level, since each series in a study may be performed by a different performer, at different times, and using different devices. A series may be performed by multiple performers. |
Comments | If the person who performed the series is not known, their Organization may be recorded. A patient, or related person, may be the performer, e.g. for patient-captured images. |
Invariants |
|
Mappings |
|
ImagingStudy.series.performer.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
ImagingStudy.series.performer.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ImagingStudy.series.performer.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
ImagingStudy.series.performer.function | |
Definition | Distinguishes the type of involvement of the performer in the series. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The type of involvement of the performer. ImagingStudySeriesPerformerFunction (extensible) |
Summary | True |
Requirements | Allows disambiguation of the types of involvement of different performers. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
ImagingStudy.series.performer.actor | |
Definition | Indicates who or what performed the series. |
Cardinality | 1...1 |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
ImagingStudy.series.instance | |
Definition | A single SOP instance within the series, e.g. an image, or presentation state. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
ImagingStudy.series.instance.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
ImagingStudy.series.instance.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ImagingStudy.series.instance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
ImagingStudy.series.instance.uid | |
Definition | The DICOM SOP Instance UID for this image or other DICOM content. |
Cardinality | 1...1 |
Type | id |
Alias | SOPInstanceUID |
Requirements | DICOM SOP Instance UID. |
Comments | See DICOM PS3.3 C.12.1. |
Invariants |
|
Examples | General 2.16.124.113543.6003.189642796.63084.16748.2599092903 |
Mappings |
|
ImagingStudy.series.instance.sopClass | |
Definition | DICOM instance type. |
Cardinality | 1...1 |
Type | Coding |
Binding | The sopClass for the instance. http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible) |
Alias | SOPClassUID |
Comments | Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. |
Invariants |
|
Mappings |
|
ImagingStudy.series.instance.number | |
Definition | The number of instance in the series. |
Cardinality | 0...1 |
Type | unsignedInt |
Alias | InstanceNumber |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Examples | General 1 |
Mappings |
|
ImagingStudy.series.instance.title | |
Definition | The description of the instance. |
Cardinality | 0...1 |
Type | string |
Comments | Particularly for post-acquisition analytic objects, such as SR, presentation states, value mapping, etc. |
Invariants |
|
Mappings |
|
Table View
ImagingStudy | .. | |
ImagingStudy.status | .. | |
ImagingStudy.modality | .. | |
ImagingStudy.subject | .. | |
ImagingStudy.encounter | .. | |
ImagingStudy.series | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-ImagingStudy" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-ImagingStudy" /> <version value="1.1.0" /> <name value="UKCoreImagingStudy" /> <title value="UK Core Imaging Study" /> <status value="draft" /> <date value="2023-12-12" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This profile defines the UK constraints and extensions on the International FHIR resource [ImagingStudy](https://hl7.org/fhir/R4/ImagingStudy.html)" /> <purpose value="This profile allows exchange of the content produced in a DICOM imaging study." /> <copyright value="Copyright &#169; 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7&#174; FHIR&#174; standard Copyright &#169; 2011+ HL7 The HL7&#174; FHIR&#174; standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="ImagingStudy" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ImagingStudy" /> <derivation value="constraint" /> <differential> <element id="ImagingStudy.status"> <path value="ImagingStudy.status" /> <mustSupport value="true" /> </element> <element id="ImagingStudy.modality"> <path value="ImagingStudy.modality" /> <mustSupport value="true" /> </element> <element id="ImagingStudy.subject"> <path value="ImagingStudy.subject" /> <mustSupport value="true" /> </element> <element id="ImagingStudy.encounter"> <path value="ImagingStudy.encounter" /> <mustSupport value="true" /> </element> <element id="ImagingStudy.series"> <path value="ImagingStudy.series" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-ImagingStudy", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-ImagingStudy", "version": "1.1.0", "name": "UKCoreImagingStudy", "title": "UK Core Imaging Study", "status": "draft", "date": "2023-12-12", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [ImagingStudy](https://hl7.org/fhir/R4/ImagingStudy.html)", "purpose": "This profile allows exchange of the content produced in a DICOM imaging study.", "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "ImagingStudy", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ImagingStudy", "derivation": "constraint", "differential": { "element": [ { "id": "ImagingStudy.status", "path": "ImagingStudy.status", "mustSupport": true }, { "id": "ImagingStudy.modality", "path": "ImagingStudy.modality", "mustSupport": true }, { "id": "ImagingStudy.subject", "path": "ImagingStudy.subject", "mustSupport": true }, { "id": "ImagingStudy.encounter", "path": "ImagingStudy.encounter", "mustSupport": true }, { "id": "ImagingStudy.series", "path": "ImagingStudy.series", "mustSupport": true } ] } }
Usage
This Profile has the following derived profiles:This Profile is referenced in the following Extensions:
This Profile is referenced in the following Profiles:
Feedback
Click here to:Examples
CT Chest Scan - An example to illustrate sharing CT scan imagery.Example UKCore-ImagingStudy-CTChestScan
Example Usage Scenarios
The following are example usage scenarios for the UK Core Imaging Study profile:
- Query and share DICOM images
Profile Specific Implementation Guidance:
Minimum Viable Content
A minimum viable content that all provider and consumer systems SHALL support are the following elements.
Element | Reason |
---|---|
ImagingStudy.status |
The current state of the ImagingStudy. |
ImagingStudy.modality |
All series modality if actual acquisition modalities. |
ImagingStudy.subject |
Who or what is the subject of the study. |
ImagingStudy.encounter |
The encounter with which this imaging study is associated |
ImagingStudy.series |
Each study has one or more series of images or other content. |
subject
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
encounter
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Encounter.
basedOn
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
- Profile UKCore-Appointment
- AppointmentResponse Resource
- Profile UKCore-CarePlan
- Profile UKCore-ServiceRequest
- Profile UKCore-Task
referrer
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
interpreter
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
procedureReference
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Procedure.
location
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Location.
reasonReference
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
- Profile UKCore-Condition
- Profile UKCore-DiagnosticReport
- Profile UKCore-DocumentReference
- Media Resource
- Profile UKCore-Observation
note
The resource being referenced by ImagingStudy.note.authorReference
SHALL conform to one of the following:
- Profile UKCore-Organization
- Profile UKCore-Patient
- Profile UKCore-Practitioner
- Profile UKCore-RelatedPerson
series
ImagingStudy.series.specimen
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Specimen.
ImagingStudy.series.performer.actor
The resource being referenced by ImagingStudy.note.authorReference
SHALL conform to one of the following:
- Profile UKCore-CareTeam
- [Profile UKCore-Device
- Profile UKCore-Organization
- Profile UKCore-Patient
- Profile UKCore-Practitioner
- Profile UKCore-PractitionerRole
- Profile UKCore-RelatedPerson