description: Declares support for automated dicovery of OAuth2 endpoints If a server requires SMART on FHIR authorization for access. Any time a client sees this extension, it\rmust be prepared to authorize using SMART's OAuth2-based protocol.
package_name: rs/hl7.fhir.uv.smart
derivation: constraint
name: Support for dicovery of OAuth2 endpoints
type: Extension
elements:
  extension:
    isModifier: false
    short: URL indicating the OAuth2 "authorize" endpoint for this FHIR server.
    type: Extension
    index: 0
    slicing:
      slices:
        authorize:
          match: {}
          schema:
            isModifier: false
            short: URL indicating the OAuth2 "authorize" endpoint for this FHIR server.
            type: Extension
            _required: true
            index: 0
            elements:
              url:
                pattern: {type: uri, value: authorize}
                type: uri
                index: 1
              valueUri: {type: uri, index: 2}
        token:
          match: {}
          schema:
            isModifier: false
            short: URL indicating the OAuth2 "token" endpoint for this FHIR server.  Required unless the implicit grant flow is used.
            type: Extension
            index: 3
            elements:
              url:
                pattern: {type: uri, value: token}
                type: uri
                index: 4
              valueUri: {type: uri, index: 5}
        register:
          match: {}
          schema:
            isModifier: false
            short: URL indicating the OAuth2 dynamic registration endpoint for this FHIR server, if supported.
            type: Extension
            index: 6
            elements:
              url:
                pattern: {type: uri, value: register}
                type: uri
                index: 7
              valueUri: {type: uri, index: 8}
        manage:
          match: {}
          schema:
            isModifier: false
            short: URL where an end-user can view which applications have access to data and make adjustments to these access rights.
            type: Extension
            index: 9
            elements:
              url:
                pattern: {type: uri, value: manage}
                type: uri
                index: 10
              valueUri: {type: uri, index: 11}
        introspect:
          match: {}
          schema:
            isModifier: false
            short: URL indicating the introspection endpoint that can be used to validate a token.
            type: Extension
            index: 12
            elements:
              url:
                pattern: {type: uri, value: introspect}
                type: uri
                index: 13
              valueUri: {type: uri, index: 14}
        revoke:
          match: {}
          schema:
            isModifier: false
            short: URL indicating the endpoint that can be used to revoke a token.
            type: Extension
            index: 15
            elements:
              url:
                pattern: {type: uri, value: revoke}
                type: uri
                index: 16
              valueUri: {type: uri, index: 17}
  url:
    pattern: {type: uri, value: 'http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris'}
    type: uri
    index: 18
  value:
    choices: []
    index: 20
package_version: app-launch-1.0.0
extensions:
  authorize:
    url: null
    isModifier: false
    short: URL indicating the OAuth2 "authorize" endpoint for this FHIR server.
    type: Extension
    _required: true
    index: 0
    elements:
      url:
        pattern: {type: uri, value: authorize}
        type: uri
        index: 1
      valueUri: {type: uri, index: 2}
  token:
    url: null
    isModifier: false
    short: URL indicating the OAuth2 "token" endpoint for this FHIR server.  Required unless the implicit grant flow is used.
    type: Extension
    index: 3
    elements:
      url:
        pattern: {type: uri, value: token}
        type: uri
        index: 4
      valueUri: {type: uri, index: 5}
  register:
    url: null
    isModifier: false
    short: URL indicating the OAuth2 dynamic registration endpoint for this FHIR server, if supported.
    type: Extension
    index: 6
    elements:
      url:
        pattern: {type: uri, value: register}
        type: uri
        index: 7
      valueUri: {type: uri, index: 8}
  manage:
    url: null
    isModifier: false
    short: URL where an end-user can view which applications have access to data and make adjustments to these access rights.
    type: Extension
    index: 9
    elements:
      url:
        pattern: {type: uri, value: manage}
        type: uri
        index: 10
      valueUri: {type: uri, index: 11}
  introspect:
    url: null
    isModifier: false
    short: URL indicating the introspection endpoint that can be used to validate a token.
    type: Extension
    index: 12
    elements:
      url:
        pattern: {type: uri, value: introspect}
        type: uri
        index: 13
      valueUri: {type: uri, index: 14}
  revoke:
    url: null
    isModifier: false
    short: URL indicating the endpoint that can be used to revoke a token.
    type: Extension
    index: 15
    elements:
      url:
        pattern: {type: uri, value: revoke}
        type: uri
        index: 16
      valueUri: {type: uri, index: 17}
class: extension
kind: complex-type
url: http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris
base: http://hl7.org/fhir/StructureDefinition/Extension
version: 1.0.0
required: [extension]