fhirbolt_model/generated/r4b/resources/
device.rs

1// Generated on 2023-05-17 by fhirbolt-codegen v0.10.0
2#[doc = "Unique device identifier (UDI) assigned to device label or package.  Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold."]
3#[derive(Debug, Clone, PartialEq)]
4pub struct DeviceUdiCarrier {
5    #[doc = "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."]
6    pub r#id: Option<std::string::String>,
7    #[doc = "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."]
8    pub r#extension: Vec<super::super::types::Extension>,
9    #[doc = "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
10    pub r#modifier_extension: Vec<super::super::types::Extension>,
11    #[doc = "The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device."]
12    pub r#device_identifier: Option<super::super::types::String>,
13    #[doc = "Organization that is charged with issuing UDIs for devices.  For example, the US FDA issuers include :\n1) GS1: \n<http://hl7.org/fhir/NamingSystem/gs1>-di, \n2) HIBCC:\n<http://hl7.org/fhir/NamingSystem/hibcc>-dI, \n3) ICCBBA for blood containers:\n<http://hl7.org/fhir/NamingSystem/iccbba>-blood-di, \n4) ICCBA for other devices:\n<http://hl7.org/fhir/NamingSystem/iccbba>-other-di."]
14    pub r#issuer: Option<super::super::types::Uri>,
15    #[doc = "The identity of the authoritative source for UDI generation within a  jurisdiction.  All UDIs are globally unique within a single namespace with the appropriate repository uri as the system.  For example,  UDIs of devices managed in the U.S. by the FDA, the value is  <http://hl7.org/fhir/NamingSystem/fda>-udi."]
16    pub r#jurisdiction: Option<super::super::types::Uri>,
17    #[doc = "The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID.   Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded."]
18    pub r#carrier_aidc: Option<super::super::types::Base64Binary>,
19    #[doc = "The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device."]
20    pub r#carrier_hrf: Option<super::super::types::String>,
21    #[doc = "A coded entry to indicate how the data was entered."]
22    pub r#entry_type: Option<super::super::types::Code>,
23}
24#[allow(clippy::derivable_impls)]
25impl Default for DeviceUdiCarrier {
26    fn default() -> Self {
27        Self {
28            r#id: Default::default(),
29            r#extension: Default::default(),
30            r#modifier_extension: Default::default(),
31            r#device_identifier: Default::default(),
32            r#issuer: Default::default(),
33            r#jurisdiction: Default::default(),
34            r#carrier_aidc: Default::default(),
35            r#carrier_hrf: Default::default(),
36            r#entry_type: Default::default(),
37        }
38    }
39}
40#[doc = "This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device.  This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition."]
41#[derive(Debug, Clone, PartialEq)]
42pub struct DeviceDeviceName {
43    #[doc = "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."]
44    pub r#id: Option<std::string::String>,
45    #[doc = "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."]
46    pub r#extension: Vec<super::super::types::Extension>,
47    #[doc = "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
48    pub r#modifier_extension: Vec<super::super::types::Extension>,
49    #[doc = "The name that identifies the device."]
50    pub r#name: super::super::types::String,
51    #[doc = "The type of deviceName.\nUDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName."]
52    pub r#type: super::super::types::Code,
53}
54#[allow(clippy::derivable_impls)]
55impl Default for DeviceDeviceName {
56    fn default() -> Self {
57        Self {
58            r#id: Default::default(),
59            r#extension: Default::default(),
60            r#modifier_extension: Default::default(),
61            r#name: super::super::types::String {
62                id: Some("$invalid".to_string()),
63                ..Default::default()
64            },
65            r#type: super::super::types::Code {
66                id: Some("$invalid".to_string()),
67                ..Default::default()
68            },
69        }
70    }
71}
72#[doc = "The capabilities supported on a  device, the standards to which the device conforms for a particular purpose, and used for the communication."]
73#[derive(Debug, Clone, PartialEq)]
74pub struct DeviceSpecialization {
75    #[doc = "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."]
76    pub r#id: Option<std::string::String>,
77    #[doc = "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."]
78    pub r#extension: Vec<super::super::types::Extension>,
79    #[doc = "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
80    pub r#modifier_extension: Vec<super::super::types::Extension>,
81    #[doc = "The standard that is used to operate and communicate."]
82    pub r#system_type: Box<super::super::types::CodeableConcept>,
83    #[doc = "The version of the standard that is used to operate and communicate."]
84    pub r#version: Option<super::super::types::String>,
85}
86#[allow(clippy::derivable_impls)]
87impl Default for DeviceSpecialization {
88    fn default() -> Self {
89        Self {
90            r#id: Default::default(),
91            r#extension: Default::default(),
92            r#modifier_extension: Default::default(),
93            r#system_type: Box::new(super::super::types::CodeableConcept {
94                id: Some("$invalid".to_string()),
95                ..Default::default()
96            }),
97            r#version: Default::default(),
98        }
99    }
100}
101#[doc = "The actual design of the device or software version running on the device."]
102#[derive(Debug, Clone, PartialEq)]
103pub struct DeviceVersion {
104    #[doc = "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."]
105    pub r#id: Option<std::string::String>,
106    #[doc = "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."]
107    pub r#extension: Vec<super::super::types::Extension>,
108    #[doc = "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
109    pub r#modifier_extension: Vec<super::super::types::Extension>,
110    #[doc = "The type of the device version, e.g. manufacturer, approved, internal."]
111    pub r#type: Option<Box<super::super::types::CodeableConcept>>,
112    #[doc = "A single component of the device version."]
113    pub r#component: Option<Box<super::super::types::Identifier>>,
114    #[doc = "The version text."]
115    pub r#value: super::super::types::String,
116}
117#[allow(clippy::derivable_impls)]
118impl Default for DeviceVersion {
119    fn default() -> Self {
120        Self {
121            r#id: Default::default(),
122            r#extension: Default::default(),
123            r#modifier_extension: Default::default(),
124            r#type: Default::default(),
125            r#component: Default::default(),
126            r#value: super::super::types::String {
127                id: Some("$invalid".to_string()),
128                ..Default::default()
129            },
130        }
131    }
132}
133#[doc = "The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties."]
134#[derive(Debug, Clone, PartialEq)]
135pub struct DeviceProperty {
136    #[doc = "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."]
137    pub r#id: Option<std::string::String>,
138    #[doc = "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."]
139    pub r#extension: Vec<super::super::types::Extension>,
140    #[doc = "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
141    pub r#modifier_extension: Vec<super::super::types::Extension>,
142    #[doc = "Code that specifies the property DeviceDefinitionPropetyCode (Extensible)."]
143    pub r#type: Box<super::super::types::CodeableConcept>,
144    #[doc = "Property value as a quantity."]
145    pub r#value_quantity: Vec<super::super::types::Quantity>,
146    #[doc = "Property value as a code, e.g., NTP4 (synced to NTP)."]
147    pub r#value_code: Vec<super::super::types::CodeableConcept>,
148}
149#[allow(clippy::derivable_impls)]
150impl Default for DeviceProperty {
151    fn default() -> Self {
152        Self {
153            r#id: Default::default(),
154            r#extension: Default::default(),
155            r#modifier_extension: Default::default(),
156            r#type: Box::new(super::super::types::CodeableConcept {
157                id: Some("$invalid".to_string()),
158                ..Default::default()
159            }),
160            r#value_quantity: Default::default(),
161            r#value_code: Default::default(),
162        }
163    }
164}
165#[doc = "A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.\n\nAllows institutions to track their devices."]
166#[derive(Debug, Clone, PartialEq)]
167pub struct Device {
168    #[doc = "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."]
169    pub r#id: Option<super::super::types::Id>,
170    #[doc = "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."]
171    pub r#meta: Option<Box<super::super::types::Meta>>,
172    #[doc = "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."]
173    pub r#implicit_rules: Option<super::super::types::Uri>,
174    #[doc = "The base language in which the resource is written."]
175    pub r#language: Option<super::super::types::Code>,
176    #[doc = "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."]
177    pub r#text: Option<Box<super::super::types::Narrative>>,
178    #[doc = "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."]
179    pub r#contained: Vec<super::super::Resource>,
180    #[doc = "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."]
181    pub r#extension: Vec<super::super::types::Extension>,
182    #[doc = "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."]
183    pub r#modifier_extension: Vec<super::super::types::Extension>,
184    #[doc = "Unique instance identifiers assigned to a device by manufacturers other organizations or owners."]
185    pub r#identifier: Vec<super::super::types::Identifier>,
186    #[doc = "The reference to the definition for the device."]
187    pub r#definition: Option<Box<super::super::types::Reference>>,
188    #[doc = "Unique device identifier (UDI) assigned to device label or package.  Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold."]
189    pub r#udi_carrier: Vec<DeviceUdiCarrier>,
190    #[doc = "Status of the Device availability."]
191    pub r#status: Option<super::super::types::Code>,
192    #[doc = "Reason for the dtatus of the Device availability."]
193    pub r#status_reason: Vec<super::super::types::CodeableConcept>,
194    #[doc = "The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product."]
195    pub r#distinct_identifier: Option<super::super::types::String>,
196    #[doc = "A name of the manufacturer."]
197    pub r#manufacturer: Option<super::super::types::String>,
198    #[doc = "The date and time when the device was manufactured."]
199    pub r#manufacture_date: Option<super::super::types::DateTime>,
200    #[doc = "The date and time beyond which this device is no longer valid or should not be used (if applicable)."]
201    pub r#expiration_date: Option<super::super::types::DateTime>,
202    #[doc = "Lot number assigned by the manufacturer."]
203    pub r#lot_number: Option<super::super::types::String>,
204    #[doc = "The serial number assigned by the organization when the device was manufactured."]
205    pub r#serial_number: Option<super::super::types::String>,
206    #[doc = "This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device.  This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition."]
207    pub r#device_name: Vec<DeviceDeviceName>,
208    #[doc = "The manufacturer's model number for the device."]
209    pub r#model_number: Option<super::super::types::String>,
210    #[doc = "The part number or catalog number of the device."]
211    pub r#part_number: Option<super::super::types::String>,
212    #[doc = "The kind or type of device."]
213    pub r#type: Option<Box<super::super::types::CodeableConcept>>,
214    #[doc = "The capabilities supported on a  device, the standards to which the device conforms for a particular purpose, and used for the communication."]
215    pub r#specialization: Vec<DeviceSpecialization>,
216    #[doc = "The actual design of the device or software version running on the device."]
217    pub r#version: Vec<DeviceVersion>,
218    #[doc = "The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties."]
219    pub r#property: Vec<DeviceProperty>,
220    #[doc = "Patient information, If the device is affixed to a person."]
221    pub r#patient: Option<Box<super::super::types::Reference>>,
222    #[doc = "An organization that is responsible for the provision and ongoing maintenance of the device."]
223    pub r#owner: Option<Box<super::super::types::Reference>>,
224    #[doc = "Contact details for an organization or a particular human that is responsible for the device."]
225    pub r#contact: Vec<super::super::types::ContactPoint>,
226    #[doc = "The place where the device can be found."]
227    pub r#location: Option<Box<super::super::types::Reference>>,
228    #[doc = "A network address on which the device may be contacted directly."]
229    pub r#url: Option<super::super::types::Uri>,
230    #[doc = "Descriptive information, usage information or implantation information that is not captured in an existing element."]
231    pub r#note: Vec<super::super::types::Annotation>,
232    #[doc = "Provides additional safety characteristics about a medical device.  For example devices containing latex."]
233    pub r#safety: Vec<super::super::types::CodeableConcept>,
234    #[doc = "The device that this device is attached to or is part of."]
235    pub r#parent: Option<Box<super::super::types::Reference>>,
236}
237#[allow(clippy::derivable_impls)]
238impl Default for Device {
239    fn default() -> Self {
240        Self {
241            r#id: Default::default(),
242            r#meta: Default::default(),
243            r#implicit_rules: Default::default(),
244            r#language: Default::default(),
245            r#text: Default::default(),
246            r#contained: Default::default(),
247            r#extension: Default::default(),
248            r#modifier_extension: Default::default(),
249            r#identifier: Default::default(),
250            r#definition: Default::default(),
251            r#udi_carrier: Default::default(),
252            r#status: Default::default(),
253            r#status_reason: Default::default(),
254            r#distinct_identifier: Default::default(),
255            r#manufacturer: Default::default(),
256            r#manufacture_date: Default::default(),
257            r#expiration_date: Default::default(),
258            r#lot_number: Default::default(),
259            r#serial_number: Default::default(),
260            r#device_name: Default::default(),
261            r#model_number: Default::default(),
262            r#part_number: Default::default(),
263            r#type: Default::default(),
264            r#specialization: Default::default(),
265            r#version: Default::default(),
266            r#property: Default::default(),
267            r#patient: Default::default(),
268            r#owner: Default::default(),
269            r#contact: Default::default(),
270            r#location: Default::default(),
271            r#url: Default::default(),
272            r#note: Default::default(),
273            r#safety: Default::default(),
274            r#parent: Default::default(),
275        }
276    }
277}