ITB - Online appointment booking service
1.0.0 - Initial Release

ITB - Online appointment booking service, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions

Resource Profile: PractitionerRolePortal

Official URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/practitioner-role-portal Version: 1.0.0
Active as of 2026-04-20 Computable Name: PractitionerRolePortal

PractitionerRolePortal represents a practitioner acting in a specific operational and financial context.

It answers the question: “In which role, at which service location, and under which financial responsibility does this practitioner perform services?”

  • Links a PractitionerPortal (the individual person).
  • Links a HealthcareServicePortal (where the service is performed).
  • Links a BillingOrganizationPortal (who is financially responsible).

A PractitionerRole defines the context in which work is performed, not the person itself.

  • A Practitioner may have multiple PractitionerRolePortals.
  • A Practitioner may work at multiple HealthcareServicePortals.
  • A Practitioner may act under different BillingOrganizationPortals depending on context.

This makes PractitionerRole the central concept for:

  • Booking and offers
  • Pricing and duration rules
  • Financial responsibility
  • Service-specific configuration

Important: PractitionerRolePortal is intentionally used to separate the person from the context in which services are delivered and billed.

Current name in Backoffice: Practitioner

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* WofBasePractitionerRole Roles/organizations the practitioner is associated with
... id Σ 1..1 id Resource identifier
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base PractitionerRole
.... profile SOΣ 1..* canonical(StructureDefinition) Profile conformance declarations
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base PractitionerRole
... Slices for extension Content/Rules for all slices
.... extension:description 0..1 (Complex) PractitionerRole Description
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-practitionerrole-description
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-practitionerrole-description"
..... value[x] S 0..1 string Description text
.... extension:binaryReference 0..1 (Complex) Binary Reference
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-binary-reference
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-binary-reference"
..... value[x] S 0..1 Reference(Binary) Reference to a contained Binary
... practitioner Σ 1..1 Reference(Practitioner) The individual practitioner
.... identifier Σ 1..1 Identifier Identifier for the practitioner
.... display Σ 1..1 string Display name of the practitioner
... organization Σ 1..1 Reference(Organization) Binding to the billing organization
.... identifier Σ 1..1 Identifier Identifier for the billing organization
... code Σ 1..* CodeableConcept Role code
Binding: PractitionerRole (example): The role a person plays representing an organization.
... healthcareService 1..1 Reference(HealthcareService) Service location where this role is performed

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.code Base example Practitioner role 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
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()

This structure is derived from WofBasePractitionerRole

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole WofBasePractitionerRole
... meta
.... versionId 0..1 id Server-managed resource version
.... profile 1..* canonical(StructureDefinition) Profile conformance declarations
... Slices for extension Content/Rules for all slices
.... extension:description 0..1 PractitionerRoleDescription PractitionerRole Description
..... value[x] S 0..1 string Description text
.... extension:binaryReference 0..1 BinaryReference Binary Reference
..... value[x] S 0..1 Reference(Binary) Reference to a contained Binary
... active 1..1 boolean Whether this practitioner role is active
... practitioner
.... reference 0..0 Literal reference, Relative, internal or absolute URL
.... identifier 1..1 Identifier Identifier for the practitioner
... organization 1..1 Reference(Organization) Binding to the billing organization
.... reference 0..0 Literal reference, Relative, internal or absolute URL
... healthcareService 1..1 Reference(HealthcareService) Service location where this role is performed
... endpoint 0..0 Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* WofBasePractitionerRole Roles/organizations the practitioner is associated with
... id Σ 1..1 id Resource identifier
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base PractitionerRole
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SOΣ 1..* canonical(StructureDefinition) Profile conformance declarations
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base PractitionerRole
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained Binary resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:description 0..1 (Complex) PractitionerRole Description
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-practitionerrole-description
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-practitionerrole-description"
..... value[x] S 0..1 string Description text
.... extension:binaryReference 0..1 (Complex) Binary Reference
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-binary-reference
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-binary-reference"
..... value[x] S 0..1 Reference(Binary) Reference to a contained Binary
... active Σ 1..1 boolean Whether this practitioner role is active
... practitioner Σ 1..1 Reference(Practitioner) The individual practitioner
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 1..1 Identifier Identifier for the practitioner
.... display Σ 1..1 string Display name of the practitioner
... organization Σ 1..1 Reference(Organization) Binding to the billing organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier Σ 1..1 Identifier Identifier for the billing organization
.... display Σ 0..1 string Display name of the billing organization
... code Σ 1..* CodeableConcept Role code
Binding: PractitionerRole (example): The role a person plays representing an organization.
... specialty Σ 0..* CodeableConcept Clinical specialty
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
... healthcareService 1..1 Reference(HealthcareService) Service location where this role is performed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference to the HealthcareService resource
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Display name of the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
PractitionerRole.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
PractitionerRole.language Base preferred Common Languages 📍4.0.1 FHIR Std.
PractitionerRole.practitioner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.code Base example Practitioner role 📍4.0.1 FHIR Std.
PractitionerRole.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
PractitionerRole.healthcareService.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
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()

