Struct DeviceBuilder

Source

pub struct DeviceBuilder { /* private fields */ }

Expand description

Builder for DeviceInner.

Implementations§

Source §

impl DeviceBuilder

Source

pub fn id(self, value: String) -> DeviceBuilder

Logical id of this artifact

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Source

pub fn meta(self, value: Meta) -> DeviceBuilder

Metadata about the resource

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.

Source

pub fn implicit_rules(self, value: String) -> DeviceBuilder

A set of rules under which this content was created

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.

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 its narrative along with other profiles, value sets, etc.

Source

pub fn language(self, value: String) -> DeviceBuilder

Language; Language of the resource content

The base language in which the resource is written.

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).

Source

pub fn text(self, value: Narrative) -> DeviceBuilder

Text summary of the resource, for human interpretation

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.

Contained resources do not have a 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.

Source

pub fn contained(self, value: Vec<Resource>) -> DeviceBuilder

Contained, inline Resources

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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.

Source

pub fn extension(self, value: Vec<Extension>) -> DeviceBuilder

Additional content defined by implementations

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 managable, 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.

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.

Source

pub fn modifier_extension(self, value: Vec<Extension>) -> DeviceBuilder

Extensions that cannot be ignored

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 managable, 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).

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.

Source

pub fn identifier(self, value: Vec<Option<Identifier>>) -> DeviceBuilder

Instance identifier

Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

Certain attributes, like serial number and UDI Carrier (the HRF or AIDC barcode string) are not device instance identifiers as they are not consistently able to uniquely identify the instance of a device, thus are not appropriate to be used to value Device.identifier. The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. The identifier is typically valued if the serialNumber or lotNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

Source

pub fn identifier_ext(self, value: Vec<Option<FieldExtension>>) -> DeviceBuilder

Extension field.

Source

pub fn display_name(self, value: String) -> DeviceBuilder

The name used to display by default when the device is referenced

The name used to display by default when the device is referenced. Based on intent of use by the resource creator, this may reflect one of the names in Device.name, or may be another simple name.

Source

pub fn display_name_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn definition(self, value: CodeableReference) -> DeviceBuilder

The reference to the definition for the device

The reference to the definition for the device.

Source

pub fn definition_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn udi_carrier(self, value: Vec<Option<DeviceUdiCarrier>>) -> DeviceBuilder

Unique Device Identifier (UDI) Barcode string

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.

UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.

Source

pub fn udi_carrier_ext( self, value: Vec<Option<FieldExtension>>, ) -> DeviceBuilder

Extension field.

Source

pub fn status(self, value: FHIRDeviceStatus) -> DeviceBuilder

FHIRDeviceStatus; active | inactive | entered-in-error

The Device record status. This is not the status of the device like availability.

Source

pub fn status_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn availability_status(self, value: CodeableConcept) -> DeviceBuilder

FHIRDeviceAvailabilityStatus; lost | damaged | destroyed | available

The availability of the device.

Source

pub fn availability_status_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn biological_source_event(self, value: Identifier) -> DeviceBuilder

An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled

An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled.

Necessary to support mandatory requirements for traceability from donor/source to recipient and vice versa, while also satisfying donor anonymity requirements. The element is defined consistently across BiologicallyDerivedProduct, NutritionProduct, and Device. The identifier references an event that links to a single biological entity such as a blood donor, or to multiple biological entities (e.g. when the product is an embryo or a pooled platelet product). A single biologicalSourceEvent identifier may appear on multiple products of many types derived from a single donation event or source extraction. As an example, a single donation event may provide 2 kidneys and a liver for organ transplantation, 2 corneas for eye surgery, heart valves and arterial tissue for cardiovascular surgery, multiple skin grafts, tendons, multiple shaped bone grafts and a large number of bone putty/paste products; and each of them may be assigned to the same biological source event identifier.

Source

pub fn biological_source_event_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn manufacturer(self, value: String) -> DeviceBuilder

Name of device manufacturer

A name of the manufacturer or entity legally responsible for the device.

Source

pub fn manufacturer_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn manufacture_date(self, value: DateTime) -> DeviceBuilder

Date when the device was made

The date and time when the device was manufactured.

Source

pub fn manufacture_date_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn expiration_date(self, value: DateTime) -> DeviceBuilder

Date and time of expiry of this device (if applicable)

The date and time beyond which this device is no longer valid or should not be used (if applicable).

Source

pub fn expiration_date_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn lot_number(self, value: String) -> DeviceBuilder

Lot number of manufacture

Lot number assigned by the manufacturer.

Source

pub fn lot_number_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn serial_number(self, value: String) -> DeviceBuilder

Serial number assigned by the manufacturer

The serial number assigned by the organization when the device was manufactured.

Alphanumeric Maximum 20. While a serial number is a type of identifier, in the context of devices for which a UDI is required, thus a serial number may be part of the production identifier, it is more informative to have the serial number as a dedicated attribute together with the other UDI production identifier. When the device is not subject to including the UDI (e.g., its presence and exchange is not mandated by local regulatory requirements or specific use case at hand), thus the concept of production identifiers is not relevant as a set, it remains helpful for consistency to still use Device.serialNumber rather than using Device.identifier with an appropriate type. Systems that do not realize an identifier is a serial number may place it in Device.identifier or if the identifier.system is known for the serial number, it may also be populated in the Device.identifier as a globally unique id_.

Source

pub fn serial_number_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn name(self, value: Vec<Option<DeviceName>>) -> DeviceBuilder

The name or names of the device as known to the manufacturer and/or patient

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.

Source

pub fn name_ext(self, value: Vec<Option<FieldExtension>>) -> DeviceBuilder

Extension field.

Source

