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 Roster Panel Core

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

Represents a roster panel for patient-provider attachment tracking, derived from the Group resource. Uses identifier-based references for managing entity and members. Allows provider/facility links via Polaris OR external IDs. Supports CPAR roster panel requirements and other roster management use cases.

Polaris Core RosterPanel Profile

Overview

The Polaris Core RosterPanel profile represents patient roster panels within primary care EMR systems. Based on the FHIR Group resource, this profile manages patient-provider attachment relationships, supporting panel-based care models and roster management across the Polaris ecosystem.

Key Features

  • Panel Management: Tracks patients assigned to specific providers or care teams
  • Organization Attribution: Links panels to managing organizations
  • Provider Assignment: Supports multiple primary providers per panel
  • Facility Association: Tracks facilities where panel care is delivered
  • CPAR Integration: Supports Canadian Primary care Assessment and Reporting requirements

Clinical Purpose

Roster panels enable:

  • Patient-provider attachment tracking
  • Panel-based care delivery
  • Population health management
  • Continuity of care documentation
  • Provider coverage arrangements
  • Care team coordination

Panel Components

Essential elements include:

  • Panel Identifier: Unique panel number or code
  • Managing Organization: Clinic or practice responsible for panel
  • Primary Providers: Healthcare providers assigned to panel
  • Panel Members: List of patients in the panel
  • Panel Facilities: Locations where care is provided

CPAR-Specific Features

For CPAR implementations, additional capabilities include:

  • Automated submission flags
  • Submission window controls
  • Panel confirmation dates
  • Provider and facility extensions
  • Provincial panel number tracking

Workflow Support

The profile enables:

  • Patient enrollment and disenrollment
  • Provider panel transfers
  • Coverage arrangements
  • Panel size management
  • Patient attachment reporting
  • Care continuity tracking

Data Quality

Supports tracking of:

  • Panel confirmation dates
  • Active vs inactive patients
  • Provider-patient relationships
  • Panel size metrics
  • Attachment status

Relationships

RosterPanel connects to:

  • Patient: Members of the panel
  • Organization: Managing entity
  • Practitioner: Primary providers (via extensions)
  • Location: Panel facilities (via extensions)

Future Considerations