This structure is derived from WofBasePractitionerRole

Summary

Mandatory: 3 elements
Must-Support: 2 elements
Prohibited: 4 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* WofBasePractitionerRole Roles/organizations the practitioner is associated with
... id Σ 1..1 id Resource identifier
... meta Σ 0..1 Meta Metadata about the resource
.... versionId SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base PractitionerRole
.... profile SOΣ 1..* canonical(StructureDefinition) Profile conformance declarations
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base PractitionerRole
... Slices for extension Content/Rules for all slices
.... extension:description 0..1 (Complex) PractitionerRole Description
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-practitionerrole-description
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-practitionerrole-description"
..... value[x] S 0..1 string Description text
.... extension:binaryReference 0..1 (Complex) Binary Reference
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-binary-reference
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-binary-reference"
..... value[x] S 0..1 Reference(Binary) Reference to a contained Binary
... practitioner Σ 1..1 Reference(Practitioner) The individual practitioner
.... identifier Σ 1..1 Identifier Identifier for the practitioner
.... display Σ 1..1 string Display name of the practitioner
... organization Σ 1..1 Reference(Organization) Binding to the billing organization
.... identifier Σ 1..1 Identifier Identifier for the billing organization
... code Σ 1..* CodeableConcept Role code
Binding: PractitionerRole (example): The role a person plays representing an organization.
... healthcareService 1..1 Reference(HealthcareService) Service location where this role is performed

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.code Base example Practitioner role 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
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()

Differential View

This structure is derived from WofBasePractitionerRole

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole WofBasePractitionerRole
... meta
.... versionId 0..1 id Server-managed resource version
.... profile 1..* canonical(StructureDefinition) Profile conformance declarations
... Slices for extension Content/Rules for all slices
.... extension:description 0..1 PractitionerRoleDescription PractitionerRole Description
..... value[x] S 0..1 string Description text
.... extension:binaryReference 0..1 BinaryReference Binary Reference
..... value[x] S 0..1 Reference(Binary) Reference to a contained Binary
... active 1..1 boolean Whether this practitioner role is active
... practitioner
.... reference 0..0 Literal reference, Relative, internal or absolute URL
.... identifier 1..1 Identifier Identifier for the practitioner
... organization 1..1 Reference(Organization) Binding to the billing organization
.... reference 0..0 Literal reference, Relative, internal or absolute URL
... healthcareService 1..1 Reference(HealthcareService) Service location where this role is performed
... endpoint 0..0 Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole 0..* WofBasePractitionerRole Roles/organizations the practitioner is associated with
... id Σ 1..1 id Resource identifier
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId SOΣ 0..1 id Server-managed resource version
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base PractitionerRole
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SOΣ 1..* canonical(StructureDefinition) Profile conformance declarations
ObligationsActorSource
SHALL:populate https://canonical.fhir.link/servicewell/wof-portal/ActorDefinition/wof-portal-server from Wof Base PractitionerRole
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... contained 0..* Resource Contained Binary resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:description 0..1 (Complex) PractitionerRole Description
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-practitionerrole-description
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-practitionerrole-description"
..... value[x] S 0..1 string Description text
.... extension:binaryReference 0..1 (Complex) Binary Reference
URL: https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-binary-reference
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-binary-reference"
..... value[x] S 0..1 Reference(Binary) Reference to a contained Binary
... active Σ 1..1 boolean Whether this practitioner role is active
... practitioner Σ 1..1 Reference(Practitioner) The individual practitioner
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 1..1 Identifier Identifier for the practitioner
.... display Σ 1..1 string Display name of the practitioner
... organization Σ 1..1 Reference(Organization) Binding to the billing organization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... identifier Σ 1..1 Identifier Identifier for the billing organization
.... display Σ 0..1 string Display name of the billing organization
... code Σ 1..* CodeableConcept Role code
Binding: PractitionerRole (example): The role a person plays representing an organization.
... specialty Σ 0..* CodeableConcept Clinical specialty
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
... healthcareService 1..1 Reference(HealthcareService) Service location where this role is performed
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference to the HealthcareService resource
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Display name of the healthcare service

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PractitionerRole.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
PractitionerRole.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
PractitionerRole.language Base preferred Common Languages 📍4.0.1 FHIR Std.
PractitionerRole.practitioner.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.code Base example Practitioner role 📍4.0.1 FHIR Std.
PractitionerRole.specialty Base preferred Practice Setting Code Value Set 📍4.0.1 FHIR Std.
PractitionerRole.healthcareService.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
PractitionerRole.availableTime.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PractitionerRole If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PractitionerRole If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error PractitionerRole If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PractitionerRole A resource should have narrative for robust management text.`div`.exists()
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()

This structure is derived from WofBasePractitionerRole

Summary

Mandatory: 3 elements
Must-Support: 2 elements
Prohibited: 4 elements

 

Other representations of profile: CSV, Excel, Schematron