ClientApplication

ResourceHaste Health

FHIR Implementation of Client Metadata from https://datatracker.ietf.org/doc/html/rfc7591#section-2

StructureSearch parametersStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

2 of 2 parameters tested

Structure

Show inherited elements (2)

Element	Card.	Type	Description
nameRequired	1..1	string	The name of the client to be presented to the end-user.
description	0..1	string	The description of the client to be presented to the end-user.
grantTypeRequired	1..*	code	Auth 2.0 grant type strings that the client can use at the token endpoint.Binding (required): ClientApplicationGrantType
responseTypesRequired	1..1	code	OAuth 2.0 response type strings that the client can use at the authorization endpoint.Binding (required): ClientApplicationResponseTypes
secret	0..1	string	This value is used by confidential clients to authenticate to the token endpoint, as described in OAuth 2.0 [RFC6749], Section 2.3.1.
redirectUri	0..5	string	Array of redirection URI strings for use in redirect-based flows such as the authorization code and implicit flows. As required by Section 2 of OAuth 2.0 [RFC6749], clients using flows with redirection MUST register their redirection URI values. Authorization servers that support dynamic registration for redirect-based flows MUST implement support for this metadata value.
launchUri	0..1	uri	URL the app is opened at for a SMART EHR launch.
uri	0..1	uri	URL string of a web page providing information about the client.
logoUri	0..1	uri	URL string that references a logo for the client.
scope	0..1	string	String containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.
contact	0..1	ContactPoint	Array of strings representing ways to contact people responsible for this client, typically email addresses.
tosUri	0..1	uri	URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.
policyUri	0..1	uri	URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.

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

Search parameters

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

Parameter	Type	Description	PG	ES
grantType	token	ClientApplication grant type. ClientApplication.grantType
name	string	ClientApplication name ClientApplication.name

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