FHIR Extensions Pack
5.1.0-ballot1 - Ballot for Release 5.1.0 International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0-ballot: Releases Ballot 4) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Extension: Organization Portal

Official URL: http://hl7.org/fhir/StructureDefinition/organization-portal Version: 5.1.0-ballot1
Standards status: Trial-use Maturity Level: 1 Computable Name: OrganizationPortal

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 patients know the portal - for example 'MyChildrens' or 'Patient Gateway'.
    • portalDescription: markdown: Describes the portal and its intended audience. May be used to help patients select the right portal if multiple options are available.
    • portalUrl: url: Indicates the location of the patient portal associated with this Brand - a URL where patients can go to see their data and manage access.
    • description: string: Patient-friendly language that explains the subset of patients eligible to connect and the data available. For example - 'a cancer center that uses one EHR for pediatric patients and another for adult patients'..
    • 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..*ExtensionOrganization Portal
    ... extension 1..*ExtensionExtension
    ... extension:portalName 0..1ExtensionPortal Name
    .... extension 0..0
    .... url 1..1uri"portalName"
    .... value[x] 0..1stringValue of extension
    ... extension:portalDescription 0..1ExtensionPortal Description
    .... extension 0..0
    .... url 1..1uri"portalDescription"
    .... value[x] 0..1markdownValue of extension
    .... extension 0..0
    .... url 1..1uri"portalUrl"
    .... value[x] 0..1urlValue of extension
    ... extension:description 0..1ExtensionPortal Description
    .... extension 0..0
    .... url 1..1uri"description"
    .... value[x] 0..1stringValue of extension
    ... extension:portalLogo 0..*ExtensionPortal Logo
    .... extension 0..0
    .... url 1..1uri"portalLogo"
    .... value[x] 0..1urlValue of extension
    ... extension:portalLogoLicenseType 0..*ExtensionPortal Logo License Type
    .... extension 0..0
    .... url 1..1uri"portalLogoLicenseType"
    .... value[x] 0..1CodingValue of extension
    Binding: SPDXLicense (extensible)
    ... extension:portalLogoLicense 0..*ExtensionPortal Logo License
    .... extension 0..0
    .... url 1..1uri"portalLogoLicense"
    .... value[x] 0..1urlValue of extension
    ... extension:portalEndpoint 0..*ExtensionEndpoint associated with this portal
    .... extension 0..0
    .... url 1..1uri"portalEndpoint"
    .... value[x] 0..1Reference()Value of extension
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/organization-portal"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..*ExtensionOrganization Portal
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 1..*ExtensionExtension
    Slice: Unordered, Open by value:url
    ... extension:portalName 0..1ExtensionPortal Name
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalName"
    .... value[x] 0..1stringValue of extension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalDescription"
    .... value[x] 0..1markdownValue of extension
    ... extension:portalUrl 0..1ExtensionPortal URL
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalUrl"
    .... value[x] 0..1urlValue of extension
    ... extension:description 0..1ExtensionPortal Description
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"description"
    .... value[x] 0..1stringValue of extension
    ... extension:portalLogo 0..*ExtensionPortal Logo
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalLogo"
    .... value[x] 0..1urlValue of extension
    ... extension:portalLogoLicenseType 0..*ExtensionPortal Logo License Type
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalLogoLicenseType"
    .... value[x] 0..1CodingValue of extension
    Binding: SPDXLicense (extensible)
    ... extension:portalLogoLicense 0..*ExtensionPortal Logo License
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalLogoLicense"
    .... value[x] 0..1urlValue of extension
    ... extension:portalEndpoint 0..*ExtensionEndpoint associated with this portal
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalEndpoint"
    .... value[x] 0..1Reference()Value of extension
    ... url 1..1uri"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 patients know the portal - for example 'MyChildrens' or 'Patient Gateway'.
    • portalDescription: markdown: Describes the portal and its intended audience. May be used to help patients select the right portal if multiple options are available.
    • portalUrl: url: Indicates the location of the patient portal associated with this Brand - a URL where patients can go to see their data and manage access.
    • description: string: Patient-friendly language that explains the subset of patients eligible to connect and the data available. For example - 'a cancer center that uses one EHR for pediatric patients and another for adult patients'..
    • 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..*ExtensionOrganization Portal
    ... extension 1..*ExtensionExtension
    ... extension:portalName 0..1ExtensionPortal Name
    .... extension 0..0
    .... url 1..1uri"portalName"
    .... value[x] 0..1stringValue of extension
    ... extension:portalDescription 0..1ExtensionPortal Description
    .... extension 0..0
    .... url 1..1uri"portalDescription"
    .... value[x] 0..1markdownValue of extension
    .... extension 0..0
    .... url 1..1uri"portalUrl"
    .... value[x] 0..1urlValue of extension
    ... extension:description 0..1ExtensionPortal Description
    .... extension 0..0
    .... url 1..1uri"description"
    .... value[x] 0..1stringValue of extension
    ... extension:portalLogo 0..*ExtensionPortal Logo
    .... extension 0..0
    .... url 1..1uri"portalLogo"
    .... value[x] 0..1urlValue of extension
    ... extension:portalLogoLicenseType 0..*ExtensionPortal Logo License Type
    .... extension 0..0
    .... url 1..1uri"portalLogoLicenseType"
    .... value[x] 0..1CodingValue of extension
    Binding: SPDXLicense (extensible)
    ... extension:portalLogoLicense 0..*ExtensionPortal Logo License
    .... extension 0..0
    .... url 1..1uri"portalLogoLicense"
    .... value[x] 0..1urlValue of extension
    ... extension:portalEndpoint 0..*ExtensionEndpoint associated with this portal
    .... extension 0..0
    .... url 1..1uri"portalEndpoint"
    .... value[x] 0..1Reference()Value of extension
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/organization-portal"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..*ExtensionOrganization Portal
    ... id 0..1idUnique id for inter-element referencing
    ... Slices for extension 1..*ExtensionExtension
    Slice: Unordered, Open by value:url
    ... extension:portalName 0..1ExtensionPortal Name
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalName"
    .... value[x] 0..1stringValue of extension
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalDescription"
    .... value[x] 0..1markdownValue of extension
    ... extension:portalUrl 0..1ExtensionPortal URL
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalUrl"
    .... value[x] 0..1urlValue of extension
    ... extension:description 0..1ExtensionPortal Description
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"description"
    .... value[x] 0..1stringValue of extension
    ... extension:portalLogo 0..*ExtensionPortal Logo
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalLogo"
    .... value[x] 0..1urlValue of extension
    ... extension:portalLogoLicenseType 0..*ExtensionPortal Logo License Type
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalLogoLicenseType"
    .... value[x] 0..1CodingValue of extension
    Binding: SPDXLicense (extensible)
    ... extension:portalLogoLicense 0..*ExtensionPortal Logo License
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalLogoLicense"
    .... value[x] 0..1urlValue of extension
    ... extension:portalEndpoint 0..*ExtensionEndpoint associated with this portal
    .... id 0..1idUnique id for inter-element referencing
    .... extension 0..0
    .... url 1..1uri"portalEndpoint"
    .... value[x] 0..1Reference()Value of extension
    ... url 1..1uri"http://hl7.org/fhir/StructureDefinition/organization-portal"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSet
    Extension.extension:portalLogoLicenseType.value[x]extensibleSPDXLicense

    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)