Invoice Profile¶
| Canonical | ../StructureDefinition/nexus-emr-core-invoice |
|---|---|
| Status | draft · 1.26.0 |
| Base | Invoice (constraint) |
| CQL primary code path | type — what this means |
| Source | FSH · 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 / Snapshot
The full effective definition: base Invoice with this profile's constraints applied.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Invoice | 0..* | Nexus EMR Invoice Core Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, nexus-note-extension-not-where-native |
||
| id | S | 0..1 | http://hl7.org/fhirpath/System.String | Logical id of this artifact i |
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| versionId | 0..1 | id | Version specific identifier i Invariants: ele-1 |
|
| lastUpdated | 0..1 | instant | When the resource version last changed i Invariants: ele-1 |
|
| source | S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from i Invariants: ele-1 |
| profile | 0..* | canonical | Profiles this resource claims to conform to i Invariants: ele-1 |
|
| security | 0..* | Coding | Security Labels applied to this resource i Binding: security-labels ( extensible)Invariants: ele-1 |
|
| tag | 0..* | Coding | Tags applied to this resource i Binding: common-tags ( example)Invariants: ele-1 |
|
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| language | 0..1 | code | Language of the resource content i Binding: languages ( preferred)Invariants: ele-1 |
|
| text | 0..1 | Narrative | Narrative i Invariants: ele-1 |
|
| contained | 0..* | Resource | Contained, inline Resources i | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:oscarBillingStatus | S | 0..1 | Extension(Oscar Billing Status Extension) | Additional content defined by implementations i Invariants: ele-1, ext-1 |
| extension:shadowBill | S | 0..1 | Extension(Shadow Bill Extension) | Additional content defined by implementations i Invariants: ele-1, ext-1 |
| extension:serviceLocation | S | 0..1 | Extension(Invoice Service Location Extension) | Additional content defined by implementations i Invariants: ele-1, ext-1 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored i Invariants: ele-1, ext-1 |
| identifier | S | 0..* | Identifier | Invoice identifier(s) (recommended; any system) i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| use | ?! | 0..1 | code | usual | official | temp | secondary | old (If known) i Binding: identifier-use ( required)Invariants: ele-1 |
| type | 0..1 | CodeableConcept | Description of identifier i Binding: identifier-type ( extensible)Invariants: ele-1 |
|
| system | 1..1 | uri | The namespace for the identifier value i Invariants: ele-1 |
|
| value | 1..1 | string | The value that is unique i Invariants: ele-1 |
|
| period | 0..1 | Period | Time period when id is/was valid for use Invariants: ele-1 |
|
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) i Invariants: ele-1 |
|
| status | S ?! | 1..1 | code | draft | issued | balanced | cancelled | entered-in-error Binding: invoice-status ( required)Invariants: ele-1 |
| cancelledReason | 0..1 | string | Reason for cancellation of this Invoice i Invariants: ele-1 |
|
| type | S | 0..1 | CodeableConcept | Type of invoice — carries pay_program coding for Canadian billing Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| coding | S | 1..* | Coding | Code defined by a terminology system i Slicing: value:system (open) Invariants: ele-1 |
| coding:payProgram | S | 0..1 | Coding | The payment program the invoice is billed under i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 1..1 | uri | Identity of the terminology system i Fixed: ../CodeSystem/oscar-pay-program-csInvariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | S | 1..1 | code | Symbol in syntax defined by the system Binding: Oscar Pay Program Value Set ( extensible)e.g. HCP · RMB · PAT …Invariants: ele-1 |
| display | 0..1 | string | Representation defined by the system Invariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| text | 0..1 | string | Plain text representation of the concept i Invariants: ele-1 |
|
| subject | S | 1..1 | Reference(Patient Profile) | The patient who received the services Invariants: ele-1 |
| recipient | 0..1 | Reference(Organization | Patient | RelatedPerson) | Recipient of this invoice Invariants: ele-1 |
|
| date | S | 0..1 | dateTime | Billing date i Invariants: ele-1 |
| participant | S | 0..* | BackboneElement | Billing provider and related roles (billing, appointment, assistant, referring) Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| role | S | 0..1 | CodeableConcept | billing | appointment | assistant | referring | etc. Invariants: ele-1 |
| actor | 1..1 | Reference(Practitioner Profile | PractitionerRole Profile | Organization Profile) | Individual who was involved Invariants: ele-1 |
|
| issuer | S | 0..1 | Reference(Organization Profile) | Organization issuing the invoice i Invariants: ele-1 |
| account | 0..1 | Reference(Account) | Account that is being balanced i Invariants: ele-1 |
|
| lineItem | S | 1..* | BackboneElement | One line per billing service code Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| sequence | S | 1..1 | positiveInt | Sequence number of line item Invariants: ele-1 |
| chargeItem[x] | S | 1..1 | CodeableConcept | OHIP fee code (e.g. A007) Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| coding | S | 1..* | Coding | Code defined by a terminology system i Slicing: value:system (open) Invariants: ele-1 |
| coding:ohip | S | 0..1 | Coding | OHIP Schedule of Benefits fee code i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 1..1 | uri | Identity of the terminology system i Fixed: ../CodeSystem/on-ohip-schedule-of-benefitsInvariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | S | 1..1 | code | Symbol in syntax defined by the system Invariants: ele-1 |
| display | 0..1 | string | Representation defined by the system Invariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| text | 0..1 | string | Plain text representation of the concept i Invariants: ele-1 |
|
| priceComponent | S | 1..* | BackboneElement | Components of total line item price Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| type | S | 1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: invoice-priceComponentType ( required)Invariants: ele-1 |
| code | 0..1 | CodeableConcept | Code identifying the specific component Invariants: ele-1 |
|
| factor | S | 0..1 | decimal | Service count / quantity i Invariants: ele-1 |
| amount | S | 0..1 | Money | Fee amount i Invariants: ele-1 |
| totalPriceComponent | 0..* | Components of Invoice total Invariants: ele-1 |
||
| totalNet | 0..1 | Money | Net total of this Invoice i Invariants: ele-1 |
|
| totalGross | S | 0..1 | Money | Total gross amount i Invariants: ele-1 |
| paymentTerms | 0..1 | markdown | Payment details i Invariants: ele-1 |
|
| note | S | 0..* | Annotation | Free-text comment Invariants: ele-1 |