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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These define constraints on FHIR resources for systems conforming to this implementation guide.
| Polaris AllergyIntolerance Profile Core |
Defines the Polaris standard for AllergyIntolerance resources, based on CA-Core+. Includes instance-specific Polaris identifiers, references via identifier (CII E01). |
| Polaris App Consent Profile Core |
Simple app consent profile: Patient X consented/refused to share information with Application Y (represented as a Device). This profile models consent for a patient to sign up with an app. |
| Polaris App Device Core |
Simple profile for applications that integrate with patient data and require consent tracking. Contains just the essential information: app name, client_id, and basic details. |
| Polaris App State Core |
A profile for representing external application state in Polaris. |
| Polaris Appointment (Minimal) Core |
Minimal Polaris profile for Appointment resources, primarily for mapping status, start date (Last Visit Date), and required patient/practitioner participants. Assumes filtering for status='fulfilled' happens during data retrieval/processing. Contains embedded aliases and invariants. |
| Polaris Clinical Document Bundle Core |
A FHIR Bundle representing a complete clinical document with embedded sections and recursive containment capabilities |
| Polaris Clinical Document Composition Core |
A FHIR Composition supporting four section types (Text, Form, Canvas, File) with recursive containment |
| Polaris Clinical Task Core |
A clinical task for healthcare workflow management combining Polaris design principles with MERT standard compatibility |
| Polaris ClinicalImpression Profile Core |
Polaris profile for ClinicalImpression capturing the Assessment section of a SOAP encounter note. Purpose: export assessment text. Should be exported by EMRs that have the ability to parse the 'A' text out of a SOAP note. |
| Polaris Condition Core |
Polaris profile for Condition resource, representing health concerns (CII E11) or clinical assessments (CII E34). Constrains necessary elements, requires a Polaris identifier, and adds support for required extensions and security labels. |
| Polaris Contained Medication Core |
DEPRECATED: Use medicationCodeableConcept in MedicationRequest instead. |
| Polaris DiagnosticReport Profile Core |
Defines the Polaris FHIR profile for DiagnosticReport resources, based on CA-Core constraints, for aggregating diagnostic reports (e.g., Lab, Imaging) from multiple EMRs. |
| Polaris DocumentReference Profile Core |
Polaris profile for managing clinical document references and their content. This profile provides a standardized approach for document exchange between EMR systems, supporting inline document storage, comprehensive metadata, and clinical context preservation. Aligned with CA-Core+ standards and CII requirements for Canadian healthcare. Key features:
|
| Polaris EMR Device Core |
Represents an EMR software application/product, capturing key details like manufacturer, product name/model, type, version, and the owning organization using standard Polaris references. Uses a non-instance-specific identifier for the Device itself. |
| Polaris Encounter Profile Core |
Defines the Encounter resource constraints for the Polaris project (CII), conforming to CA-Core+ requirements. |
| Polaris Immunization Profile Core |
Polaris profile for Immunization resources, aligned with CA-Core+ and CII requirements. Records details about vaccines administered to a patient. |
| Polaris Invoice Core |
Polaris profile for Invoice representing Canadian provider-side billing records. Aligned with Oscar Pro's existing |
| Polaris Location Core |
Generic Polaris core profile for Location, represents an EMR 'location' or 'site' – basically whatever the EMR uses to break the EMR up into separate slices (often for multisite clinics using the same EMR instance) For single-site clinics, at least one Location object must exist that represents the main site: this makes downstream consumers of the FHIR data easier to write as they can always assume Locations exist. Also, note that PolarisAppointment REQUIRES a Location as a participant. |
| Polaris Medication Dispense Core |
Polaris profile for MedicationDispense resources, primarily for recording dispense events. Aligns with CII N1/N2 requirements and Polaris standards. |
| Polaris MedicationRequest Profile Core |
Defines the Polaris FHIR profile for MedicationRequest resources, based on CA-Core constraints, for aggregating prescription data from multiple EMRs. |
| Polaris Observation Profile Core |
Polaris profile for the Observation resource, based on CA-Core. Represents measurements, tests, and simple assertions originating from source EMRs for aggregation. |
| Polaris Organization Core |
Generic Polaris core profile for Organization, based on CA Core+. Designed to support a broad range of integration needs. |
| Polaris Patient Core |
Generic Polaris core profile for patient demographic and administrative information, based on CA Core+. Designed to support a broad range of integration needs. |
| Polaris Practitioner Core |
Represents a human that practices medicine. May work at multiple organizations, represented by a PractitionerRole. If you want to reference an EMR user, use PractitionerRole. |
| Polaris PractitionerRole Core |
Represents an EMR user. Focuses on linking a Practitioner to Organizations and Locations via Polaris identifiers. |
| Polaris Procedure Profile Core |
Defines the Polaris FHIR profile for Procedure resources, based on CA-Core Procedure constraints, for aggregating data from multiple EMRs. |
| Polaris Roster Panel Core |
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 Schedule (Minimal) Core |
Minimal Polaris profile for Schedule resources, representing a clinic or provider's bookable calendar. Slots reference back to a Schedule via Slot.schedule. Phase 1 sources OscarPro provider templates (one Schedule per provider) but the profile supports room/equipment (Location) and service-line (HealthcareService) schedules as well. |
| Polaris ServiceRequest Profile Core |
Defines the Polaris FHIR profile for ServiceRequest resources, based on CA-Core ServiceRequest constraints, for aggregating order/referral data from multiple EMRs. |
| Polaris Slot (Minimal) Core |
Minimal Polaris profile for Slot resources — an individual bookable time window owned by a Schedule. Slots are materialised from recurring templates (Phase 1: OscarPro |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| App State Boolean Value Extension Core |
A simple extension to hold the value of a Polaris application-state entry as a boolean. |
||||||||||
| App State String Value Extension Core |
A simple extension to hold the value of a Polaris application-state entry as a string. |
||||||||||
| Automated Submission Flag Extension |
Indicates if the panel submission is automated. |
||||||||||
| Invoice Service Location Extension |
Reference to the PolarisCoreLocation where the billed service was delivered. Resolves Oscar's billing_on_cheader1.location (Service Location Indicator) to a typed Location resource. The SLI code is carried on Location.identifier[sliCode]. |
||||||||||
| Oscar Billing Status Extension |
|
||||||||||
| Panel Confirmation Date Extension |
Records the date when the panel was confirmed or validated. |
||||||||||
| Panel Facilities Extension |
Captures the facility(ies) associated with the panel. Links via identifier. |
||||||||||
| Polaris Canvas Annotation Extension |
Supports drawings, signatures, positioned elements, and embedded complete sections at specific coordinates on canvas |
||||||||||
| Polaris Canvas Metadata Extension |
Canvas dimensions, coordinate system, PDF page mapping |
||||||||||
| Polaris Embedded Section Answer Extension |
Allows questionnaire answer options to contain complete embedded sections |
||||||||||
| Polaris Embedded Section Extension |
Embeds complete Polaris sections (Text/Form/Canvas/File) within text content as actual nested content |
||||||||||
| Polaris Embedded Section Response Extension |
Contains complete sections as questionnaire response values |
||||||||||
| Polaris File Metadata Extension |
Additional metadata for file attachments including display hints and embedded sections |
||||||||||
| Polaris Markdown Content Extension |
Provides Markdown representation of text content for systems supporting markdown rendering |
||||||||||
| Polaris Medication Strength Extension |
Extension to capture medication strength information when using medicationCodeableConcept |
||||||||||
| Primary Providers Extension |
Captures the primary provider(s) associated with the panel. Links via identifier. |
||||||||||
| Shadow Bill Extension |
True when the Invoice represents a shadow bill (capitated FHO/FHN submission) rather than a regular FFS claim. Derived from Oscar billing status |
||||||||||
| Submit During Next Window Flag Extension |
Indicates if the panel should be submitted during the next available window. |
These define sets of codes used by systems conforming to this implementation guide.
| Canadian Provincial Health Number Systems |
Naming systems for provincial and territorial health numbers across Canada, based on Infoway standards |
| Oscar Billing Status Value Set |
The 10 raw Oscar Pro billing_on_cheader1.status codes. |
| Oscar Pay Program Value Set |
Known Oscar Pro pay_program values verified from backend source (BillingONCHeader1.java + BillingONCHeader1Controller.java + BillingONCHeader1Repository.java). Extensible binding — additional values may exist. |
| Polaris Attachment Section Codes Core |
LOINC codes for file attachment sections |
| Polaris Canvas Annotation Types |
Types of annotations that can be placed on canvas sections |
| Polaris Coordinate Systems |
Coordinate systems for canvas positioning |
| Polaris Embedded Section Types |
Types of sections that can be embedded within other sections |
| Polaris File Categories |
Categories for file attachments to aid in processing and display |
| Polaris Form Section Codes Core |
LOINC codes for form-based sections |
These define new code systems used by systems conforming to this implementation guide.
| Canadian Provincial Health Number Systems CodeSystem |
URIs for provincial and territorial health number naming systems across Canada |
| Oscar Billing Status Code System |
Raw Oscar Pro billing_on_cheader1.status codes (the BillingStatus Java enum at ca.kai.billing.header.BillingONCHeader1). |
| Oscar Pay Program Code System |
Oscar Pro pay_program code values. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| Alberta Diabetes Research Portal |
Clinical research platform - MORE INFO REQUESTED by Avery |
| Anemia Consultation Document |
Example document reference for anemia consultation note from April 8, 2025 |
| Anemia Diagnostic Report |
Example diagnostic report for anemia workup from April 8, 2025 |
| Appointment With Slot Linkage |
Example Appointment booked from a free Slot — demonstrates the new Appointment.slot reference wired in 1.10.0 |
| Avery Anemia Condition |
Example condition record for patient Avery Linwood's anemia diagnosis |
| Avery April 8 Encounter |
Example patient encounter for Avery Linwood's visit on April 8, 2025 |
| Avery Diastolic Blood Pressure |
Example diastolic blood pressure observation for Avery Linwood |
| Avery Height Observation |
Example height measurement observation for Avery Linwood |
| Avery Linwood Patient |
Example patient record demonstrating Polaris patient profile |
| Avery Systolic Blood Pressure |
Example systolic blood pressure observation for Avery Linwood |
| Avery TDAP Immunization |
Example immunization record for TDAP vaccine given to Avery Linwood |
| Busy Slot Example |
Example PolarisCoreSlot in 'busy' state, referenced by a booked Appointment |
| Busy-Tentative Slot Example |
Example PolarisCoreSlot in 'busy-tentative' state, demonstrating the hold-flow status that only the booking system writes |
| Cedarbrook Clinic Organization |
Example healthcare organization demonstrating Polaris organization profile |
| Cedarbrook Clinic Site A |
Example healthcare facility location for Cedarbrook Clinic |
| Cedarbrook Juno EMR Device |
Example EMR device record for Cedarbrook Clinic's Juno system |
| Detailed MedicationRequest Example |
Example medication request demonstrating Polaris profile with detailed information |
| Dr. Emil Navarro |
Example practitioner record demonstrating Polaris practitioner profile |
| Dr. Navarro Bookable Schedule |
Example PolarisCoreSchedule for Dr. Navarro at Cedarbrook Site A, 90-day planning horizon |
| Dr. Navarro Family Medicine Role |
Example practitioner role linking Dr. Navarro to family medicine practice |
| Free Slot Example |
Example PolarisCoreSlot in 'free' state, demonstrating a 15-minute bookable window |
| Hemoglobin Lab Request |
Example service request for hemoglobin laboratory test |
| Hemoglobin Lab Result |
Example hemoglobin laboratory result observation |
| Iron Sample Medication Dispense |
Example medication dispense for iron supplement sample given to Avery Linwood |
| Iron Therapy Procedure |
Example procedure record for iron therapy prescribed to Avery Linwood |
| Polaris AllergyIntolerance Example |
Example allergy intolerance record demonstrating Polaris profile |
| Polaris App Consent - DENIED Example |
FHIR R4 consent deny pattern - patient declined WellnessTracker Pro (3:45 PM) |
| Polaris App Consent - GRANTED Example |
FHIR R4 consent grant pattern - patient consented to SmartDocs AI Scribe (10:30 AM) |
| Polaris App Consent - PROPOSED Example |
FHIR R4 consent request pattern - more info needed for research study (2:15 PM) |
| Polaris AppState Example |
Example application state record demonstrating Polaris AppState profile |
| Polaris Appointment Example |
Example appointment with requested period demonstrating Polaris profile |
| Polaris Invoice Example |
Example OHIP billing invoice with 2 line items (A007 general assessment + K030 chronic care premium) demonstrating oscarBillingStatus, shadowBill, and payProgram extensions |
| Roster Panel Example |
Example roster panel group demonstrating Polaris roster panel profile used in CPAR implementations |
| SmartDocs AI Scribe App |
AI clinical documentation app - CONSENT GRANTED by Avery |
| Walk-in Appointment Example |
Example Appointment created without a Slot reference, demonstrating the 0..* cardinality on Appointment.slot for historical and walk-in cases |
| WellnessTracker Pro App |
Personal wellness monitoring app - CONSENT DENIED by Avery |
| avery-clinicalimpression-20250408 |
Assessment: Patient presents with acute symptomatic anemia (hemoglobin 68 g/L) following new-onset dizziness and fatigue. Iron therapy prescribed (ferrous sulfate 325 mg daily) and follow-up assessment scheduled in two weeks. |
| john-smith-alberta | |
| polaris-core-clinical-task-ai-triage-001 |
Patient message about blood pressure concerns requires triage assessment with AI assistance. Message: 'I've been checking my BP at home and it's been running 150/90. Should I be concerned?' |
| polaris-core-clinical-task-completed-001 |
Provide diabetes education follow-up for Jennifer Martinez. Review blood glucose logs, insulin adjustment, and dietary counseling. Patient newly diagnosed with Type 2 diabetes. |
| polaris-core-clinical-task-lab-review-001 |
Review CBC results for John Doe - flagged values need clinical assessment. Hemoglobin 8.2 g/dL (low), requires evaluation for anemia workup. |
| polaris-core-clinical-task-nursing-pool-001 |
Complete medication reconciliation for David Chen following hospital discharge. Patient returned from Calgary General Hospital after pneumonia treatment. Reconcile discharge medications with home medications. |
| polaris-core-clinical-task-referral-001 |
Process cardiology referral for Alice Johnson - chest pain evaluation. Patient reports intermittent chest discomfort with exertion. ECG shows possible T-wave abnormalities in leads V4-V6. |