Current Build

Extension oauth-uris - Detailed Descriptions

FHIR Infrastructure Work Group Maturity Level: 1InformativeUse Context: Any

Detailed Descriptions for the elements in the extension.

Extension
Element IdExtension
Definition

Supports automated discovery of OAuth2 endpoints.

Cardinality0..1 This element is affected by the following invariants: ele-1
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
Extension.id
Element IdExtension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Extension.extension
Element IdExtension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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.

Cardinality0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension(authorize)
Element IdExtension.extension:authorize
Definition

The OAuth2 "authorize" endpoint for this FHIR server.

Cardinality1..1
TypeExtension
Extension.extension.id
Element IdExtension.extension:authorize.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Extension.extension.extension
Element IdExtension.extension:authorize.extension
Definition

An Extension

Cardinality0..0
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension.url
Element IdExtension.extension:authorize.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valueauthorize
Extension.extension.valueUri
Element IdExtension.extension:authorize.valueUri
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..1
Typeuri
Extension.extension(token)
Element IdExtension.extension:token
Definition

The OAuth2 "token" endpoint for this FHIR server.

Cardinality1..1
TypeExtension
Extension.extension.id
Element IdExtension.extension:token.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Extension.extension.extension
Element IdExtension.extension:token.extension
Definition

An Extension

Cardinality0..0
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension.url
Element IdExtension.extension:token.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuetoken
Extension.extension.valueUri
Element IdExtension.extension:token.valueUri
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..1
Typeuri
Extension.extension(register)
Element IdExtension.extension:register
Definition

The OAuth2 dynamic registration endpoint for this FHIR server, if supported.

Cardinality0..1
TypeExtension
Extension.extension.id
Element IdExtension.extension:register.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Extension.extension.extension
Element IdExtension.extension:register.extension
Definition

An Extension

Cardinality0..0
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension.url
Element IdExtension.extension:register.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valueregister
Extension.extension.valueUri
Element IdExtension.extension:register.valueUri
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..1
Typeuri
Extension.extension(manage)
Element IdExtension.extension:manage
Definition

The user-facing authorization management workflow entry point for this FHIR server.

Cardinality0..1
TypeExtension
Extension.extension.id
Element IdExtension.extension:manage.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Cardinality0..1
Typestring
Extension.extension.extension
Element IdExtension.extension:manage.extension
Definition

An Extension

Cardinality0..0
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Extension.extension.url
Element IdExtension.extension:manage.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuemanage
Extension.extension.valueUri
Element IdExtension.extension:manage.valueUri
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..1
Typeuri
Extension.url
Element IdExtension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttp://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris
Extension.value[x]
Element IdExtension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..0
TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
[x] NoteSee Choice of Data Types for further information about how to use [x]