Polaris FHIR Implementation Guide
1.10.0 - ci-build

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

Resource Profile: Polaris Invoice Core

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.

Polaris Core Invoice Profile

Overview

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[].

Key Features

  • Header + inline line items — one Invoice per billing_on_cheader1 header, with Invoice.lineItem[] components per billing_on_item row; no separate ChargeItem resource
  • Canonical FHIR status + rich Oscar extensionInvoice.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 extension
  • Shadow-bill indicatorshadowBill boolean extension on Invoice flags FHO/FHN capitated submissions (Oscar status H)
  • Pay program extensionpayProgram extension carries Oscar's pay_program code
  • OHIP fee codeslineItem.chargeItemCodeableConcept.coding sliced for OHIP Schedule of Benefits codes
  • Per-line diagnostic codes — up to 3 dx codes per line via DIAGNOSTIC_1/2/3 extensions (Oscar product feature)

Mapping to Source

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.

Future Considerations

  • Separate ChargeItem resource for per-line cross-resource referencing (needed if adjudication linkage is added)
  • ChargeItemDefinition to expose the OHIP Schedule of Benefits catalog as FHIR
  • Coverage profile for payer-level filtering and eligibility
  • Adjudication / remittance-advice feedback loop via ClaimResponse or custom extension
  • Multi-province support (BC MSP, AB AHCIP) with shared extensions

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice C 0..* Invoice Polaris Invoice Core
Constraints: invoice-has-polaris-id
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:oscarBillingStatus 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)
.... extension:shadowBill S 0..1 boolean Shadow bill indicator
URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension
.... extension:serviceLocation S 0..1 Reference(Polaris Location Core) Service location reference
URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Invoice identifiers (Polaris ID required)
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris Invoice ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... system Σ 1..1 uri Polaris invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:rawCode SΣ 0..* Identifier Source EMR invoice identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... type SΣ 0..1 CodeableConcept Type of invoice — carries pay_program coding for Canadian billing
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:payProgram SΣ 0..1 Coding Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB)
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs
...... code SΣ 1..1 code Symbol in syntax defined by the system
Binding: Oscar Pay Program Value Set (extensible)
... subject SΣ 1..1 Reference(Polaris Patient Core) The patient who received the services
... date SΣ 0..1 dateTime Billing date (maps to billing_on_cheader1.billing_date)
... participant S 0..* BackboneElement Billing provider and related roles (billing, appointment, assistant, referring)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role S 0..1 CodeableConcept billing | appointment | assistant | referring | etc.
.... actor 1..1 Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) Individual who was involved
... issuer S 0..1 Reference(Polaris Organization Core) Organization issuing the invoice
... lineItem S 1..* BackboneElement One line per billing service code
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence S 1..1 positiveInt Sequence number of line item
.... chargeItem[x] S 1..1 CodeableConcept OHIP fee code (e.g. A007)
..... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:ohip SΣ 0..1 Coding OHIP Schedule of Benefits fee code
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits
....... code SΣ 1..1 code Symbol in syntax defined by the system
.... priceComponent S 1..* BackboneElement Components of total line item price
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... factor S 0..1 decimal Service count / quantity (billing_on_item.ser_num)
..... amount S 0..1 Money Fee amount (billing_on_item.fee, parsed from String)
... totalGross SΣ 0..1 Money Total gross amount (billing_on_cheader1.total)
... note S 0..* Annotation Free-text comment (billing_on_cheader1.comment1)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Invoice.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Invoice.statusrequiredInvoiceStatus
http://hl7.org/fhir/ValueSet/invoice-status|4.0.1
From the FHIR Standard
Invoice.type.coding:payProgram.codeextensibleOscarPayProgramVS(a valid code from Oscar Pay Program Code System)
https://fhir.apps.health/ValueSet/oscar-pay-program-vs
From this IG
Invoice.lineItem.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf 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-4errorInvoiceIf 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-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
invoice-has-polaris-iderrorInvoiceMust 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice C 0..* Invoice Polaris Invoice Core
Constraints: invoice-has-polaris-id
... id S 0..1 id Logical id of this artifact
... meta
.... source S 0..1 uri Identifies EMR instance & pipeline version the resource came from
... text 0..1 Narrative Narrative
.... extension:oscarBillingStatus 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)
.... extension:shadowBill S 0..1 boolean Shadow bill indicator
URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension
.... extension:serviceLocation S 0..1 Reference(Polaris Location Core) Service location reference
URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension
... Slices for identifier S 1..* Identifier Invoice identifiers (Polaris ID required)
Slice: Unordered, Open by pattern:system
.... identifier:polarisId S 1..1 Identifier Polaris Invoice ID
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 1..1 uri Polaris invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier
..... value 1..1 string The value that is unique
.... identifier:rawCode S 0..* Identifier Source EMR invoice identifier
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
... status S 1..1 code draft | issued | balanced | cancelled | entered-in-error
... type S 0..1 CodeableConcept Type of invoice — carries pay_program coding for Canadian billing
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:payProgram S 0..1 Coding Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB)
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs
...... code S 1..1 code Symbol in syntax defined by the system
Binding: Oscar Pay Program Value Set (extensible)
... subject S 1..1 Reference(Polaris Patient Core) The patient who received the services
... date S 0..1 dateTime Billing date (maps to billing_on_cheader1.billing_date)
... participant S 0..* BackboneElement Billing provider and related roles (billing, appointment, assistant, referring)
.... role S 0..1 CodeableConcept billing | appointment | assistant | referring | etc.
.... actor 1..1 Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) Individual who was involved
... issuer S 0..1 Reference(Polaris Organization Core) Organization issuing the invoice
... lineItem S 1..* BackboneElement One line per billing service code
.... sequence S 1..1 positiveInt Sequence number of line item
.... chargeItem[x] S 1..1 CodeableConcept OHIP fee code (e.g. A007)
..... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:ohip S 0..1 Coding OHIP Schedule of Benefits fee code
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits
....... code S 1..1 code Symbol in syntax defined by the system
.... priceComponent S 1..* BackboneElement Components of total line item price
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
..... factor S 0..1 decimal Service count / quantity (billing_on_item.ser_num)
..... amount S 0..1 Money Fee amount (billing_on_item.fee, parsed from String)
... totalGross S 0..1 Money Total gross amount (billing_on_cheader1.total)
... note S 0..* Annotation Free-text comment (billing_on_cheader1.comment1)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Invoice.type.coding:payProgram.codeextensibleOscarPayProgramVS(a valid code from Oscar Pay Program Code System)
https://fhir.apps.health/ValueSet/oscar-pay-program-vs
From this IG

