Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4

Extension: oauth-uris

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris

Version: 5.0.0-ballot

Name: oauth-uris

Title: null

Modifier: This extension is not a modifier extension

Status: active

Definition: Supports automated discovery of OAuth2 endpoints.

Committee: FHIR Infrastructure Work Group

Status: active. Extension maintained by: Health Level Seven International (FHIR Infrastructure)

Supports automated discovery of OAuth2 endpoints.

Context of Use: Use on Element ID CapabilityStatement.rest.security

Summary

Name	Card.	Type	Description & Constraints
oauth-uris	0..1	Extension	URL = http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris oauth-uris: Supports automated discovery of OAuth2 endpoints. Use on Element ID CapabilityStatement.rest.security
authorize	1..1	uri	OAuth2 "authorize" endpoint
token	1..1	uri	OAuth2 "token" endpoint
register	0..1	uri	OAuth2 dynamic registration endpoint
manage	0..1	uri	User-facing authorization management entry point
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris oauth-uris: Supports automated discovery of OAuth2 endpoints. Use on Element ID CapabilityStatement.rest.security
Slices for extension	0..*	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"
value[x]	0..0
Documentation for this format

XML Template

<!-- oauth-uris -->

<extension xmlns="http://hl7.org/fhir"
     url="http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="authorize"> I 1..1 Extension  <!-- I 1..1 OAuth2 "authorize" endpoint -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="token"> I 1..1 Extension  <!-- I 1..1 OAuth2 "token" endpoint -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="register"> I 0..1 Extension  <!-- I 0..1 OAuth2 dynamic registration endpoint -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="manage"> I 0..1 Extension  <!-- I 0..1 User-facing authorization management entry point -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // oauth-uris
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // OAuth2 "authorize" endpoint // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "authorize", // R! 
        "valueUri" : "<uri>" // I R! Value of extension
      },
      { // OAuth2 "token" endpoint // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "token", // R! 
        "valueUri" : "<uri>" // I R! Value of extension
      },
      { // OAuth2 dynamic registration endpoint // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "register", // R! 
        "valueUri" : "<uri>" // I R! Value of extension
      },
      { // User-facing authorization management entry point // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "manage", // R! 
        "valueUri" : "<uri>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! OAuth2 "authorize" endpoint
    "extension" : { Extension }, // I R! OAuth2 "token" endpoint
    "extension" : { Extension }, // IOAuth2 dynamic registration endpoint
    "extension" : { Extension }, // IUser-facing authorization management entry point
    "url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
oauth-uris	0..1	Extension	URL = http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris oauth-uris: Supports automated discovery of OAuth2 endpoints. Use on Element ID CapabilityStatement.rest.security
authorize	1..1	uri	OAuth2 "authorize" endpoint
token	1..1	uri	OAuth2 "token" endpoint
register	0..1	uri	OAuth2 dynamic registration endpoint
manage	0..1	uri	User-facing authorization management entry point
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris oauth-uris: Supports automated discovery of OAuth2 endpoints. Use on Element ID CapabilityStatement.rest.security
Slices for extension	0..*	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"
value[x]	0..0
Documentation for this format

XML Template

<!-- oauth-uris -->

<extension xmlns="http://hl7.org/fhir"
     url="http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="authorize"> I 1..1 Extension  <!-- I 1..1 OAuth2 "authorize" endpoint -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="token"> I 1..1 Extension  <!-- I 1..1 OAuth2 "token" endpoint -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="register"> I 0..1 Extension  <!-- I 0..1 OAuth2 dynamic registration endpoint -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="manage"> I 0..1 Extension  <!-- I 0..1 User-facing authorization management entry point -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // oauth-uris
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // OAuth2 "authorize" endpoint // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "authorize", // R! 
        "valueUri" : "<uri>" // I R! Value of extension
      },
      { // OAuth2 "token" endpoint // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "token", // R! 
        "valueUri" : "<uri>" // I R! Value of extension
      },
      { // OAuth2 dynamic registration endpoint // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "register", // R! 
        "valueUri" : "<uri>" // I R! Value of extension
      },
      { // User-facing authorization management entry point // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "manage", // R! 
        "valueUri" : "<uri>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! OAuth2 "authorize" endpoint
    "extension" : { Extension }, // I R! OAuth2 "token" endpoint
    "extension" : { Extension }, // IOAuth2 dynamic registration endpoint
    "extension" : { Extension }, // IUser-facing authorization management entry point
    "url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris" // R! 
  // value[x]: Value of extension: Prohibited
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.