Polaris FHIR Implementation Guide
1.10.0 - ci-build

Polaris FHIR Implementation Guide - Local Development build (v1.10.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Polaris PractitionerRole Core

Official URL: https://fhir.apps.health/StructureDefinition/polaris-core-practitionerrole Version: 1.10.0
Draft as of 2026-05-26 Computable Name: PolarisCorePractitionerRole

Represents an EMR user. Focuses on linking a Practitioner to Organizations and Locations via Polaris identifiers.

Overview

Represents an EMR user - linking a practitioner to their role at an organization. This is the profile to use for EMR user accounts, not PolarisCorePractitioner which represents the person independent of roles.

Key Requirements

  • At least one identifier must use Polaris naming pattern
  • Required reference to the practitioner (Must Support)
  • Organization where role is performed (Must Support)
  • Locations where practitioner works in this role
  • Human-readable text summary recommended

Identifiers

Required Pattern: https://fhir.apps.health/NamingSystem/[system]-practitionerrole-identifier

Where [system] = EMR product + instance ID (e.g., Juno-7e3b9c2a-4f6d-4e8a-9b2e-1f5c8d7a2b3c)

EMR User IDs: Consider adding a slice for EMR-specific user identifiers using subtype pattern:

https://fhir.apps.health/NamingSystem/[system]-practitionerrole-identifier/emr-userid

Invariants

practitionerrole-has-polaris-id: At least one identifier must match pattern:

^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-practitionerrole-identifier$

Examples

Implementation Notes

  • Primary Use Case: EMR user accounts and role assignments
  • Not for: General practitioner information (use PolarisCorePractitioner)
  • Practitioner Reference: Must always reference a valid PolarisCorePractitioner
  • Organization Reference: Should reference a valid PolarisCoreOrganization when known

See Also

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 C 0..* PractitionerRole Roles/organizations the practitioner is associated with
Constraints: practitionerrole-has-polaris-id
... meta Σ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 0..1 Narrative Narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for identifier SΣ 1..* Identifier identifiers including Polaris ID and EMR user ID
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris PractitionerRole ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... system Σ 1..1 uri Polaris practitionerrole identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris practitioner role ID value: unique in source system
Example General: 123456
.... identifier:rawCode SΣ 0..* Identifier Source EMR user/role identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-raw-code
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
... practitioner SΣ 1..1 Reference(Practitioner) Reference to the practitioner
... organization SΣ 0..1 Reference(Organization) Organization where the role is performed
... code SΣ 0..* CodeableConcept Practitioner role with raw code support
Binding: PractitionerRole (example): The role a person plays representing an organization.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard role code
...... system Σ 1..1 uri Standard terminology system URI
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:rawCode SΣ 0..* Coding Source EMR role code
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-code-raw-code
...... code Σ 1..1 code EMR-specific role code
...... display Σ 1..1 string EMR's display text for this role
... specialty SΣ 0..* CodeableConcept Practitioner specialty with raw code support
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard specialty code
...... system Σ 1..1 uri Standard terminology system URI
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:rawCode SΣ 0..* Coding Source EMR specialty code
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-specialty-raw-code
...... code Σ 1..1 code EMR-specific specialty code
...... display Σ 1..1 string EMR's display text for this specialty
... location Σ 0..* Reference(Location) Location(s) where the practitioner provides care

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PractitionerRole.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PractitionerRole.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PractitionerRole.codeexamplePractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
From the FHIR Standard
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
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()
practitionerrole-has-polaris-iderrorPractitionerRoleMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-practitionerrole-identifier$'))

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* PractitionerRole Roles/organizations the practitioner is associated with
Constraints: practitionerrole-has-polaris-id
... meta
.... source S 0..1 uri Identifies EMR instance & pipeline version the resource came from
... text S 0..1 Narrative Narrative
... Slices for identifier S 1..* Identifier identifiers including Polaris ID and EMR user ID
Slice: Unordered, Open by pattern:system
.... identifier:polarisId S 1..1 Identifier Polaris PractitionerRole ID
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 1..1 uri Polaris practitionerrole identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-identifier
..... value 1..1 string The actual Polaris practitioner role ID value: unique in source system
.... identifier:rawCode S 0..* Identifier Source EMR user/role identifier
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-raw-code
..... value 1..1 string The value that is unique
... organization S 0..1 Reference(Organization) Organization where the role is performed
... code S 0..* CodeableConcept Practitioner role with raw code support
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard S 0..* Coding Standard role code
...... system 1..1 uri Standard terminology system URI
...... code 1..1 code Symbol in syntax defined by the system
..... coding:rawCode S 0..* Coding Source EMR role code
...... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-code-raw-code
...... code 1..1 code EMR-specific role code
...... display 1..1 string EMR's display text for this role
... specialty S 0..* CodeableConcept Practitioner specialty with raw code support
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard S 0..* Coding Standard specialty code
...... system 1..1 uri Standard terminology system URI
...... code 1..1 code Symbol in syntax defined by the system
..... coding:rawCode S 0..* Coding Source EMR specialty code
...... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-specialty-raw-code
...... code 1..1 code EMR-specific specialty code
...... display 1..1 string EMR's display text for this specialty
... location 0..* Reference(Location) Location(s) where the practitioner provides care

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
practitionerrole-has-polaris-iderrorPractitionerRoleMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-practitionerrole-identifier$'))
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* PractitionerRole Roles/organizations the practitioner is associated with
Constraints: practitionerrole-has-polaris-id
... id Σ 0..1 id Logical id of this artifact
... 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 Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 0..1 Narrative Narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier identifiers including Polaris ID and EMR user ID
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris PractitionerRole ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri Polaris practitionerrole identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris practitioner role ID value: unique in source system
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:rawCode SΣ 0..* Identifier Source EMR user/role identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-raw-code
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ 1..1 Reference(Practitioner) Reference to the practitioner
... organization SΣ 0..1 Reference(Organization) Organization where the role is performed
... code SΣ 0..* CodeableConcept Practitioner role with raw code support
Binding: PractitionerRole (example): The role a person plays representing an 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
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard role code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Standard terminology system URI
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:rawCode SΣ 0..* Coding Source EMR role code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-code-raw-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code EMR-specific role code
...... display Σ 1..1 string EMR's display text for this role
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... specialty SΣ 0..* CodeableConcept Practitioner specialty with raw code support
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard specialty code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Standard terminology system URI
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:rawCode SΣ 0..* Coding Source EMR specialty code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-specialty-raw-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code EMR-specific specialty code
...... display Σ 1..1 string EMR's display text for this specialty
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... location Σ 0..* Reference(Location) Location(s) where the practitioner provides care
... healthcareService 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom Σ 0..* ContactPoint Contact details that are specific to the role/location/service
... availableTime 0..* BackboneElement Times the Service Site is available
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable 0..* BackboneElement Not available during this time due to provided reason
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PractitionerRole.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
PractitionerRole.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
PractitionerRole.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PractitionerRole.identifier:polarisId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PractitionerRole.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PractitionerRole.identifier:rawCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PractitionerRole.codeexamplePractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
From the FHIR Standard
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
From the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
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()
practitionerrole-has-polaris-iderrorPractitionerRoleMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-practitionerrole-identifier$'))

This structure is derived from PractitionerRole

Summary

Mandatory: 5 elements(12 nested mandatory elements)
Must-Support: 13 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PractitionerRole.identifier
  • The element 1 is sliced based on the value of PractitionerRole.code.coding
  • The element 1 is sliced based on the value of PractitionerRole.specialty.coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* PractitionerRole Roles/organizations the practitioner is associated with
Constraints: practitionerrole-has-polaris-id
... meta Σ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 0..1 Narrative Narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for identifier SΣ 1..* Identifier identifiers including Polaris ID and EMR user ID
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris PractitionerRole ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... system Σ 1..1 uri Polaris practitionerrole identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris practitioner role ID value: unique in source system
Example General: 123456
.... identifier:rawCode SΣ 0..* Identifier Source EMR user/role identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-raw-code
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
... practitioner SΣ 1..1 Reference(Practitioner) Reference to the practitioner
... organization SΣ 0..1 Reference(Organization) Organization where the role is performed
... code SΣ 0..* CodeableConcept Practitioner role with raw code support
Binding: PractitionerRole (example): The role a person plays representing an organization.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard role code
...... system Σ 1..1 uri Standard terminology system URI
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:rawCode SΣ 0..* Coding Source EMR role code
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-code-raw-code
...... code Σ 1..1 code EMR-specific role code
...... display Σ 1..1 string EMR's display text for this role
... specialty SΣ 0..* CodeableConcept Practitioner specialty with raw code support
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard specialty code
...... system Σ 1..1 uri Standard terminology system URI
...... code Σ 1..1 code Symbol in syntax defined by the system
..... coding:rawCode SΣ 0..* Coding Source EMR specialty code
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-specialty-raw-code
...... code Σ 1..1 code EMR-specific specialty code
...... display Σ 1..1 string EMR's display text for this specialty
... location Σ 0..* Reference(Location) Location(s) where the practitioner provides care

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PractitionerRole.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PractitionerRole.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PractitionerRole.codeexamplePractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
From the FHIR Standard
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
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()
practitionerrole-has-polaris-iderrorPractitionerRoleMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-practitionerrole-identifier$'))

Differential View

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* PractitionerRole Roles/organizations the practitioner is associated with
Constraints: practitionerrole-has-polaris-id
... meta
.... source S 0..1 uri Identifies EMR instance & pipeline version the resource came from
... text S 0..1 Narrative Narrative
... Slices for identifier S 1..* Identifier identifiers including Polaris ID and EMR user ID
Slice: Unordered, Open by pattern:system
.... identifier:polarisId S 1..1 Identifier Polaris PractitionerRole ID
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 1..1 uri Polaris practitionerrole identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-identifier
..... value 1..1 string The actual Polaris practitioner role ID value: unique in source system
.... identifier:rawCode S 0..* Identifier Source EMR user/role identifier
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-raw-code
..... value 1..1 string The value that is unique
... organization S 0..1 Reference(Organization) Organization where the role is performed
... code S 0..* CodeableConcept Practitioner role with raw code support
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard S 0..* Coding Standard role code
...... system 1..1 uri Standard terminology system URI
...... code 1..1 code Symbol in syntax defined by the system
..... coding:rawCode S 0..* Coding Source EMR role code
...... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-code-raw-code
...... code 1..1 code EMR-specific role code
...... display 1..1 string EMR's display text for this role
... specialty S 0..* CodeableConcept Practitioner specialty with raw code support
.... Slices for coding 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard S 0..* Coding Standard specialty code
...... system 1..1 uri Standard terminology system URI
...... code 1..1 code Symbol in syntax defined by the system
..... coding:rawCode S 0..* Coding Source EMR specialty code
...... system 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-specialty-raw-code
...... code 1..1 code EMR-specific specialty code
...... display 1..1 string EMR's display text for this specialty
... location 0..* Reference(Location) Location(s) where the practitioner provides care

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
practitionerrole-has-polaris-iderrorPractitionerRoleMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-practitionerrole-identifier$'))

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PractitionerRole C 0..* PractitionerRole Roles/organizations the practitioner is associated with
Constraints: practitionerrole-has-polaris-id
... id Σ 0..1 id Logical id of this artifact
... 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 Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 0..1 Narrative Narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier identifiers including Polaris ID and EMR user ID
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris PractitionerRole ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri Polaris practitionerrole identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris practitioner role ID value: unique in source system
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:rawCode SΣ 0..* Identifier Source EMR user/role identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-raw-code
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
... practitioner SΣ 1..1 Reference(Practitioner) Reference to the practitioner
... organization SΣ 0..1 Reference(Organization) Organization where the role is performed
... code SΣ 0..* CodeableConcept Practitioner role with raw code support
Binding: PractitionerRole (example): The role a person plays representing an 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
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard role code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Standard terminology system URI
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:rawCode SΣ 0..* Coding Source EMR role code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-code-raw-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code EMR-specific role code
...... display Σ 1..1 string EMR's display text for this role
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... specialty SΣ 0..* CodeableConcept Practitioner specialty with raw code support
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 0..* Coding Code defined by a terminology system
Slice: Unordered, Open by pattern:system
..... coding:standard SΣ 0..* Coding Standard specialty code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Standard terminology system URI
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:rawCode SΣ 0..* Coding Source EMR specialty code
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-practitionerrole-specialty-raw-code
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 1..1 code EMR-specific specialty code
...... display Σ 1..1 string EMR's display text for this specialty
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... location Σ 0..* Reference(Location) Location(s) where the practitioner provides care
... healthcareService 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom Σ 0..* ContactPoint Contact details that are specific to the role/location/service
... availableTime 0..* BackboneElement Times the Service Site is available
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
.... allDay 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable 0..* BackboneElement Not available during this time due to provided reason
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date
... availabilityExceptions 0..1 string Description of availability exceptions
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PractitionerRole.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
PractitionerRole.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
PractitionerRole.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PractitionerRole.identifier:polarisId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PractitionerRole.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
PractitionerRole.identifier:rawCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
PractitionerRole.codeexamplePractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
From the FHIR Standard
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
From the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf 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-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
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()
practitionerrole-has-polaris-iderrorPractitionerRoleMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-practitionerrole-identifier$'))

This structure is derived from PractitionerRole

Summary

Mandatory: 5 elements(12 nested mandatory elements)
Must-Support: 13 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PractitionerRole.identifier
  • The element 1 is sliced based on the value of PractitionerRole.code.coding
  • The element 1 is sliced based on the value of PractitionerRole.specialty.coding

 

Other representations of profile: CSV, Excel, Schematron