Skip to content

Invoice Profile

Canonical../StructureDefinition/nexus-emr-core-invoice
Statusdraft · 1.26.0
BaseInvoice (constraint)
CQL primary code pathtypewhat this means
SourceFSH · JSON

Nexus EMR profile for Invoice representing Canadian provider-side billing records. Aligned with Oscar Pro's billing model: one invoice per claim header, with its line items inline. Phase 1 scope: Ontario OHIP billing via Oscar Pro.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

Invoice

Short Nexus EMR Invoice Core
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 a claim header and its line items. Covers OHIP FFS claims, FHO/FHN shadow bills, third-party / patient-pay billing, WCB submissions, and bonus codes.
Cardinality 0..*
Invariants dom-2, dom-3, dom-4, dom-5, dom-6, nexus-note-extension-not-where-native

Invoice.id

Short Logical id of this artifact
Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String
Must Support yes

Invoice.meta

Short Metadata about the resource
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.
Cardinality 0..1
Type Meta
Invariants ele-1

Invoice.meta.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Invoice.meta.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.meta.versionId

Short Version specific identifier
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.
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.
Cardinality 0..1
Type id
Invariants ele-1

Invoice.meta.lastUpdated

Short When the resource version last changed
Definition When the resource last changed - e.g. when the version 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.
Cardinality 0..1
Type instant
Invariants ele-1

Invoice.meta.source

Short Identifies EMR instance & pipeline version the resource came from
Definition A URI that identifies the EMR pipeline and version from which this resource originated.
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.
Cardinality 0..1
Type uri
Must Support yes
Invariants ele-1

Invoice.meta.profile

Short Profiles this resource claims to conform to
Definition A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
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.
Cardinality 0..*
Type canonical
Invariants ele-1

Invoice.meta.security

Short Security Labels applied to this resource
Definition Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
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.
Cardinality 0..*
Type Coding
Binding security-labels (extensible)
Invariants ele-1

Invoice.meta.tag

Short Tags applied to this resource
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.
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.
Cardinality 0..*
Type Coding
Binding common-tags (example)
Invariants ele-1

Invoice.implicitRules

Short A set of rules under which this content was created
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.
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.
Cardinality 0..1
Type uri
Modifier yes — 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
Invariants ele-1

Invoice.language

Short Language of the resource content
Definition The base language in which the resource is written.
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).
Cardinality 0..1
Type code
Binding languages (preferred)
Invariants ele-1

Invoice.text

Short Narrative
Definition A human-readable narrative summary of the Invoice.
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.
Cardinality 0..1
Type Narrative
Invariants ele-1
Also called narrative, html, xhtml, display

Invoice.contained

Short Contained, inline Resources
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.
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.
Cardinality 0..*
Type Resource
Also called inline resources, anonymous resources, contained resources

Invoice.extension

Short Additional content defined by implementations
Definition 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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.extension:oscarBillingStatus

Short Additional content defined by implementations
Definition 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.
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.
Cardinality 0..1
Type Extension(Oscar Billing Status Extension)
Must Support yes
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.extension:shadowBill

Short Additional content defined by implementations
Definition 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.
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.
Cardinality 0..1
Type Extension(Shadow Bill Extension)
Must Support yes
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.extension:serviceLocation

Short Additional content defined by implementations
Definition 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.
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.
Cardinality 0..1
Type Extension(Invoice Service Location Extension)
Must Support yes
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.modifierExtension

Short Extensions that cannot be ignored
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).
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.
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.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.identifier

Short Invoice identifier(s) (recommended; any system)
Definition Identifiers for the invoice. A business identifier is recommended but not required; no specific canonical system is mandated.
Requirements Allows Identification of this Invoice instance.
Comments A source system's own identifier SHOULD be carried alongside this one, flagged use = secondary. See Carrying the raw code.
Cardinality 0..*
Type Identifier
Must Support yes
Invariants ele-1

Invoice.identifier.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Invoice.identifier.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.identifier.use

Short usual | official | temp | secondary | old (If known)
Definition The purpose of this identifier.
Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Cardinality 0..1
Type code
Modifier yes — This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Binding identifier-use (required)
Invariants ele-1

Invoice.identifier.type

