RetinaIntegration
0.5.0 - ci-build

RetinaIntegration - Local Development build (v0.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Retina ImagingStudy ( Experimental )

Official URL: http://dips.no/fhir/RetinaIntegration/StructureDefinition/retina-imagingstudy Version: 0.5.0
Draft as of 2025-12-02 Computable Name: RetinaImagingStudy

Profile for imaging studies related to retina examinations, including fundus photography and OCT imaging.

Overview

The RetinaImagingStudy profile is used to document imaging studies performed during retina screening examination.

The study will include what type of study was done (fundus photography or Optical Coherence Tomography (OCT)), what camera was used, a reference to the Sectra Media Archive, a description of the picture taken.

Structure

Structure of ImagingStudy after information about the images is added by the AI system. The ImagingSystem.status will then be available. Before the series is added the status will be registered.

ImagingStudy Structure Diagram

Key Elements

Status changes during the EyeCare Retinopathy Workflow

Of the possible statuses of a ImagingStudy (registered available cancelled entered-in-error unknown) we use the following two stages:
  • registered: The photographer has registered the EyeCare form and DIPS has connected the examination with a Sectra study.
  • available: The AI system has appended information about the image study.

identifier

The identifier is the study's ID in the Sectra media archive. It is set by DIPS after DIPS has matched a study to an examination.

Identifier slice: sectraStudyId

System: http://dips.no/fhir/RetinaIntegration/sectra-image-study-id

Subject

Reference to the patient for whom the imaging was performed. This is mandatory and must reference a Patient resource.

procedureCode

The procedure code specifies if OCT or fundus photography was taken.

This code is set when AI system append the image information.

Valid codes are RetinaImagingProcedureValueSet:

  • CKDP10 http://ehelse.no/fhir/CodeSystem/no-kodeverk-7275#CKDP10 for fundus photography
  • CKFX16 http://ehelse.no/fhir/CodeSystem/no-kodeverk-7275#CKFX16 for OCT examination of eye fundus structures using light-wave based technique

Series

After AI has appended results, the ImagingStudy.Series will be populated with one series for each eye. Each series will have a bodySite indicating left or right eye and several image Instances. Each image instance will have a view extension indicating macula or optic disc centring.

Each series may also have a CameraDevice as performer.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... Slices for identifier SΣ 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:sectraStudyId SΣ 1..1 Identifier Sectra Study Identifier.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://dips.no/fhir/RetinaIntegration/sectra-image-study-id
... status ?!SΣ 1..1 code Status of the imaging study: registered (SectraId identified) | available (Image information appended by AI system and is available).
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... subject Σ 1..1 Reference(Patient) Patient who is the subject of the imaging study.
... series Σ 0..* BackboneElement Image series will be added by the AI system.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uid Σ 1..1 id Series Instance UID.
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... modality Σ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality . (extensible): Type of acquired data in the instance.
.... bodySite Σ 1..1 Coding Body site (eye) for this series.
Binding: Retina Body Site (required)
.... performer Σ 0..* BackboneElement Device that captured the images in this series.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Who performed the series
.... instance 1..* BackboneElement Individual image instances in this series.
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:view 1..1 CodeableConcept Image view/centering
URL: http://dips.no/fhir/RetinaIntegration/StructureDefinition/retinal-image-view
Binding: Retina Image View (required)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid 1..1 id Image 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.status Base required ImagingStudyStatus 📍4.0.1 FHIR Std.
ImagingStudy.procedureCode Base required Retina Imaging Procedures 📦0.5.0 This IG
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​bodySite Base required Retina Body Site 📦0.5.0 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 Not State Unknown

Constraints

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()

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... implicitRules 0..0 A set of rules under which this content was created
... modifierExtension 0..0 Extension
... Slices for identifier S 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:sectraStudyId S 1..1 Identifier Sectra Study Identifier.
..... use 0..0 usual | official | temp | secondary | old (If known)
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://dips.no/fhir/RetinaIntegration/sectra-image-study-id
... subject 1..1 Reference(Patient) Patient who is the subject of the imaging study.
... procedureCode S 0..1 CodeableConcept OCT or Fundus Photography procedure (after AI analysis).
Binding: Retina Imaging Procedures (required)
... series 0..* BackboneElement Image series will be added by the AI system.
.... uid 1..1 id Series Instance UID.
.... bodySite 1..1 Coding Body site (eye) for this series.
Binding: Retina Body Site (required)
.... performer 0..* BackboneElement Device that captured the images in this series.
.... instance 1..* BackboneElement Individual image instances in this series.
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:view 1..1 CodeableConcept Image view/centering
URL: http://dips.no/fhir/RetinaIntegration/StructureDefinition/retinal-image-view
Binding: Retina Image View (required)
..... uid 1..1 id Image Instance UID.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImagingStudy.procedureCode Base required Retina Imaging Procedures 📦0.5.0 This IG
ImagingStudy.series.​bodySite Base required Retina Body Site 📦0.5.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... Slices for identifier SΣ 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:sectraStudyId SΣ 1..1 Identifier Sectra Study Identifier.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://dips.no/fhir/RetinaIntegration/sectra-image-study-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code Status of the imaging study: registered (SectraId identified) | available (Image information appended by AI system and is available).
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality Σ 0..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible): Type of acquired data in the instance.
... subject Σ 1..1 Reference(Patient) Patient who is the subject of the imaging 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(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) 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 Σ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances Σ 0..1 unsignedInt Number of Study Related Instances
... procedureReference Σ 0..1 Reference(Procedure) The performed Procedure reference
... procedureCode SΣ 0..1 CodeableConcept OCT or Fundus Photography procedure (after AI analysis).
Binding: Retina Imaging Procedures (required)
... location Σ 0..1 Reference(Location) Where ImagingStudy occurred
... reasonCode Σ 0..* CodeableConcept Why the study was requested
Binding: ProcedureReasonCodes (example): The reason for the study.
... reasonReference Σ 0..* Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) Why was study performed
... note Σ 0..* Annotation User-defined comments
... description Σ 0..1 string Institution-generated description
... series Σ 0..* BackboneElement Image series will be added by the AI system.
.... 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 Series Instance UID.
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality Σ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality . (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 Σ 1..1 Coding Body site (eye) for this series.
Binding: Retina Body Site (required)
.... 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 Device that captured the images in this 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(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Who performed the series
.... instance 1..* BackboneElement Individual image instances in this series.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:view 1..1 CodeableConcept Image view/centering
URL: http://dips.no/fhir/RetinaIntegration/StructureDefinition/retinal-image-view
Binding: Retina Image View (required)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid 1..1 id Image 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImagingStudy.identifier:sectraStudyId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ImagingStudy.status Base required ImagingStudyStatus 📍4.0.1 FHIR Std.
ImagingStudy.modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.procedureCode Base required Retina Imaging Procedures 📦0.5.0 This IG
ImagingStudy.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​bodySite Base required Retina Body Site 📦0.5.0 This IG
ImagingStudy.series.​laterality Base example Laterality 📍4.0.1 FHIR Std.
ImagingStudy.series.​performer.function Base extensible ImagingStudy series performer function 📍4.0.1 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

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()

This structure is derived from ImagingStudy

Summary

Mandatory: 3 elements(4 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImagingStudy.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... Slices for identifier SΣ 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:sectraStudyId SΣ 1..1 Identifier Sectra Study Identifier.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://dips.no/fhir/RetinaIntegration/sectra-image-study-id
... status ?!SΣ 1..1 code Status of the imaging study: registered (SectraId identified) | available (Image information appended by AI system and is available).
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... subject Σ 1..1 Reference(Patient) Patient who is the subject of the imaging study.
... series Σ 0..* BackboneElement Image series will be added by the AI system.
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uid Σ 1..1 id Series Instance UID.
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... modality Σ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality . (extensible): Type of acquired data in the instance.
.... bodySite Σ 1..1 Coding Body site (eye) for this series.
Binding: Retina Body Site (required)
.... performer Σ 0..* BackboneElement Device that captured the images in this series.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Who performed the series
.... instance 1..* BackboneElement Individual image instances in this series.
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:view 1..1 CodeableConcept Image view/centering
URL: http://dips.no/fhir/RetinaIntegration/StructureDefinition/retinal-image-view
Binding: Retina Image View (required)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid 1..1 id Image 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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.status Base required ImagingStudyStatus 📍4.0.1 FHIR Std.
ImagingStudy.procedureCode Base required Retina Imaging Procedures 📦0.5.0 This IG
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​bodySite Base required Retina Body Site 📦0.5.0 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 Not State Unknown

Constraints

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()

Differential View

This structure is derived from ImagingStudy

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudy A set of images produced in single study (one or more series of references images)
... implicitRules 0..0 A set of rules under which this content was created
... modifierExtension 0..0 Extension
... Slices for identifier S 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:sectraStudyId S 1..1 Identifier Sectra Study Identifier.
..... use 0..0 usual | official | temp | secondary | old (If known)
..... system 1..1 uri The namespace for the identifier value
Required Pattern: http://dips.no/fhir/RetinaIntegration/sectra-image-study-id
... subject 1..1 Reference(Patient) Patient who is the subject of the imaging study.
... procedureCode S 0..1 CodeableConcept OCT or Fundus Photography procedure (after AI analysis).
Binding: Retina Imaging Procedures (required)
... series 0..* BackboneElement Image series will be added by the AI system.
.... uid 1..1 id Series Instance UID.
.... bodySite 1..1 Coding Body site (eye) for this series.
Binding: Retina Body Site (required)
.... performer 0..* BackboneElement Device that captured the images in this series.
.... instance 1..* BackboneElement Individual image instances in this series.
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:view 1..1 CodeableConcept Image view/centering
URL: http://dips.no/fhir/RetinaIntegration/StructureDefinition/retinal-image-view
Binding: Retina Image View (required)
..... uid 1..1 id Image Instance UID.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImagingStudy.procedureCode Base required Retina Imaging Procedures 📦0.5.0 This IG
ImagingStudy.series.​bodySite Base required Retina Body Site 📦0.5.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... Slices for identifier SΣ 1..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:system
.... identifier:sectraStudyId SΣ 1..1 Identifier Sectra Study Identifier.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: http://dips.no/fhir/RetinaIntegration/sectra-image-study-id
..... value Σ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code Status of the imaging study: registered (SectraId identified) | available (Image information appended by AI system and is available).
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality Σ 0..* Coding All series modality if actual acquisition modalities
Binding: AcquisitionModality . (extensible): Type of acquired data in the instance.
... subject Σ 1..1 Reference(Patient) Patient who is the subject of the imaging 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(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) 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 Σ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances Σ 0..1 unsignedInt Number of Study Related Instances
... procedureReference Σ 0..1 Reference(Procedure) The performed Procedure reference
... procedureCode SΣ 0..1 CodeableConcept OCT or Fundus Photography procedure (after AI analysis).
Binding: Retina Imaging Procedures (required)
... location Σ 0..1 Reference(Location) Where ImagingStudy occurred
... reasonCode Σ 0..* CodeableConcept Why the study was requested
Binding: ProcedureReasonCodes (example): The reason for the study.
... reasonReference Σ 0..* Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) Why was study performed
... note Σ 0..* Annotation User-defined comments
... description Σ 0..1 string Institution-generated description
... series Σ 0..* BackboneElement Image series will be added by the AI system.
.... 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 Series Instance UID.
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality Σ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality . (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 Σ 1..1 Coding Body site (eye) for this series.
Binding: Retina Body Site (required)
.... 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 Device that captured the images in this 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(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Who performed the series
.... instance 1..* BackboneElement Individual image instances in this series.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:view 1..1 CodeableConcept Image view/centering
URL: http://dips.no/fhir/RetinaIntegration/StructureDefinition/retinal-image-view
Binding: Retina Image View (required)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid 1..1 id Image 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImagingStudy.identifier:sectraStudyId.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ImagingStudy.status Base required ImagingStudyStatus 📍4.0.1 FHIR Std.
ImagingStudy.modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.procedureCode Base required Retina Imaging Procedures 📦0.5.0 This IG
ImagingStudy.reasonCode Base example Procedure Reason Codes 📍4.0.1 FHIR Std.
ImagingStudy.series.​modality Base extensible AcquisitionModality . ⏿2025.3.20250714 tx.fhir.org
ImagingStudy.series.​bodySite Base required Retina Body Site 📦0.5.0 This IG
ImagingStudy.series.​laterality Base example Laterality 📍4.0.1 FHIR Std.
ImagingStudy.series.​performer.function Base extensible ImagingStudy series performer function 📍4.0.1 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

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()

This structure is derived from ImagingStudy

Summary

Mandatory: 3 elements(4 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 3 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImagingStudy.identifier

 

Other representations of profile: CSV, Excel, Schematron