FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.2.0-ballot: Release 5.2) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 5.1.0. For a full list of available versions, see the Directory of published versions

Extension: OAuth URIs

Official URL: http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: OAuthUris
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1506

Supports automated discovery of OAuth2 endpoints.

Context of Use

This extension may be used on the following element(s):

  • Element ID CapabilityStatement.rest.security

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: Supports automated discovery of OAuth2 endpoints.

    • authorize: uri: The OAuth2 "authorize" endpoint for this FHIR server.
    • token: uri: The OAuth2 "token" endpoint for this FHIR server.
    • register: uri: The OAuth2 dynamic registration endpoint for this FHIR server, if supported.
    • manage: uri: The user-facing authorization management workflow entry point for this FHIR server.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Automated discovery of OAuth2 endpoints
    ... Slices for extension Content/Rules for all slices
    .... extension:authorize 1..1 Extension OAuth2 "authorize" endpoint
    ..... extension 0..0
    ..... url 1..1 uri "authorize"
    ..... value[x] 1..1 uri Value of extension
    .... extension:token 1..1 Extension OAuth2 "token" endpoint
    ..... extension 0..0
    ..... url 1..1 uri "token"
    ..... value[x] 1..1 uri Value of extension
    .... extension:register 0..1 Extension OAuth2 dynamic registration endpoint
    ..... extension 0..0
    ..... url 1..1 uri "register"
    ..... value[x] 1..1 uri Value of extension
    .... extension:manage 0..1 Extension User-facing authorization management entry point
    ..... extension 0..0
    ..... url 1..1 uri "manage"
    ..... value[x] 1..1 uri Value of extension
    ... url 1..1 uri "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Automated discovery of OAuth2 endpoints
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:authorize 1..1 Extension OAuth2 "authorize" endpoint
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "authorize"
    ..... value[x] 1..1 uri Value of extension
    .... extension:token 1..1 Extension OAuth2 "token" endpoint
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "token"
    ..... value[x] 1..1 uri Value of extension
    .... extension:register 0..1 Extension OAuth2 dynamic registration endpoint
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "register"
    ..... value[x] 1..1 uri Value of extension
    .... extension:manage 0..1 Extension User-facing authorization management entry point
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "manage"
    ..... value[x] 1..1 uri Value of extension
    ... url 1..1 uri "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Supports automated discovery of OAuth2 endpoints.

    • authorize: uri: The OAuth2 "authorize" endpoint for this FHIR server.
    • token: uri: The OAuth2 "token" endpoint for this FHIR server.
    • register: uri: The OAuth2 dynamic registration endpoint for this FHIR server, if supported.
    • manage: uri: The user-facing authorization management workflow entry point for this FHIR server.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Automated discovery of OAuth2 endpoints
    ... Slices for extension Content/Rules for all slices
    .... extension:authorize 1..1 Extension OAuth2 "authorize" endpoint
    ..... extension 0..0
    ..... url 1..1 uri "authorize"
    ..... value[x] 1..1 uri Value of extension
    .... extension:token 1..1 Extension OAuth2 "token" endpoint
    ..... extension 0..0
    ..... url 1..1 uri "token"
    ..... value[x] 1..1 uri Value of extension
    .... extension:register 0..1 Extension OAuth2 dynamic registration endpoint
    ..... extension 0..0
    ..... url 1..1 uri "register"
    ..... value[x] 1..1 uri Value of extension
    .... extension:manage 0..1 Extension User-facing authorization management entry point
    ..... extension 0..0
    ..... url 1..1 uri "manage"
    ..... value[x] 1..1 uri Value of extension
    ... url 1..1 uri "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Automated discovery of OAuth2 endpoints
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:authorize 1..1 Extension OAuth2 "authorize" endpoint
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "authorize"
    ..... value[x] 1..1 uri Value of extension
    .... extension:token 1..1 Extension OAuth2 "token" endpoint
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "token"
    ..... value[x] 1..1 uri Value of extension
    .... extension:register 0..1 Extension OAuth2 dynamic registration endpoint
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "register"
    ..... value[x] 1..1 uri Value of extension
    .... extension:manage 0..1 Extension User-facing authorization management entry point
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "manage"
    ..... value[x] 1..1 uri Value of extension
    ... url 1..1 uri "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)