FHIR Extensions Pack
5.3.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.3.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.3.0
Standards status: Trial-use Maturity Level: 1 Computable Name: AuthorizationHint

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

This extension is a mechanism to annotate a resource with hinting for authorization requirements used to access content or services. E.g., indicating the preferred authorization mechanism to access an Endpoint; providing additional tokens for resolving notifications; etc.. Note that the context for this extension for the Reference type is restricted to Reference(Endpoint).

This is an draft extension definition; the committee is seeking implementation feedback, and the definition or contents of the extension may change in future versions

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.2.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: Filtersdoco
    .. Extension 0..* Extension A hint for authorization requirements
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:type 1..1 Extension Authorization Type
    ..... url 1..1 uri "type"
    ..... value[x] 1..1 CodeableConcept Authorization Type
    Binding: AuthorizationHintVS (preferred): Binding to the Authorization Hint Codes starter value set.
    .... extension:value 0..1 Extension Authorization Value
    ..... url 1..1 uri "value"
    ..... value[x] 0..1 string Authorization Value
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/authorization-hint"
    ... value[x] 0..0 Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension A hint for authorization requirements
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:type 1..1 Extension Authorization Type
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "type"
    ..... value[x] 1..1 CodeableConcept Authorization Type
    Binding: AuthorizationHintVS (preferred): Binding to the Authorization Hint Codes starter value set.
    .... extension:value 0..1 Extension Authorization Value
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "value"
    ..... value[x] 0..1 string Authorization Value
    ... 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: Filtersdoco
    .. Extension 0..* Extension A hint for authorization requirements
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:type 1..1 Extension Authorization Type
    ..... url 1..1 uri "type"
    ..... value[x] 1..1 CodeableConcept Authorization Type
    Binding: AuthorizationHintVS (preferred): Binding to the Authorization Hint Codes starter value set.
    .... extension:value 0..1 Extension Authorization Value
    ..... url 1..1 uri "value"
    ..... value[x] 0..1 string Authorization Value
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/authorization-hint"
    ... value[x] 0..0 Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension A hint for authorization requirements
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:type 1..1 Extension Authorization Type
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "type"
    ..... value[x] 1..1 CodeableConcept Authorization Type
    Binding: AuthorizationHintVS (preferred): Binding to the Authorization Hint Codes starter value set.
    .... extension:value 0..1 Extension Authorization Value
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    ..... url 1..1 uri "value"
    ..... value[x] 0..1 string Authorization Value
    ... 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.3.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 unchanged in R4

    R3

    The extension is unchanged in R3

    Search Parameters for this Extension

    (none found)