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-invoice | Version: 1.10.0 | |||
| Draft as of 2026-05-26 | Computable Name: PolarisCoreInvoice | |||
Polaris profile for Invoice representing Canadian provider-side billing records. Aligned with Oscar Pro's existing InvoiceConverter emission (header on billing_on_cheader1, inline line items on billing_on_item). Phase 1 scope: Ontario OHIP billing via Oscar Pro.
The Polaris Core Invoice profile represents Canadian provider-side billing records — the header and line items a physician submits or records for services provided. Aligned with Oscar Pro's existing InvoiceConverter emission so that source tables (billing_on_cheader1 + billing_on_item) map cleanly to Invoice + inline Invoice.lineItem[].
Invoice per billing_on_cheader1 header, with Invoice.lineItem[] components per billing_on_item row; no separate ChargeItem resourceInvoice.status uses FHIR's required binding (draft|issued|balanced|cancelled|entered-in-error); the 10-code Oscar enum (H|O|P|N|W|B|S|X|D|I) is preserved via the oscarBillingStatus extensionshadowBill boolean extension on Invoice flags FHO/FHN capitated submissions (Oscar status H)payProgram extension carries Oscar's pay_program codelineItem.chargeItemCodeableConcept.coding sliced for OHIP Schedule of Benefits codesDIAGNOSTIC_1/2/3 extensions (Oscar product feature)See the Oscar Billing feature section under Guide → Features for the full field-by-field mapping between billing_on_cheader1 + billing_on_item and this profile (Oscar → FHIR and FHIR → Oscar directions), and the Write-Back Design page for the Jarvis → Oscar round-trip state machine.
ChargeItem resource for per-line cross-resource referencing (needed if adjudication linkage is added)ChargeItemDefinition to expose the OHIP Schedule of Benefits catalog as FHIRCoverage profile for payer-level filtering and eligibilityClaimResponse or custom extensionUsages:
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..* | Invoice | Polaris Invoice Core Constraints: invoice-has-polaris-id |
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 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 |
![]() ![]() |
0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | code | Raw Oscar billing status code URL: https://fhir.apps.health/StructureDefinition/oscar-billing-status-extension Binding: Oscar Billing Status Value Set (required) |
![]() ![]() ![]() |
S | 0..1 | boolean | Shadow bill indicator URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension |
![]() ![]() ![]() |
S | 0..1 | Reference(Polaris Location Core) | Service location reference URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Invoice identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Invoice 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 invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR invoice 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 | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Type of invoice — carries pay_program coding for Canadian billing |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Binding: Oscar Pay Program Value Set (extensible) |
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | The patient who received the services |
![]() ![]() |
SΣ | 0..1 | dateTime | Billing date (maps to billing_on_cheader1.billing_date) |
![]() ![]() |
S | 0..* | BackboneElement | Billing provider and related roles (billing, appointment, assistant, referring) |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | billing | appointment | assistant | referring | etc. |
![]() ![]() ![]() |
1..1 | Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) | Individual who was involved | |
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | Organization issuing the invoice |
![]() ![]() |
S | 1..* | BackboneElement | One line per billing service code |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | positiveInt | Sequence number of line item |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | OHIP fee code (e.g. A007) |
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | OHIP Schedule of Benefits fee code |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Components of total line item price |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. |
![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Service count / quantity (billing_on_item.ser_num) |
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Fee amount (billing_on_item.fee, parsed from String) |
![]() ![]() |
SΣ | 0..1 | Money | Total gross amount (billing_on_cheader1.total) |
![]() ![]() |
S | 0..* | Annotation | Free-text comment (billing_on_cheader1.comment1) |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Invoice.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Invoice.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Invoice.status | required | InvoiceStatushttp://hl7.org/fhir/ValueSet/invoice-status|4.0.1From the FHIR Standard | |
| Invoice.type.coding:payProgram.code | extensible | OscarPayProgramVS(a valid code from Oscar Pay Program Code System)https://fhir.apps.health/ValueSet/oscar-pay-program-vsFrom this IG | |
| Invoice.lineItem.priceComponent.type | required | InvoicePriceComponentTypehttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Invoice | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Invoice | 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 | Invoice | 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 | Invoice | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Invoice | 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() | |
| invoice-has-polaris-id | error | Invoice | Must have at least one identifier whose system matches the Polaris Invoice pattern. : identifier.where(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-invoice-identifier$')).exists() |
This structure is derived from Invoice
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Invoice | Polaris Invoice Core Constraints: invoice-has-polaris-id |
![]() ![]() |
S | 0..1 | id | Logical id of this artifact |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
0..1 | Narrative | Narrative | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | code | Raw Oscar billing status code URL: https://fhir.apps.health/StructureDefinition/oscar-billing-status-extension Binding: Oscar Billing Status Value Set (required) |
![]() ![]() ![]() |
S | 0..1 | boolean | Shadow bill indicator URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension |
![]() ![]() ![]() |
S | 0..1 | Reference(Polaris Location Core) | Service location reference URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension |
![]() ![]() |
S | 1..* | Identifier | Invoice identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
S | 1..1 | Identifier | Polaris Invoice ID |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() |
1..1 | uri | Polaris invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
S | 0..* | Identifier | Source EMR invoice identifier |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: secondary | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
S | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error |
![]() ![]() |
S | 0..1 | CodeableConcept | Type of invoice — carries pay_program coding for Canadian billing |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system Binding: Oscar Pay Program Value Set (extensible) |
![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | The patient who received the services |
![]() ![]() |
S | 0..1 | dateTime | Billing date (maps to billing_on_cheader1.billing_date) |
![]() ![]() |
S | 0..* | BackboneElement | Billing provider and related roles (billing, appointment, assistant, referring) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | billing | appointment | assistant | referring | etc. |
![]() ![]() ![]() |
1..1 | Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) | Individual who was involved | |
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | Organization issuing the invoice |
![]() ![]() |
S | 1..* | BackboneElement | One line per billing service code |
![]() ![]() ![]() |
S | 1..1 | positiveInt | Sequence number of line item |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | OHIP fee code (e.g. A007) |
![]() ![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | OHIP Schedule of Benefits fee code |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Components of total line item price |
![]() ![]() ![]() ![]() |
S | 1..1 | code | base | surcharge | deduction | discount | tax | informational |
![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Service count / quantity (billing_on_item.ser_num) |
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Fee amount (billing_on_item.fee, parsed from String) |
![]() ![]() |
S | 0..1 | Money | Total gross amount (billing_on_cheader1.total) |
![]() ![]() |
S | 0..* | Annotation | Free-text comment (billing_on_cheader1.comment1) |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Invoice.type.coding:payProgram.code | extensible | OscarPayProgramVS(a valid code from Oscar Pay Program Code System)https://fhir.apps.health/ValueSet/oscar-pay-program-vsFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| invoice-has-polaris-id | error | Invoice | Must have at least one identifier whose system matches the Polaris Invoice pattern. : identifier.where(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-invoice-identifier$')).exists() |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Invoice | Polaris Invoice Core Constraints: invoice-has-polaris-id | ||||
![]() ![]() |
SΣ | 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.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | code | Raw Oscar billing status code URL: https://fhir.apps.health/StructureDefinition/oscar-billing-status-extension Binding: Oscar Billing Status Value Set (required) | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | Shadow bill indicator URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Polaris Location Core) | Service location reference URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Invoice identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Invoice 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 invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier 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) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR invoice 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 | The namespace for the identifier value 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) | ||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. | ||||
![]() ![]() |
0..1 | string | Reason for cancellation of this Invoice | |||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Type of invoice — carries pay_program coding for Canadian billing | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Binding: Oscar Pay Program Value Set (extensible) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | The patient who received the services | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice | ||||
![]() ![]() |
SΣ | 0..1 | dateTime | Billing date (maps to billing_on_cheader1.billing_date) | ||||
![]() ![]() |
S | 0..* | BackboneElement | Billing provider and related roles (billing, appointment, assistant, referring) | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | billing | appointment | assistant | referring | etc. | ||||
![]() ![]() ![]() |
1..1 | Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) | Individual who was involved | |||||
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | Organization issuing the invoice | ||||
![]() ![]() |
0..1 | Reference(Account) | Account that is being balanced | |||||
![]() ![]() |
S | 1..* | BackboneElement | One line per billing service code | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
S | 1..1 | positiveInt | Sequence number of line item | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | OHIP fee code (e.g. A007) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | OHIP Schedule of Benefits fee code | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Components of total line item price | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Service count / quantity (billing_on_item.ser_num) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Fee amount (billing_on_item.fee, parsed from String) | ||||
![]() ![]() |
0..* | See priceComponent (Invoice) | Components of Invoice total | |||||
![]() ![]() |
Σ | 0..1 | Money | Net total of this Invoice | ||||
![]() ![]() |
SΣ | 0..1 | Money | Total gross amount (billing_on_cheader1.total) | ||||
![]() ![]() |
0..1 | markdown | Payment details | |||||
![]() ![]() |
S | 0..* | Annotation | Free-text comment (billing_on_cheader1.comment1) | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Invoice.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Invoice.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Invoice.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Invoice.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Invoice.identifier:polarisId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Invoice.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Invoice.identifier:rawCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Invoice.status | required | InvoiceStatushttp://hl7.org/fhir/ValueSet/invoice-status|4.0.1From the FHIR Standard | ||||
| Invoice.type.coding:payProgram.code | extensible | OscarPayProgramVS(a valid code from Oscar Pay Program Code System)https://fhir.apps.health/ValueSet/oscar-pay-program-vsFrom this IG | ||||
| Invoice.lineItem.priceComponent.type | required | InvoicePriceComponentTypehttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Invoice | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Invoice | 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 | Invoice | 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 | Invoice | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Invoice | 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() | |
| invoice-has-polaris-id | error | Invoice | Must have at least one identifier whose system matches the Polaris Invoice pattern. : identifier.where(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-invoice-identifier$')).exists() |
This structure is derived from Invoice
Summary
Mandatory: 9 elements(7 nested mandatory elements)
Must-Support: 30 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..* | Invoice | Polaris Invoice Core Constraints: invoice-has-polaris-id |
![]() ![]() |
SΣ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 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 |
![]() ![]() |
0..1 | Narrative | Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | code | Raw Oscar billing status code URL: https://fhir.apps.health/StructureDefinition/oscar-billing-status-extension Binding: Oscar Billing Status Value Set (required) |
![]() ![]() ![]() |
S | 0..1 | boolean | Shadow bill indicator URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension |
![]() ![]() ![]() |
S | 0..1 | Reference(Polaris Location Core) | Service location reference URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 1..* | Identifier | Invoice identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Invoice 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 invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR invoice 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 | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() |
?!SΣ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. |
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Type of invoice — carries pay_program coding for Canadian billing |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB) |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Binding: Oscar Pay Program Value Set (extensible) |
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | The patient who received the services |
![]() ![]() |
SΣ | 0..1 | dateTime | Billing date (maps to billing_on_cheader1.billing_date) |
![]() ![]() |
S | 0..* | BackboneElement | Billing provider and related roles (billing, appointment, assistant, referring) |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | billing | appointment | assistant | referring | etc. |
![]() ![]() ![]() |
1..1 | Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) | Individual who was involved | |
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | Organization issuing the invoice |
![]() ![]() |
S | 1..* | BackboneElement | One line per billing service code |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
S | 1..1 | positiveInt | Sequence number of line item |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | OHIP fee code (e.g. A007) |
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | OHIP Schedule of Benefits fee code |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Components of total line item price |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. |
![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Service count / quantity (billing_on_item.ser_num) |
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Fee amount (billing_on_item.fee, parsed from String) |
![]() ![]() |
SΣ | 0..1 | Money | Total gross amount (billing_on_cheader1.total) |
![]() ![]() |
S | 0..* | Annotation | Free-text comment (billing_on_cheader1.comment1) |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Invoice.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Invoice.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Invoice.status | required | InvoiceStatushttp://hl7.org/fhir/ValueSet/invoice-status|4.0.1From the FHIR Standard | |
| Invoice.type.coding:payProgram.code | extensible | OscarPayProgramVS(a valid code from Oscar Pay Program Code System)https://fhir.apps.health/ValueSet/oscar-pay-program-vsFrom this IG | |
| Invoice.lineItem.priceComponent.type | required | InvoicePriceComponentTypehttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Invoice | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Invoice | 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 | Invoice | 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 | Invoice | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Invoice | 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() | |
| invoice-has-polaris-id | error | Invoice | Must have at least one identifier whose system matches the Polaris Invoice pattern. : identifier.where(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-invoice-identifier$')).exists() |
Differential View
This structure is derived from Invoice
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Invoice | Polaris Invoice Core Constraints: invoice-has-polaris-id |
![]() ![]() |
S | 0..1 | id | Logical id of this artifact |
![]() ![]() |
||||
![]() ![]() ![]() |
S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from |
![]() ![]() |
0..1 | Narrative | Narrative | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() |
S | 0..1 | code | Raw Oscar billing status code URL: https://fhir.apps.health/StructureDefinition/oscar-billing-status-extension Binding: Oscar Billing Status Value Set (required) |
![]() ![]() ![]() |
S | 0..1 | boolean | Shadow bill indicator URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension |
![]() ![]() ![]() |
S | 0..1 | Reference(Polaris Location Core) | Service location reference URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension |
![]() ![]() |
S | 1..* | Identifier | Invoice identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system |
![]() ![]() ![]() |
S | 1..1 | Identifier | Polaris Invoice ID |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
![]() ![]() ![]() ![]() |
1..1 | uri | Polaris invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() ![]() |
S | 0..* | Identifier | Source EMR invoice identifier |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: secondary | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique | |
![]() ![]() |
S | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error |
![]() ![]() |
S | 0..1 | CodeableConcept | Type of invoice — carries pay_program coding for Canadian billing |
![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB) |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system Binding: Oscar Pay Program Value Set (extensible) |
![]() ![]() |
S | 1..1 | Reference(Polaris Patient Core) | The patient who received the services |
![]() ![]() |
S | 0..1 | dateTime | Billing date (maps to billing_on_cheader1.billing_date) |
![]() ![]() |
S | 0..* | BackboneElement | Billing provider and related roles (billing, appointment, assistant, referring) |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | billing | appointment | assistant | referring | etc. |
![]() ![]() ![]() |
1..1 | Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) | Individual who was involved | |
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | Organization issuing the invoice |
![]() ![]() |
S | 1..* | BackboneElement | One line per billing service code |
![]() ![]() ![]() |
S | 1..1 | positiveInt | Sequence number of line item |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | OHIP fee code (e.g. A007) |
![]() ![]() ![]() ![]() |
S | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Coding | OHIP Schedule of Benefits fee code |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Components of total line item price |
![]() ![]() ![]() ![]() |
S | 1..1 | code | base | surcharge | deduction | discount | tax | informational |
![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Service count / quantity (billing_on_item.ser_num) |
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Fee amount (billing_on_item.fee, parsed from String) |
![]() ![]() |
S | 0..1 | Money | Total gross amount (billing_on_cheader1.total) |
![]() ![]() |
S | 0..* | Annotation | Free-text comment (billing_on_cheader1.comment1) |
Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Invoice.type.coding:payProgram.code | extensible | OscarPayProgramVS(a valid code from Oscar Pay Program Code System)https://fhir.apps.health/ValueSet/oscar-pay-program-vsFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| invoice-has-polaris-id | error | Invoice | Must have at least one identifier whose system matches the Polaris Invoice pattern. : identifier.where(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-invoice-identifier$')).exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Invoice | Polaris Invoice Core Constraints: invoice-has-polaris-id | ||||
![]() ![]() |
SΣ | 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.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
S | 0..1 | code | Raw Oscar billing status code URL: https://fhir.apps.health/StructureDefinition/oscar-billing-status-extension Binding: Oscar Billing Status Value Set (required) | ||||
![]() ![]() ![]() |
S | 0..1 | boolean | Shadow bill indicator URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Polaris Location Core) | Service location reference URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension | ||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 1..* | Identifier | Invoice identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Polaris Invoice 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 invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier 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) | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Source EMR invoice 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 | The namespace for the identifier value 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) | ||||
![]() ![]() |
?!SΣ | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice. | ||||
![]() ![]() |
0..1 | string | Reason for cancellation of this Invoice | |||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Type of invoice — carries pay_program coding for Canadian billing | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system Binding: Oscar Pay Program Value Set (extensible) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Polaris Patient Core) | The patient who received the services | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice | ||||
![]() ![]() |
SΣ | 0..1 | dateTime | Billing date (maps to billing_on_cheader1.billing_date) | ||||
![]() ![]() |
S | 0..* | BackboneElement | Billing provider and related roles (billing, appointment, assistant, referring) | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | billing | appointment | assistant | referring | etc. | ||||
![]() ![]() ![]() |
1..1 | Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) | Individual who was involved | |||||
![]() ![]() |
S | 0..1 | Reference(Polaris Organization Core) | Organization issuing the invoice | ||||
![]() ![]() |
0..1 | Reference(Account) | Account that is being balanced | |||||
![]() ![]() |
S | 1..* | BackboneElement | One line per billing service code | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
S | 1..1 | positiveInt | Sequence number of line item | ||||
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | OHIP fee code (e.g. A007) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | OHIP Schedule of Benefits fee code | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Components of total line item price | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component. | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | decimal | Service count / quantity (billing_on_item.ser_num) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Money | Fee amount (billing_on_item.fee, parsed from String) | ||||
![]() ![]() |
0..* | See priceComponent (Invoice) | Components of Invoice total | |||||
![]() ![]() |
Σ | 0..1 | Money | Net total of this Invoice | ||||
![]() ![]() |
SΣ | 0..1 | Money | Total gross amount (billing_on_cheader1.total) | ||||
![]() ![]() |
0..1 | markdown | Payment details | |||||
![]() ![]() |
S | 0..* | Annotation | Free-text comment (billing_on_cheader1.comment1) | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Invoice.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Invoice.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Invoice.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Invoice.identifier:polarisId.use | required | Pattern Value: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Invoice.identifier:polarisId.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Invoice.identifier:rawCode.use | required | Pattern Value: secondaryhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Invoice.identifier:rawCode.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Invoice.status | required | InvoiceStatushttp://hl7.org/fhir/ValueSet/invoice-status|4.0.1From the FHIR Standard | ||||
| Invoice.type.coding:payProgram.code | extensible | OscarPayProgramVS(a valid code from Oscar Pay Program Code System)https://fhir.apps.health/ValueSet/oscar-pay-program-vsFrom this IG | ||||
| Invoice.lineItem.priceComponent.type | required | InvoicePriceComponentTypehttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Invoice | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Invoice | 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 | Invoice | 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 | Invoice | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Invoice | 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() | |
| invoice-has-polaris-id | error | Invoice | Must have at least one identifier whose system matches the Polaris Invoice pattern. : identifier.where(system.matches('^https://fhir.apps.health/NamingSystem/[A-Za-z0-9._-]+-invoice-identifier$')).exists() |
This structure is derived from Invoice
Summary
Mandatory: 9 elements(7 nested mandatory elements)
Must-Support: 30 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