FHIR Extensions Pack
5.4.0 - May 2026 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.4.0 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: Authorization Hint

Official URL: http://hl7.org/fhir/StructureDefinition/authorization-hint Version: 5.4.0
Standards status: Trial-use Maturity Level: 1 Computable Name: AuthorizationHint
Other Identifiers: OID:2.16.840.1.113883.4.642.40.97.42.121

A hint for authorization requirements used to access content or services.

Context of Use

This extension may be used on the following element(s)

Usage info

Usages:

  • This Extension is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Changes since version 5.3.0:

  • New Content

    • 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: A hint for authorization requirements used to access content or services.

    • type: CodeableConcept: Used by clients to determine what kind of authorization is appropriate in this context.
    • value: string: A value related to the declared authorization type (e.g., a token).

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension A hint for authorization requirements
    Extension.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:type 1..1 Extension Authorization Type
    Extension.Slices for extension.extension:type.url 1..1 uri "type"
    Extension.Slices for extension.extension:type.value[x] 1..1 CodeableConcept Authorization Type
    Binding: AuthorizationHintVS (preferred): Binding to the Authorization Hint Codes starter value set.
    Extension.Slices for extension.extension:value 0..1 Extension Authorization Value
    Extension.Slices for extension.extension:value.url 1..1 uri "value"
    Extension.Slices for extension.extension:value.value[x] 0..1 string Authorization Value
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/authorization-hint"
    Extension.value[x] 0..0 Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension A hint for authorization requirements
    Extension.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:type 1..1 Extension Authorization Type
    Extension.Slices for extension.extension:type.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:type.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:type.url 1..1 uri "type"
    Extension.Slices for extension.extension:type.value[x] 1..1 CodeableConcept Authorization Type
    Binding: AuthorizationHintVS (preferred): Binding to the Authorization Hint Codes starter value set.
    Extension.Slices for extension.extension:value 0..1 Extension Authorization Value
    Extension.Slices for extension.extension:value.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:value.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:value.url 1..1 uri "value"
    Extension.Slices for extension.extension:value.value[x] 0..1 string Authorization Value
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/authorization-hint"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: A hint for authorization requirements used to access content or services.

    • type: CodeableConcept: Used by clients to determine what kind of authorization is appropriate in this context.
    • value: string: A value related to the declared authorization type (e.g., a token).

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension A hint for authorization requirements
    Extension.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:type 1..1 Extension Authorization Type
    Extension.Slices for extension.extension:type.url 1..1 uri "type"
    Extension.Slices for extension.extension:type.value[x] 1..1 CodeableConcept Authorization Type
    Binding: AuthorizationHintVS (preferred): Binding to the Authorization Hint Codes starter value set.
    Extension.Slices for extension.extension:value 0..1 Extension Authorization Value
    Extension.Slices for extension.extension:value.url 1..1 uri "value"
    Extension.Slices for extension.extension:value.value[x] 0..1 string Authorization Value
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/authorization-hint"
    Extension.value[x] 0..0 Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..* Extension A hint for authorization requirements
    Extension.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:type 1..1 Extension Authorization Type
    Extension.Slices for extension.extension:type.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:type.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:type.url 1..1 uri "type"
    Extension.Slices for extension.extension:type.value[x] 1..1 CodeableConcept Authorization Type
    Binding: AuthorizationHintVS (preferred): Binding to the Authorization Hint Codes starter value set.
    Extension.Slices for extension.extension:value 0..1 Extension Authorization Value
    Extension.Slices for extension.extension:value.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:value.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Extension.Slices for extension.extension:value.url 1..1 uri "value"
    Extension.Slices for extension.extension:value.value[x] 0..1 string Authorization Value
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/authorization-hint"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Extension.extension:type.​value[x] Base preferred Authorization Hint ValueSet 📦5.4.0 This IG

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is represented a little differently in R4:

    • Remove the extension context SubscriptionStatus.notificationEvent (not for this version)
    • Note: Extensions that have been modified for R4 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: doco
    Extension 0..* Extension A hint for authorization requirements
    Extension. Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension. extension:type 1..1 Extension Authorization Type
    Extension.Slices for extension.extension:type. url 1..1 uri "type"
    Extension.Slices for extension.extension:type. value[x] 1..1 CodeableConcept Authorization Type
    Binding: AuthorizationHintVS ( preferred ) : Binding to the Authorization Hint Codes starter value set.
    Extension.Slices for extension. extension:value 0..1 Extension Authorization Value
    Extension.Slices for extension.extension:value. url 1..1 uri "value"
    Extension.Slices for extension.extension:value. value[x] 0..1 string Authorization Value
    Extension. url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/authorization-hint"
    Extension. value[x] 0 .. 0 Value of extension

    doco Documentation for this format

    R3

    The extension is represented a little differently in R3:

    • Remove the extension context SubscriptionStatus.notificationEvent (not for this version)
    • Note: Extensions that have been modified for R3 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: doco
    Extension 0..* Extension A hint for authorization requirements
    Extension. Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension. extension:type 1..1 Extension Authorization Type
    Extension.Slices for extension.extension:type. url 1..1 uri "type"
    Extension.Slices for extension.extension:type. value[x] 1..1 CodeableConcept Authorization Type
    Binding: AuthorizationHintVS ( preferred ) : Binding to the Authorization Hint Codes starter value set.
    Extension.Slices for extension. extension:value 0..1 Extension Authorization Value
    Extension.Slices for extension.extension:value. url 1..1 uri "value"
    Extension.Slices for extension.extension:value. value[x] 0..1 string Authorization Value
    Extension. url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/authorization-hint"
    Extension. value[x] 0 .. 0 Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)