ViewDefinition

ResourceSQL on FHIR

A ViewDefinition represents a tabular projection of a FHIR resource, where the columns and inclusion criteria are defined by FHIRPath expressions.

StructureSearch parametersOperations (1)StructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

0 of 0 parameters tested

Structure

Show inherited elements (40)

Element	Card.	Type	Description
resourceRequired	1..1	code	FHIR resource for the ViewDefinitionBinding (required): resource-types
profile	0..*	canonical(StructureDefinition)	FHIR profiles that this view definition was intended to be executed against
fhirVersion	0..*	code	FHIR version(s) of the resource for the ViewDefinitionBinding (required): FHIR-version
constant	0..*	BackboneElement	Constant that can be used in FHIRPath expressions
nameRequired	1..1	string	Name of constant (referred to in FHIRPath as %[name])
value[x]Required	1..1	base64Binary | boolean | canonical | code | date | dateTime | decimal | id | instant | integer | oid | string | positiveInt | time | unsignedInt | uri | url | uuid	Value of constant
selectRequired	1..*	BackboneElement	A collection of columns and nested selects to include in the view.
column	0..*	BackboneElement	A column to be produced in the resulting table.
pathRequired	1..1	string	FHIRPath expression that creates a column and defines its content
nameRequired	1..1	string	Column name produced in the output
description	0..1	markdown	Description of the column
collection	0..1	boolean	Indicates whether the column may have multiple values.
type	0..1	uri	A FHIR StructureDefinition URI for the column's type.
tag	0..*	BackboneElement	Additional metadata describing the column
nameRequired	1..1	string	Name of tag
valueRequired	1..1	string	Value of tag
select	0..*	Same as ViewDefinition.select	Nested select relative to a parent expression.
forEach	0..1	string	A FHIRPath expression to retrieve the parent element(s) used in the containing select. The default is effectively `$this`.
forEachOrNull	0..1	string	Same as forEach, but will produce a row with null values if the collection is empty.
repeat	0..*	string	FHIRPath expressions to recursively select from.
unionAll	0..*	Same as ViewDefinition.select	Creates a union of all rows in the given selection structures.
where	0..*	BackboneElement	A series of zero or more FHIRPath constraints to filter resources for the view.
pathRequired	1..1	string	A FHIRPath expression defining a filter condition
description	0..1	string	A human-readable description of the above where constraint.

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/ViewDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

ViewDefinition defines no search parameters of its own; the common parameters below apply.

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition

Operations

Invoke with POST [base]/ViewDefinition/$[name] on the type, or POST [base]/ViewDefinition/[id]/$[name] on one resource, sending a Parameters resource as the body. See invoke-type and invoke-instance.

$viewdefinition-run

SystemTypeInstance

ViewDefinition Run

Execute a view definition against supplied or server data.

POST [base]/$viewdefinition-runPOST [base]/ViewDefinition/$viewdefinition-runPOST [base]/ViewDefinition/[id]/$viewdefinition-run

Parameters: 10 in, 1 out

Name	Card.	Type	Description
In
_format	0..1	code	Output format for the result (for example json, ndjson, csv, parquet). Optional; if omitted, the server returns ndjson by default. Binding: extensible OutputFormatCodes
header	0..1	boolean	Include CSV headers (default true). Applies only when csv output is requested.
viewReference	0..1	Reference	Reference to a ViewDefinition stored on the server.
viewResource	0..1	ViewDefinition(ViewDefinition)	Inline ViewDefinition resource to execute.
patient	0..1	Reference	Restrict execution to the specified patient.
group	0..*	Reference	Restrict execution to members of the given group(s).
source	0..1	string	External data source to use (for example a URI or bucket name).
resource	0..*	Resource	FHIR resources to transform instead of using server data.
_limit	0..1	integer	Maximum number of rows to return.
_since	0..1	instant	Include only resources modified after this instant.
Out
return	1..1	Binary	Transformed data encoded in the requested output format.

OperationDefinition JSON