ClientApplication
FHIR Implementation of Client Metadata from https://datatracker.ietf.org/doc/html/rfc7591#section-2
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 2 of 2 parameters tested
Structure
| 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. |
jwks | 0..1 | string | The client's public keys, as a JSON Web Key Set (RFC 7517) document, for private_key_jwt client authentication. |
jwksUri | 0..1 | uri | The https URL of the client's JSON Web Key Set, for private_key_jwt client authentication. |
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. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken
Operations
Invoke with SMART EHR launch Starts a SMART App Launch EHR launch of this client application for a patient, and optionally one of the patient's encounters. Only a signed-in user can start a launch, and the same user must then authorize the app. Open the returned url to start the app. The patient the app is launched for. The caller must be able to read it. The encounter the app is launched in. It must be the patient's, and the caller must be able to read it. The opaque launch value the app passes back at authorization. It expires five minutes after it is created. The FHIR base URL the app is launched against. The client's launchUri with iss and launch added to its query. Open it to start the app.POST [base]/ClientApplication/$[name] on the type, or POST [base]/ClientApplication/[id]/$[name] on one resource, sending a Parameters resource as the body. See invoke-type and invoke-instance.$launch
InstancePOST [base]/ClientApplication/[id]/$launchParameters: 2 in, 3 out
Name Card. Type Description In patient 1..1 Reference(Patient) encounter 0..1 Reference(Encounter) Out launch 1..1 string iss 1..1 uri url 1..1 uri