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

: Retina Append AI Result Operation - JSON Representation

Draft as of 2025-12-18

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "append-retina-ai-result",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition append-retina-ai-result</b></p><a name=\"append-retina-ai-result\"> </a><a name=\"hcappend-retina-ai-result\"> </a><p>URL: [base]/DiagnosticReport/[id]/$append-retina-ai-result</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>sectraStudyId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Identifier\">Identifier</a></td><td/><td><div><p>Sectra study identifier for the retinal images that were analyzed. System: http://dips.no/fhir/RetinaIntegration/sectra-image-study-id</p>\n</div></td></tr><tr><td>IN</td><td>conclusion</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#CodeableConcept\">CodeableConcept</a></td><td/><td><div><p>Conclusion code for the AI analysis, added to DiagnosticReport.conclusionCode. MUST use codes from RetinaDiagnosticReportConclusionCodeValueSet (http://dips.no/fhir/RetinaIntegration/ValueSet/retina-diagnosticreport-conclusioncode-vs)</p>\n</div></td></tr><tr><td>IN</td><td>daysUntilNextExamination</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#integer\">integer</a></td><td/><td><div><p>Number of days until next examination, stored in extension http://dips.no/fhir/StructureDefinition/days-until-next-examination-extension</p>\n</div></td></tr><tr><td>IN</td><td>aiDevice</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/device.html\">Device</a></td><td/><td><div><p>AI Device that performed the analysis. MUST conform to RetinaAIDevice profile (http://dips.no/fhir/RetinaIntegration/StructureDefinition/retina-ai-device). Should include deviceName with AI product name, and version elements for algorithm version and protocol.</p>\n</div></td></tr><tr><td>IN</td><td>rightDiabeticRetinopathyFinding</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></td><td/><td><div><p>Right eye diabetic retinopathy finding. MUST conform to RetinaDiabeticRetinopathyFinding profile with bodySite set to right eye (SNOMED CT: 5597008).</p>\n</div></td></tr><tr><td>IN</td><td>rightDiabeticMacularEdemaFinding</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></td><td/><td><div><p>Right eye diabetic macular edema finding. MUST conform to RetinaDiabeticMacularEdemaFinding profile with bodySite set to right eye (SNOMED CT: 5597008).</p>\n</div></td></tr><tr><td>IN</td><td>rightImageQualityAssessment</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></td><td/><td><div><p>Right eye image quality assessment. MUST conform to RetinaImageQualityAssessment profile with bodySite set to right eye (SNOMED CT: 5597008).</p>\n</div></td></tr><tr><td>IN</td><td>leftDiabeticRetinopathyFinding</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></td><td/><td><div><p>Left eye diabetic retinopathy finding. MUST conform to RetinaDiabeticRetinopathyFinding profile with bodySite set to left eye (SNOMED CT: 58443009).</p>\n</div></td></tr><tr><td>IN</td><td>leftDiabeticMacularEdemaFinding</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></td><td/><td><div><p>Left eye diabetic macular edema finding. MUST conform to RetinaDiabeticMacularEdemaFinding profile with bodySite set to left eye (SNOMED CT: 58443009).</p>\n</div></td></tr><tr><td>IN</td><td>leftImageQualityAssessment</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></td><td/><td><div><p>Left eye image quality assessment. MUST conform to RetinaImageQualityAssessment profile with bodySite set to left eye (SNOMED CT: 58443009).</p>\n</div></td></tr><tr><td>IN</td><td>fullReport</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Attachment\">Attachment</a></td><td/><td><div><p>Technical details for further reference about the AI grading, stored in DiagnosticReport.presentedForm</p>\n</div></td></tr><tr><td>IN</td><td>metaTags</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#Coding\">Coding</a></td><td/><td><div><p>Workflow tags.\nAdd code http://terminology.hl7.org/CodeSystem/v3-ActReason#VALIDATION when data is for validation purposes only\nand the result from the AI analysis will not be used in clinical decision making.</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://dips.no/fhir/RetinaIntegration/OperationDefinition/append-retina-ai-result",
  "version" : "0.5.0",
  "name" : "AppendRetinaAIResult",
  "title" : "Retina Append AI Result Operation",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2025-12-18T07:21:20+01:00",
  "publisher" : "DIPS AS",
  "contact" : [
    {
      "name" : "DIPS AS",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://dips.no/"
        },
        {
          "system" : "email",
          "value" : "teamsolsiden@dips.no"
        }
      ]
    }
  ],
  "description" : "OperationDefinition for appending retina AI results to an existing DiagnosticReport.",
  "purpose" : "Append results from AI analysis of retina images to a existing DiagnosticReport",
  "code" : "append-retina-ai-result",
  "resource" : [
    "DiagnosticReport"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "sectraStudyId",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Sectra study identifier for the retinal images that were analyzed. System: http://dips.no/fhir/RetinaIntegration/sectra-image-study-id",
      "type" : "Identifier"
    },
    {
      "name" : "conclusion",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Conclusion code for the AI analysis, added to DiagnosticReport.conclusionCode. MUST use codes from RetinaDiagnosticReportConclusionCodeValueSet (http://dips.no/fhir/RetinaIntegration/ValueSet/retina-diagnosticreport-conclusioncode-vs)",
      "type" : "CodeableConcept"
    },
    {
      "name" : "daysUntilNextExamination",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Number of days until next examination, stored in extension http://dips.no/fhir/StructureDefinition/days-until-next-examination-extension",
      "type" : "integer"
    },
    {
      "name" : "aiDevice",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "AI Device that performed the analysis. MUST conform to RetinaAIDevice profile (http://dips.no/fhir/RetinaIntegration/StructureDefinition/retina-ai-device). Should include deviceName with AI product name, and version elements for algorithm version and protocol.",
      "type" : "Device"
    },
    {
      "name" : "rightDiabeticRetinopathyFinding",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Right eye diabetic retinopathy finding. MUST conform to RetinaDiabeticRetinopathyFinding profile with bodySite set to right eye (SNOMED CT: 5597008).",
      "type" : "Observation"
    },
    {
      "name" : "rightDiabeticMacularEdemaFinding",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Right eye diabetic macular edema finding. MUST conform to RetinaDiabeticMacularEdemaFinding profile with bodySite set to right eye (SNOMED CT: 5597008).",
      "type" : "Observation"
    },
    {
      "name" : "rightImageQualityAssessment",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Right eye image quality assessment. MUST conform to RetinaImageQualityAssessment profile with bodySite set to right eye (SNOMED CT: 5597008).",
      "type" : "Observation"
    },
    {
      "name" : "leftDiabeticRetinopathyFinding",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Left eye diabetic retinopathy finding. MUST conform to RetinaDiabeticRetinopathyFinding profile with bodySite set to left eye (SNOMED CT: 58443009).",
      "type" : "Observation"
    },
    {
      "name" : "leftDiabeticMacularEdemaFinding",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Left eye diabetic macular edema finding. MUST conform to RetinaDiabeticMacularEdemaFinding profile with bodySite set to left eye (SNOMED CT: 58443009).",
      "type" : "Observation"
    },
    {
      "name" : "leftImageQualityAssessment",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Left eye image quality assessment. MUST conform to RetinaImageQualityAssessment profile with bodySite set to left eye (SNOMED CT: 58443009).",
      "type" : "Observation"
    },
    {
      "name" : "fullReport",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Technical details for further reference about the AI grading, stored in DiagnosticReport.presentedForm",
      "type" : "Attachment"
    },
    {
      "name" : "metaTags",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "Workflow tags. \n    Add code http://terminology.hl7.org/CodeSystem/v3-ActReason#VALIDATION when data is for validation purposes only\n    and the result from the AI analysis will not be used in clinical decision making.",
      "type" : "Coding"
    }
  ]
}