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