ClientApplication

Medplum client application for automated access.

Schema

Elements

Name	Required	Type	Description
status		code	active | error | off Details The client application status. The status is active by default. The status can be set to error to indicate that the client application is not working properly. The status can be set to off to indicate that the client application is no longer in use.
name		string	Details A name associated with the ClientApplication.
description		string	Details A summary, characterization or explanation of the ClientApplication.
signInForm		ClientApplicationSignInForm	Details Custom values for the Log In form.
welcomeString		string	Details Welcome string for the Log In Form.
logo		Attachment	Details Logo for the Log In Form.
secret		string	Details Client secret string used to verify the identity of a client.
jwksUri		uri	Details Optional JWKS URI for public key verification of JWTs issued by the authorization server (client_secret_jwt).
redirectUri		uri	Details Optional redirect URI used when redirecting a client back to the client application.
launchUri		uri	Details Optional launch URI for SMART EHR launch sequence.
pkceOptional		boolean	Details Flag to make PKCE optional for this client application. PKCE is required by default for compliance with Smart App Launch. It can be disabled for compatibility with legacy client applications.
identityProvider		IdentityProvider	Details Optional external Identity Provider (IdP) for the client application.
refreshTokenLifetime		string	Details Optional configuration to set the refresh token duration

Search Parameters

Name	Type	Description	Expression
name	string	The name of the client application	ClientApplication.name

Inherited Elements

Name	Required	Type	Description
id		string	Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta		Meta	Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules		uri	Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language		code	Details The base language in which the resource is written.
text		Narrative	Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained		Resource[]	Contained, inline Resources Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension		Extension[]	Extensions that cannot be ignored Details May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).