Constraints

IdGradePath(s)DetailsRequirements
invoice-has-polaris-iderrorInvoiceMust 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()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice C 0..* Invoice Polaris Invoice Core
Constraints: invoice-has-polaris-id
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:oscarBillingStatus 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)
.... extension:shadowBill S 0..1 boolean Shadow bill indicator
URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension
.... extension:serviceLocation S 0..1 Reference(Polaris Location Core) Service location reference
URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Invoice identifiers (Polaris ID required)
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris Invoice ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri Polaris invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:rawCode SΣ 0..* Identifier Source EMR invoice identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type SΣ 0..1 CodeableConcept Type of invoice — carries pay_program coding for Canadian billing
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:payProgram SΣ 0..1 Coding Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
Binding: Oscar Pay Program Value Set (extensible)
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Polaris Patient Core) The patient who received the services
... recipient Σ 0..1 Reference(Organization | Patient | RelatedPerson) Recipient of this invoice
... date SΣ 0..1 dateTime Billing date (maps to billing_on_cheader1.billing_date)
... participant S 0..* BackboneElement Billing provider and related roles (billing, appointment, assistant, referring)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role S 0..1 CodeableConcept billing | appointment | assistant | referring | etc.
.... actor 1..1 Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) Individual who was involved
... issuer S 0..1 Reference(Polaris Organization Core) Organization issuing the invoice
... account 0..1 Reference(Account) Account that is being balanced
... lineItem S 1..* BackboneElement One line per billing service code
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence S 1..1 positiveInt Sequence number of line item
.... chargeItem[x] S 1..1 CodeableConcept OHIP fee code (e.g. A007)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:ohip SΣ 0..1 Coding OHIP Schedule of Benefits fee code
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... priceComponent S 1..* BackboneElement Components of total line item price
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code 0..1 CodeableConcept Code identifying the specific component
..... factor S 0..1 decimal Service count / quantity (billing_on_item.ser_num)
..... amount S 0..1 Money Fee amount (billing_on_item.fee, parsed from String)
... totalPriceComponent 0..* See priceComponent (Invoice) Components of Invoice total
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross SΣ 0..1 Money Total gross amount (billing_on_cheader1.total)
... paymentTerms 0..1 markdown Payment details
... note S 0..* Annotation Free-text comment (billing_on_cheader1.comment1)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Invoice.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Invoice.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Invoice.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Invoice.identifier:polarisId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Invoice.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Invoice.identifier:rawCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Invoice.statusrequiredInvoiceStatus
http://hl7.org/fhir/ValueSet/invoice-status|4.0.1
From the FHIR Standard
Invoice.type.coding:payProgram.codeextensibleOscarPayProgramVS(a valid code from Oscar Pay Program Code System)
https://fhir.apps.health/ValueSet/oscar-pay-program-vs
From this IG
Invoice.lineItem.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf 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-4errorInvoiceIf 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-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
invoice-has-polaris-iderrorInvoiceMust 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:

  • The element 1 is sliced based on the value of Invoice.identifier
  • The element 1 is sliced based on the value of Invoice.type.coding
  • The element 1 is sliced based on the value of Invoice.lineItem.chargeItem[x].coding

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice C 0..* Invoice Polaris Invoice Core
Constraints: invoice-has-polaris-id
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:oscarBillingStatus 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)
.... extension:shadowBill S 0..1 boolean Shadow bill indicator
URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension
.... extension:serviceLocation S 0..1 Reference(Polaris Location Core) Service location reference
URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Invoice identifiers (Polaris ID required)
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris Invoice ID
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... system Σ 1..1 uri Polaris invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
.... identifier:rawCode SΣ 0..* Identifier Source EMR invoice identifier
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!SΣ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... type SΣ 0..1 CodeableConcept Type of invoice — carries pay_program coding for Canadian billing
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:payProgram SΣ 0..1 Coding Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB)
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs
...... code SΣ 1..1 code Symbol in syntax defined by the system
Binding: Oscar Pay Program Value Set (extensible)
... subject SΣ 1..1 Reference(Polaris Patient Core) The patient who received the services
... date SΣ 0..1 dateTime Billing date (maps to billing_on_cheader1.billing_date)
... participant S 0..* BackboneElement Billing provider and related roles (billing, appointment, assistant, referring)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role S 0..1 CodeableConcept billing | appointment | assistant | referring | etc.
.... actor 1..1 Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) Individual who was involved
... issuer S 0..1 Reference(Polaris Organization Core) Organization issuing the invoice
... lineItem S 1..* BackboneElement One line per billing service code
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence S 1..1 positiveInt Sequence number of line item
.... chargeItem[x] S 1..1 CodeableConcept OHIP fee code (e.g. A007)
..... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:ohip SΣ 0..1 Coding OHIP Schedule of Benefits fee code
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits
....... code SΣ 1..1 code Symbol in syntax defined by the system
.... priceComponent S 1..* BackboneElement Components of total line item price
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... factor S 0..1 decimal Service count / quantity (billing_on_item.ser_num)
..... amount S 0..1 Money Fee amount (billing_on_item.fee, parsed from String)
... totalGross SΣ 0..1 Money Total gross amount (billing_on_cheader1.total)
... note S 0..* Annotation Free-text comment (billing_on_cheader1.comment1)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Invoice.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Invoice.statusrequiredInvoiceStatus
http://hl7.org/fhir/ValueSet/invoice-status|4.0.1
From the FHIR Standard
Invoice.type.coding:payProgram.codeextensibleOscarPayProgramVS(a valid code from Oscar Pay Program Code System)
https://fhir.apps.health/ValueSet/oscar-pay-program-vs
From this IG
Invoice.lineItem.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf 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-4errorInvoiceIf 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-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
invoice-has-polaris-iderrorInvoiceMust 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice C 0..* Invoice Polaris Invoice Core
Constraints: invoice-has-polaris-id
... id S 0..1 id Logical id of this artifact
... meta
.... source S 0..1 uri Identifies EMR instance & pipeline version the resource came from
... text 0..1 Narrative Narrative
.... extension:oscarBillingStatus 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)
.... extension:shadowBill S 0..1 boolean Shadow bill indicator
URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension
.... extension:serviceLocation S 0..1 Reference(Polaris Location Core) Service location reference
URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension
... Slices for identifier S 1..* Identifier Invoice identifiers (Polaris ID required)
Slice: Unordered, Open by pattern:system
.... identifier:polarisId S 1..1 Identifier Polaris Invoice ID
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 1..1 uri Polaris invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier
..... value 1..1 string The value that is unique
.... identifier:rawCode S 0..* Identifier Source EMR invoice identifier
..... use 0..1 code usual | official | temp | secondary | old (If known)
Required Pattern: secondary
..... system 1..1 uri The namespace for the identifier value
..... value 1..1 string The value that is unique
... status S 1..1 code draft | issued | balanced | cancelled | entered-in-error
... type S 0..1 CodeableConcept Type of invoice — carries pay_program coding for Canadian billing
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:payProgram S 0..1 Coding Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB)
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs
...... code S 1..1 code Symbol in syntax defined by the system
Binding: Oscar Pay Program Value Set (extensible)
... subject S 1..1 Reference(Polaris Patient Core) The patient who received the services
... date S 0..1 dateTime Billing date (maps to billing_on_cheader1.billing_date)
... participant S 0..* BackboneElement Billing provider and related roles (billing, appointment, assistant, referring)
.... role S 0..1 CodeableConcept billing | appointment | assistant | referring | etc.
.... actor 1..1 Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) Individual who was involved
... issuer S 0..1 Reference(Polaris Organization Core) Organization issuing the invoice
... lineItem S 1..* BackboneElement One line per billing service code
.... sequence S 1..1 positiveInt Sequence number of line item
.... chargeItem[x] S 1..1 CodeableConcept OHIP fee code (e.g. A007)
..... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:ohip S 0..1 Coding OHIP Schedule of Benefits fee code
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits
....... code S 1..1 code Symbol in syntax defined by the system
.... priceComponent S 1..* BackboneElement Components of total line item price
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
..... factor S 0..1 decimal Service count / quantity (billing_on_item.ser_num)
..... amount S 0..1 Money Fee amount (billing_on_item.fee, parsed from String)
... totalGross S 0..1 Money Total gross amount (billing_on_cheader1.total)
... note S 0..* Annotation Free-text comment (billing_on_cheader1.comment1)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Invoice.type.coding:payProgram.codeextensibleOscarPayProgramVS(a valid code from Oscar Pay Program Code System)
https://fhir.apps.health/ValueSet/oscar-pay-program-vs
From this IG

