SQL on FHIR
2.1.0-pre - release
SQL on FHIR
2.1.0-pre - release
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
| Active as of 2025-10-08 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="ViewDefinitionRun"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition ViewDefinitionRun</b></p><a name="ViewDefinitionRun"> </a><a name="hcViewDefinitionRun"> </a><p>URL: [base]/$viewdefinition-run</p><p>URL: [base]/CanonicalResource/$viewdefinition-run</p><p>URL: [base]/CanonicalResource/[id]/$viewdefinition-run</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>_format</td><td>type, instance</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>Output format for the result (for example json, ndjson, csv, parquet).</p>
</div></td></tr><tr><td>IN</td><td>header</td><td>type, instance</td><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#boolean">boolean</a></td><td/><td><div><p>Include CSV headers (default true). Applies only when csv output is requested.</p>
</div></td></tr><tr><td>IN</td><td>viewReference</td><td>type, instance</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 a ViewDefinition stored on the server.</p>
</div></td></tr><tr><td>IN</td><td>viewResource</td><td>type</td><td>0..1</td><td><a href="http://hl7.org/fhir/R5/canonicalresource.html">CanonicalResource</a> (<a href="StructureDefinition-ViewDefinition.html" title="https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition">View Definition</a>)</td><td/><td><div><p>Inline ViewDefinition resource to execute.</p>
</div></td></tr><tr><td>IN</td><td>patient</td><td>type, instance</td><td>0..1</td><td><a href="http://hl7.org/fhir/R5/references.html#Reference">Reference</a></td><td/><td><div><p>Restrict execution to the specified patient.</p>
</div></td></tr><tr><td>IN</td><td>group</td><td>type, instance</td><td>0..*</td><td><a href="http://hl7.org/fhir/R5/references.html#Reference">Reference</a></td><td/><td><div><p>Restrict execution to members of the given group(s).</p>
</div></td></tr><tr><td>IN</td><td>source</td><td>type, instance</td><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td/><td><div><p>External data source to use (for example a URI or bucket name).</p>
</div></td></tr><tr><td>IN</td><td>resource</td><td>type, instance</td><td>0..*</td><td><a href="http://hl7.org/fhir/R5/resource.html">Resource</a></td><td/><td><div><p>FHIR resources to transform instead of using server data.</p>
</div></td></tr><tr><td>IN</td><td>_limit</td><td>type, instance</td><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#integer">integer</a></td><td/><td><div><p>Maximum number of rows to return.</p>
</div></td></tr><tr><td>IN</td><td>_since</td><td>type, instance</td><td>0..1</td><td><a href="http://hl7.org/fhir/R5/datatypes.html#instant">instant</a></td><td/><td><div><p>Include only resources modified after this instant.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/binary.html">Binary</a></td><td/><td><div><p>Transformed data encoded in the requested output format.</p>
</div></td></tr></table></div>
</text>
<url
value="http://sql-on-fhir.org/OperationDefinition/$viewdefinition-run"/>
<version value="2.1.0-pre"/>
<versionAlgorithmString value="semver"/>
<name value="ViewDefinitionRun"/>
<title value="ViewDefinition Run"/>
<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="Execute a view definition against supplied or server data."/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<code value="viewdefinition-run"/>
<resource value="CanonicalResource"/>
<system value="true"/>
<type value="true"/>
<instance value="true"/>
<parameter>
<name value="_format"/>
<use value="in"/>
<scope value="type"/>
<scope value="instance"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Output format for the result (for example json, ndjson, csv, parquet)."/>
<type value="code"/>
<binding>
<strength value="extensible"/>
<valueSet
value="https://sql-on-fhir.org/ig/ValueSet/OutputFormatCodes"/>
</binding>
</parameter>
<parameter>
<name value="header"/>
<use value="in"/>
<scope value="type"/>
<scope value="instance"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Include CSV headers (default true). Applies only when csv output is requested."/>
<type value="boolean"/>
</parameter>
<parameter>
<name value="viewReference"/>
<use value="in"/>
<scope value="type"/>
<scope value="instance"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Reference to a ViewDefinition stored on the server."/>
<type value="Reference"/>
</parameter>
<parameter>
<name value="viewResource"/>
<use value="in"/>
<scope value="type"/>
<min value="0"/>
<max value="1"/>
<documentation value="Inline ViewDefinition resource to execute."/>
<type value="CanonicalResource"/>
<targetProfile
value="https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"/>
</parameter>
<parameter>
<name value="patient"/>
<use value="in"/>
<scope value="type"/>
<scope value="instance"/>
<min value="0"/>
<max value="1"/>
<documentation value="Restrict execution to the specified patient."/>
<type value="Reference"/>
</parameter>
<parameter>
<name value="group"/>
<use value="in"/>
<scope value="type"/>
<scope value="instance"/>
<min value="0"/>
<max value="*"/>
<documentation
value="Restrict execution to members of the given group(s)."/>
<type value="Reference"/>
</parameter>
<parameter>
<name value="source"/>
<use value="in"/>
<scope value="type"/>
<scope value="instance"/>
<min value="0"/>
<max value="1"/>
<documentation
value="External data source to use (for example a URI or bucket name)."/>
<type value="string"/>
</parameter>
<parameter>
<name value="resource"/>
<use value="in"/>
<scope value="type"/>
<scope value="instance"/>
<min value="0"/>
<max value="*"/>
<documentation
value="FHIR resources to transform instead of using server data."/>
<type value="Resource"/>
</parameter>
<parameter>
<name value="_limit"/>
<use value="in"/>
<scope value="type"/>
<scope value="instance"/>
<min value="0"/>
<max value="1"/>
<documentation value="Maximum number of rows to return."/>
<type value="integer"/>
</parameter>
<parameter>
<name value="_since"/>
<use value="in"/>
<scope value="type"/>
<scope value="instance"/>
<min value="0"/>
<max value="1"/>
<documentation
value="Include only resources modified after this instant."/>
<type value="instant"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="Transformed data encoded in the requested output format."/>
<type value="Binary"/>
</parameter>
</OperationDefinition>