This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). 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
FHIR Infrastructure Work Group | Maturity Level: 1 | Informative | Use Context: Any |
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 of OAuth2 endpoints.
Context of Use: Use on Element ID CapabilityStatement.rest.security
Summary
Name | Flags | 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 | 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. | |
manage | 0..1 | uri | The user-facing authorization management workflow entry point for this FHIR server. | |
Documentation for this format |
Full Structure
Name | Flags | 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 | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
extension:authorize | I | 1..1 | Extension | OAuth2 "authorize" endpoint |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "authorize" | |
value[x] | I | 1..1 | uri | Value of extension |
extension:token | I | 1..1 | Extension | OAuth2 "token" endpoint |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "token" | |
value[x] | I | 1..1 | uri | Value of extension |
extension:register | I | 0..1 | Extension | OAuth2 dynamic registration endpoint |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "register" | |
value[x] | I | 1..1 | uri | Value of extension |
extension:manage | I | 0..1 | Extension | User-facing authorization management entry point |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "manage" | |
value[x] | I | 1..1 | uri | Value of extension |
url | 1..1 | uri | "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris" | |
value[x] | I | 0..0 | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueInteger64 | integer64 | |||
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 | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
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 | |||
valueMeta | Meta | |||
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"> 1..1 Extension <!-- 1..1 OAuth2 "authorize" endpoint --> <valueUri value="[uri]"/><!-- 1..1 Value of extension --> </extension> <extension url="token"> 1..1 Extension <!-- 1..1 OAuth2 "token" endpoint --> <valueUri value="[uri]"/><!-- 1..1 Value of extension --> </extension> <extension url="register"> 0..1 Extension <!-- 0..1 OAuth2 dynamic registration endpoint --> <valueUri value="[uri]"/><!-- 1..1 Value of extension --> </extension> <extension url="manage"> 0..1 Extension <!-- 0..1 User-facing authorization management entry point --> <valueUri value="[uri]"/><!-- 1..1 Value of extension --> </extension> </extension>
JSON Template
{ // oauth-uris "extension" : [ // sliced by value:url in the specified order, Open { // OAuth2 "authorize" endpoint // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "authorize", // R! "valueUri" : "<uri>" // C? R! Value of extension }, { // OAuth2 "token" endpoint // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "token", // R! "valueUri" : "<uri>" // C? R! Value of extension }, { // OAuth2 dynamic registration endpoint // C? // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "register", // R! "valueUri" : "<uri>" // C? R! Value of extension }, { // User-facing authorization management entry point // C? // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "manage", // R! "valueUri" : "<uri>" // C? R! Value of extension } ], "url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris", // R! // value[x]: Value of extension. One of these 51: }
Summary
Name | Flags | 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 | 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. | |
manage | 0..1 | uri | The user-facing authorization management workflow entry point for this FHIR server. | |
Documentation for this format |
Full Structure
Name | Flags | 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 | |
extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
extension:authorize | I | 1..1 | Extension | OAuth2 "authorize" endpoint |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "authorize" | |
value[x] | I | 1..1 | uri | Value of extension |
extension:token | I | 1..1 | Extension | OAuth2 "token" endpoint |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "token" | |
value[x] | I | 1..1 | uri | Value of extension |
extension:register | I | 0..1 | Extension | OAuth2 dynamic registration endpoint |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "register" | |
value[x] | I | 1..1 | uri | Value of extension |
extension:manage | I | 0..1 | Extension | User-facing authorization management entry point |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..0 | ||
url | 1..1 | uri | "manage" | |
value[x] | I | 1..1 | uri | Value of extension |
url | 1..1 | uri | "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris" | |
value[x] | I | 0..0 | ||
valueBase64Binary | base64Binary | |||
valueBoolean | boolean | |||
valueCanonical | canonical(Any) | |||
valueCode | code | |||
valueDate | date | |||
valueDateTime | dateTime | |||
valueDecimal | decimal | |||
valueId | id | |||
valueInstant | instant | |||
valueInteger | integer | |||
valueInteger64 | integer64 | |||
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 | |||
valueCoding | Coding | |||
valueContactPoint | ContactPoint | |||
valueCount | Count | |||
valueDistance | Distance | |||
valueDuration | Duration | |||
valueHumanName | HumanName | |||
valueIdentifier | Identifier | |||
valueMoney | Money | |||
valuePeriod | Period | |||
valueQuantity | Quantity | |||
valueRange | Range | |||
valueRatio | Ratio | |||
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 | |||
valueMeta | Meta | |||
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"> 1..1 Extension <!-- 1..1 OAuth2 "authorize" endpoint --> <valueUri value="[uri]"/><!-- 1..1 Value of extension --> </extension> <extension url="token"> 1..1 Extension <!-- 1..1 OAuth2 "token" endpoint --> <valueUri value="[uri]"/><!-- 1..1 Value of extension --> </extension> <extension url="register"> 0..1 Extension <!-- 0..1 OAuth2 dynamic registration endpoint --> <valueUri value="[uri]"/><!-- 1..1 Value of extension --> </extension> <extension url="manage"> 0..1 Extension <!-- 0..1 User-facing authorization management entry point --> <valueUri value="[uri]"/><!-- 1..1 Value of extension --> </extension> </extension>
JSON Template
{ // oauth-uris "extension" : [ // sliced by value:url in the specified order, Open { // OAuth2 "authorize" endpoint // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "authorize", // R! "valueUri" : "<uri>" // C? R! Value of extension }, { // OAuth2 "token" endpoint // C? R! // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "token", // R! "valueUri" : "<uri>" // C? R! Value of extension }, { // OAuth2 dynamic registration endpoint // C? // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "register", // R! "valueUri" : "<uri>" // C? R! Value of extension }, { // User-facing authorization management entry point // C? // from Element: extension "extension" : [ // sliced by value:url in the specified order, Open ] "url" : "manage", // R! "valueUri" : "<uri>" // C? R! Value of extension } ], "url" : "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris", // R! // value[x]: Value of extension. One of these 51: }
Constraints