FHIR IG analytics| Package | org.sql-on-fhir.ig |
| Resource Type | OperationDefinition |
| Id | OperationDefinition-ViewDefinitionRun.json |
| FHIR Version | R5 |
| Source | https://build.fhir.org/ig/FHIR/sql-on-fhir-v2/OperationDefinition-ViewDefinitionRun.html |
| URL | http://sql-on-fhir.org/OperationDefinition/$viewdefinition-run |
| Version | 2.1.0-pre |
| Status | active |
| Date | 2026-02-04T07:56:19+00:00 |
| Name | ViewDefinitionRun |
| Title | ViewDefinition Run |
| Realm | uv |
| Description | Execute a view definition against supplied or server data. |
| Type | true |
| Kind | operation |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition ViewDefinitionRun
URL: [base]/$viewdefinition-run
URL: [base]/CanonicalResource/$viewdefinition-run
URL: [base]/CanonicalResource/[id]/$viewdefinition-run
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | _format | type, instance | 1..1 | code | Output Format Codes (Extensible) | Output format for the result (for example json, ndjson, csv, parquet). |
| IN | header | type, instance | 0..1 | boolean | Include CSV headers (default true). Applies only when csv output is requested. | |
| IN | viewReference | type, instance | 0..1 | Reference | Reference to a ViewDefinition stored on the server. | |
| IN | viewResource | type | 0..1 | https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition (View Definition) | Inline ViewDefinition resource to execute. | |
| IN | patient | type, instance | 0..1 | Reference | Restrict execution to the specified patient. | |
| IN | group | type, instance | 0..* | Reference | Restrict execution to members of the given group(s). | |
| IN | source | type, instance | 0..1 | string | External data source to use (for example a URI or bucket name). | |
| IN | resource | type, instance | 0..* | Resource | FHIR resources to transform instead of using server data. | |
| IN | _limit | type, instance | 0..1 | integer | Maximum number of rows to return. | |
| IN | _since | type, instance | 0..1 | instant | Include only resources modified after this instant. | |
| OUT | return | 1..1 | Binary | Transformed data encoded in the requested output format. |
{
"resourceType": "OperationDefinition",
"id": "ViewDefinitionRun",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "http://sql-on-fhir.org/OperationDefinition/$viewdefinition-run",
"version": "2.1.0-pre",
"versionAlgorithmString": "semver",
"name": "ViewDefinitionRun",
"title": "ViewDefinition Run",
"status": "active",
"kind": "operation",
"date": "2026-02-04T07:56:19+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": "Execute a view definition against supplied or server data.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"code": "viewdefinition-run",
"resource": [
"CanonicalResource"
],
"system": true,
"type": true,
"instance": true,
"parameter": [
{
"name": "_format",
"use": "in",
"scope": [
"type",
"instance"
],
"min": 1,
"max": "1",
"documentation": "Output format for the result (for example json, ndjson, csv, parquet).",
"type": "code",
"binding": {
"strength": "extensible",
"valueSet": "https://sql-on-fhir.org/ig/ValueSet/OutputFormatCodes"
}
},
{
"name": "header",
"use": "in",
"scope": [
"type",
"instance"
],
"min": 0,
"max": "1",
"documentation": "Include CSV headers (default true). Applies only when csv output is requested.",
"type": "boolean"
},
{
"name": "viewReference",
"use": "in",
"scope": [
"type",
"instance"
],
"min": 0,
"max": "1",
"documentation": "Reference to a ViewDefinition stored on the server.",
"type": "Reference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type",
"valueUri": "https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
}
],
"name": "viewResource",
"use": "in",
"scope": [
"type"
],
"min": 0,
"max": "1",
"documentation": "Inline ViewDefinition resource to execute.",
"type": "CanonicalResource",
"targetProfile": [
"https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition"
]
},
{
"name": "patient",
"use": "in",
"scope": [
"type",
"instance"
],
"min": 0,
"max": "1",
"documentation": "Restrict execution to the specified patient.",
"type": "Reference"
},
{
"name": "group",
"use": "in",
"scope": [
"type",
"instance"
],
"min": 0,
"max": "*",
"documentation": "Restrict execution to members of the given group(s).",
"type": "Reference"
},
{
"name": "source",
"use": "in",
"scope": [
"type",
"instance"
],
"min": 0,
"max": "1",
"documentation": "External data source to use (for example a URI or bucket name).",
"type": "string"
},
{
"name": "resource",
"use": "in",
"scope": [
"type",
"instance"
],
"min": 0,
"max": "*",
"documentation": "FHIR resources to transform instead of using server data.",
"type": "Resource"
},
{
"name": "_limit",
"use": "in",
"scope": [
"type",
"instance"
],
"min": 0,
"max": "1",
"documentation": "Maximum number of rows to return.",
"type": "integer"
},
{
"name": "_since",
"use": "in",
"scope": [
"type",
"instance"
],
"min": 0,
"max": "1",
"documentation": "Include only resources modified after this instant.",
"type": "instant"
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "Transformed data encoded in the requested output format.",
"type": "Binary"
}
]
}