Short Description of identifier
Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Requirements Allows users to make use of identifiers when the identifier system is not known.
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.
Cardinality 0..1
Type CodeableConcept
Binding identifier-type (extensible)
Invariants ele-1

Invoice.identifier.system

Short The namespace for the identifier value
Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
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.
Comments Identifier.system is always case sensitive.
Cardinality 1..1
Type uri
Invariants ele-1

Invoice.identifier.value

Short The value that is unique
Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system.
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.
Cardinality 1..1
Type string
Invariants ele-1

Invoice.identifier.period

Short Time period when id is/was valid for use
Definition Time period during which identifier is/was valid for use.
Cardinality 0..1
Type Period
Invariants ele-1

Invoice.identifier.assigner

Short Organization that issued id (may be just text)
Definition Organization that issued/manages the identifier.
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.
Cardinality 0..1
Type Reference(Organization)
Invariants ele-1

Invoice.status

Short draft | issued | balanced | cancelled | entered-in-error
Definition FHIR InvoiceStatus. Required binding — cannot carry raw Oscar status codes directly. Use the oscar-billing-status-extension on this invoice to preserve the 10-code Oscar enum. Oscar → FHIR status mapping (see oscar-to-fhir feature docs): | Oscar | FHIR Invoice.status | Notes | |---|---|---| | O (Bill OHIP) | issued | | | P (Bill Patient) | issued | + payProgram extension | | W (Bill WCB) | issued | + payProgram=WCB | | B (Submitted OHIP) | issued | awaiting adjudication | | X (Bad Debt) | cancelled | + oscarBillingStatus=X | | H (Capitated) | balanced | + shadowBill=true | | I (Bonus Codes) | issued | + oscarBillingStatus=I | | S (Settled) | balanced | | | D (Deleted) | cancelled | | | N (Do Not Bill) | entered-in-error | | The table is the contract. A reader meeting an Invoice whose status does not match the source status it was converted from is meeting a converter that has not caught up, and should read the table rather than the value.
Cardinality 1..1
Type code
Must Support yes
Modifier yes — 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
Binding invoice-status (required)
Invariants ele-1

Invoice.cancelledReason

Short Reason for cancellation of this Invoice
Definition In case of Invoice cancellation a reason must be given (entered in error, superseded by corrected invoice etc.).
Comments Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.
Cardinality 0..1
Type string
Invariants ele-1

Invoice.type

Short Type of invoice — carries pay_program coding for Canadian billing
Definition FHIR Invoice.type carries the destination payer / program classification for a bill. In 1.9.8 this lived on a custom payProgram extension; 1.9.9 migrated it to Invoice.type.coding using the same OscarPayProgramCS code system so FHIR consumers can read it without unpacking a custom extension. The extensible binding permits additional coding systems alongside the Oscar coding (e.g. future AHCIP/MSP payer program codes).
Cardinality 0..1
Type CodeableConcept
Must Support yes
Invariants ele-1
Also called type

Invoice.type.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Invoice.type.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.type.coding

Short Code defined by a terminology system
Definition A reference to a code defined by a terminology system.
Requirements Allows for alternative encodings within a code system, and translations to other code systems.
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.
Cardinality 1..*
Type Coding
Must Support yes
Invariants ele-1

Invoice.type.coding:payProgram

Short The payment program the invoice is billed under
Definition A reference to a code defined by a terminology system.
Requirements Allows for alternative encodings within a code system, and translations to other code systems.
Comments Carries the OSCAR pay_program code.
Cardinality 0..1
Type Coding
Must Support yes
Invariants ele-1

Invoice.type.coding:payProgram.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Invoice.type.coding:payProgram.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.type.coding:payProgram.system

Short Identity of the terminology system
Definition The identification of the code system that defines the meaning of the symbol in the code.
Requirements Need to be unambiguous about the source of the definition of the symbol.
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.
Cardinality 1..1
Type uri
Fixed value ../CodeSystem/oscar-pay-program-cs
Invariants ele-1

Invoice.type.coding:payProgram.version

Short Version of the system - if relevant
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.
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.
Cardinality 0..1
Type string
Invariants ele-1

Invoice.type.coding:payProgram.code

