Polaris FHIR Implementation Guide
1.9.8 - ci-build
Polaris FHIR Implementation Guide - Local Development build (v1.9.8) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Draft as of 2026-04-24 |
Definitions for the polaris-core-invoice resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Invoice | ||||||||||||||||||||||||||||||||||
| Definition | Represents a Canadian provider-side billing record — the header and line items a physician
submits or records for services provided. Phase 1 sources from Oscar Pro's
Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose. | |||||||||||||||||||||||||||||||||
| Short | Polaris Invoice CoreInvoice containing ChargeItems from an Account | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) invoice-has-polaris-id: 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()) | |||||||||||||||||||||||||||||||||
| 2. Invoice.id | ||||||||||||||||||||||||||||||||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||||||||||||||||||||||||||||||||
| Short | Logical id of this artifact | |||||||||||||||||||||||||||||||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | idstring | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| 4. Invoice.meta | ||||||||||||||||||||||||||||||||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |||||||||||||||||||||||||||||||||
| Short | Metadata about the resource | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Meta | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 6. Invoice.meta.source | ||||||||||||||||||||||||||||||||||
| Definition | A URI that identifies the EMR pipeline and version from which this resource originated. A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | |||||||||||||||||||||||||||||||||
| Short | Identifies EMR instance & pipeline version the resource came fromIdentifies where the resource comes from | |||||||||||||||||||||||||||||||||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | uri | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 8. Invoice.implicitRules | ||||||||||||||||||||||||||||||||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |||||||||||||||||||||||||||||||||
| Short | A set of rules under which this content was created | |||||||||||||||||||||||||||||||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | uri | |||||||||||||||||||||||||||||||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 10. Invoice.text | ||||||||||||||||||||||||||||||||||
| Definition | A human-readable narrative summary of the Invoice. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |||||||||||||||||||||||||||||||||
| Short | NarrativeText summary of the resource, for human interpretation | |||||||||||||||||||||||||||||||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Narrative | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | narrative, html, xhtml, display | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 12. Invoice.extension | ||||||||||||||||||||||||||||||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||||||||||||||||||||||||||
| Short | ExtensionAdditional content defined by implementations | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 14. Invoice.extension:oscarBillingStatus | ||||||||||||||||||||||||||||||||||
| Slice Name | oscarBillingStatus | |||||||||||||||||||||||||||||||||
| Definition | The raw Oscar Pro billing status code as stored in
Used in combination with (not instead of) FHIR | |||||||||||||||||||||||||||||||||
| Short | Raw Oscar billing status code | |||||||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||||||||||||||||||||||||||
| Type | Extension(Oscar Billing Status Extension) (Extension Type: code) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 16. Invoice.extension:shadowBill | ||||||||||||||||||||||||||||||||||
| Slice Name | shadowBill | |||||||||||||||||||||||||||||||||
| Definition | True when the Invoice represents a shadow bill — a capitated submission under Ontario's
FHO/FHN models where payment is via capitation and the bill is submitted for tracking and
utilization-reporting purposes only. Derived from Oscar Pro's When true, | |||||||||||||||||||||||||||||||||
| Short | Shadow bill indicator | |||||||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||||||||||||||||||||||||||
| Type | Extension(Shadow Bill Extension) (Extension Type: boolean) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 18. Invoice.extension:payProgram | ||||||||||||||||||||||||||||||||||
| Slice Name | payProgram | |||||||||||||||||||||||||||||||||
| Definition | The Oscar Pro pay_program code identifying the destination payer or program for this billing
record. Sourced from
See MTG-071 v2.4 §4 for context and additional notes. | |||||||||||||||||||||||||||||||||
| Short | Oscar pay program code | |||||||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||||||||||||||||||||||||||
| Type | Extension(Pay Program Extension) (Extension Type: code) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 20. Invoice.modifierExtension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 22. Invoice.identifier | ||||||||||||||||||||||||||||||||||
| Definition | Identifiers for the invoice. At least one must use the Polaris invoice naming pattern. When a source EMR billing-header id exists (e.g. Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. | |||||||||||||||||||||||||||||||||
| Short | Invoice identifiers (Polaris ID required)Business Identifier for item | |||||||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||||||||||||||||||||||||||
| Control | 10..* | |||||||||||||||||||||||||||||||||
| Type | Identifier | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows Identification of this Invoice instance. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 24. Invoice.identifier:polarisId | ||||||||||||||||||||||||||||||||||
| Slice Name | polarisId | |||||||||||||||||||||||||||||||||
| Definition | The primary Polaris identifier for this invoice, following the standard Polaris naming pattern. Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. | |||||||||||||||||||||||||||||||||
| Short | Polaris Invoice IDBusiness Identifier for item | |||||||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||||||||||||||||||||||||||
| Control | 10..1* | |||||||||||||||||||||||||||||||||
| Type | Identifier | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows Identification of this Invoice instance. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 26. Invoice.identifier:polarisId.use | ||||||||||||||||||||||||||||||||||
| Definition | The purpose of this identifier. | |||||||||||||||||||||||||||||||||
| Short | usual | official | temp | secondary | old (If known) | |||||||||||||||||||||||||||||||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | |||||||||||||||||||||||||||||||||
| Type | code | |||||||||||||||||||||||||||||||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||||||||||||||||||||||||||||||||
| Pattern Value | official | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 28. Invoice.identifier:polarisId.system | ||||||||||||||||||||||||||||||||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||||||||||||||||||||||||||||||||
| Short | Polaris invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifierThe namespace for the identifier value | |||||||||||||||||||||||||||||||||
| Comments | Identifier.system is always case sensitive. | |||||||||||||||||||||||||||||||||
| Control | 10..1 | |||||||||||||||||||||||||||||||||
| Type | uri | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||||||||||||||||||||||||||||||||
| Example | General: http://www.acme.com/identifiers/patient | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 30. Invoice.identifier:polarisId.value | ||||||||||||||||||||||||||||||||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||||||||||||||||||||||||||||||||
| Short | The value that is unique | |||||||||||||||||||||||||||||||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||||||||||||||||||||||||||||||||
| Control | 10..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Example | General: 123456 | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 32. Invoice.identifier:rawCode | ||||||||||||||||||||||||||||||||||
| Slice Name | rawCode | |||||||||||||||||||||||||||||||||
| Definition | The original raw identifier(s) from the source EMR (e.g. Identifier of this Invoice, often used for reference in correspondence about this invoice or for tracking of payments. | |||||||||||||||||||||||||||||||||
| Short | Source EMR invoice identifierBusiness Identifier for item | |||||||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Identifier | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows Identification of this Invoice instance. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 34. Invoice.identifier:rawCode.use | ||||||||||||||||||||||||||||||||||
| Definition | The purpose of this identifier. | |||||||||||||||||||||||||||||||||
| Short | usual | official | temp | secondary | old (If known) | |||||||||||||||||||||||||||||||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | |||||||||||||||||||||||||||||||||
| Type | code | |||||||||||||||||||||||||||||||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||||||||||||||||||||||||||||||||
| Pattern Value | secondary | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 36. Invoice.identifier:rawCode.system | ||||||||||||||||||||||||||||||||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||||||||||||||||||||||||||||||||
| Short | The namespace for the identifier value | |||||||||||||||||||||||||||||||||
| Comments | Identifier.system is always case sensitive. | |||||||||||||||||||||||||||||||||
| Control | 10..1 | |||||||||||||||||||||||||||||||||
| Type | uri | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||||||||||||||||||||||||||||||||
| Example | General: http://www.acme.com/identifiers/patient | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 38. Invoice.identifier:rawCode.value | ||||||||||||||||||||||||||||||||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||||||||||||||||||||||||||||||||
| Short | The value that is unique | |||||||||||||||||||||||||||||||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||||||||||||||||||||||||||||||||
| Control | 10..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Example | General: 123456 | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 40. Invoice.status | ||||||||||||||||||||||||||||||||||
| Definition | FHIR Oscar → FHIR status mapping (see oscar-to-fhir feature docs):
Current The current state of the Invoice. | |||||||||||||||||||||||||||||||||
| Short | draft | issued | balanced | cancelled | entered-in-error | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from InvoiceStatushttp://hl7.org/fhir/ValueSet/invoice-status|4.0.1 (required to http://hl7.org/fhir/ValueSet/invoice-status|4.0.1)Codes identifying the lifecycle stage of an Invoice. | |||||||||||||||||||||||||||||||||
| Type | code | |||||||||||||||||||||||||||||||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 42. Invoice.subject | ||||||||||||||||||||||||||||||||||
| Definition | The individual or set of individuals receiving the goods and services billed in this invoice. | |||||||||||||||||||||||||||||||||
| Short | The patient who received the servicesRecipient(s) of goods and services | |||||||||||||||||||||||||||||||||
| Control | 10..1 | |||||||||||||||||||||||||||||||||
| Type | Reference(Polaris Patient Core, Patient, Group) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Links the event to the Patient context. | |||||||||||||||||||||||||||||||||
| Alternate Names | patient | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 44. Invoice.date | ||||||||||||||||||||||||||||||||||
| Definition | Date/time(s) of when this Invoice was posted. | |||||||||||||||||||||||||||||||||
| Short | Billing date (maps to billing_on_cheader1.billing_date)Invoice date / posting date | |||||||||||||||||||||||||||||||||
| Comments | The list of types may be constrained as appropriate for the type of charge item. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | dateTime | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 46. Invoice.participant | ||||||||||||||||||||||||||||||||||
| Definition | Indicates who or what performed or participated in the charged service. | |||||||||||||||||||||||||||||||||
| Short | Billing provider and related roles (billing, appointment, assistant, referring)Participant in creation of this Invoice | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | BackboneElement | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 48. Invoice.participant.modifierExtension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content, modifiers | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 50. Invoice.participant.role | ||||||||||||||||||||||||||||||||||
| Definition | Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device. | |||||||||||||||||||||||||||||||||
| Short | billing | appointment | assistant | referring | etc.Type of involvement in creation of this Invoice | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | CodeableConcept | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 52. Invoice.participant.actor | ||||||||||||||||||||||||||||||||||
| Definition | The device, practitioner, etc. who performed or participated in the service. | |||||||||||||||||||||||||||||||||
| Short | Individual who was involved | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | Reference(Polaris Practitioner Core, Polaris PractitionerRole Core, Polaris Organization Core, Practitioner, Organization, Patient, PractitionerRole, Device, RelatedPerson) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 54. Invoice.issuer | ||||||||||||||||||||||||||||||||||
| Definition | The organizationissuing the Invoice. | |||||||||||||||||||||||||||||||||
| Short | Organization issuing the invoiceIssuing Organization of Invoice | |||||||||||||||||||||||||||||||||
| Comments | Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Reference(Polaris Organization Core, Organization) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 56. Invoice.lineItem | ||||||||||||||||||||||||||||||||||
| Definition | One line item per Note on OHIP submission: Oscar stores up to 3 dx codes per line as a product feature, but OHIP's H-file format allows only 1 dx per service line at submission time. Extra slots are preserved in FHIR for round-trip fidelity. Each line item represents one charge for goods and services rendered. Details such as date, code and amount are found in the referenced ChargeItem resource. | |||||||||||||||||||||||||||||||||
| Short | One line per billing service codeLine items of this Invoice | |||||||||||||||||||||||||||||||||
| Control | 10..* | |||||||||||||||||||||||||||||||||
| Type | BackboneElement | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 58. Invoice.lineItem.modifierExtension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content, modifiers | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 60. Invoice.lineItem.sequence | ||||||||||||||||||||||||||||||||||
| Definition | Sequence in which the items appear on the invoice. | |||||||||||||||||||||||||||||||||
| Short | Sequence number of line item | |||||||||||||||||||||||||||||||||
| Control | 10..1 | |||||||||||||||||||||||||||||||||
| Type | positiveInt | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 62. Invoice.lineItem.chargeItem[x] | ||||||||||||||||||||||||||||||||||
| Definition | OHIP Schedule of Benefits fee code. Coding system should be The ChargeItem contains information such as the billing code, date, amount etc. If no further details are required for the lineItem, inline billing codes can be added using the CodeableConcept data type instead of the Reference. | |||||||||||||||||||||||||||||||||
| Short | OHIP fee code (e.g. A007)Reference to ChargeItem containing details of this line item or an inline billing code | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | CodeableConcept, Reference(ChargeItem) | |||||||||||||||||||||||||||||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 64. Invoice.lineItem.chargeItem[x].coding | ||||||||||||||||||||||||||||||||||
| Definition | A reference to a code defined by a terminology system. | |||||||||||||||||||||||||||||||||
| Short | Code defined by a terminology system | |||||||||||||||||||||||||||||||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | |||||||||||||||||||||||||||||||||
| Control | 10..* | |||||||||||||||||||||||||||||||||
| Type | Coding | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.lineItem.chargeItem[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 66. Invoice.lineItem.chargeItem[x].coding:ohip | ||||||||||||||||||||||||||||||||||
| Slice Name | ohip | |||||||||||||||||||||||||||||||||
| Definition | A reference to a code defined by a terminology system. | |||||||||||||||||||||||||||||||||
| Short | OHIP Schedule of Benefits fee codeCode defined by a terminology system | |||||||||||||||||||||||||||||||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | |||||||||||||||||||||||||||||||||
| Control | 0..1* | |||||||||||||||||||||||||||||||||
| Type | Coding | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 68. Invoice.lineItem.chargeItem[x].coding:ohip.system | ||||||||||||||||||||||||||||||||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | |||||||||||||||||||||||||||||||||
| Short | Identity of the terminology system | |||||||||||||||||||||||||||||||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | |||||||||||||||||||||||||||||||||
| Control | 10..1 | |||||||||||||||||||||||||||||||||
| Type | uri | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | |||||||||||||||||||||||||||||||||
| Fixed Value | https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 70. Invoice.lineItem.chargeItem[x].coding:ohip.code | ||||||||||||||||||||||||||||||||||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | |||||||||||||||||||||||||||||||||
| Short | Symbol in syntax defined by the system | |||||||||||||||||||||||||||||||||
| Control | 10..1 | |||||||||||||||||||||||||||||||||
| Type | code | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Need to refer to a particular code in the system. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 72. Invoice.lineItem.priceComponent | ||||||||||||||||||||||||||||||||||
| Definition | The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated. | |||||||||||||||||||||||||||||||||
| Short | Components of total line item price | |||||||||||||||||||||||||||||||||
| Control | 10..* | |||||||||||||||||||||||||||||||||
| Type | BackboneElement | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 74. Invoice.lineItem.priceComponent.modifierExtension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content, modifiers | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 76. Invoice.lineItem.priceComponent.type | ||||||||||||||||||||||||||||||||||
| Definition | This code identifies the type of the component. | |||||||||||||||||||||||||||||||||
| Short | base | surcharge | deduction | discount | tax | informational | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from InvoicePriceComponentTypehttp://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1 (required to http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1)Codes indicating the kind of the price component. | |||||||||||||||||||||||||||||||||
| Type | code | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 78. Invoice.lineItem.priceComponent.factor | ||||||||||||||||||||||||||||||||||
| Definition | The factor that has been applied on the base price for calculating this component. | |||||||||||||||||||||||||||||||||
| Short | Service count / quantity (billing_on_item.ser_num)Factor used for calculating this component | |||||||||||||||||||||||||||||||||
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | decimal | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 80. Invoice.lineItem.priceComponent.amount | ||||||||||||||||||||||||||||||||||
| Definition | The amount calculated for this component. | |||||||||||||||||||||||||||||||||
| Short | Fee amount (billing_on_item.fee, parsed from String)Monetary amount associated with this component | |||||||||||||||||||||||||||||||||
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Money | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 82. Invoice.totalGross | ||||||||||||||||||||||||||||||||||
| Definition | Invoice total, tax included. | |||||||||||||||||||||||||||||||||
| Short | Total gross amount (billing_on_cheader1.total)Gross total of this Invoice | |||||||||||||||||||||||||||||||||
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Money | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 84. Invoice.note | ||||||||||||||||||||||||||||||||||
| Definition | Comments made about the invoice by the issuer, subject, or other participants. | |||||||||||||||||||||||||||||||||
| Short | Free-text comment (billing_on_cheader1.comment1)Comments made about the invoice | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Annotation | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
Guidance on how to interpret the contents of this table can be foundhere
| 0. Invoice | ||||||||||||||||||||||||||||||||||
| Definition | Represents a Canadian provider-side billing record — the header and line items a physician
submits or records for services provided. Phase 1 sources from Oscar Pro's
| |||||||||||||||||||||||||||||||||
| Short | Polaris Invoice Core | |||||||||||||||||||||||||||||||||
| Invariants | invoice-has-polaris-id: 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()) | |||||||||||||||||||||||||||||||||
| 2. Invoice.id | ||||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 4. Invoice.meta | ||||||||||||||||||||||||||||||||||
| 6. Invoice.meta.source | ||||||||||||||||||||||||||||||||||
| Definition | A URI that identifies the EMR pipeline and version from which this resource originated. | |||||||||||||||||||||||||||||||||
| Short | Identifies EMR instance & pipeline version the resource came from | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 8. Invoice.text | ||||||||||||||||||||||||||||||||||
| Definition | A human-readable narrative summary of the Invoice. | |||||||||||||||||||||||||||||||||
| Short | Narrative | |||||||||||||||||||||||||||||||||
| 10. Invoice.extension | ||||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 12. Invoice.extension:oscarBillingStatus | ||||||||||||||||||||||||||||||||||
| Slice Name | oscarBillingStatus | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Extension(Oscar Billing Status Extension) (Extension Type: code) | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 14. Invoice.extension:shadowBill | ||||||||||||||||||||||||||||||||||
| Slice Name | shadowBill | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Extension(Shadow Bill Extension) (Extension Type: boolean) | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 16. Invoice.extension:payProgram | ||||||||||||||||||||||||||||||||||
| Slice Name | payProgram | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Extension(Pay Program Extension) (Extension Type: code) | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 18. Invoice.identifier | ||||||||||||||||||||||||||||||||||
| Definition | Identifiers for the invoice. At least one must use the Polaris invoice naming pattern. When a source EMR billing-header id exists (e.g. | |||||||||||||||||||||||||||||||||
| Short | Invoice identifiers (Polaris ID required) | |||||||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 20. Invoice.identifier:polarisId | ||||||||||||||||||||||||||||||||||
| Slice Name | polarisId | |||||||||||||||||||||||||||||||||
| Definition | The primary Polaris identifier for this invoice, following the standard Polaris naming pattern. | |||||||||||||||||||||||||||||||||
| Short | Polaris Invoice ID | |||||||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 22. Invoice.identifier:polarisId.use | ||||||||||||||||||||||||||||||||||
| Pattern Value | official | |||||||||||||||||||||||||||||||||
| 24. Invoice.identifier:polarisId.system | ||||||||||||||||||||||||||||||||||
| Short | Polaris invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier | |||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| 26. Invoice.identifier:polarisId.value | ||||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| 28. Invoice.identifier:rawCode | ||||||||||||||||||||||||||||||||||
| Slice Name | rawCode | |||||||||||||||||||||||||||||||||
| Definition | The original raw identifier(s) from the source EMR (e.g. | |||||||||||||||||||||||||||||||||
| Short | Source EMR invoice identifier | |||||||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 30. Invoice.identifier:rawCode.use | ||||||||||||||||||||||||||||||||||
| Pattern Value | secondary | |||||||||||||||||||||||||||||||||
| 32. Invoice.identifier:rawCode.system | ||||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| 34. Invoice.identifier:rawCode.value | ||||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| 36. Invoice.status | ||||||||||||||||||||||||||||||||||
| Definition | FHIR Oscar → FHIR status mapping (see oscar-to-fhir feature docs):
Current | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 38. Invoice.subject | ||||||||||||||||||||||||||||||||||
| Short | The patient who received the services | |||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| Type | Reference(Polaris Patient Core) | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 40. Invoice.date | ||||||||||||||||||||||||||||||||||
| Short | Billing date (maps to billing_on_cheader1.billing_date) | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 42. Invoice.participant | ||||||||||||||||||||||||||||||||||
| Short | Billing provider and related roles (billing, appointment, assistant, referring) | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 44. Invoice.participant.role | ||||||||||||||||||||||||||||||||||
| Short | billing | appointment | assistant | referring | etc. | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 46. Invoice.participant.actor | ||||||||||||||||||||||||||||||||||
| Type | Reference(Polaris Practitioner Core, Polaris PractitionerRole Core, Polaris Organization Core) | |||||||||||||||||||||||||||||||||
| 48. Invoice.issuer | ||||||||||||||||||||||||||||||||||
| Short | Organization issuing the invoice | |||||||||||||||||||||||||||||||||
| Type | Reference(Polaris Organization Core) | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 50. Invoice.lineItem | ||||||||||||||||||||||||||||||||||
| Definition | One line item per Note on OHIP submission: Oscar stores up to 3 dx codes per line as a product feature, but OHIP's H-file format allows only 1 dx per service line at submission time. Extra slots are preserved in FHIR for round-trip fidelity. | |||||||||||||||||||||||||||||||||
| Short | One line per billing service code | |||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 52. Invoice.lineItem.sequence | ||||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 54. Invoice.lineItem.chargeItem[x] | ||||||||||||||||||||||||||||||||||
| Definition | OHIP Schedule of Benefits fee code. Coding system should be | |||||||||||||||||||||||||||||||||
| Short | OHIP fee code (e.g. A007) | |||||||||||||||||||||||||||||||||
| Type | CodeableConcept, Reference(ChargeItem) | |||||||||||||||||||||||||||||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 56. Invoice.lineItem.chargeItem[x].coding | ||||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.lineItem.chargeItem[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 58. Invoice.lineItem.chargeItem[x].coding:ohip | ||||||||||||||||||||||||||||||||||
| Slice Name | ohip | |||||||||||||||||||||||||||||||||
| Short | OHIP Schedule of Benefits fee code | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 60. Invoice.lineItem.chargeItem[x].coding:ohip.system | ||||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| Fixed Value | https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits | |||||||||||||||||||||||||||||||||
| 62. Invoice.lineItem.chargeItem[x].coding:ohip.code | ||||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 64. Invoice.lineItem.priceComponent | ||||||||||||||||||||||||||||||||||
| Control | 1..? | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 66. Invoice.lineItem.priceComponent.type | ||||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 68. Invoice.lineItem.priceComponent.factor | ||||||||||||||||||||||||||||||||||
| Short | Service count / quantity (billing_on_item.ser_num) | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 70. Invoice.lineItem.priceComponent.amount | ||||||||||||||||||||||||||||||||||
| Short | Fee amount (billing_on_item.fee, parsed from String) | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 72. Invoice.totalGross | ||||||||||||||||||||||||||||||||||
| Short | Total gross amount (billing_on_cheader1.total) | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| 74. Invoice.note | ||||||||||||||||||||||||||||||||||
| Short | Free-text comment (billing_on_cheader1.comment1) | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
Guidance on how to interpret the contents of this table can be foundhere
| 0. Invoice | ||||||||||||||||||||||||||||||||||
| Definition | Represents a Canadian provider-side billing record — the header and line items a physician
submits or records for services provided. Phase 1 sources from Oscar Pro's
| |||||||||||||||||||||||||||||||||
| Short | Polaris Invoice Core | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists())invoice-has-polaris-id: 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()) | |||||||||||||||||||||||||||||||||
| 2. Invoice.id | ||||||||||||||||||||||||||||||||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |||||||||||||||||||||||||||||||||
| Short | Logical id of this artifact | |||||||||||||||||||||||||||||||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | id | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| 4. Invoice.meta | ||||||||||||||||||||||||||||||||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |||||||||||||||||||||||||||||||||
| Short | Metadata about the resource | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Meta | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 6. Invoice.meta.id | ||||||||||||||||||||||||||||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||||||||||||||||||||
| Short | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| 8. Invoice.meta.extension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||||||||||||||||||||||||||
| Short | Additional content defined by implementations | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 10. Invoice.meta.versionId | ||||||||||||||||||||||||||||||||||
| Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | |||||||||||||||||||||||||||||||||
| Short | Version specific identifier | |||||||||||||||||||||||||||||||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | id | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 12. Invoice.meta.lastUpdated | ||||||||||||||||||||||||||||||||||
| Definition | When the resource last changed - e.g. when the version changed. | |||||||||||||||||||||||||||||||||
| Short | When the resource version last changed | |||||||||||||||||||||||||||||||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | instant | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 14. Invoice.meta.source | ||||||||||||||||||||||||||||||||||
| Definition | A URI that identifies the EMR pipeline and version from which this resource originated. | |||||||||||||||||||||||||||||||||
| Short | Identifies EMR instance & pipeline version the resource came from | |||||||||||||||||||||||||||||||||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | uri | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 16. Invoice.meta.profile | ||||||||||||||||||||||||||||||||||
| Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | |||||||||||||||||||||||||||||||||
| Short | Profiles this resource claims to conform to | |||||||||||||||||||||||||||||||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | canonical(StructureDefinition) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 18. Invoice.meta.security | ||||||||||||||||||||||||||||||||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | |||||||||||||||||||||||||||||||||
| Short | Security Labels applied to this resource | |||||||||||||||||||||||||||||||||
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels)Security Labels from the Healthcare Privacy and Security Classification System. | |||||||||||||||||||||||||||||||||
| Type | Coding | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 20. Invoice.meta.tag | ||||||||||||||||||||||||||||||||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | |||||||||||||||||||||||||||||||||
| Short | Tags applied to this resource | |||||||||||||||||||||||||||||||||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||||||||||||||||||||||||||||||
| Type | Coding | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 22. Invoice.implicitRules | ||||||||||||||||||||||||||||||||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |||||||||||||||||||||||||||||||||
| Short | A set of rules under which this content was created | |||||||||||||||||||||||||||||||||
| Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | uri | |||||||||||||||||||||||||||||||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 24. Invoice.language | ||||||||||||||||||||||||||||||||||
| Definition | The base language in which the resource is written. | |||||||||||||||||||||||||||||||||
| Short | Language of the resource content | |||||||||||||||||||||||||||||||||
| Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages)A human language.
| |||||||||||||||||||||||||||||||||
| Type | code | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 26. Invoice.text | ||||||||||||||||||||||||||||||||||
| Definition | A human-readable narrative summary of the Invoice. | |||||||||||||||||||||||||||||||||
| Short | Narrative | |||||||||||||||||||||||||||||||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Narrative | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | narrative, html, xhtml, display | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 28. Invoice.contained | ||||||||||||||||||||||||||||||||||
| Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |||||||||||||||||||||||||||||||||
| Short | Contained, inline Resources | |||||||||||||||||||||||||||||||||
| Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Resource | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | inline resources, anonymous resources, contained resources | |||||||||||||||||||||||||||||||||
| 30. Invoice.extension | ||||||||||||||||||||||||||||||||||
| Definition | An Extension | |||||||||||||||||||||||||||||||||
| Short | Extension | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 32. Invoice.extension:oscarBillingStatus | ||||||||||||||||||||||||||||||||||
| Slice Name | oscarBillingStatus | |||||||||||||||||||||||||||||||||
| Definition | The raw Oscar Pro billing status code as stored in
Used in combination with (not instead of) FHIR | |||||||||||||||||||||||||||||||||
| Short | Raw Oscar billing status code | |||||||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||||||||||||||||||||||||||
| Type | Extension(Oscar Billing Status Extension) (Extension Type: code) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 34. Invoice.extension:shadowBill | ||||||||||||||||||||||||||||||||||
| Slice Name | shadowBill | |||||||||||||||||||||||||||||||||
| Definition | True when the Invoice represents a shadow bill — a capitated submission under Ontario's
FHO/FHN models where payment is via capitation and the bill is submitted for tracking and
utilization-reporting purposes only. Derived from Oscar Pro's When true, | |||||||||||||||||||||||||||||||||
| Short | Shadow bill indicator | |||||||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||||||||||||||||||||||||||
| Type | Extension(Shadow Bill Extension) (Extension Type: boolean) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 36. Invoice.extension:payProgram | ||||||||||||||||||||||||||||||||||
| Slice Name | payProgram | |||||||||||||||||||||||||||||||||
| Definition | The Oscar Pro pay_program code identifying the destination payer or program for this billing
record. Sourced from
See MTG-071 v2.4 §4 for context and additional notes. | |||||||||||||||||||||||||||||||||
| Short | Oscar pay program code | |||||||||||||||||||||||||||||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | |||||||||||||||||||||||||||||||||
| Type | Extension(Pay Program Extension) (Extension Type: code) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 38. Invoice.modifierExtension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 40. Invoice.identifier | ||||||||||||||||||||||||||||||||||
| Definition | Identifiers for the invoice. At least one must use the Polaris invoice naming pattern. When a source EMR billing-header id exists (e.g. | |||||||||||||||||||||||||||||||||
| Short | Invoice identifiers (Polaris ID required) | |||||||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||||||||||||||||||||||||||
| Control | 1..* | |||||||||||||||||||||||||||||||||
| Type | Identifier | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows Identification of this Invoice instance. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 42. Invoice.identifier:polarisId | ||||||||||||||||||||||||||||||||||
| Slice Name | polarisId | |||||||||||||||||||||||||||||||||
| Definition | The primary Polaris identifier for this invoice, following the standard Polaris naming pattern. | |||||||||||||||||||||||||||||||||
| Short | Polaris Invoice ID | |||||||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | Identifier | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows Identification of this Invoice instance. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 44. Invoice.identifier:polarisId.id | ||||||||||||||||||||||||||||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||||||||||||||||||||
| Short | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| 46. Invoice.identifier:polarisId.extension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||||||||||||||||||||||||||
| Short | Additional content defined by implementations | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 48. Invoice.identifier:polarisId.use | ||||||||||||||||||||||||||||||||||
| Definition | The purpose of this identifier. | |||||||||||||||||||||||||||||||||
| Short | usual | official | temp | secondary | old (If known) | |||||||||||||||||||||||||||||||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | |||||||||||||||||||||||||||||||||
| Type | code | |||||||||||||||||||||||||||||||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||||||||||||||||||||||||||||||||
| Pattern Value | official | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 50. Invoice.identifier:polarisId.type | ||||||||||||||||||||||||||||||||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||||||||||||||||||||||||||
| Short | Description of identifier | |||||||||||||||||||||||||||||||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||||||||||||||||||||||||||
| Type | CodeableConcept | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 52. Invoice.identifier:polarisId.system | ||||||||||||||||||||||||||||||||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||||||||||||||||||||||||||||||||
| Short | Polaris invoice identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-invoice-identifier | |||||||||||||||||||||||||||||||||
| Comments | Identifier.system is always case sensitive. | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | uri | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||||||||||||||||||||||||||||||||
| Example | General: http://www.acme.com/identifiers/patient | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 54. Invoice.identifier:polarisId.value | ||||||||||||||||||||||||||||||||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||||||||||||||||||||||||||||||||
| Short | The value that is unique | |||||||||||||||||||||||||||||||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Example | General: 123456 | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 56. Invoice.identifier:polarisId.period | ||||||||||||||||||||||||||||||||||
| Definition | Time period during which identifier is/was valid for use. | |||||||||||||||||||||||||||||||||
| Short | Time period when id is/was valid for use | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Period | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 58. Invoice.identifier:polarisId.assigner | ||||||||||||||||||||||||||||||||||
| Definition | Organization that issued/manages the identifier. | |||||||||||||||||||||||||||||||||
| Short | Organization that issued id (may be just text) | |||||||||||||||||||||||||||||||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Reference(Organization) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 60. Invoice.identifier:rawCode | ||||||||||||||||||||||||||||||||||
| Slice Name | rawCode | |||||||||||||||||||||||||||||||||
| Definition | The original raw identifier(s) from the source EMR (e.g. | |||||||||||||||||||||||||||||||||
| Short | Source EMR invoice identifier | |||||||||||||||||||||||||||||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Identifier | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows Identification of this Invoice instance. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 62. Invoice.identifier:rawCode.id | ||||||||||||||||||||||||||||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||||||||||||||||||||
| Short | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| 64. Invoice.identifier:rawCode.extension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||||||||||||||||||||||||||
| Short | Additional content defined by implementations | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 66. Invoice.identifier:rawCode.use | ||||||||||||||||||||||||||||||||||
| Definition | The purpose of this identifier. | |||||||||||||||||||||||||||||||||
| Short | usual | official | temp | secondary | old (If known) | |||||||||||||||||||||||||||||||||
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from IdentifierUse (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)Identifies the purpose for this identifier, if known . | |||||||||||||||||||||||||||||||||
| Type | code | |||||||||||||||||||||||||||||||||
| Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. | |||||||||||||||||||||||||||||||||
| Pattern Value | secondary | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 68. Invoice.identifier:rawCode.type | ||||||||||||||||||||||||||||||||||
| Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||||||||||||||||||||||||||
| Short | Description of identifier | |||||||||||||||||||||||||||||||||
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to http://hl7.org/fhir/ValueSet/identifier-type)A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||||||||||||||||||||||||||
| Type | CodeableConcept | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows users to make use of identifiers when the identifier system is not known. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 70. Invoice.identifier:rawCode.system | ||||||||||||||||||||||||||||||||||
| Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. | |||||||||||||||||||||||||||||||||
| Short | The namespace for the identifier value | |||||||||||||||||||||||||||||||||
| Comments | Identifier.system is always case sensitive. | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | uri | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. | |||||||||||||||||||||||||||||||||
| Example | General: http://www.acme.com/identifiers/patient | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 72. Invoice.identifier:rawCode.value | ||||||||||||||||||||||||||||||||||
| Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. | |||||||||||||||||||||||||||||||||
| Short | The value that is unique | |||||||||||||||||||||||||||||||||
| Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Example | General: 123456 | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 74. Invoice.identifier:rawCode.period | ||||||||||||||||||||||||||||||||||
| Definition | Time period during which identifier is/was valid for use. | |||||||||||||||||||||||||||||||||
| Short | Time period when id is/was valid for use | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Period | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 76. Invoice.identifier:rawCode.assigner | ||||||||||||||||||||||||||||||||||
| Definition | Organization that issued/manages the identifier. | |||||||||||||||||||||||||||||||||
| Short | Organization that issued id (may be just text) | |||||||||||||||||||||||||||||||||
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Reference(Organization) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 78. Invoice.status | ||||||||||||||||||||||||||||||||||
| Definition | FHIR Oscar → FHIR status mapping (see oscar-to-fhir feature docs):
Current | |||||||||||||||||||||||||||||||||
| Short | draft | issued | balanced | cancelled | entered-in-error | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from InvoiceStatus (required to http://hl7.org/fhir/ValueSet/invoice-status|4.0.1)Codes identifying the lifecycle stage of an Invoice. | |||||||||||||||||||||||||||||||||
| Type | code | |||||||||||||||||||||||||||||||||
| Is Modifier | true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 80. Invoice.cancelledReason | ||||||||||||||||||||||||||||||||||
| Definition | In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.). | |||||||||||||||||||||||||||||||||
| Short | Reason for cancellation of this Invoice | |||||||||||||||||||||||||||||||||
| Comments | Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 82. Invoice.type | ||||||||||||||||||||||||||||||||||
| Definition | Type of Invoice depending on domain, realm an usage (e.g. internal/external, dental, preliminary). | |||||||||||||||||||||||||||||||||
| Short | Type of Invoice | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | CodeableConcept | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Alternate Names | type | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 84. Invoice.subject | ||||||||||||||||||||||||||||||||||
| Definition | The individual or set of individuals receiving the goods and services billed in this invoice. | |||||||||||||||||||||||||||||||||
| Short | The patient who received the services | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | Reference(Polaris Patient Core) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Links the event to the Patient context. | |||||||||||||||||||||||||||||||||
| Alternate Names | patient | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 86. Invoice.recipient | ||||||||||||||||||||||||||||||||||
| Definition | The individual or Organization responsible for balancing of this invoice. | |||||||||||||||||||||||||||||||||
| Short | Recipient of this invoice | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Reference(Organization, Patient, RelatedPerson) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 88. Invoice.date | ||||||||||||||||||||||||||||||||||
| Definition | Date/time(s) of when this Invoice was posted. | |||||||||||||||||||||||||||||||||
| Short | Billing date (maps to billing_on_cheader1.billing_date) | |||||||||||||||||||||||||||||||||
| Comments | The list of types may be constrained as appropriate for the type of charge item. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | dateTime | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 90. Invoice.participant | ||||||||||||||||||||||||||||||||||
| Definition | Indicates who or what performed or participated in the charged service. | |||||||||||||||||||||||||||||||||
| Short | Billing provider and related roles (billing, appointment, assistant, referring) | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | BackboneElement | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 92. Invoice.participant.id | ||||||||||||||||||||||||||||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||||||||||||||||||||
| Short | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| 94. Invoice.participant.extension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||||||||||||||||||||||||||
| Short | Additional content defined by implementations | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 96. Invoice.participant.modifierExtension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content, modifiers | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 98. Invoice.participant.role | ||||||||||||||||||||||||||||||||||
| Definition | Describes the type of involvement (e.g. transcriptionist, creator etc.). If the invoice has been created automatically, the Participant may be a billing engine or another kind of device. | |||||||||||||||||||||||||||||||||
| Short | billing | appointment | assistant | referring | etc. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | CodeableConcept | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 100. Invoice.participant.actor | ||||||||||||||||||||||||||||||||||
| Definition | The device, practitioner, etc. who performed or participated in the service. | |||||||||||||||||||||||||||||||||
| Short | Individual who was involved | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | Reference(Polaris Practitioner Core, Polaris PractitionerRole Core, Polaris Organization Core) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 102. Invoice.issuer | ||||||||||||||||||||||||||||||||||
| Definition | The organizationissuing the Invoice. | |||||||||||||||||||||||||||||||||
| Short | Organization issuing the invoice | |||||||||||||||||||||||||||||||||
| Comments | Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Reference(Polaris Organization Core) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 104. Invoice.account | ||||||||||||||||||||||||||||||||||
| Definition | Account which is supposed to be balanced with this Invoice. | |||||||||||||||||||||||||||||||||
| Short | Account that is being balanced | |||||||||||||||||||||||||||||||||
| Comments | Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the potprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Reference(Account) | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 106. Invoice.lineItem | ||||||||||||||||||||||||||||||||||
| Definition | One line item per Note on OHIP submission: Oscar stores up to 3 dx codes per line as a product feature, but OHIP's H-file format allows only 1 dx per service line at submission time. Extra slots are preserved in FHIR for round-trip fidelity. | |||||||||||||||||||||||||||||||||
| Short | One line per billing service code | |||||||||||||||||||||||||||||||||
| Control | 1..* | |||||||||||||||||||||||||||||||||
| Type | BackboneElement | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 108. Invoice.lineItem.id | ||||||||||||||||||||||||||||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||||||||||||||||||||
| Short | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| 110. Invoice.lineItem.extension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||||||||||||||||||||||||||
| Short | Additional content defined by implementations | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 112. Invoice.lineItem.modifierExtension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content, modifiers | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 114. Invoice.lineItem.sequence | ||||||||||||||||||||||||||||||||||
| Definition | Sequence in which the items appear on the invoice. | |||||||||||||||||||||||||||||||||
| Short | Sequence number of line item | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | positiveInt | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 116. Invoice.lineItem.chargeItem[x] | ||||||||||||||||||||||||||||||||||
| Definition | OHIP Schedule of Benefits fee code. Coding system should be | |||||||||||||||||||||||||||||||||
| Short | OHIP fee code (e.g. A007) | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | CodeableConcept | |||||||||||||||||||||||||||||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 118. Invoice.lineItem.chargeItem[x].id | ||||||||||||||||||||||||||||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||||||||||||||||||||
| Short | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| 120. Invoice.lineItem.chargeItem[x].extension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||||||||||||||||||||||||||
| Short | Additional content defined by implementations | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.lineItem.chargeItem[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 122. Invoice.lineItem.chargeItem[x].coding | ||||||||||||||||||||||||||||||||||
| Definition | A reference to a code defined by a terminology system. | |||||||||||||||||||||||||||||||||
| Short | Code defined by a terminology system | |||||||||||||||||||||||||||||||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | |||||||||||||||||||||||||||||||||
| Control | 1..* | |||||||||||||||||||||||||||||||||
| Type | Coding | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.lineItem.chargeItem[x].coding. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 124. Invoice.lineItem.chargeItem[x].coding:ohip | ||||||||||||||||||||||||||||||||||
| Slice Name | ohip | |||||||||||||||||||||||||||||||||
| Definition | A reference to a code defined by a terminology system. | |||||||||||||||||||||||||||||||||
| Short | OHIP Schedule of Benefits fee code | |||||||||||||||||||||||||||||||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Coding | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 126. Invoice.lineItem.chargeItem[x].coding:ohip.id | ||||||||||||||||||||||||||||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||||||||||||||||||||
| Short | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| 128. Invoice.lineItem.chargeItem[x].coding:ohip.extension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||||||||||||||||||||||||||
| Short | Additional content defined by implementations | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| Slicing | This element introduces a set of slices on Invoice.lineItem.chargeItem[x].coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | |||||||||||||||||||||||||||||||||
| 130. Invoice.lineItem.chargeItem[x].coding:ohip.system | ||||||||||||||||||||||||||||||||||
| Definition | The identification of the code system that defines the meaning of the symbol in the code. | |||||||||||||||||||||||||||||||||
| Short | Identity of the terminology system | |||||||||||||||||||||||||||||||||
| Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | uri | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Need to be unambiguous about the source of the definition of the symbol. | |||||||||||||||||||||||||||||||||
| Fixed Value | https://fhir.apps.health/CodeSystem/on-ohip-schedule-of-benefits | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 132. Invoice.lineItem.chargeItem[x].coding:ohip.version | ||||||||||||||||||||||||||||||||||
| Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | |||||||||||||||||||||||||||||||||
| Short | Version of the system - if relevant | |||||||||||||||||||||||||||||||||
| Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | |||||||||||||||||||||||||||||||||
| Note | This is a business version Id, not a resource version Id (see discussion) | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 134. Invoice.lineItem.chargeItem[x].coding:ohip.code | ||||||||||||||||||||||||||||||||||
| Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | |||||||||||||||||||||||||||||||||
| Short | Symbol in syntax defined by the system | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Type | code | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Need to refer to a particular code in the system. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 136. Invoice.lineItem.chargeItem[x].coding:ohip.display | ||||||||||||||||||||||||||||||||||
| Definition | A representation of the meaning of the code in the system, following the rules of the system. | |||||||||||||||||||||||||||||||||
| Short | Representation defined by the system | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 138. Invoice.lineItem.chargeItem[x].coding:ohip.userSelected | ||||||||||||||||||||||||||||||||||
| Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | |||||||||||||||||||||||||||||||||
| Short | If this coding was chosen directly by the user | |||||||||||||||||||||||||||||||||
| Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | boolean | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 140. Invoice.lineItem.chargeItem[x].text | ||||||||||||||||||||||||||||||||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | |||||||||||||||||||||||||||||||||
| Short | Plain text representation of the concept | |||||||||||||||||||||||||||||||||
| Comments | Very often the text is the same as a displayName of one of the codings. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 142. Invoice.lineItem.priceComponent | ||||||||||||||||||||||||||||||||||
| Definition | The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice as to how the prices have been calculated. | |||||||||||||||||||||||||||||||||
| Short | Components of total line item price | |||||||||||||||||||||||||||||||||
| Control | 1..* | |||||||||||||||||||||||||||||||||
| Type | BackboneElement | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 144. Invoice.lineItem.priceComponent.id | ||||||||||||||||||||||||||||||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||||||||||||||||||||||||||||||
| Short | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | string | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| XML Format | In the XML format, this property is represented as an attribute. | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| 146. Invoice.lineItem.priceComponent.extension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |||||||||||||||||||||||||||||||||
| Short | Additional content defined by implementations | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 148. Invoice.lineItem.priceComponent.modifierExtension | ||||||||||||||||||||||||||||||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |||||||||||||||||||||||||||||||||
| Short | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||||||||
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Extension | |||||||||||||||||||||||||||||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | |||||||||||||||||||||||||||||||||
| Alternate Names | extensions, user content, modifiers | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | |||||||||||||||||||||||||||||||||
| 150. Invoice.lineItem.priceComponent.type | ||||||||||||||||||||||||||||||||||
| Definition | This code identifies the type of the component. | |||||||||||||||||||||||||||||||||
| Short | base | surcharge | deduction | discount | tax | informational | |||||||||||||||||||||||||||||||||
| Control | 1..1 | |||||||||||||||||||||||||||||||||
| Binding | The codes SHALL be taken from InvoicePriceComponentType (required to http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1)Codes indicating the kind of the price component. | |||||||||||||||||||||||||||||||||
| Type | code | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 152. Invoice.lineItem.priceComponent.code | ||||||||||||||||||||||||||||||||||
| Definition | A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. | |||||||||||||||||||||||||||||||||
| Short | Code identifying the specific component | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | CodeableConcept | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 154. Invoice.lineItem.priceComponent.factor | ||||||||||||||||||||||||||||||||||
| Definition | The factor that has been applied on the base price for calculating this component. | |||||||||||||||||||||||||||||||||
| Short | Service count / quantity (billing_on_item.ser_num) | |||||||||||||||||||||||||||||||||
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | decimal | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 156. Invoice.lineItem.priceComponent.amount | ||||||||||||||||||||||||||||||||||
| Definition | The amount calculated for this component. | |||||||||||||||||||||||||||||||||
| Short | Fee amount (billing_on_item.fee, parsed from String) | |||||||||||||||||||||||||||||||||
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Money | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 158. Invoice.totalPriceComponent | ||||||||||||||||||||||||||||||||||
| Definition | The total amount for the Invoice may be calculated as the sum of the line items with surcharges/deductions that apply in certain conditions. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the total price was calculated. | |||||||||||||||||||||||||||||||||
| Short | Components of Invoice total | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Seettp://hl7.org/fhir/StructureDefinition/Invoice#Invoice.lineItem.priceComponent | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 160. Invoice.totalNet | ||||||||||||||||||||||||||||||||||
| Definition | Invoice total , taxes excluded. | |||||||||||||||||||||||||||||||||
| Short | Net total of this Invoice | |||||||||||||||||||||||||||||||||
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Money | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 162. Invoice.totalGross | ||||||||||||||||||||||||||||||||||
| Definition | Invoice total, tax included. | |||||||||||||||||||||||||||||||||
| Short | Total gross amount (billing_on_cheader1.total) | |||||||||||||||||||||||||||||||||
| Comments | There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | Money | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | true | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 164. Invoice.paymentTerms | ||||||||||||||||||||||||||||||||||
| Definition | Payment details such as banking details, period of payment, deductibles, methods of payment. | |||||||||||||||||||||||||||||||||
| Short | Payment details | |||||||||||||||||||||||||||||||||
| Comments | Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled. | |||||||||||||||||||||||||||||||||
| Control | 0..1 | |||||||||||||||||||||||||||||||||
| Type | markdown | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||
| 166. Invoice.note | ||||||||||||||||||||||||||||||||||
| Definition | Comments made about the invoice by the issuer, subject, or other participants. | |||||||||||||||||||||||||||||||||
| Short | Free-text comment (billing_on_cheader1.comment1) | |||||||||||||||||||||||||||||||||
| Control | 0..* | |||||||||||||||||||||||||||||||||
| Type | Annotation | |||||||||||||||||||||||||||||||||
| Is Modifier | false | |||||||||||||||||||||||||||||||||
| Must Support | true | |||||||||||||||||||||||||||||||||
| Summary | false | |||||||||||||||||||||||||||||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | |||||||||||||||||||||||||||||||||