FHIR Extensions Pack
5.1.0-cibuild - Working Copy International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.1.0-cibuild built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: OAuth URIs

Official URL: http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris Version: 5.1.0-cibuild
Standards status: Trial-use Maturity Level: 3 Computable Name: OAuthUris

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..1ExtensionAutomated discovery of OAuth2 endpoints
    ... extension:authorize 1..1ExtensionOAuth2 "authorize" endpoint
    .... extension 0..0
    .... url 1..1uri"authorize"
    .... value[x] 1..1uriValue of extension
    ... extension:token 1..1ExtensionOAuth2 "token" endpoint
    .... extension 0..0
    .... url 1..1uri"token"
    .... value[x] 1..1uriValue of extension
    ... extension:register 0..1ExtensionOAuth2 dynamic registration endpoint
    .... extension 0..0
    .... url 1..1uri"register"
    .... value[x] 1..1uriValue of extension
    .... extension 0..0
    .... url 1..1uri"manage"
    .... value[x] 1..1uriValue of extension
    ... url 1..1uri"http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1ExtensionAutomated discovery of OAuth2 endpoints
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 2..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    ... extension:authorize 1..1ExtensionOAuth2 "authorize" endpoint
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"authorize"
    .... value[x] 1..1uriValue of extension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"token"
    .... value[x] 1..1uriValue of extension
    ... extension:register 0..1ExtensionOAuth2 dynamic registration endpoint
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"register"
    .... value[x] 1..1uriValue of extension
    ... extension:manage 0..1ExtensionUser-facing authorization management entry point
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"manage"
    .... value[x] 1..1uriValue of extension
    ... url 1..1uri"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..1ExtensionAutomated discovery of OAuth2 endpoints
    ... extension:authorize 1..1ExtensionOAuth2 "authorize" endpoint
    .... extension 0..0
    .... url 1..1uri"authorize"
    .... value[x] 1..1uriValue of extension
    ... extension:token 1..1ExtensionOAuth2 "token" endpoint
    .... extension 0..0
    .... url 1..1uri"token"
    .... value[x] 1..1uriValue of extension
    ... extension:register 0..1ExtensionOAuth2 dynamic registration endpoint
    .... extension 0..0
    .... url 1..1uri"register"
    .... value[x] 1..1uriValue of extension
    .... extension 0..0
    .... url 1..1uri"manage"
    .... value[x] 1..1uriValue of extension
    ... url 1..1uri"http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1ExtensionAutomated discovery of OAuth2 endpoints
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 2..*ExtensionAdditional content defined by implementations
    Slice: Unordered, Open by value:url
    ... extension:authorize 1..1ExtensionOAuth2 "authorize" endpoint
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"authorize"
    .... value[x] 1..1uriValue of extension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"token"
    .... value[x] 1..1uriValue of extension
    ... extension:register 0..1ExtensionOAuth2 dynamic registration endpoint
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"register"
    .... value[x] 1..1uriValue of extension
    ... extension:manage 0..1ExtensionUser-facing authorization management entry point
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"manage"
    .... value[x] 1..1uriValue of extension
    ... url 1..1uri"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)