pub fn model_number(self, value: String) -> DeviceBuilder

The manufacturer’s model number for the device

The manufacturer’s model number for the device.

Source

pub fn model_number_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn part_number(self, value: String) -> DeviceBuilder

The part number or catalog number of the device

The part number or catalog number of the device.

Alphanumeric Maximum 20.

Source

pub fn part_number_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn category(self, value: Vec<Option<CodeableConcept>>) -> DeviceBuilder

DeviceCategory; Indicates a high-level grouping of the device

Devices may be associated with one or more categories.

Source

pub fn category_ext(self, value: Vec<Option<FieldExtension>>) -> DeviceBuilder

Extension field.

Source

pub fn type(self, value: Vec<Option<CodeableConcept>>) -> DeviceBuilder

DeviceType; The kind or type of device

The kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the device.

Multiple device types are use when a device is categorized in more than one context – for example, hybrid devices in which the device is both of type gateway and sensor.

Source

pub fn type_ext(self, value: Vec<Option<FieldExtension>>) -> DeviceBuilder

Extension field.

Source

pub fn version(self, value: Vec<Option<DeviceVersion>>) -> DeviceBuilder

The actual design of the device or software version running on the device

The actual design of the device or software version running on the device.

Source

pub fn version_ext(self, value: Vec<Option<FieldExtension>>) -> DeviceBuilder

Extension field.

Source

pub fn conforms_to(self, value: Vec<Option<DeviceConformsTo>>) -> DeviceBuilder

Identifies the standards, specifications, or formal guidances for the capabilities supported by the device

Identifies the standards, specifications, or formal guidances for the capabilities supported by the device. The device may be certified as conformant to these specifications e.g., communication, performance, process, measurement, or specialization standards.

Source

pub fn conforms_to_ext( self, value: Vec<Option<FieldExtension>>, ) -> DeviceBuilder

Extension field.

Source

pub fn property(self, value: Vec<Option<DeviceProperty>>) -> DeviceBuilder

Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.

Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.

Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific DeviceMetric and recorded using Observation. Static characteristics of a device could also be documented in an associated DeviceDefinition instance. The Device instance’s properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

Source

pub fn property_ext(self, value: Vec<Option<FieldExtension>>) -> DeviceBuilder

Extension field.

Source

pub fn mode(self, value: CodeableConcept) -> DeviceBuilder

DeviceOperationMode; The designated condition for performing a task

The designated condition for performing a task with the device.

Source

pub fn mode_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn cycle(self, value: Count) -> DeviceBuilder

The series of occurrences that repeats during the operation of the device

The series of occurrences that repeats during the operation of the device.

Source

pub fn cycle_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn duration(self, value: Duration) -> DeviceBuilder

A measurement of time during the device’s operation (e.g., days, hours, mins, etc.)

A measurement of time during the device’s operation (e.g., days, hours, mins, etc.).

Source

pub fn duration_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn owner(self, value: Reference) -> DeviceBuilder

Organization responsible for device

An organization that is responsible for the provision and ongoing maintenance of the device.

Source

pub fn owner_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn contact(self, value: Vec<Option<ContactPoint>>) -> DeviceBuilder

Details for human/organization for support

Contact details for an organization or a particular human that is responsible for the device.

used for troubleshooting etc.

Source

pub fn contact_ext(self, value: Vec<Option<FieldExtension>>) -> DeviceBuilder

Extension field.

Source

pub fn location(self, value: Reference) -> DeviceBuilder

Where the device is found

The place where the device can be found.

Source

pub fn location_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn url(self, value: String) -> DeviceBuilder

Network address to contact device

A network address on which the device may be contacted directly.

If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.

Source

pub fn url_ext(self, value: FieldExtension) -> DeviceBuilder

Extension field.

Source

pub fn endpoint(self, value: Vec<Option<Reference>>) -> DeviceBuilder

Technical endpoints providing access to electronic services provided by the device

Technical endpoints providing access to services provided by the device defined at this resource.

Source

pub fn endpoint_ext(self, value: Vec<Option<FieldExtension>>) -> DeviceBuilder

Extension field.

Source

pub fn gateway(self, value: Vec<Option<CodeableReference>>) -> DeviceBuilder

Linked device acting as a communication/data collector, translator or controller

The linked device acting as a communication controller, data collector, translator, or concentrator for the current device (e.g., mobile phone application that relays a blood pressure device’s data).

The Device.gateway may be used when the Device being referenced has a gateway and/or to capture one or more gateways associated with the device. If the Gateway is included in the Observation resource, the Observation.gatewayDevice should be used instead.

Source

pub fn gateway_ext(self, value: Vec<Option<FieldExtension>>) -> DeviceBuilder

Extension field.

Source

pub fn note(self, value: Vec<Option<Annotation>>) -> DeviceBuilder

Device notes and comments

Descriptive information, usage information or implantation information that is not captured in an existing element.

Source

pub fn note_ext(self, value: Vec<Option<FieldExtension>>) -> DeviceBuilder

Extension field.

Source

pub fn safety(self, value: Vec<Option<CodeableConcept>>) -> DeviceBuilder

Safety; Safety Characteristics of Device

Provides additional safety characteristics about a medical device. For example devices containing latex.

Source

pub fn safety_ext(self, value: Vec<Option<FieldExtension>>) -> DeviceBuilder

Extension field.

Source

pub fn parent(self, value: Reference) -> DeviceBuilder

The higher level or encompassing device that this device is a logical part of

The higher level or encompassing device that this device is a logical part of.

For example a vital signs monitor (parent) where three separate modules can be plugged into such as interchangeable blood pressure, oximeter, temperature modules. These modules are represented as devices with the .parent valued to the vital signs monitor when plugged in.

Source