Short Symbol in syntax defined by the system
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).
Requirements Need to refer to a particular code in the system.
Cardinality 1..1
Type code
Must Support yes
Binding Oscar Pay Program Value Set (extensible)
Invariants ele-1

Invoice.type.coding:payProgram.display

Short Representation defined by the system
Definition A representation of the meaning of the code in the system, following the rules of the system.
Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Cardinality 0..1
Type string
Invariants ele-1

Invoice.type.coding:payProgram.userSelected

Short If this coding was chosen directly by the user
Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
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.
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.
Cardinality 0..1
Type boolean
Invariants ele-1

Invoice.type.text

Short Plain text representation of the concept
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.
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.
Comments Very often the text is the same as a displayName of one of the codings.
Cardinality 0..1
Type string
Invariants ele-1

Invoice.subject

Short The patient who received the services
Definition The individual or set of individuals receiving the goods and services billed in this invoice.
Requirements Links the event to the Patient context.
Cardinality 1..1
Type Reference(Patient Profile)
Must Support yes
Invariants ele-1
Also called patient

Invoice.recipient

Short Recipient of this invoice
Definition The individual or Organization responsible for balancing of this invoice.
Cardinality 0..1
Type Reference(Organization | Patient | RelatedPerson)
Invariants ele-1

Invoice.date

Short Billing date
Definition Date/time(s) of when this Invoice was posted.
Comments The list of types may be constrained as appropriate for the type of charge item.
Cardinality 0..1
Type dateTime
Must Support yes
Invariants ele-1

Invoice.participant

Short Billing provider and related roles (billing, appointment, assistant, referring)
Definition Indicates who or what performed or participated in the charged service.
Cardinality 0..*
Type BackboneElement
Must Support yes
Invariants ele-1

Invoice.participant.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Invoice.participant.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.participant.modifierExtension

Short Extensions that cannot be ignored even if unrecognized
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).
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.
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.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Invariants ele-1, ext-1
Also called extensions, user content, modifiers

Invoice.participant.role

Short billing | appointment | assistant | referring | etc.
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.
Cardinality 0..1
Type CodeableConcept
Must Support yes
Invariants ele-1

Invoice.participant.actor

Short Individual who was involved
Definition The device, practitioner, etc. who performed or participated in the service.
Cardinality 1..1
Type Reference(Practitioner Profile | PractitionerRole Profile | Organization Profile)
Invariants ele-1

Invoice.issuer

Short Organization issuing the invoice
Definition The organizationissuing 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.
Cardinality 0..1
Type Reference(Organization Profile)
Must Support yes
Invariants ele-1

Invoice.account

Short Account that is being balanced
Definition Account which is supposed to be balanced with this Invoice.
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.
Cardinality 0..1
Type Reference(Account)
Invariants ele-1

Invoice.lineItem

Short One line per billing service code
Definition One line item per billed service. Each line carries an OHIP fee code (chargeItemCodeableConcept), a price component (fee amount + quantity), and up to three diagnostic code extensions (DIAGNOSTIC_1 / DIAGNOSTIC_2 / DIAGNOSTIC_3). 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.
Cardinality 1..*
Type BackboneElement
Must Support yes
Invariants ele-1

Invoice.lineItem.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Invoice.lineItem.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.lineItem.modifierExtension

Short Extensions that cannot be ignored even if unrecognized
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).
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.
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.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Invariants ele-1, ext-1
Also called extensions, user content, modifiers

Invoice.lineItem.sequence

Short Sequence number of line item
Definition Sequence in which the items appear on the invoice.
Cardinality 1..1
Type positiveInt
Must Support yes
Invariants ele-1

Invoice.lineItem.chargeItem[x]

Short OHIP fee code (e.g. A007)
Definition OHIP Schedule of Benefits fee code. Coding system should be $OhipSoB for Phase 1 Ontario bills.
Cardinality 1..1
Type CodeableConcept
Must Support yes
Invariants ele-1

Invoice.lineItem.chargeItem[x].id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Invoice.lineItem.chargeItem[x].extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.lineItem.chargeItem[x].coding

Short Code defined by a terminology system
Definition A reference to a code defined by a terminology system.
Requirements Allows for alternative encodings within a code system, and translations to other code systems.
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.
Cardinality 1..*
Type Coding
Must Support yes
Invariants ele-1

