Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.3.0: R4B - STU ). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . 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 Trial Use Use Context : Any
Official URL for this extension: : http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris Status: active. Extension maintained by: Health Level Seven International (FHIR Infrastructure) Supports automated discovery Version : 5.0.0-snapshot3
active as of OAuth2 endpoints. 2018-02-15 Computable Name : oauth-uris
Flags : Non-Modifier OID : TBD

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

Definition

Supports automated discovery of OAuth2 endpoints.

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . 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 The OAuth2 "authorize" endpoint for this FHIR server.

. . . token 1..1 uri The OAuth2 "token" endpoint for this FHIR server.

. . . register 0..1 uri The OAuth2 dynamic registration endpoint for this FHIR server, if supported.


doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer valueMarkdown markdown valueOid oid valuePositiveInt positiveInt valueString string valueTime time valueUnsignedInt unsignedInt valueUri uri valueUrl url valueUuid uuid valueAddress Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept CodeableConcept valueCodeableReference CodeableReference valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
Name Flags Card. Type Description & Constraints doco
. . 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
. . . . 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

doco Documentation for this format

XML Template 

<!-- oauth-uris -->doco

<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 Flags Card. Type Description & Constraints doco
. . 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 The OAuth2 "authorize" endpoint for this FHIR server.

. . . token 1..1 uri The OAuth2 "token" endpoint for this FHIR server.

. . . register 0..1 uri The OAuth2 dynamic registration endpoint for this FHIR server, if supported.


doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer valueMarkdown markdown valueOid oid valuePositiveInt positiveInt valueString string valueTime time valueUnsignedInt unsignedInt valueUri uri valueUrl url valueUuid uuid valueAddress Address valueAge Age valueAnnotation Annotation valueAttachment Attachment valueCodeableConcept CodeableConcept valueCodeableReference CodeableReference valueCoding Coding valueContactPoint ContactPoint valueCount Count valueDistance Distance valueDuration Duration valueHumanName HumanName valueIdentifier Identifier valueMoney Money valuePeriod Period valueQuantity Quantity valueRange Range valueRatio Ratio valueRatioRange RatioRange valueReference Reference (Any) valueSampledData SampledData valueSignature Signature valueTiming Timing valueContactDetail ContactDetail valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
Name Flags Card. Type Description & Constraints doco
. . 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
. . . . 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

doco Documentation for this format

XML Template 

<!-- oauth-uris -->doco

<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 unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters hasValue() or (children().count() > id.count()) )
  • ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • 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 hasValue() or (children().count() > id.count()) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • 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 hasValue() or (children().count() > id.count()) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • 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 hasValue() or (children().count() > id.count()) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • 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 hasValue() or (children().count() > id.count()) )
  • ele-1 : On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div hasValue() or (children().count() > id.count()) )

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.