Potential enhancements being evaluated:

  • Care team member roles
  • Panel capacity limits
  • Patient complexity scoring
  • Panel performance metrics
  • Attachment priority levels
  • Virtual panel support

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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
.. Group C 0..* Group Polaris Roster Panel Core
Constraints: grp-1, rosterpanel-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
.... extension:automatedSubmissionFlag S 0..1 boolean Automated Submission Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension
.... extension:submitNextWindowFlag S 0..1 boolean Submit During Next Window Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension
.... extension:primaryProvider S 1..* Reference(Polaris PractitionerRole Core) Primary Provider Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension
.... extension:panelFacility S 0..* Reference(Polaris Location Core | Polaris Organization Core) Panel Facility Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Business identifier(s) for rosterpanel
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris RosterPanel 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 rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris rosterpanel ID value: unique in source system
Example General: 123456
.... identifier:rawCode SΣ 0..* Identifier Source EMR rosterpanel 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>-rosterpanel-raw-code
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
... type Σ 1..1 code Group of people
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person
... actual ΣC 1..1 boolean Actual membership group
Fixed Value: true
... name Σ 0..1 string Panel name or description
... managingEntity SΣ 1..1 Reference(Polaris Organization Core) Organization responsible for panel
... member SC 0..* BackboneElement Patients in this panel
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:confirmationDate S 0..1 date Panel Confirmation Date
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(Polaris Patient Core) Reference to panel patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Group.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA 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()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
rosterpanel-has-polaris-iderrorGroupMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-rosterpanel-identifier$'))

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Polaris Roster Panel Core
Constraints: rosterpanel-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 extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:automatedSubmissionFlag S 0..1 boolean Automated Submission Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension
.... extension:submitNextWindowFlag S 0..1 boolean Submit During Next Window Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension
.... extension:primaryProvider S 1..* Reference(Polaris PractitionerRole Core) Primary Provider Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension
.... extension:panelFacility S 0..* Reference(Polaris Location Core | Polaris Organization Core) Panel Facility Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension
.... identifier:polarisId S 1..1 Identifier Polaris RosterPanel ID
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 1..1 uri Polaris rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier
..... value 1..1 string The actual Polaris rosterpanel ID value: unique in source system
.... identifier:rawCode S 0..* Identifier Source EMR rosterpanel 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>-rosterpanel-raw-code
..... value 1..1 string The value that is unique
... type 1..1 code Group of people
Fixed Value: person
... actual 1..1 boolean Actual membership group
Fixed Value: true
... name 0..1 string Panel name or description
... managingEntity S 1..1 Reference(Polaris Organization Core) Organization responsible for panel
... member S 0..* BackboneElement Patients in this panel
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:confirmationDate S 0..1 date Panel Confirmation Date
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension
.... entity S 1..1 Reference(Polaris Patient Core) Reference to panel patient

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
rosterpanel-has-polaris-iderrorGroupMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-rosterpanel-identifier$'))
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Polaris Roster Panel Core
Constraints: grp-1, rosterpanel-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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:automatedSubmissionFlag S 0..1 boolean Automated Submission Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension
.... extension:submitNextWindowFlag S 0..1 boolean Submit During Next Window Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension
.... extension:primaryProvider S 1..* Reference(Polaris PractitionerRole Core) Primary Provider Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension
.... extension:panelFacility S 0..* Reference(Polaris Location Core | Polaris Organization Core) Panel Facility Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Business identifier(s) for rosterpanel
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris RosterPanel 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 rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris rosterpanel 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 rosterpanel 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>-rosterpanel-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 group's record is in active use
... type Σ 1..1 code Group of people
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person
... actual ΣC 1..1 boolean Actual membership group
Fixed Value: true
... code Σ 0..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name Σ 0..1 string Panel name or description
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity SΣ 1..1 Reference(Polaris Organization Core) Organization responsible for panel
... characteristic 0..* BackboneElement Include / Exclude group members by Trait
.... 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
.... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
.... value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
.... exclude 1..1 boolean Group includes or excludes
.... period 0..1 Period Period over which characteristic is tested
... member SC 0..* BackboneElement Patients in this panel
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:confirmationDate S 0..1 date Panel Confirmation Date
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(Polaris Patient Core) Reference to panel patient
.... period 0..1 Period Period member belonged to the group
.... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Group.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Group.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Group.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Group.identifier:polarisId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Group.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Group.identifier:rawCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
From the FHIR Standard
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA 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()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
rosterpanel-has-polaris-iderrorGroupMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-rosterpanel-identifier$'))

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Polaris Roster Panel Core
Constraints: grp-1, rosterpanel-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
.... extension:automatedSubmissionFlag S 0..1 boolean Automated Submission Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension
.... extension:submitNextWindowFlag S 0..1 boolean Submit During Next Window Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension
.... extension:primaryProvider S 1..* Reference(Polaris PractitionerRole Core) Primary Provider Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension
.... extension:panelFacility S 0..* Reference(Polaris Location Core | Polaris Organization Core) Panel Facility Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Business identifier(s) for rosterpanel
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris RosterPanel 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 rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris rosterpanel ID value: unique in source system
Example General: 123456
.... identifier:rawCode SΣ 0..* Identifier Source EMR rosterpanel 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>-rosterpanel-raw-code
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
... type Σ 1..1 code Group of people
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person
... actual ΣC 1..1 boolean Actual membership group
Fixed Value: true
... name Σ 0..1 string Panel name or description
... managingEntity SΣ 1..1 Reference(Polaris Organization Core) Organization responsible for panel
... member SC 0..* BackboneElement Patients in this panel
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:confirmationDate S 0..1 date Panel Confirmation Date
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(Polaris Patient Core) Reference to panel patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Group.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA 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()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
rosterpanel-has-polaris-iderrorGroupMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-rosterpanel-identifier$'))

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Polaris Roster Panel Core
Constraints: rosterpanel-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 extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:automatedSubmissionFlag S 0..1 boolean Automated Submission Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension
.... extension:submitNextWindowFlag S 0..1 boolean Submit During Next Window Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension
.... extension:primaryProvider S 1..* Reference(Polaris PractitionerRole Core) Primary Provider Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension
.... extension:panelFacility S 0..* Reference(Polaris Location Core | Polaris Organization Core) Panel Facility Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension
.... identifier:polarisId S 1..1 Identifier Polaris RosterPanel ID
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 1..1 uri Polaris rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier
..... value 1..1 string The actual Polaris rosterpanel ID value: unique in source system
.... identifier:rawCode S 0..* Identifier Source EMR rosterpanel 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>-rosterpanel-raw-code
..... value 1..1 string The value that is unique
... type 1..1 code Group of people
Fixed Value: person
... actual 1..1 boolean Actual membership group
Fixed Value: true
... name 0..1 string Panel name or description
... managingEntity S 1..1 Reference(Polaris Organization Core) Organization responsible for panel
... member S 0..* BackboneElement Patients in this panel
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:confirmationDate S 0..1 date Panel Confirmation Date
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension
.... entity S 1..1 Reference(Polaris Patient Core) Reference to panel patient

doco Documentation for this format

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Polaris Roster Panel Core
Constraints: grp-1, rosterpanel-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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:automatedSubmissionFlag S 0..1 boolean Automated Submission Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension
.... extension:submitNextWindowFlag S 0..1 boolean Submit During Next Window Flag
URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension
.... extension:primaryProvider S 1..* Reference(Polaris PractitionerRole Core) Primary Provider Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension
.... extension:panelFacility S 0..* Reference(Polaris Location Core | Polaris Organization Core) Panel Facility Reference
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Business identifier(s) for rosterpanel
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris RosterPanel 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 rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The actual Polaris rosterpanel 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 rosterpanel 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>-rosterpanel-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 group's record is in active use
... type Σ 1..1 code Group of people
Binding: GroupType (required): Types of resources that are part of group.
Fixed Value: person
... actual ΣC 1..1 boolean Actual membership group
Fixed Value: true
... code Σ 0..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name Σ 0..1 string Panel name or description
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity SΣ 1..1 Reference(Polaris Organization Core) Organization responsible for panel
... characteristic 0..* BackboneElement Include / Exclude group members by Trait
.... 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
.... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
.... value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
..... valueCodeableConcept CodeableConcept
..... valueBoolean boolean
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(Any)
.... exclude 1..1 boolean Group includes or excludes
.... period 0..1 Period Period over which characteristic is tested
... member SC 0..* BackboneElement Patients in this panel
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:confirmationDate S 0..1 date Panel Confirmation Date
URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity S 1..1 Reference(Polaris Patient Core) Reference to panel patient
.... period 0..1 Period Period member belonged to the group
.... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Group.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Group.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Group.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Group.identifier:polarisId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Group.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Group.identifier:rawCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Group.typerequiredFixed Value: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
From the FHIR Standard
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA 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()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
rosterpanel-has-polaris-iderrorGroupMust have at least one identifier with a canonical Polaris system URI
: identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-rosterpanel-identifier$'))

 

Other representations of profile: CSV, Excel, Schematron