Invoice.lineItem.chargeItem[x].coding:ohip

Short OHIP Schedule of Benefits fee code
Definition A reference to a code defined by a terminology system.
Requirements Allows for alternative encodings within a code system, and translations to other code systems.
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.
Cardinality 0..1
Type Coding
Must Support yes
Invariants ele-1

Invoice.lineItem.chargeItem[x].coding:ohip.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Invoice.lineItem.chargeItem[x].coding:ohip.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.lineItem.chargeItem[x].coding:ohip.system

Short Identity of the terminology system
Definition The identification of the code system that defines the meaning of the symbol in the code.
Requirements Need to be unambiguous about the source of the definition of the symbol.
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.
Cardinality 1..1
Type uri
Fixed value ../CodeSystem/on-ohip-schedule-of-benefits
Invariants ele-1

Invoice.lineItem.chargeItem[x].coding:ohip.version

Short Version of the system - if relevant
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.
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.
Cardinality 0..1
Type string
Invariants ele-1

Invoice.lineItem.chargeItem[x].coding:ohip.code

Short Symbol in syntax defined by the system
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).
Requirements Need to refer to a particular code in the system.
Cardinality 1..1
Type code
Must Support yes
Invariants ele-1

Invoice.lineItem.chargeItem[x].coding:ohip.display

Short Representation defined by the system
Definition A representation of the meaning of the code in the system, following the rules of the system.
Requirements Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
Cardinality 0..1
Type string
Invariants ele-1

Invoice.lineItem.chargeItem[x].coding:ohip.userSelected

Short If this coding was chosen directly by the user
Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
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.
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.
Cardinality 0..1
Type boolean
Invariants ele-1

Invoice.lineItem.chargeItem[x].text

Short Plain text representation of the concept
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.
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.
Comments Very often the text is the same as a displayName of one of the codings.
Cardinality 0..1
Type string
Invariants ele-1

Invoice.lineItem.priceComponent

Short Components of total line item price
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.
Cardinality 1..*
Type BackboneElement
Must Support yes
Invariants ele-1

Invoice.lineItem.priceComponent.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Invoice.lineItem.priceComponent.extension

Short Additional content defined by implementations
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.
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.
Cardinality 0..*
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Invoice.lineItem.priceComponent.modifierExtension

Short Extensions that cannot be ignored even if unrecognized
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).
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.
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.
Cardinality 0..*
Type Extension
Modifier yes — Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Invariants ele-1, ext-1
Also called extensions, user content, modifiers

Invoice.lineItem.priceComponent.type

Short base | surcharge | deduction | discount | tax | informational
Definition This code identifies the type of the component.
Cardinality 1..1
Type code
Must Support yes
Binding invoice-priceComponentType (required)
Invariants ele-1

Invoice.lineItem.priceComponent.code

Short Code identifying the specific component
Definition A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
Cardinality 0..1
Type CodeableConcept
Invariants ele-1

Invoice.lineItem.priceComponent.factor

Short Service count / quantity
Definition The factor that has been applied on the base price 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.
Cardinality 0..1
Type decimal
Must Support yes
Invariants ele-1

Invoice.lineItem.priceComponent.amount

Short Fee amount
Definition The amount calculated for 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.
Cardinality 0..1
Type Money
Must Support yes
Invariants ele-1

Invoice.totalPriceComponent

Short Components of Invoice total
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.
Cardinality 0..*
Invariants ele-1

Invoice.totalNet

Short Net total of this Invoice
Definition Invoice total , taxes excluded.
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.
Cardinality 0..1
Type Money
Invariants ele-1

Invoice.totalGross

Short Total gross amount
Definition Invoice total, tax included.
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.
Cardinality 0..1
Type Money
Must Support yes
Invariants ele-1

Invoice.paymentTerms

Short Payment details
Definition Payment details such as banking details, period of payment, deductibles, methods of payment.
Comments Derived Profiles may chose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.
Cardinality 0..1
Type markdown
Invariants ele-1

Invoice.note

Short Free-text comment
Definition Comments made about the invoice by the issuer, subject, or other participants.
Cardinality 0..*
Type Annotation
Must Support yes
Invariants ele-1