Constraints

IdGradePath(s)DetailsRequirements
invoice-has-polaris-iderrorInvoiceMust 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Invoice C 0..* Invoice Polaris Invoice Core
Constraints: invoice-has-polaris-id
... id SΣ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source SΣ 0..1 uri Identifies EMR instance & pipeline version the resource came from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:oscarBillingStatus 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)
.... extension:shadowBill S 0..1 boolean Shadow bill indicator
URL: https://fhir.apps.health/StructureDefinition/oscar-billing-shadow-bill-extension
.... extension:serviceLocation S 0..1 Reference(Polaris Location Core) Service location reference
URL: https://fhir.apps.health/StructureDefinition/oscar-service-location-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* Identifier Invoice identifiers (Polaris ID required)
Slice: Unordered, Open by pattern:system
.... identifier:polarisId SΣ 1..1 Identifier Polaris Invoice ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri Polaris invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:rawCode SΣ 0..* Identifier Source EMR invoice identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: secondary
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... status ?!SΣ 1..1 code draft | issued | balanced | cancelled | entered-in-error
Binding: InvoiceStatus (required): Codes identifying the lifecycle stage of an Invoice.
... cancelledReason 0..1 string Reason for cancellation of this Invoice
... type SΣ 0..1 CodeableConcept Type of invoice — carries pay_program coding for Canadian billing
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:payProgram SΣ 0..1 Coding Oscar pay_program code (HCP | RMB | PAT | OCF | ODS | CPP | STD | IFH | WCB)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/oscar-pay-program-cs
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
Binding: Oscar Pay Program Value Set (extensible)
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Polaris Patient Core) The patient who received the services
... recipient Σ 0..1 Reference(Organization | Patient | RelatedPerson) Recipient of this invoice
... date SΣ 0..1 dateTime Billing date (maps to billing_on_cheader1.billing_date)
... participant S 0..* BackboneElement Billing provider and related roles (billing, appointment, assistant, referring)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role S 0..1 CodeableConcept billing | appointment | assistant | referring | etc.
.... actor 1..1 Reference(Polaris Practitioner Core | Polaris PractitionerRole Core | Polaris Organization Core) Individual who was involved
... issuer S 0..1 Reference(Polaris Organization Core) Organization issuing the invoice
... account 0..1 Reference(Account) Account that is being balanced
... lineItem S 1..* BackboneElement One line per billing service code
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... sequence S 1..1 positiveInt Sequence number of line item
.... chargeItem[x] S 1..1 CodeableConcept OHIP fee code (e.g. A007)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:ohip SΣ 0..1 Coding OHIP Schedule of Benefits fee code
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... priceComponent S 1..* BackboneElement Components of total line item price
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code 0..1 CodeableConcept Code identifying the specific component
..... factor S 0..1 decimal Service count / quantity (billing_on_item.ser_num)
..... amount S 0..1 Money Fee amount (billing_on_item.fee, parsed from String)
... totalPriceComponent 0..* See priceComponent (Invoice) Components of Invoice total
... totalNet Σ 0..1 Money Net total of this Invoice
... totalGross SΣ 0..1 Money Total gross amount (billing_on_cheader1.total)
... paymentTerms 0..1 markdown Payment details
... note S 0..* Annotation Free-text comment (billing_on_cheader1.comment1)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Invoice.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
Invoice.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
Invoice.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Invoice.identifier:polarisId.userequiredPattern Value: official
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Invoice.identifier:polarisId.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Invoice.identifier:rawCode.userequiredPattern Value: secondary
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Invoice.identifier:rawCode.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
Invoice.statusrequiredInvoiceStatus
http://hl7.org/fhir/ValueSet/invoice-status|4.0.1
From the FHIR Standard
Invoice.type.coding:payProgram.codeextensibleOscarPayProgramVS(a valid code from Oscar Pay Program Code System)
https://fhir.apps.health/ValueSet/oscar-pay-program-vs
From this IG
Invoice.lineItem.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorInvoiceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorInvoiceIf 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-4errorInvoiceIf 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-5errorInvoiceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceInvoiceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
invoice-has-polaris-iderrorInvoiceMust 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:

  • The element 1 is sliced based on the value of Invoice.identifier
  • The element 1 is sliced based on the value of Invoice.type.coding
  • The element 1 is sliced based on the value of Invoice.lineItem.chargeItem[x].coding

 

Other representations of profile: CSV, Excel, Schematron