FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) 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-ballot-tc1 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: Confidential (Experimental)

Official URL: http://hl7.org/fhir/StructureDefinition/confidential Version: 5.3.0-ballot-tc1
Standards status: Deprecated Maturity Level: 1 Computable Name: Confidential
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1648

Expresses the access policy associated with the element.

This is an experimental extension definition; the definition is intended for testing purposes, education or evaluation, and the definition is not anticipated to be matured to a point where it is intended for genuine usage.

Context of Use

This extension is deprecated and should no longer be used

This extension is deprecated, use the Inline-sec-label extension instead. The Inline-sec-label extension is generic and useable anywhere and has significant guidance around its use in the defining DS4P Implementation Guide

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

Usage info

Usages:

  • This Extension is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.0:

  • The resource metadata has changed (status)

    • 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

    Simple Extension with the type uri, CodeableConcept: Expresses the access policy associated with the element.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Confidential
    ... extension 0..0 Extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/confidential"
    ... Slices for value[x] 1..1 Value of extension
    Slice: Unordered, Open by type:$this
    .... valueUri uri
    .... valueCodeableConcept CodeableConcept
    .... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
    Binding: Confidentiality (example)

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Confidential
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0 Extension
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/confidential"
    .... valueUri uri
    .... valueCodeableConcept CodeableConcept
    .... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
    Binding: Confidentiality (example)

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type uri, CodeableConcept: Expresses the access policy associated with the element.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Confidential
    ... extension 0..0 Extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/confidential"
    ... Slices for value[x] 1..1 Value of extension
    Slice: Unordered, Open by type:$this
    .... valueUri uri
    .... valueCodeableConcept CodeableConcept
    .... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
    Binding: Confidentiality (example)

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Confidential
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0 Extension
    Slice: Unordered, Open by value:url
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/confidential"
    .... valueUri uri
    .... valueCodeableConcept CodeableConcept
    .... value[x]:valueCodeableConcept 0..1 CodeableConcept Value of extension
    Binding: Confidentiality (example)

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Extension.value[x]:valueCodeableConcept Base example Confidentiality 📦3.0.0 THO v6.5

    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 not used in R4B

    • Range [19, 18) out of bounds for length 18

    R4

    The extension is not used in R4

    • Range [19, 18) out of bounds for length 18

    R3

    The extension is not used in R3

    • Range [19, 18) out of bounds for length 18

    Search Parameters for this Extension

    (none found)