Generated Narrative: OperationDefinition SQLExport

URL: [base]/$sql-export

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INsubject1..*

One or more artifacts to export, in any mixture of ViewDefinitions, SQLQuery Libraries and SQLView Libraries. Each repetition names a single subject and produces exactly one output entry in the manifest. A request supplying no subject is rejected with 400 Bad Request, as is a request in which two repetitions would produce the same output name.

INsubject.name0..1string

Name for this subject's output entry in the manifest. Where it is omitted the server uses the subject's own name element, and where the subject declares none, a server-generated identifier. Output names are unique across the job.

INsubject.subjectCanonical0..1canonical (View Definition, SQL Query Library, SQL View Library)

Canonical URL of the ViewDefinition, SQLQuery Library or SQLView Library to export, optionally with a |version suffix pinning a version. Exactly one of subjectCanonical, subjectReference and subjectResource is supplied in each repetition.

INsubject.subjectReference0..1Reference (View Definition, SQL Query Library, SQL View Library)

Literal location of the subject to export: a relative URL on this server, or an absolute URL. Not a canonical URL; use subjectCanonical for that. Exactly one of subjectCanonical, subjectReference and subjectResource is supplied in each repetition.

INsubject.subjectResource0..1CanonicalResource (View Definition, SQL Query Library, SQL View Library)

