SQL on FHIR
2.1.0-pre - release International flag

SQL on FHIR - Local Development build (v2.1.0-pre) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: ViewDefinition Export - XML Representation

Active as of 2025-10-08

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ViewDefinitionExport"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition ViewDefinitionExport</b></p><a name="ViewDefinitionExport"> </a><a name="hcViewDefinitionExport"> </a><p>URL: [base]/$viewdefinition-export</p><p>URL: [base]/CanonicalResource/$viewdefinition-export</p><p>URL: [base]/CanonicalResource/[id]/$viewdefinition-export</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>clientId</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td/><td><div><p>The client-supplied identifier for the export. Optional, but can be used for tracking if supported by the server.</p>
</div></td></tr><tr><td>IN</td><td>viewReference</td><td>type</td><td>0..*</td><td><a href="http://hl7.org/fhir/R5/references.html#Reference">Reference</a></td><td/><td><div><p>Reference to an existing view definition on the server.</p>
</div></td></tr><tr><td>IN</td><td>viewResource</td><td>type</td><td>0..*</td><td><a href="http://hl7.org/fhir/R5/resource.html">Resource</a></td><td/><td><div><p>An inline view definition resource to export.</p>
</div></td></tr><tr><td>IN</td><td>view</td><td>type</td><td>0..*</td><td/><td/><td><div><p>Convenience wrapper containing either a view reference, inline resource, or desired output format.</p>
</div></td></tr><tr><td>IN</td><td>view.reference</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/references.html#Reference">Reference</a></td><td/><td><div><p>Reference to the view definition on the server.</p>
</div></td></tr><tr><td>IN</td><td>view.resource</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/resource.html">Resource</a></td><td/><td><div><p>The inline view definition resource.</p>
</div></td></tr><tr><td>IN</td><td>view.format</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td><a href="ValueSet-OutputFormatCodes.html">Output Format Codes</a> (Extensible)</td><td><div><p>Optional explicit output format for this specific view.</p>
</div></td></tr><tr><td>IN</td><td>_format</td><td>type</td><td>1..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td><a href="ValueSet-OutputFormatCodes.html">Output Format Codes</a> (Extensible)</td><td><div><p>The requested bulk export format (for example csv, parquet, json).</p>
</div></td></tr><tr><td>OUT</td><td>clientId</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td/><td><div><p>Echoed clientId when supplied and supported by the server.</p>
</div></td></tr><tr><td>OUT</td><td>exportId</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td/><td><div><p>Identifier assigned to the export request.</p>
</div></td></tr><tr><td>OUT</td><td>location</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#uri">uri</a></td><td/><td><div><p>Polling URL for the export status.</p>
</div></td></tr><tr><td>OUT</td><td>status</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td><a href="ValueSet-ExportStatusCodes.html">Export Status Codes</a> (Required)</td><td><div><p>Status of the export (accepted, in-progress, completed, cancelled, failed).</p>
</div></td></tr><tr><td>OUT</td><td>output</td><td/><td>0..*</td><td/><td/><td><div><p>Collection of exported artefacts.</p>
</div></td></tr><tr><td>OUT</td><td>output.name</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td/><td><div><p>Human-friendly name of the exported view definition.</p>
</div></td></tr><tr><td>OUT</td><td>output.location</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#uri">uri</a></td><td/><td><div><p>Location of the exported file.</p>
</div></td></tr><tr><td>OUT</td><td>output.format</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td><a href="ValueSet-OutputFormatCodes.html">Output Format Codes</a> (Extensible)</td><td><div><p>Format of the exported file (for example csv, parquet, json).</p>
</div></td></tr></table></div>
  </text>
  <url
       value="http://sql-on-fhir.org/OperationDefinition/$viewdefinition-export"/>
  <version value="2.1.0-pre"/>
  <name value="ViewDefinitionExport"/>
  <title value="ViewDefinition Export"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2025-10-08T06:30:12+00:00"/>
  <publisher value="SQL on FHIR Working Group"/>
  <contact>
    <name value="SQL on FHIR Working Group"/>
    <telecom>
      <system value="url"/>
      <value value="https://sql-on-fhir.org"/>
    </telecom>
  </contact>
  <description
               value="Export a view definition. User can provide view definition references and/or resources as part of the input parameters."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <code value="viewdefinition-export"/>
  <resource value="CanonicalResource"/>
  <system value="true"/>
  <type value="true"/>
  <instance value="true"/>
  <parameter>
    <name value="clientId"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="The client-supplied identifier for the export. Optional, but can be used for tracking if supported by the server."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="viewReference"/>
    <use value="in"/>
    <scope value="type"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Reference to an existing view definition on the server."/>
    <type value="Reference"/>
  </parameter>
  <parameter>
    <name value="viewResource"/>
    <use value="in"/>
    <scope value="type"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="An inline view definition resource to export."/>
    <type value="Resource"/>
  </parameter>
  <parameter>
    <name value="view"/>
    <use value="in"/>
    <scope value="type"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="Convenience wrapper containing either a view reference, inline resource, or desired output format."/>
    <part>
      <name value="reference"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="Reference to the view definition on the server."/>
      <type value="Reference"/>
    </part>
    <part>
      <name value="resource"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation value="The inline view definition resource."/>
      <type value="Resource"/>
    </part>
    <part>
      <name value="format"/>
      <use value="in"/>
      <min value="0"/>
      <max value="1"/>
      <documentation
                     value="Optional explicit output format for this specific view."/>
      <type value="code"/>
      <binding>
        <strength value="extensible"/>
        <valueSet
                  value="https://sql-on-fhir.org/ig/ValueSet/OutputFormatCodes"/>
      </binding>
    </part>
  </parameter>
  <parameter>
    <name value="_format"/>
    <use value="in"/>
    <scope value="type"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="The requested bulk export format (for example csv, parquet, json)."/>
    <type value="code"/>
    <binding>
      <strength value="extensible"/>
      <valueSet
                value="https://sql-on-fhir.org/ig/ValueSet/OutputFormatCodes"/>
    </binding>
  </parameter>
  <parameter>
    <name value="clientId"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Echoed clientId when supplied and supported by the server."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="exportId"/>
    <use value="out"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="Identifier assigned to the export request."/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="location"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Polling URL for the export status."/>
    <type value="uri"/>
  </parameter>
  <parameter>
    <name value="status"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Status of the export (accepted, in-progress, completed, cancelled, failed)."/>
    <type value="code"/>
    <binding>
      <strength value="required"/>
      <valueSet
                value="https://sql-on-fhir.org/ig/ValueSet/ExportStatusCodes"/>
    </binding>
  </parameter>
  <parameter>
    <name value="output"/>
    <use value="out"/>
    <min value="0"/>
    <max value="*"/>
    <documentation value="Collection of exported artefacts."/>
    <part>
      <name value="name"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation
                     value="Human-friendly name of the exported view definition."/>
      <type value="string"/>
    </part>
    <part>
      <name value="location"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation value="Location of the exported file."/>
      <type value="uri"/>
    </part>
    <part>
      <name value="format"/>
      <use value="out"/>
      <min value="1"/>
      <max value="1"/>
      <documentation
                     value="Format of the exported file (for example csv, parquet, json)."/>
      <type value="code"/>
      <binding>
        <strength value="extensible"/>
        <valueSet
                  value="https://sql-on-fhir.org/ig/ValueSet/OutputFormatCodes"/>
      </binding>
    </part>
  </parameter>
</OperationDefinition>