Organization Portal - FHIR Extensions Pack v5.4.0

FHIR Extensions Pack
5.4.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.4.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: Organization Portal

Official URL: http://hl7.org/fhir/StructureDefinition/organization-portal	Version: 5.4.0	Highlight text changes?
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

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.3.0:

No changes

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Text Summary
Differential Table
Snapshot Table
All

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

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

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	0..*	Extension	Organization Portal
Extension.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension	1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalName	0..1	Extension	Portal Name
Extension.Slices for extension.extension:portalName.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalName.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalName.url	1..1	uri	"portalName"
Extension.Slices for extension.extension:portalName.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:portalDescription	0..1	Extension	Portal Description
Extension.Slices for extension.extension:portalDescription.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalDescription.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalDescription.url	1..1	uri	"portalDescription"
Extension.Slices for extension.extension:portalDescription.value[x]	0..1	markdown	Value of extension
Extension.Slices for extension.extension:portalUrl	0..1	Extension	Portal URL
Extension.Slices for extension.extension:portalUrl.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalUrl.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalUrl.url	1..1	uri	"portalUrl"
Extension.Slices for extension.extension:portalUrl.value[x]	0..1	url	Value of extension
Extension.Slices for extension.extension:portalLogo	0..*	Extension	Portal Logo
Extension.Slices for extension.extension:portalLogo.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalLogo.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalLogo.url	1..1	uri	"portalLogo"
Extension.Slices for extension.extension:portalLogo.value[x]	0..1	url	Value of extension
Extension.Slices for extension.extension:portalLogoLicenseType	0..*	Extension	Portal Logo License Type
Extension.Slices for extension.extension:portalLogoLicenseType.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalLogoLicenseType.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalLogoLicenseType.url	1..1	uri	"portalLogoLicenseType"
Extension.Slices for extension.extension:portalLogoLicenseType.value[x]	0..1	Coding	Value of extension Binding: SPDXLicense (extensible)
Extension.Slices for extension.extension:portalLogoLicense	0..*	Extension	Portal Logo License
Extension.Slices for extension.extension:portalLogoLicense.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalLogoLicense.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalLogoLicense.url	1..1	uri	"portalLogoLicense"
Extension.Slices for extension.extension:portalLogoLicense.value[x]	0..1	url	Value of extension
Extension.Slices for extension.extension:portalEndpoint	0..*	Extension	Endpoint associated with this portal
Extension.Slices for extension.extension:portalEndpoint.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalEndpoint.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalEndpoint.url	1..1	uri	"portalEndpoint"
Extension.Slices for extension.extension:portalEndpoint.value[x]	0..1	Reference()	Value of extension
Extension.url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/organization-portal"
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

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

Snapshot View

Name	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
Extension	0..*	Extension	Organization Portal
Extension.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension	1..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalName	0..1	Extension	Portal Name
Extension.Slices for extension.extension:portalName.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalName.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalName.url	1..1	uri	"portalName"
Extension.Slices for extension.extension:portalName.value[x]	0..1	string	Value of extension
Extension.Slices for extension.extension:portalDescription	0..1	Extension	Portal Description
Extension.Slices for extension.extension:portalDescription.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalDescription.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalDescription.url	1..1	uri	"portalDescription"
Extension.Slices for extension.extension:portalDescription.value[x]	0..1	markdown	Value of extension
Extension.Slices for extension.extension:portalUrl	0..1	Extension	Portal URL
Extension.Slices for extension.extension:portalUrl.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalUrl.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalUrl.url	1..1	uri	"portalUrl"
Extension.Slices for extension.extension:portalUrl.value[x]	0..1	url	Value of extension
Extension.Slices for extension.extension:portalLogo	0..*	Extension	Portal Logo
Extension.Slices for extension.extension:portalLogo.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalLogo.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalLogo.url	1..1	uri	"portalLogo"
Extension.Slices for extension.extension:portalLogo.value[x]	0..1	url	Value of extension
Extension.Slices for extension.extension:portalLogoLicenseType	0..*	Extension	Portal Logo License Type
Extension.Slices for extension.extension:portalLogoLicenseType.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalLogoLicenseType.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalLogoLicenseType.url	1..1	uri	"portalLogoLicenseType"
Extension.Slices for extension.extension:portalLogoLicenseType.value[x]	0..1	Coding	Value of extension Binding: SPDXLicense (extensible)
Extension.Slices for extension.extension:portalLogoLicense	0..*	Extension	Portal Logo License
Extension.Slices for extension.extension:portalLogoLicense.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalLogoLicense.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalLogoLicense.url	1..1	uri	"portalLogoLicense"
Extension.Slices for extension.extension:portalLogoLicense.value[x]	0..1	url	Value of extension
Extension.Slices for extension.extension:portalEndpoint	0..*	Extension	Endpoint associated with this portal
Extension.Slices for extension.extension:portalEndpoint.id	0..1	id	Unique id for inter-element referencing
Extension.Slices for extension.extension:portalEndpoint.extension	0..0		Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Extension.Slices for extension.extension:portalEndpoint.url	1..1	uri	"portalEndpoint"
Extension.Slices for extension.extension:portalEndpoint.value[x]	0..1	Reference()	Value of extension
Extension.url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/organization-portal"
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Extension.extension:portalLogoLicenseType.value[x]	Base	extensible	S P D X License	📦5.0.0	FHIR Std.

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 represented a little differently in R3:

Map the type url to uri on the element Extension.extension:portalUrl.value[x]
Map the type url to uri on the element Extension.extension:portalLogo.value[x]
Map the type url to uri on the element Extension.extension:portalLogoLicense.value[x]
Note: Extensions that have been modified for R3 are still draft while real-world experience is collected

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

Search Parameters for this Extension

(none found)

IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.extensions#5.4.0 based on FHIR 5.0.0. Generated 2026-10-09
Links: Table of Contents | QA Report | Version History | | Propose a change