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 Portal

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

Organization-level portal 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:

  • No changes

    • 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 portal information.

    • portalName: string: Indicates the name by which users know the portal - for example 'MyChildrens' or 'Patient Gateway'.
    • portalDescription: markdown: Describes the portal and its intended audience. May be used to help users select the right portal if multiple options are available.
    • portalUrl: url: Indicates the location of the user portal associated with this Brand - a URL where users can go to see their data and manage access.
    • portalLogo: url: Portal logo image. Used if the portal has its own logo in addition to the Brand's logo. See the documentation for 'brand' profile.
    • portalLogoLicenseType: Coding: The license type for the portal logo. Uses SPDX license identifier when available. See https://spdx.org/licenses/ for more information.
    • portalLogoLicense: url: The license for the portal logo. This is a URL to the license details.
    • portalEndpoint: Reference: Reference to endpoints asociated with this portal. These endpoints will also appear in Organization.endpoint; inclusion here indicates that endpoint are associated specifically with this portal.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Organization Portal
    ... extension 1..* Extension Extension
    ... Slices for extension Content/Rules for all slices
    .... extension:portalName 0..1 Extension Portal Name
    ..... extension 0..0
    ..... url 1..1 uri "portalName"
    ..... value[x] 0..1 string Value of extension
    .... extension:portalDescription 0..1 Extension Portal Description
    ..... extension 0..0
    ..... url 1..1 uri "portalDescription"
    ..... value[x] 0..1 markdown Value of extension
    .... extension:portalUrl 0..1 Extension Portal URL
    ..... extension 0..0
    ..... url 1..1 uri "portalUrl"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalLogo 0..* Extension Portal Logo
    ..... extension 0..0
    ..... url 1..1 uri "portalLogo"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalLogoLicenseType 0..* Extension Portal Logo License Type
    ..... extension 0..0
    ..... url 1..1 uri "portalLogoLicenseType"
    ..... value[x] 0..1 Coding Value of extension
    Binding: SPDXLicense (extensible)
    .... extension:portalLogoLicense 0..* Extension Portal Logo License
    ..... extension 0..0
    ..... url 1..1 uri "portalLogoLicense"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalEndpoint 0..* Extension Endpoint associated with this portal
    ..... extension 0..0
    ..... url 1..1 uri "portalEndpoint"
    ..... value[x] 0..1 Reference() Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-portal"

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Organization Portal
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:portalName 0..1 Extension Portal Name
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalName"
    ..... value[x] 0..1 string Value of extension
    .... extension:portalDescription 0..1 Extension Portal Description
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalDescription"
    ..... value[x] 0..1 markdown Value of extension
    .... extension:portalUrl 0..1 Extension Portal URL
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalUrl"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalLogo 0..* Extension Portal Logo
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalLogo"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalLogoLicenseType 0..* Extension Portal Logo License Type
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalLogoLicenseType"
    ..... value[x] 0..1 Coding Value of extension
    Binding: SPDXLicense (extensible)
    .... extension:portalLogoLicense 0..* Extension Portal Logo License
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalLogoLicense"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalEndpoint 0..* Extension Endpoint associated with this portal
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalEndpoint"
    ..... value[x] 0..1 Reference() Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-portal"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Organization-level portal information.

    • portalName: string: Indicates the name by which users know the portal - for example 'MyChildrens' or 'Patient Gateway'.
    • portalDescription: markdown: Describes the portal and its intended audience. May be used to help users select the right portal if multiple options are available.
    • portalUrl: url: Indicates the location of the user portal associated with this Brand - a URL where users can go to see their data and manage access.
    • portalLogo: url: Portal logo image. Used if the portal has its own logo in addition to the Brand's logo. See the documentation for 'brand' profile.
    • portalLogoLicenseType: Coding: The license type for the portal logo. Uses SPDX license identifier when available. See https://spdx.org/licenses/ for more information.
    • portalLogoLicense: url: The license for the portal logo. This is a URL to the license details.
    • portalEndpoint: Reference: Reference to endpoints asociated with this portal. These endpoints will also appear in Organization.endpoint; inclusion here indicates that endpoint are associated specifically with this portal.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Organization Portal
    ... extension 1..* Extension Extension
    ... Slices for extension Content/Rules for all slices
    .... extension:portalName 0..1 Extension Portal Name
    ..... extension 0..0
    ..... url 1..1 uri "portalName"
    ..... value[x] 0..1 string Value of extension
    .... extension:portalDescription 0..1 Extension Portal Description
    ..... extension 0..0
    ..... url 1..1 uri "portalDescription"
    ..... value[x] 0..1 markdown Value of extension
    .... extension:portalUrl 0..1 Extension Portal URL
    ..... extension 0..0
    ..... url 1..1 uri "portalUrl"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalLogo 0..* Extension Portal Logo
    ..... extension 0..0
    ..... url 1..1 uri "portalLogo"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalLogoLicenseType 0..* Extension Portal Logo License Type
    ..... extension 0..0
    ..... url 1..1 uri "portalLogoLicenseType"
    ..... value[x] 0..1 Coding Value of extension
    Binding: SPDXLicense (extensible)
    .... extension:portalLogoLicense 0..* Extension Portal Logo License
    ..... extension 0..0
    ..... url 1..1 uri "portalLogoLicense"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalEndpoint 0..* Extension Endpoint associated with this portal
    ..... extension 0..0
    ..... url 1..1 uri "portalEndpoint"
    ..... value[x] 0..1 Reference() Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-portal"

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Organization Portal
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url
    .... extension:portalName 0..1 Extension Portal Name
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalName"
    ..... value[x] 0..1 string Value of extension
    .... extension:portalDescription 0..1 Extension Portal Description
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalDescription"
    ..... value[x] 0..1 markdown Value of extension
    .... extension:portalUrl 0..1 Extension Portal URL
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalUrl"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalLogo 0..* Extension Portal Logo
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalLogo"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalLogoLicenseType 0..* Extension Portal Logo License Type
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalLogoLicenseType"
    ..... value[x] 0..1 Coding Value of extension
    Binding: SPDXLicense (extensible)
    .... extension:portalLogoLicense 0..* Extension Portal Logo License
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalLogoLicense"
    ..... value[x] 0..1 url Value of extension
    .... extension:portalEndpoint 0..* Extension Endpoint associated with this portal
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "portalEndpoint"
    ..... value[x] 0..1 Reference() Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/organization-portal"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:portalLogoLicenseType.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)