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
| 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.
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.
Roster panels enable:
Essential elements include:
For CPAR implementations, additional capabilities include:
The profile enables:
Supports tracking of:
RosterPanel connects to:
Potential enhancements being evaluated:
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Group | Polaris Roster Panel Core Constraints: grp-1, rosterpanel-has-polaris-id |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | boolean | Automated Submission Flag URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension |
![]() ![]() ![]() |
S | 0..1 | boolean | Submit During Next Window Flag URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension |
![]() ![]() ![]() |
S | 1..* | Reference(Polaris PractitionerRole Core) | Primary Provider Reference URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension |
![]() ![]() ![]() |
S | 0..* | Reference(Polaris Location Core | Polaris Organization Core) | Panel Facility Reference URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for rosterpanel Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris RosterPanel ID |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris rosterpanel ID value: unique in source system Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR rosterpanel identifier |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
Σ | 1..1 | code | Group of people Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
![]() ![]() |
ΣC | 1..1 | boolean | Actual membership group Fixed Value: true |
![]() ![]() |
Σ | 0..1 | string | Panel name or description |
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Organization Core) | Organization responsible for panel |
![]() ![]() |
SC | 0..* | BackboneElement | Patients in this panel |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | date | Panel Confirmation Date URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | Reference to panel patient |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Group.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Group.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Group | 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 | Group | 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 | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Group | 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() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) | |
| rosterpanel-has-polaris-id | error | Group | Must 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Group | Polaris Roster Panel Core Constraints: rosterpanel-has-polaris-id |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
S | 0..1 | Narrative | Narrative |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | boolean | Automated Submission Flag URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension |
![]() ![]() ![]() |
S | 0..1 | boolean | Submit During Next Window Flag URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension |
![]() ![]() ![]() |
S | 1..* | Reference(Polaris PractitionerRole Core) | Primary Provider Reference URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension |
![]() ![]() ![]() |
S | 0..* | Reference(Polaris Location Core | Polaris Organization Core) | Panel Facility Reference URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension |
![]() ![]() |
S | 1..* | Identifier | Business identifier(s) for rosterpanel Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
S | 1..1 | Identifier | Polaris RosterPanel ID |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() |
1..1 | uri | Polaris rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier | |
![]() ![]() ![]() ![]() |
1..1 | string | The actual Polaris rosterpanel ID value: unique in source system | |
![]() ![]() ![]() |
S | 0..* | Identifier | Source EMR rosterpanel identifier |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: secondary | |
![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-raw-code | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
1..1 | code | Group of people Fixed Value: person | |
![]() ![]() |
1..1 | boolean | Actual membership group Fixed Value: true | |
![]() ![]() |
0..1 | string | Panel name or description | |
![]() ![]() |
S | 1..1 | Reference(Polaris Organization Core) | Organization responsible for panel |
![]() ![]() |
S | 0..* | BackboneElement | Patients in this panel |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | date | Panel Confirmation Date URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension |
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | Reference to panel patient |
Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| rosterpanel-has-polaris-id | error | Group | Must 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$')) |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Group | Polaris Roster Panel Core Constraints: grp-1, rosterpanel-has-polaris-id | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | boolean | Automated Submission Flag URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | Submit During Next Window Flag URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension | ||||
![]() ![]() ![]() |
S | 1..* | Reference(Polaris PractitionerRole Core) | Primary Provider Reference URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension | ||||
![]() ![]() ![]() |
S | 0..* | Reference(Polaris Location Core | Polaris Organization Core) | Panel Facility Reference URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for rosterpanel Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris RosterPanel ID | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris rosterpanel ID value: unique in source system Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR rosterpanel identifier | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
![]() ![]() |
Σ | 1..1 | code | Group of people Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person | ||||
![]() ![]() |
ΣC | 1..1 | boolean | Actual membership group Fixed Value: true | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
![]() ![]() |
Σ | 0..1 | string | Panel name or description | ||||
![]() ![]() |
Σ | 0..1 | unsignedInt | Number of members | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Organization Core) | Organization responsible for panel | ||||
![]() ![]() |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
![]() ![]() ![]() |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() |
1..1 | boolean | Group includes or excludes | |||||
![]() ![]() ![]() |
0..1 | Period | Period over which characteristic is tested | |||||
![]() ![]() |
SC | 0..* | BackboneElement | Patients in this panel | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | date | Panel Confirmation Date URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | Reference to panel patient | ||||
![]() ![]() ![]() |
0..1 | Period | Period member belonged to the group | |||||
![]() ![]() ![]() |
0..1 | boolean | If member is no longer in group | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Group.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Group.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Group.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Group.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Group.identifier:polarisId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Group.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Group.identifier:rawCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1From the FHIR Standard | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Group | 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 | Group | 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 | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Group | 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() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) | |
| rosterpanel-has-polaris-id | error | Group | Must 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
Summary
Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 13 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Group | Polaris Roster Panel Core Constraints: grp-1, rosterpanel-has-polaris-id |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | boolean | Automated Submission Flag URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension |
![]() ![]() ![]() |
S | 0..1 | boolean | Submit During Next Window Flag URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension |
![]() ![]() ![]() |
S | 1..* | Reference(Polaris PractitionerRole Core) | Primary Provider Reference URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension |
![]() ![]() ![]() |
S | 0..* | Reference(Polaris Location Core | Polaris Organization Core) | Panel Facility Reference URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for rosterpanel Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris RosterPanel ID |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris rosterpanel ID value: unique in source system Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR rosterpanel identifier |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary |
![]() ![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
Σ | 1..1 | code | Group of people Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person |
![]() ![]() |
ΣC | 1..1 | boolean | Actual membership group Fixed Value: true |
![]() ![]() |
Σ | 0..1 | string | Panel name or description |
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Organization Core) | Organization responsible for panel |
![]() ![]() |
SC | 0..* | BackboneElement | Patients in this panel |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | date | Panel Confirmation Date URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | Reference to panel patient |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Group.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Group.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Group | 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 | Group | 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 | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Group | 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() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) | |
| rosterpanel-has-polaris-id | error | Group | Must 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Group | Polaris Roster Panel Core Constraints: rosterpanel-has-polaris-id |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
S | 0..1 | Narrative | Narrative |
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | boolean | Automated Submission Flag URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension |
![]() ![]() ![]() |
S | 0..1 | boolean | Submit During Next Window Flag URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension |
![]() ![]() ![]() |
S | 1..* | Reference(Polaris PractitionerRole Core) | Primary Provider Reference URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension |
![]() ![]() ![]() |
S | 0..* | Reference(Polaris Location Core | Polaris Organization Core) | Panel Facility Reference URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension |
![]() ![]() |
S | 1..* | Identifier | Business identifier(s) for rosterpanel Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
S | 1..1 | Identifier | Polaris RosterPanel ID |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() |
1..1 | uri | Polaris rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier | |
![]() ![]() ![]() ![]() |
1..1 | string | The actual Polaris rosterpanel ID value: unique in source system | |
![]() ![]() ![]() |
S | 0..* | Identifier | Source EMR rosterpanel identifier |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: secondary | |
![]() ![]() ![]() ![]() |
1..1 | uri | Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-raw-code | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
1..1 | code | Group of people Fixed Value: person | |
![]() ![]() |
1..1 | boolean | Actual membership group Fixed Value: true | |
![]() ![]() |
0..1 | string | Panel name or description | |
![]() ![]() |
S | 1..1 | Reference(Polaris Organization Core) | Organization responsible for panel |
![]() ![]() |
S | 0..* | BackboneElement | Patients in this panel |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..1 | date | Panel Confirmation Date URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension |
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | Reference to panel patient |
Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| rosterpanel-has-polaris-id | error | Group | Must 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Group | Polaris Roster Panel Core Constraints: grp-1, rosterpanel-has-polaris-id | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
SΣ | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
S | 0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | boolean | Automated Submission Flag URL: https://fhir.apps.health/StructureDefinition/cpar-automated-submission-extension | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | Submit During Next Window Flag URL: https://fhir.apps.health/StructureDefinition/cpar-submit-during-next-window-extension | ||||
![]() ![]() ![]() |
S | 1..* | Reference(Polaris PractitionerRole Core) | Primary Provider Reference URL: https://fhir.apps.health/StructureDefinition/cpar-primary-providers-extension | ||||
![]() ![]() ![]() |
S | 0..* | Reference(Polaris Location Core | Polaris Organization Core) | Panel Facility Reference URL: https://fhir.apps.health/StructureDefinition/cpar-panel-facilities-extension | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Business identifier(s) for rosterpanel Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris RosterPanel ID | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Polaris rosterpanel identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-rosterpanel-identifier Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The actual Polaris rosterpanel ID value: unique in source system Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR rosterpanel identifier | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 0..1 | boolean | Whether this group's record is in active use | ||||
![]() ![]() |
Σ | 1..1 | code | Group of people Binding: GroupType (required): Types of resources that are part of group. Fixed Value: person | ||||
![]() ![]() |
ΣC | 1..1 | boolean | Actual membership group Fixed Value: true | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of Group members Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc. | ||||
![]() ![]() |
Σ | 0..1 | string | Panel name or description | ||||
![]() ![]() |
Σ | 0..1 | unsignedInt | Number of members | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Organization Core) | Organization responsible for panel | ||||
![]() ![]() |
0..* | BackboneElement | Include / Exclude group members by Trait | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of characteristic Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc. | |||||
![]() ![]() ![]() |
1..1 | Value held by characteristic Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc. | ||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() |
1..1 | boolean | Group includes or excludes | |||||
![]() ![]() ![]() |
0..1 | Period | Period over which characteristic is tested | |||||
![]() ![]() |
SC | 0..* | BackboneElement | Patients in this panel | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | date | Panel Confirmation Date URL: https://fhir.apps.health/StructureDefinition/cpar-panel-confirmation-date-extension | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | Reference to panel patient | ||||
![]() ![]() ![]() |
0..1 | Period | Period member belonged to the group | |||||
![]() ![]() ![]() |
0..1 | boolean | If member is no longer in group | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Group.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Group.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Group.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Group.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Group.identifier:polarisId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Group.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Group.identifier:rawCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Group.type | required | Fixed Value: personhttp://hl7.org/fhir/ValueSet/group-type|4.0.1From the FHIR Standard | ||||
| Group.code | example | |||||
| Group.characteristic.code | example | |||||
| Group.characteristic.value[x] | example |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Group | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Group | 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 | Group | 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 | Group | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Group | 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() | |
| grp-1 | error | Group | Can only have members if group is "actual" : member.empty() or (actual = true) | |
| rosterpanel-has-polaris-id | error | Group | Must 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
Summary
Mandatory: 7 elements(2 nested mandatory elements)
Must-Support: 13 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron