DeviceRequest constructor

const DeviceRequest({
  1. @Default(R5ResourceType.DeviceRequest) @JsonKey(unknownEnumValue: R5ResourceType.DeviceRequest) R5ResourceType resourceType,
  2. @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
  3. @JsonKey(name: 'id') FhirId? fhirId,
  4. FhirMeta? meta,
  5. FhirUri? implicitRules,
  6. @JsonKey(name: '_implicitRules') Element? implicitRulesElement,
  7. FhirCode? language,
  8. @JsonKey(name: '_language') Element? languageElement,
  9. Narrative? text,
  10. List<Resource>? contained,
  11. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  12. List<FhirExtension>? modifierExtension,
  13. List<Identifier>? identifier,
  14. List<FhirCanonical>? instantiatesCanonical,
  15. List<FhirUri>? instantiatesUri,
  16. @JsonKey(name: '_instantiatesUri') List<Element>? instantiatesUriElement,
  17. List<Reference>? basedOn,
  18. List<Reference>? replaces,
  19. Identifier? groupIdentifier,
  20. FhirCode? status,
  21. @JsonKey(name: '_status') Element? statusElement,
  22. FhirCode? intent,
  23. @JsonKey(name: '_intent') Element? intentElement,
  24. FhirCode? priority,
  25. @JsonKey(name: '_priority') Element? priorityElement,
  26. FhirBoolean? doNotPerform,
  27. @JsonKey(name: '_doNotPerform') Element? doNotPerformElement,
  28. required CodeableReference code,
  29. FhirInteger? quantity,
  30. @JsonKey(name: '_quantity') Element? quantityElement,
  31. List<DeviceRequestParameter>? parameter,
  32. required Reference subject,
  33. Reference? encounter,
  34. FhirDateTime? occurrenceDateTime,
  35. @JsonKey(name: '_occurrenceDateTime') Element? occurrenceDateTimeElement,
  36. Period? occurrencePeriod,
  37. Timing? occurrenceTiming,
  38. FhirDateTime? authoredOn,
  39. @JsonKey(name: '_authoredOn') Element? authoredOnElement,
  40. Reference? requester,
  41. CodeableReference? performer,
  42. List<CodeableReference>? reason,
  43. FhirBoolean? asNeeded,
  44. @JsonKey(name: '_asNeeded') Element? asNeededElement,
  45. CodeableConcept? asNeededFor,
  46. List<Reference>? insurance,
  47. List<Reference>? supportingInfo,
  48. List<Annotation>? note,
  49. List<Reference>? relevantHistory,
})

DeviceRequest Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

resourceType This is a DeviceRequest resource

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

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

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

implicitRulesElement ("_implicitRules") Extensions for implicitRules

language The base language in which the resource is written.

languageElement ("_language") Extensions for language

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

extension_ ("extension") 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.

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

identifier Identifiers assigned to this order by the orderer or by the receiver.

instantiatesCanonical The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

instantiatesUri The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

instantiatesUriElement ("_instantiatesUri") Extensions for instantiatesUri

basedOn Plan/proposal/order fulfilled by this request.

replaces The request takes the place of the referenced completed or terminated request(s).

groupIdentifier A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

status The status of the request.

statusElement ("_status") Extensions for status

intent Whether the request is a proposal, plan, an original order or a reflex order.

intentElement ("_intent") Extensions for intent

priority Indicates how quickly the request should be addressed with respect to other requests.

priorityElement ("_priority") Extensions for priority

doNotPerform If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices. For example, the patient has undergone surgery and the provider is indicating that the patient should not wear contact lenses.

doNotPerformElement ("_doNotPerform") Extensions for doNotPerform

code The details of the device to be used.

quantity The number of devices to be provided.

quantityElement ("_quantity") Extensions for quantity

parameter Specific parameters for the ordered item. For example, the prism value for lenses.

subject The patient who will use the device.

encounter An encounter that provides additional context in which this request is made.

occurrenceDateTime The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".

occurrenceDateTimeElement ("_occurrenceDateTime") Extensions for occurrenceDateTime

occurrencePeriod The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".

occurrenceTiming The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".

authoredOn When the request transitioned to being actionable.

authoredOnElement ("_authoredOn") Extensions for authoredOn

requester The individual or entity who initiated the request and has responsibility for its activation.

performer The desired individual or entity to provide the device to the subject of the request (e.g., patient, location).

reason Reason or justification for the use of this device.

asNeeded This status is to indicate whether the request is a PRN or may be given as needed.

asNeededElement ("_asNeeded") Extensions for asNeeded

asNeededFor The reason for using the device.

insurance Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

supportingInfo Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).

note Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.

relevantHistory Key events in the history of the request.

Implementation

