FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) 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.2.0-ballot 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: Organization Brand

Official URL: http://hl7.org/fhir/StructureDefinition/organization-brand Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: OrganizationBrand
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1499

Organization-level Brand information.

Context of Use

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

  • Element ID Organization

Usage info

Usage:

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

Changes since version 1.0.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: Organization-level Brand information.

    • brandLogo: url: Brand logo URL. SHOULD be optimized for display as a 1 in / 2.54 cm square and formatted as SVG or 1024x1024 pixel PNG with transparent background. Logo should be be legible at small sizes (e.g., as small as 50x50 pixels). Tips to achieve this: if the logo contains both a brandmark and a wordmark, separate them and use just the brandmark. If the logo is predominantly horizontal, consider creating a vertically-oriented logo that is still recognizable when scaled to smaller sizes. Multiple logos may be supplied. The URL can be an absolute URL with the https:// schema, or a Data URL with the data: schema that directly embeds content. Additional resolutions can be supplied with repeated 'brandLogo' extensions.
    • brandLogoLicenseType: Coding: The license type for the brand logo. Uses SPDX license identifier when available. See https://spdx.org/licenses/ for more information.
    • brandLogoLicense: url: The license for the brand logo. This is a URL to the license details.
    • brandBundle: url: URL to an authoritative Brand Bundle where additional information about this Brand may be available

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Organization Brand
    ... Slices for extension Content/Rules for all slices
    .... extension:brandLogo 0..* Extension Brand Logo
    ..... extension 0..0
    ..... url 1..1 uri "brandLogo"
    ..... value[x] 0..1 url Value of extension
    .... extension:brandLogoLicenseType 0..* Extension Brand Logo License Type
    ..... extension 0..0
    ..... url 1..1 uri "brandLogoLicenseType"
    ..... value[x] 0..1 Coding Value of extension
    Binding: SPDXLicense (extensible)
    .... extension:brandLogoLicense 0..* Extension Brand Logo License
    ..... extension 0..0
    ..... url 1..1 uri "brandLogoLicense"
    ..... value[x] 0..1 url Value of extension
    .... extension:brandBundle 0..* Extension Brand Bundle URL
    ..... extension 0..0
    ..... url 1..1 uri "brandBundle"
    ..... value[x] 0..1 url Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-brand"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Organization Brand
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:brandLogo 0..* Extension Brand Logo
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "brandLogo"
    ..... value[x] 0..1 url Value of extension
    .... extension:brandLogoLicenseType 0..* Extension Brand Logo License Type
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "brandLogoLicenseType"
    ..... value[x] 0..1 Coding Value of extension
    Binding: SPDXLicense (extensible)
    .... extension:brandLogoLicense 0..* Extension Brand Logo License
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "brandLogoLicense"
    ..... value[x] 0..1 url Value of extension
    .... extension:brandBundle 0..* Extension Brand Bundle URL
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "brandBundle"
    ..... value[x] 0..1 url Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-brand"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Organization-level Brand information.

    • brandLogo: url: Brand logo URL. SHOULD be optimized for display as a 1 in / 2.54 cm square and formatted as SVG or 1024x1024 pixel PNG with transparent background. Logo should be be legible at small sizes (e.g., as small as 50x50 pixels). Tips to achieve this: if the logo contains both a brandmark and a wordmark, separate them and use just the brandmark. If the logo is predominantly horizontal, consider creating a vertically-oriented logo that is still recognizable when scaled to smaller sizes. Multiple logos may be supplied. The URL can be an absolute URL with the https:// schema, or a Data URL with the data: schema that directly embeds content. Additional resolutions can be supplied with repeated 'brandLogo' extensions.
    • brandLogoLicenseType: Coding: The license type for the brand logo. Uses SPDX license identifier when available. See https://spdx.org/licenses/ for more information.
    • brandLogoLicense: url: The license for the brand logo. This is a URL to the license details.
    • brandBundle: url: URL to an authoritative Brand Bundle where additional information about this Brand may be available

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Organization Brand
    ... Slices for extension Content/Rules for all slices
    .... extension:brandLogo 0..* Extension Brand Logo
    ..... extension 0..0
    ..... url 1..1 uri "brandLogo"
    ..... value[x] 0..1 url Value of extension
    .... extension:brandLogoLicenseType 0..* Extension Brand Logo License Type
    ..... extension 0..0
    ..... url 1..1 uri "brandLogoLicenseType"
    ..... value[x] 0..1 Coding Value of extension
    Binding: SPDXLicense (extensible)
    .... extension:brandLogoLicense 0..* Extension Brand Logo License
    ..... extension 0..0
    ..... url 1..1 uri "brandLogoLicense"
    ..... value[x] 0..1 url Value of extension
    .... extension:brandBundle 0..* Extension Brand Bundle URL
    ..... extension 0..0
    ..... url 1..1 uri "brandBundle"
    ..... value[x] 0..1 url Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-brand"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Organization Brand
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:brandLogo 0..* Extension Brand Logo
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "brandLogo"
    ..... value[x] 0..1 url Value of extension
    .... extension:brandLogoLicenseType 0..* Extension Brand Logo License Type
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "brandLogoLicenseType"
    ..... value[x] 0..1 Coding Value of extension
    Binding: SPDXLicense (extensible)
    .... extension:brandLogoLicense 0..* Extension Brand Logo License
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "brandLogoLicense"
    ..... value[x] 0..1 url Value of extension
    .... extension:brandBundle 0..* Extension Brand Bundle URL
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "brandBundle"
    ..... value[x] 0..1 url Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-brand"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:brandLogoLicenseType.value[x]extensibleSPDXLicense
    http://hl7.org/fhir/ValueSet/spdx-license
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)