1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
//! Invoice
//!
//! URL: http://hl7.org/fhir/StructureDefinition/Invoice
//!
//! Version: 5.0.0
//!
//! Invoice Resource: Invoice containing collected ChargeItems from an Account with calculated individual and total price for Billing purpose.
//!
//! FHIR: <https://build.fhir.org/>
//!
//! UML: <https://build.fhir.org/uml.html>
// Allow unused crate::r5::types as types;
#![allow(unused_imports)]
use crate::r5::types;
use ::serde::{Deserialize, Serialize};
use fhir_derive_macros::Validate;
/// Invoice containing collected ChargeItems from an Account with calculated
/// individual and total price for Billing purpose.
///
/// The Invoice resource represents a formal statement of financial charges
/// issued to a subject or organization. It aggregates individual ChargeItem
/// entries drawn from an [`Account`](crate::r5::resources::account::Account)
/// into discrete line items, each carrying its own price components, and rolls
/// them up into calculated net and gross totals. Invoices are produced by an
/// issuing organization once the services or goods recorded against an account
/// are ready to be billed, and they carry the status of the billing process
/// (draft, issued, balanced, cancelled, or entered-in-error) as it progresses.
///
/// Within the FHIR R5 financial and billing workflows, an Invoice sits
/// downstream of clinical and administrative activity: charges captured as
/// they occur are collected onto an account, and the Invoice then presents
/// those charges in a structured, human- and machine-readable form suitable
/// for submission, payment, and reconciliation. Payment terms, participants
/// involved in its creation, and free-text notes may accompany the charges.
///
/// See also: [`Account`](crate::r5::resources::account::Account) for the
/// running balance being invoiced, [`Reference`](crate::r5::types::Reference)
/// for links to the subject, recipient, and issuer, and
/// [`Money`](crate::r5::types::Money) and
/// [`MonetaryComponent`](crate::r5::types::MonetaryComponent) for how amounts
/// are expressed. The recipient and issuer are commonly a `Patient`,
/// `RelatedPerson`, or `Organization`.
///
/// # Examples
///
/// ```
/// use fhir::r5::resources::invoice::Invoice;
///
/// let value = Invoice::default();
/// let json = ::serde_json::to_value(&value).unwrap();
/// let back: Invoice = ::serde_json::from_value(json).unwrap();
/// assert_eq!(value, back);
/// ```
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct Invoice {
/// Logical id of this artifact
pub id: Option<types::String>,
/// Metadata about the resource
pub meta: Option<types::Meta>,
/// A set of rules under which this content was created
pub implicit_rules: Option<types::Uri>,
/// Language of the resource content
pub language: Option<types::Code>,
/// Text summary of the resource, for human interpretation
pub text: Option<types::Narrative>,
/// Contained, inline Resources
pub contained: Option<Vec<::serde_json::Value>>,
/// Additional content defined by implementations
pub extension: Option<Vec<types::Extension>>,
/// Extensions that cannot be ignored
pub modifier_extension: Option<Vec<types::Extension>>,
/// Business Identifier for item
pub identifier: Option<Vec<types::Identifier>>,
/// Current state of the invoice in the billing process: draft, issued, balanced, cancelled, or entered-in-error.
pub status: types::Code,
/// Reason for cancellation of this Invoice
pub cancelled_reason: Option<types::String>,
/// Type of Invoice
pub r#type: Option<types::CodeableConcept>,
/// Recipient(s) of goods and services
pub subject: Option<types::Reference>,
/// Recipient of this invoice
pub recipient: Option<types::Reference>,
/// DEPRICATED
pub date: Option<types::DateTime>,
/// When posted
pub creation: Option<types::DateTime>,
/// Billing date or period
pub period_date: Option<types::Date>,
/// Billing date or period
pub period_period: Option<types::Period>,
/// Participant in creation of this Invoice
pub participant: Option<Vec<InvoiceParticipant>>,
/// Issuing Organization of Invoice
pub issuer: Option<types::Reference>,
/// Reference to the Account whose collected charges are being balanced by this invoice.
pub account: Option<types::Reference>,
/// Individual charge lines that make up this invoice, each with its own price components.
pub line_item: Option<Vec<InvoiceLineItem>>,
/// Components of Invoice total
pub total_price_component: Option<Vec<types::MonetaryComponent>>,
/// Net total of this invoice, excluding taxes and surcharges captured as components.
pub total_net: Option<types::Money>,
/// Gross total of this invoice, including all price components such as taxes.
pub total_gross: Option<types::Money>,
/// Payment details
pub payment_terms: Option<types::Markdown>,
/// Comments made about the invoice
pub note: Option<Vec<types::Annotation>>,
}
/// Participant in creation of this Invoice.
///
/// Indicates who or what was involved in the creation of the Invoice and in
/// what role.
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct InvoiceParticipant {
/// Unique id for inter-element referencing
pub id: Option<types::String>,
/// Additional content defined by implementations
pub extension: Option<Vec<types::Extension>>,
/// Extensions that cannot be ignored even if unrecognized
pub modifier_extension: Option<Vec<types::Extension>>,
/// Type of involvement in creation of this Invoice
pub role: Option<types::CodeableConcept>,
/// Individual who was involved
pub actor: types::Reference,
}
/// Line items of this Invoice.
///
/// Each line item captures a specific charge, referencing a ChargeItem or an
/// inline billing code, together with its price components.
#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq, Validate)]
#[serde(rename_all = "camelCase")]
pub struct InvoiceLineItem {
/// Unique id for inter-element referencing
pub id: Option<types::String>,
/// Additional content defined by implementations
pub extension: Option<Vec<types::Extension>>,
/// Extensions that cannot be ignored even if unrecognized
pub modifier_extension: Option<Vec<types::Extension>>,
/// Sequence number of line item
pub sequence: Option<types::PositiveInt>,
/// Service data or period
pub serviced_date: Option<types::Date>,
/// Service data or period
pub serviced_period: Option<types::Period>,
/// Reference to ChargeItem containing details of this line item or an inline billing code
pub charge_item_reference: Option<types::Reference>,
/// Reference to ChargeItem containing details of this line item or an inline billing code
pub charge_item_codeable_concept: Option<types::CodeableConcept>,
/// Components of total line item price
pub price_component: Option<Vec<types::MonetaryComponent>>,
}
#[cfg(test)]
mod tests {
use super::*;
type T = Invoice;
#[test]
fn test_default() {
let _ = T::default();
}
#[test]
fn test_serde_round_trip() {
let value = T::default();
let json = ::serde_json::to_value(&value).expect("to_value");
let back: T = ::serde_json::from_value(json).expect("from_value");
assert_eq!(value, back);
}
}