This page is part of the Structured Data Capture FHIR IG (v4.0.0-ballot: STU 4 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Assemble Modular Questionnaire Operation - JSON Representation

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "Questionnaire-assemble",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition Questionnaire-assemble</b></p><a name=\"Questionnaire-assemble\"> </a><a name=\"hcQuestionnaire-assemble\"> </a><a name=\"Questionnaire-assemble-en-US\"> </a><p>URL: [base]/Questionnaire/$assemble</p><p>URL: [base]/Questionnaire/[id]/$assemble</p><p>Input parameters Profile:<a href=\"StructureDefinition-sdc-questionnaire-modular.html\">SDC Modular Questionnaire</a></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>questionnaire</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a> | <a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> | <a href=\"http://hl7.org/fhir/R4/questionnaire.html\">Questionnaire</a></td><td/><td><div><p>The <a href=\"StructureDefinition-sdc-questionnaire-modular.html\">Modular Questionnaire</a> to assemble the content of. Can be provided as a canonical for the questionnaire, a questionnaire reference, or directly as a questionnaire resource.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>The fully assembled <a href=\"StructureDefinition-sdc-questionnaire.html\">Questionnaire</a> with all subQuestionnaires inlined and all items with item.definitions have had relevant metadata propagated into the item.</p>\n</div></td></tr><tr><td>OUT</td><td>outcome</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/resource.html\">Resource</a></td><td/><td><div><p>The OperationOutcome indicating any warnings or information messages with the assembly process</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fhir"
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 4,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
          }
        ]
      }
    },
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode" : "trial-use",
      "_valueCode" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-assemble",
  "version" : "4.0.0-ballot",
  "name" : "SDCAssemble",
  "title" : "Assemble Modular Questionnaire Operation",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-12-17T01:55:34+00:00",
  "publisher" : "HL7 International / FHIR Infrastructure",
  "contact" : [
    {
      "name" : "HL7 International / FHIR Infrastructure",
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    },
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description" : "The $assemble operation takes a modular questionnaire (one that references sub-questionnaires and/or relies on definition elements to contain the content for item definitions) and produces the equivalent fully-inline Questionnaire.  Full details on the process can be found [here](modular.html).",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "code" : "assemble",
  "resource" : [
    "Questionnaire"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "inputProfile" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-modular",
  "parameter" : [
    {
      "extension" : [
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "uri"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "Reference"
        },
        {
          "url" : "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
          "valueUri" : "Questionnaire"
        }
      ],
      "name" : "questionnaire",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The [Modular Questionnaire](StructureDefinition-sdc-questionnaire-modular.html) to assemble the content of. Can be provided as a canonical for the questionnaire, a questionnaire reference, or directly as a questionnaire resource.",
      "type" : "Element"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "The fully assembled [Questionnaire](StructureDefinition-sdc-questionnaire.html) with all subQuestionnaires inlined and all items with item.definitions have had relevant metadata propagated into the item.",
      "type" : "Resource"
    },
    {
      "name" : "outcome",
      "use" : "out",
      "min" : 0,
      "max" : "1",
      "documentation" : "The OperationOutcome indicating any warnings or information messages with the assembly process",
      "type" : "Resource"
    }
  ]
}