KISIM Medical Report IG
0.1.0 - ci-build CH

KISIM Medical Report IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: Search Document Resources - JSON Representation

Draft as of 2025-04-24

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "operation-medical-report",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition operation-medical-report</b></p><a name=\"operation-medical-report\"> </a><a name=\"hcoperation-medical-report\"> </a><a name=\"operation-medical-report-en-US\"> </a><p>URL: [base]/Bundle/$medical-report</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>questionnaireId</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#string\">string</a>)</td><td/><td><div><p>Questionnaire ID to add to the bundle. Same as a call to /Questionnaire/{questionnaireId}</p>\n</div></td></tr><tr><td>IN</td><td>compoundId</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#string\">string</a>)</td><td/><td><div><p>Compound ID which represents a set of Questionnaires. The Questionnaires are added to the Bundle</p>\n</div></td></tr><tr><td>IN</td><td>encounterId</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#string\">string</a>)</td><td/><td><div><p>Encounter ID which is mandatory and produces an Encounter resource added to the bundle</p>\n</div></td></tr><tr><td>IN</td><td>reportId</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a><br/>(<a href=\"http://hl7.org/fhir/R4/search.html#string\">string</a>)</td><td/><td><div><p>Report ID, which if set, adds a specific identifier to the bundle. This identifier needs to be returned with the document bundle</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://fhir.kisimdocs.ch/ig/KisimMedicalReport/OperationDefinition/operation-medical-report",
  "version" : "0.1.0",
  "name" : "OperationMedicalReport",
  "title" : "Search Document Resources",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2025-04-24T18:27:33+02:00",
  "publisher" : "CISTEC AG",
  "contact" : [
    {
      "name" : "CISTEC AG",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.cistec.com"
        }
      ]
    }
  ],
  "description" : "Returns a bundle of type collection containing all the resources needed to create a medical report document",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "CH",
          "display" : "Switzerland"
        }
      ]
    }
  ],
  "code" : "medical-report",
  "resource" : [
    "Bundle"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "questionnaireId",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Questionnaire ID to add to the bundle. Same as a call to /Questionnaire/{questionnaireId}",
      "type" : "string",
      "searchType" : "string"
    },
    {
      "name" : "compoundId",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Compound ID which represents a set of Questionnaires. The Questionnaires are added to the Bundle",
      "type" : "string",
      "searchType" : "string"
    },
    {
      "name" : "encounterId",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "Encounter ID which is mandatory and produces an Encounter resource added to the bundle",
      "type" : "string",
      "searchType" : "string"
    },
    {
      "name" : "reportId",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Report ID, which if set, adds a specific identifier to the bundle. This identifier needs to be returned with the document bundle",
      "type" : "string",
      "searchType" : "string"
    }
  ]
}