Inline ViewDefinition, SQLQuery Library or SQLView Library to export. Exactly one of subjectCanonical, subjectReference and subjectResource is supplied in each repetition. The declared type is CanonicalResource because ViewDefinition is a logical model rather than a FHIR resource; see Common Operation Behavior (operations-common.html#declared-type).

INsubject.parameters0..1Parameters

Input parameter values for this subject, bound by name to the parameters the Library declares (Library.parameter.name). Permitted only where this repetition's subject is a SQLQuery or SQLView; supplying it where the subject is a ViewDefinition is rejected with 400 Bad Request, because a ViewDefinition declares no parameters.

INcontext0..*CanonicalResource (View Definition, SQL View Library)

Supporting artifacts the server cannot itself resolve, supplied inline and matched by canonical URL against the dependencies in the subjects' transitive relatedArtifact graphs. Applies to the job as a whole rather than to one subject, so an artifact several subjects depend on is supplied once. Accepts inline resources only; there is no context by canonical URL, because a URL is exactly what the server has already failed to resolve. A context entry produces no output entry. See Common Operation Behavior (operations-common.html#context).

INclientTrackingId0..1string

Client-provided tracking identifier for the export job, echoed in the manifest.

IN_format0..1codeExport Output Format Codes (Extensible)

Output format for the exported files (csv, ndjson, parquet, json). Optional; if omitted, the server uses ndjson irrespective of Accept. Requesting fhir is rejected with 400 Bad Request, because an export produces flat files. See Common Operation Behavior (operations-common.html).

INheader0..1boolean

Include CSV headers (default true). Applies only when csv output is requested.

INpatient0..*Reference

Restrict the FHIR resources feeding every subject in the job, before projection, to the supplied patient(s). Where a subject is a SQLQuery or SQLView, that means before the SQL executes. An unresolvable patient is rejected with 400 Bad Request. See Common Operation Behavior (operations-common.html#patient-filter).

INgroup0..*Reference

Restrict the FHIR resources feeding every subject in the job, before projection, to members of the supplied group(s). Where a subject is a SQLQuery or SQLView, that means before the SQL executes. An unresolvable group is rejected with 400 Bad Request. See Common Operation Behavior (operations-common.html#group-filter).

IN_since0..1instant

Include only resources whose state changed after this instant. See Common Operation Behavior (operations-common.html#since-filter).

INsource0..1string

External data source to read from instead of the server's own data (for example a URI or bucket name). Where a subject is a SQLQuery or SQLView, this is where the ViewDefinition tables the query selects from are found.

OUTexportId1..1string

Server-generated identifier assigned to the export job.

OUTclientTrackingId0..1string

Echoed client tracking identifier when provided.

OUTstatus1..1codeExport Status Codes (Required)

Status of the export (accepted, in-progress, completed, cancelled, failed).

OUTlocation1..1uri

URL to poll for export status updates.

OUTcancelUrl0..1uri

Optional URL for cancelling the export.

OUT_format0..1codeExport Output Format Codes (Extensible)

Format of the exported files (echoed from input if supplied).

OUTexportStartTime0..1instant

Timestamp when the export job began.

OUTexportEndTime0..1instant

Timestamp when the export job completed.

OUTexportDuration0..1integer

Duration of the export in seconds.

OUTestimatedTimeRemaining0..1integer

Estimated seconds remaining until completion. Interim polling responses only.

OUToutput0..*

Output information for each exported subject. Exactly one entry per subject repetition, and none for a context entry. Neither manifest order nor computation order is guaranteed; clients correlate entries by name.

OUToutput.name1..1string

Name assigned to this subject's output, derived from subject.name, else the subject's own name element, else a server-generated identifier.

OUToutput.location1..*uri

Download URL(s) for the exported file(s).

 <status value="active"/> <kind value="operation"/> <date value="2026-08-13T15:42:34+00:00"/> <publisher value="HL7 International / FHIR Infrastructure"/> <contact> <name value="HL7 International / FHIR Infrastructure"/> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fiwg"/> </telecom> </contact> <description value="Export one or more ViewDefinitions, SQLQuery Libraries and SQLView Libraries as a single asynchronous job, using the FHIR Asynchronous Interaction Request Pattern."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="001"/> <display value="World"/> </coding> </jurisdiction> <code value="sql-export"/> <system value="true"/> <type value="false"/> <instance value="false"/> <parameter> <name value="subject"/> <use value="in"/> <min value="1"/> <max value="*"/> <documentation value="One or more artifacts to export, in any mixture of ViewDefinitions, SQLQuery Libraries and SQLView Libraries. Each repetition names a single subject and produces exactly one output entry in the manifest. A request supplying no subject is rejected with 400 Bad Request, as is a request in which two repetitions would produce the same output name."/> <part> <name value="name"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Name for this subject's output entry in the manifest. Where it is omitted the server uses the subject's own name element, and where the subject declares none, a server-generated identifier. Output names are unique across the job."/> <type value="string"/> </part> <part> <name value="subjectCanonical"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Canonical URL of the ViewDefinition, SQLQuery Library or SQLView Library to export, optionally with a |version suffix pinning a version. Exactly one of subjectCanonical, subjectReference and subjectResource is supplied in each repetition."/> <type value="canonical"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ViewDefinition"/> <targetProfile value="http://hl7.org/fhir/uv/sql-on-fhir/StructureDefinition/SQLQuery"/> <targetProfile value="http://hl7.org/fhir/uv/sql-on-fhir/StructureDefinition/SQLView"/> </part> <part> <name value="subjectReference"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Literal location of the subject to export: a relative URL on this server, or an absolute URL. Not a canonical URL; use subjectCanonical for that. Exactly one of subjectCanonical, subjectReference and subjectResource is supplied in each repetition."/> <type value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ViewDefinition"/> <targetProfile value="http://hl7.org/fhir/uv/sql-on-fhir/StructureDefinition/SQLQuery"/> <targetProfile value="http://hl7.org/fhir/uv/sql-on-fhir/StructureDefinition/SQLView"/> </part> <part> <name value="subjectResource"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Inline ViewDefinition, SQLQuery Library or SQLView Library to export. Exactly one of subjectCanonical, subjectReference and subjectResource is supplied in each repetition. The declared type is CanonicalResource because ViewDefinition is a logical model rather than a FHIR resource; see Common Operation Behavior (operations-common.html#declared-type)."/> <type value="CanonicalResource"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ViewDefinition"/> <targetProfile value="http://hl7.org/fhir/uv/sql-on-fhir/StructureDefinition/SQLQuery"/> <targetProfile value="http://hl7.org/fhir/uv/sql-on-fhir/StructureDefinition/SQLView"/> </part> <part> <name value="parameters"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Input parameter values for this subject, bound by name to the parameters the Library declares (Library.parameter.name). Permitted only where this repetition's subject is a SQLQuery or SQLView; supplying it where the subject is a ViewDefinition is rejected with 400 Bad Request, because a ViewDefinition declares no parameters."/> <type value="Parameters"/> </part> </parameter> <parameter> <name value="context"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="Supporting artifacts the server cannot itself resolve, supplied inline and matched by canonical URL against the dependencies in the subjects' transitive relatedArtifact graphs. Applies to the job as a whole rather than to one subject, so an artifact several subjects depend on is supplied once. Accepts inline resources only; there is no context by canonical URL, because a URL is exactly what the server has already failed to resolve. A context entry produces no output entry. See Common Operation Behavior (operations-common.html#context)."/> <type value="CanonicalResource"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ViewDefinition"/> <targetProfile value="http://hl7.org/fhir/uv/sql-on-fhir/StructureDefinition/SQLView"/> </parameter> <parameter> <name value="clientTrackingId"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Client-provided tracking identifier for the export job, echoed in the manifest."/> <type value="string"/> </parameter> <parameter> <name value="_format"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Output format for the exported files (csv, ndjson, parquet, json). Optional; if omitted, the server uses ndjson irrespective of Accept. Requesting fhir is rejected with 400 Bad Request, because an export produces flat files. See Common Operation Behavior (operations-common.html)."/> <type value="code"/> <binding> <strength value="extensible"/> <valueSet value="http://hl7.org/fhir/uv/sql-on-fhir/ValueSet/ExportOutputFormatCodes"/> </binding> </parameter> <parameter> <name value="header"/> <use value="in"/> <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="patient"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="Restrict the FHIR resources feeding every subject in the job, before projection, to the supplied patient(s). Where a subject is a SQLQuery or SQLView, that means before the SQL executes. An unresolvable patient is rejected with 400 Bad Request. See Common Operation Behavior (operations-common.html#patient-filter)."/> <type value="Reference"/> </parameter> <parameter> <name value="group"/> <use value="in"/> <min value="0"/> <max value="*"/> <documentation value="Restrict the FHIR resources feeding every subject in the job, before projection, to members of the supplied group(s). Where a subject is a SQLQuery or SQLView, that means before the SQL executes. An unresolvable group is rejected with 400 Bad Request. See Common Operation Behavior (operations-common.html#group-filter)."/> <type value="Reference"/> </parameter> <parameter> <name value="_since"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="Include only resources whose state changed after this instant. See Common Operation Behavior (operations-common.html#since-filter)."/> <type value="instant"/> </parameter> <parameter> <name value="source"/> <use value="in"/> <min value="0"/> <max value="1"/> <documentation value="External data source to read from instead of the server's own data (for example a URI or bucket name). Where a subject is a SQLQuery or SQLView, this is where the ViewDefinition tables the query selects from are found."/> <type value="string"/> </parameter> <parameter> <name value="exportId"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="Server-generated identifier assigned to the export job."/> <type value="string"/> </parameter> <parameter> <name value="clientTrackingId"/> <use value="out"/> <min value="0"/> <max value="1"/> <documentation value="Echoed client tracking identifier when provided."/> <type value="string"/> </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="http://hl7.org/fhir/uv/sql-on-fhir/ValueSet/ExportStatusCodes"/> </binding> </parameter> <parameter> <name value="location"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="URL to poll for export status updates."/> <type value="uri"/> </parameter> <parameter> <name value="cancelUrl"/> <use value="out"/> <min value="0"/> <max value="1"/> <documentation value="Optional URL for cancelling the export."/> <type value="uri"/> </parameter> <parameter> <name value="_format"/> <use value="out"/> <min value="0"/> <max value="1"/> <documentation value="Format of the exported files (echoed from input if supplied)."/> <type value="code"/> <binding> <strength value="extensible"/> <valueSet value="http://hl7.org/fhir/uv/sql-on-fhir/ValueSet/ExportOutputFormatCodes"/> </binding> </parameter> <parameter> <name value="exportStartTime"/> <use value="out"/> <min value="0"/> <max value="1"/> <documentation value="Timestamp when the export job began."/> <type value="instant"/> </parameter> <parameter> <name value="exportEndTime"/> <use value="out"/> <min value="0"/> <max value="1"/> <documentation value="Timestamp when the export job completed."/> <type value="instant"/> </parameter> <parameter> <name value="exportDuration"/> <use value="out"/> <min value="0"/> <max value="1"/> <documentation value="Duration of the export in seconds."/> <type value="integer"/> </parameter> <parameter> <name value="estimatedTimeRemaining"/> <use value="out"/> <min value="0"/> <max value="1"/> <documentation value="Estimated seconds remaining until completion. Interim polling responses only."/> <type value="integer"/> </parameter> <parameter> <name value="output"/> <use value="out"/> <min value="0"/> <max value="*"/> <documentation value="Output information for each exported subject. Exactly one entry per subject repetition, and none for a context entry. Neither manifest order nor computation order is guaranteed; clients correlate entries by name."/> <part> <name value="name"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="Name assigned to this subject's output, derived from subject.name, else the subject's own name element, else a server-generated identifier."/> <type value="string"/> </part> <part> <name value="location"/> <use value="out"/> <min value="1"/> <max value="*"/> <documentation value="Download URL(s) for the exported file(s)."/> <type value="uri"/> </part> </parameter> </OperationDefinition>