const factory DeviceRequest({
  /// [resourceType] This is a DeviceRequest resource
  @Default(R5ResourceType.DeviceRequest)
  @JsonKey(unknownEnumValue: R5ResourceType.DeviceRequest)
  R5ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the
  ///  resource. Once assigned, this value never changes.
  @JsonKey(name: 'id') FhirId? fhirId,

  /// [meta] 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.
  FhirMeta? meta,

  /// [implicitRules] 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.
  FhirUri? implicitRules,

  /// [implicitRulesElement] ("_implicitRules") Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] ("_language") Extensions for language
  @JsonKey(name: '_language') Element? languageElement,

  /// [text] 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.
  Narrative? text,

  /// [contained] 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.
  List<Resource>? contained,

  /// [extension_] ("extension") 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] 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).
  List<FhirExtension>? modifierExtension,

  /// [identifier] Identifiers assigned to this order by the orderer or by
  ///  the receiver.
  List<Identifier>? identifier,

  /// [instantiatesCanonical] The URL pointing to a FHIR-defined protocol,
  ///  guideline, orderset or other definition that is adhered to in whole or
  ///  in part by this DeviceRequest.
  List<FhirCanonical>? instantiatesCanonical,

  /// [instantiatesUri] The URL pointing to an externally maintained
  ///  protocol, guideline, orderset or other definition that is adhered to
  ///  in whole or in part by this DeviceRequest.
  List<FhirUri>? instantiatesUri,

  /// [instantiatesUriElement] ("_instantiatesUri") Extensions for
  ///  instantiatesUri
  @JsonKey(name: '_instantiatesUri') List<Element>? instantiatesUriElement,

  /// [basedOn] Plan/proposal/order fulfilled by this request.
  List<Reference>? basedOn,

  /// [replaces] The request takes the place of the referenced completed or
  ///  terminated request(s).
  List<Reference>? replaces,

  /// [groupIdentifier] A shared identifier common to multiple independent
  ///  Request instances that were activated/authorized more or less
  ///  simultaneously by a single author.  The presence of the same
  ///  identifier on each request ties those requests together and may have
  ///  business ramifications in terms of reporting of results, billing, etc.
  ///   E.g. a requisition number shared by a set of lab tests ordered
  ///  together, or a prescription number shared by all meds ordered at one
  ///  time.
  Identifier? groupIdentifier,

  /// [status] The status of the request.
  FhirCode? status,

  /// [statusElement] ("_status") Extensions for status
  @JsonKey(name: '_status') Element? statusElement,

  /// [intent] Whether the request is a proposal, plan, an original order or
  ///  a reflex order.
  FhirCode? intent,

  /// [intentElement] ("_intent") Extensions for intent
  @JsonKey(name: '_intent') Element? intentElement,

  /// [priority] Indicates how quickly the request should be addressed with
  ///  respect to other requests.
  FhirCode? priority,

  /// [priorityElement] ("_priority") Extensions for priority
  @JsonKey(name: '_priority') Element? priorityElement,

  /// [doNotPerform] If true, indicates that the provider is asking for the
  ///  patient to either stop using or to not start using the specified
  ///  device or category of devices. For example, the patient has undergone
  ///  surgery and the provider is indicating that the patient should not
  ///  wear contact lenses.
  FhirBoolean? doNotPerform,

  /// [doNotPerformElement] ("_doNotPerform") Extensions for doNotPerform
  @JsonKey(name: '_doNotPerform') Element? doNotPerformElement,

  /// [code] The details of the device to be used.
  required CodeableReference code,

  /// [quantity] The number of devices to be provided.
  FhirInteger? quantity,

  /// [quantityElement] ("_quantity") Extensions for quantity
  @JsonKey(name: '_quantity') Element? quantityElement,

  /// [parameter] Specific parameters for the ordered item.  For example, the
  ///  prism value for lenses.
  List<DeviceRequestParameter>? parameter,

  /// [subject] The patient who will use the device.
  required Reference subject,

  /// [encounter] An encounter that provides additional context in which this
  ///  request is made.
  Reference? encounter,

  /// [occurrenceDateTime] The timing schedule for the use of the device. The
  ///  Schedule data type allows many different expressions, for example.
  ///  "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast
  ///  for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov
  ///  2013".
  FhirDateTime? occurrenceDateTime,

  /// [occurrenceDateTimeElement] ("_occurrenceDateTime") Extensions for
  ///  occurrenceDateTime
  @JsonKey(name: '_occurrenceDateTime') Element? occurrenceDateTimeElement,

  /// [occurrencePeriod] The timing schedule for the use of the device. The
  ///  Schedule data type allows many different expressions, for example.
  ///  "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast
  ///  for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov
  ///  2013".
  Period? occurrencePeriod,

  /// [occurrenceTiming] The timing schedule for the use of the device. The
  ///  Schedule data type allows many different expressions, for example.
  ///  "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast
  ///  for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov
  ///  2013".
  Timing? occurrenceTiming,

  /// [authoredOn] When the request transitioned to being actionable.
  FhirDateTime? authoredOn,

  /// [authoredOnElement] ("_authoredOn") Extensions for authoredOn
  @JsonKey(name: '_authoredOn') Element? authoredOnElement,

  /// [requester] The individual or entity who initiated the request and has
  ///  responsibility for its activation.
  Reference? requester,

  /// [performer] The desired individual or entity to provide the device to
  ///  the subject of the request (e.g., patient, location).
  CodeableReference? performer,

  /// [reason] Reason or justification for the use of this device.
  List<CodeableReference>? reason,

  /// [asNeeded] This status is to indicate whether the request is a PRN or
  ///  may be given as needed.
  FhirBoolean? asNeeded,

  /// [asNeededElement] ("_asNeeded") Extensions for asNeeded
  @JsonKey(name: '_asNeeded') Element? asNeededElement,

  /// [asNeededFor] The reason for using the device.
  CodeableConcept? asNeededFor,

  /// [insurance] Insurance plans, coverage extensions, pre-authorizations
  ///  and/or pre-determinations that may be required for delivering the
  ///  requested service.
  List<Reference>? insurance,

  /// [supportingInfo] Additional clinical information about the patient that
  ///  may influence the request fulfilment.  For example, this may include
  ///  where on the subject's body the device will be used (i.e. the target
  ///  site).
  List<Reference>? supportingInfo,

  /// [note] Details about this request that were not represented at all or
  ///  sufficiently in one of the attributes provided in a class. These may
  ///  include for example a comment, an instruction, or a note associated
  ///  with the statement.
  List<Annotation>? note,

  /// [relevantHistory] Key events in the history of the request.
  List<Reference>? relevantHistory,
}) = _DeviceRequest;