Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-DeviceRequest resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. DeviceRequest | |
| Definition | 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. |
| Short | Medical device request |
| Control | 0..* |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
| 2. DeviceRequest.implicitRules | |
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
| Short | A set of rules under which this content was created |
| Comments | 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. DeviceRequest.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on DeviceRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. DeviceRequest.extension:instantiatesCanonical | |
| Slice Name | instantiatesCanonical |
| Definition | R5: |
| Short | R5: Instantiates FHIR protocol or definition (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Instantiates FHIR protocol or definition (new)) (Extension Type: uri(Cross-version Profile for R5.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R5.PlanDefinition for use in FHIR STU3, PlanDefinition)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. DeviceRequest.extension:instantiatesUri | |
| Slice Name | instantiatesUri |
| Definition | R5: |
| Short | R5: Instantiates external protocol or definition (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Instantiates external protocol or definition (new)) (Extension Type: uri) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. DeviceRequest.extension:quantity | |
| Slice Name | quantity |
| Definition | R5: |
| Short | R5: Quantity of devices to supply (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Quantity of devices to supply (new)) (Extension Type: integer) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. DeviceRequest.extension:parameter | |
| Slice Name | parameter |
| Definition | R5: |
| Short | R5: Device details (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Device details (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 14. DeviceRequest.extension:performer | |
| Slice Name | performer |
| Definition | R5: |
| Short | R5: Requested Filler additional types |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Requested Filler additional types) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. DeviceRequest.extension:reason | |
| Slice Name | reason |
| Definition | R5: |
| Short | R5: Coded/Linked Reason for request additional types |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Coded/Linked Reason for request additional types) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 18. DeviceRequest.extension:asNeeded | |
| Slice Name | asNeeded |
| Definition | R5: |
| Short | R5: PRN status of request (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: PRN status of request (new)) (Extension Type: boolean) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 20. DeviceRequest.extension:asNeededFor | |
| Slice Name | asNeededFor |
| Definition | R5: |
| Short | R5: Device usage reason (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Device usage reason (new)) (Extension Type: CodeableConcept) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 22. DeviceRequest.extension:insurance | |
| Slice Name | insurance |
| Definition | R5: |
| Short | R5: Associated insurance coverage (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Associated insurance coverage (new)) (Extension Type: Reference(Cross-version Profile for R5.Coverage for use in FHIR STU3, Coverage, Cross-version Profile for R5.ClaimResponse for use in FHIR STU3, ClaimResponse)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 24. DeviceRequest.modifierExtension | |
| Definition | An Extension 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. Usually modifier elements provide negation or qualification. In order 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. |
| Short | ExtensionExtensions that cannot be ignored |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on DeviceRequest.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 26. DeviceRequest.modifierExtension:doNotPerform | |
| Slice Name | doNotPerform |
| Definition | R5: |
| Short | R5: True if the request is to stop or not to start using the device (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: True if the request is to stop or not to start using the device (new)) (Extension Type: boolean) |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 28. DeviceRequest.status | |
| Definition | The status of the request. |
| Short | draft | active | suspended | completed | entered-in-error | cancelled |
| Comments | This element is labeled as a modifier because the status contains the codes cancelled and entered-in-error that mark the request as not currently valid. |
| Control | 0..1 |
| Binding | The codes SHALL be taken from RequestStatushttp://hl7.org/fhir/ValueSet/request-status|3.0.2 (required to http://hl7.org/fhir/ValueSet/request-status|3.0.2)Codes representing the status of the request. |
| Type | code |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 30. DeviceRequest.intent | |
| Definition | Whether the request is a proposal, plan, an original order or a reflex order. |
| Short | proposal | plan | original-order | encoded | reflex-order |
| Control | 1..1 |
| Binding | The codes SHALL be taken from RequestIntenthttp://hl7.org/fhir/ValueSet/request-intent|3.0.2 (required to http://hl7.org/fhir/ValueSet/request-intent|3.0.2)The kind of diagnostic request |
| Type | CodeableConcept |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Summary | true |
| 32. DeviceRequest.intent.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on DeviceRequest.intent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 34. DeviceRequest.intent.extension:intent | |
| Slice Name | intent |
| Definition | R5: |
| Short | R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option) (Extension Type: code) |
| 36. DeviceRequest.code[x] | |
| Definition | The details of the device to be used. |
| Short | Device requested |
| Control | 1..1 |
| Binding | For example codes, see FHIR Device Typeshttp://hl7.org/fhir/ValueSet/device-kind|3.0.2 (example to http://hl7.org/fhir/ValueSet/device-kind|3.0.2)Codes for devices that can be requested |
| Type | Choice of: Reference(Device), CodeableConcept |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Summary | true |
| 38. DeviceRequest.subject | |
| Definition | The patient who will use the device. |
| Short | Focus of request |
| Control | 1..1 |
| Type | Reference(Patient, Group, Location, Device) |
| Summary | true |
| 40. DeviceRequest.subject.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
| Short | ExtensionAdditional Content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on DeviceRequest.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 42. DeviceRequest.subject.extension:subject | |
| Slice Name | subject |
| Definition | R5: |
| Short | R5: subject |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DeviceRequest | |
| 2. DeviceRequest.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DeviceRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. DeviceRequest.extension:instantiatesCanonical | |
| Slice Name | instantiatesCanonical |
| Definition | R5: |
| Short | R5: Instantiates FHIR protocol or definition (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Instantiates FHIR protocol or definition (new)) (Extension Type: uri(Cross-version Profile for R5.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R5.PlanDefinition for use in FHIR STU3, PlanDefinition)) |
| 6. DeviceRequest.extension:instantiatesUri | |
| Slice Name | instantiatesUri |
| Definition | R5: |
| Short | R5: Instantiates external protocol or definition (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Instantiates external protocol or definition (new)) (Extension Type: uri) |
| 8. DeviceRequest.extension:quantity | |
| Slice Name | quantity |
| Definition | R5: |
| Short | R5: Quantity of devices to supply (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Quantity of devices to supply (new)) (Extension Type: integer) |
| 10. DeviceRequest.extension:parameter | |
| Slice Name | parameter |
| Definition | R5: |
| Short | R5: Device details (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Device details (new)) (Complex Extension) |
| 12. DeviceRequest.extension:performer | |
| Slice Name | performer |
| Definition | R5: |
| Short | R5: Requested Filler additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Requested Filler additional types) (Complex Extension) |
| 14. DeviceRequest.extension:reason | |
| Slice Name | reason |
| Definition | R5: |
| Short | R5: Coded/Linked Reason for request additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Coded/Linked Reason for request additional types) (Complex Extension) |
| 16. DeviceRequest.extension:asNeeded | |
| Slice Name | asNeeded |
| Definition | R5: |
| Short | R5: PRN status of request (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: PRN status of request (new)) (Extension Type: boolean) |
| 18. DeviceRequest.extension:asNeededFor | |
| Slice Name | asNeededFor |
| Definition | R5: |
| Short | R5: Device usage reason (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Device usage reason (new)) (Extension Type: CodeableConcept) |
| 20. DeviceRequest.extension:insurance | |
| Slice Name | insurance |
| Definition | R5: |
| Short | R5: Associated insurance coverage (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Associated insurance coverage (new)) (Extension Type: Reference(Cross-version Profile for R5.Coverage for use in FHIR STU3, Coverage, Cross-version Profile for R5.ClaimResponse for use in FHIR STU3, ClaimResponse)) |
| 22. DeviceRequest.modifierExtension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DeviceRequest.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 24. DeviceRequest.modifierExtension:doNotPerform | |
| Slice Name | doNotPerform |
| Definition | R5: |
| Short | R5: True if the request is to stop or not to start using the device (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: True if the request is to stop or not to start using the device (new)) (Extension Type: boolean) |
| 26. DeviceRequest.basedOn | |
| 28. DeviceRequest.basedOn.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DeviceRequest.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 30. DeviceRequest.basedOn.extension:basedOn | |
| Slice Name | basedOn |
| Definition | R5: |
| Short | R5: basedOn additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 32. DeviceRequest.priorRequest | |
| 34. DeviceRequest.priorRequest.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DeviceRequest.priorRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 36. DeviceRequest.priorRequest.extension:replaces | |
| Slice Name | replaces |
| Definition | R5: |
| Short | R5: replaces additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 38. DeviceRequest.intent | |
| 40. DeviceRequest.intent.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DeviceRequest.intent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 42. DeviceRequest.intent.extension:intent | |
| Slice Name | intent |
| Definition | R5: |
| Short | R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option) (Extension Type: code) |
| 44. DeviceRequest.subject | |
| 46. DeviceRequest.subject.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DeviceRequest.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. DeviceRequest.subject.extension:subject | |
| Slice Name | subject |
| Definition | R5: |
| Short | R5: subject |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 50. DeviceRequest.context | |
| 52. DeviceRequest.context.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DeviceRequest.context.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 54. DeviceRequest.context.extension:encounter | |
| Slice Name | encounter |
| Definition | R5: |
| Short | R5: Encounter motivating request additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 56. DeviceRequest.requester | |
| 58. DeviceRequest.requester.agent | |
| 60. DeviceRequest.requester.agent.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DeviceRequest.requester.agent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 62. DeviceRequest.requester.agent.extension:requester | |
| Slice Name | requester |
| Definition | R5: |
| Short | R5: Who/what submitted the device request |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 64. DeviceRequest.supportingInfo | |
| 66. DeviceRequest.supportingInfo.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DeviceRequest.supportingInfo.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 68. DeviceRequest.supportingInfo.extension:supportingInfo | |
| Slice Name | supportingInfo |
| Definition | R5: |
| Short | R5: supportingInfo additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 70. DeviceRequest.relevantHistory | |
| 72. DeviceRequest.relevantHistory.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on DeviceRequest.relevantHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 74. DeviceRequest.relevantHistory.extension:relevantHistory | |
| Slice Name | relevantHistory |
| Definition | R5: |
| Short | R5: relevantHistory additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. DeviceRequest | |||||
| Definition | 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. | ||||
| Short | Medical device request | ||||
| Control | 0..* | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty()) | ||||
| 2. DeviceRequest.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. DeviceRequest.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. DeviceRequest.implicitRules | |||||
| Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. | ||||
| Short | A set of rules under which this content was created | ||||
| Comments | 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 8. DeviceRequest.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| Comments | 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). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages ![]() (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 10. DeviceRequest.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource, and may 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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have 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 in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 12. DeviceRequest.contained | |||||
| Definition | 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. | ||||
| Short | Contained, inline Resources | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. DeviceRequest.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DeviceRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. DeviceRequest.extension:instantiatesCanonical | |||||
| Slice Name | instantiatesCanonical | ||||
| Definition | R5: | ||||
| Short | R5: Instantiates FHIR protocol or definition (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Instantiates FHIR protocol or definition (new)) (Extension Type: uri(Cross-version Profile for R5.ActivityDefinition for use in FHIR STU3, ActivityDefinition, Cross-version Profile for R5.PlanDefinition for use in FHIR STU3, PlanDefinition)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. DeviceRequest.extension:instantiatesUri | |||||
| Slice Name | instantiatesUri | ||||
| Definition | R5: | ||||
| Short | R5: Instantiates external protocol or definition (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Instantiates external protocol or definition (new)) (Extension Type: uri) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. DeviceRequest.extension:quantity | |||||
| Slice Name | quantity | ||||
| Definition | R5: | ||||
| Short | R5: Quantity of devices to supply (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Quantity of devices to supply (new)) (Extension Type: integer) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 22. DeviceRequest.extension:parameter | |||||
| Slice Name | parameter | ||||
| Definition | R5: | ||||
| Short | R5: Device details (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Device details (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 24. DeviceRequest.extension:performer | |||||
| Slice Name | performer | ||||
| Definition | R5: | ||||
| Short | R5: Requested Filler additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Requested Filler additional types) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 26. DeviceRequest.extension:reason | |||||
| Slice Name | reason | ||||
| Definition | R5: | ||||
| Short | R5: Coded/Linked Reason for request additional types | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Coded/Linked Reason for request additional types) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 28. DeviceRequest.extension:asNeeded | |||||
| Slice Name | asNeeded | ||||
| Definition | R5: | ||||
| Short | R5: PRN status of request (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: PRN status of request (new)) (Extension Type: boolean) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 30. DeviceRequest.extension:asNeededFor | |||||
| Slice Name | asNeededFor | ||||
| Definition | R5: | ||||
| Short | R5: Device usage reason (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Device usage reason (new)) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 32. DeviceRequest.extension:insurance | |||||
| Slice Name | insurance | ||||
| Definition | R5: | ||||
| Short | R5: Associated insurance coverage (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Associated insurance coverage (new)) (Extension Type: Reference(Cross-version Profile for R5.Coverage for use in FHIR STU3, Coverage, Cross-version Profile for R5.ClaimResponse for use in FHIR STU3, ClaimResponse)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 34. DeviceRequest.modifierExtension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Slicing | This element introduces a set of slices on DeviceRequest.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 36. DeviceRequest.modifierExtension:doNotPerform | |||||
| Slice Name | doNotPerform | ||||
| Definition | R5: | ||||
| Short | R5: True if the request is to stop or not to start using the device (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: True if the request is to stop or not to start using the device (new)) (Extension Type: boolean) | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 38. DeviceRequest.identifier | |||||
| Definition | Identifiers assigned to this order by the orderer or by the receiver. | ||||
| Short | External Request identifier | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 40. DeviceRequest.definition | |||||
| Definition | Protocol or definition followed by this request. For example: The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%. | ||||
| Short | Protocol or definition | ||||
| Control | 0..* | ||||
| Type | Reference(ActivityDefinition, PlanDefinition) | ||||
| Summary | true | ||||
| 42. DeviceRequest.basedOn | |||||
| Definition | Plan/proposal/order fulfilled by this request. | ||||
| Short | What request fulfills | ||||
| Control | 0..* | ||||
| Type | Reference(Resource) | ||||
| Summary | true | ||||
| 44. DeviceRequest.basedOn.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 46. DeviceRequest.basedOn.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DeviceRequest.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 48. DeviceRequest.basedOn.extension:basedOn | |||||
| Slice Name | basedOn | ||||
| Definition | R5: | ||||
| Short | R5: basedOn additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 50. DeviceRequest.basedOn.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 52. DeviceRequest.basedOn.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 54. DeviceRequest.basedOn.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 56. DeviceRequest.priorRequest | |||||
| Definition | The request takes the place of the referenced completed or terminated request(s). | ||||
| Short | What request replaces | ||||
| Control | 0..* | ||||
| Type | Reference(Resource) | ||||
| Summary | true | ||||
| 58. DeviceRequest.priorRequest.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 60. DeviceRequest.priorRequest.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DeviceRequest.priorRequest.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 62. DeviceRequest.priorRequest.extension:replaces | |||||
| Slice Name | replaces | ||||
| Definition | R5: | ||||
| Short | R5: replaces additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 64. DeviceRequest.priorRequest.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 66. DeviceRequest.priorRequest.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 68. DeviceRequest.priorRequest.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 70. DeviceRequest.groupIdentifier | |||||
| Definition | Composite request this is part of. | ||||
| Short | Identifier of composite request | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 72. DeviceRequest.status | |||||
| Definition | The status of the request. | ||||
| Short | draft | active | suspended | completed | entered-in-error | cancelled | ||||
| Comments | This element is labeled as a modifier because the status contains the codes cancelled and entered-in-error that mark the request as not currently valid. | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from RequestStatus (required to http://hl7.org/fhir/ValueSet/request-status|3.0.2)Codes representing the status of the request. | ||||
| Type | code | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 74. DeviceRequest.intent | |||||
| Definition | Whether the request is a proposal, plan, an original order or a reflex order. | ||||
| Short | proposal | plan | original-order | encoded | reflex-order | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from RequestIntent (required to http://hl7.org/fhir/ValueSet/request-intent|3.0.2)The kind of diagnostic request | ||||
| Type | CodeableConcept | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| 76. DeviceRequest.intent.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 78. DeviceRequest.intent.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DeviceRequest.intent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 80. DeviceRequest.intent.extension:intent | |||||
| Slice Name | intent | ||||
| Definition | R5: | ||||
| Short | R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option | ||||
| Comments | Element | ||||
| Control | 1..1 | ||||
| Type | Extension(R5: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option) (Extension Type: code) | ||||
| 82. DeviceRequest.intent.coding | |||||
| Definition | A reference to a code defined by a terminology system. | ||||
| Short | Code defined by a terminology system | ||||
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. | ||||
| Control | 0..* | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
| 84. DeviceRequest.intent.text | |||||
| Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. | ||||
| Short | Plain text representation of the concept | ||||
| Comments | Very often the text is the same as a displayName of one of the codings. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. | ||||
| 86. DeviceRequest.priority | |||||
| Definition | Indicates how quickly the {{title}} should be addressed with respect to other requests. | ||||
| Short | Indicates how quickly the {{title}} should be addressed with respect to other requests | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from RequestPriority (required to http://hl7.org/fhir/ValueSet/request-priority|3.0.2)Identifies the level of importance to be assigned to actioning the request | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| Default Value | If missing, normal priority | ||||
| 88. DeviceRequest.code[x] | |||||
| Definition | The details of the device to be used. | ||||
| Short | Device requested | ||||
| Control | 1..1 | ||||
| Binding | For example codes, see FHIR Device Types (example to http://hl7.org/fhir/ValueSet/device-kind|3.0.2)Codes for devices that can be requested | ||||
| Type | Choice of: Reference(Device), CodeableConcept | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Summary | true | ||||
| 90. DeviceRequest.subject | |||||
| Definition | The patient who will use the device. | ||||
| Short | Focus of request | ||||
| Control | 1..1 | ||||
| Type | Reference(Patient, Group, Location, Device) | ||||
| Summary | true | ||||
| 92. DeviceRequest.subject.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 94. DeviceRequest.subject.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DeviceRequest.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 96. DeviceRequest.subject.extension:subject | |||||
| Slice Name | subject | ||||
| Definition | R5: | ||||
| Short | R5: subject | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 98. DeviceRequest.subject.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 100. DeviceRequest.subject.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 102. DeviceRequest.subject.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 104. DeviceRequest.context | |||||
| Definition | An encounter that provides additional context in which this request is made. | ||||
| Short | Encounter or Episode motivating request | ||||
| Control | 0..1 | ||||
| Type | Reference(Encounter, EpisodeOfCare) | ||||
| Summary | true | ||||
| 106. DeviceRequest.context.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 108. DeviceRequest.context.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DeviceRequest.context.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 110. DeviceRequest.context.extension:encounter | |||||
| Slice Name | encounter | ||||
| Definition | R5: | ||||
| Short | R5: Encounter motivating request additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 112. DeviceRequest.context.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 114. DeviceRequest.context.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 116. DeviceRequest.context.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 118. DeviceRequest.occurrence[x] | |||||
| Definition | 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". | ||||
| Short | Desired time or schedule for use | ||||
| Control | 0..1 | ||||
| Type | Choice of: dateTime, Period, Timing | ||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 120. DeviceRequest.authoredOn | |||||
| Definition | When the request transitioned to being actionable. | ||||
| Short | When recorded | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 122. DeviceRequest.requester | |||||
| Definition | The individual who initiated the request and has responsibility for its activation. | ||||
| Short | Who/what is requesting diagnostics | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 124. DeviceRequest.requester.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 126. DeviceRequest.requester.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||||
| Short | Additional Content defined by implementations | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 128. DeviceRequest.requester.modifierExtension | |||||
| Definition | 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 that contains it. Usually modifier elements provide negation or qualification. In order 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| Comments | 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 130. DeviceRequest.requester.agent | |||||
| Definition | The device, practitioner, etc. who initiated the request. | ||||
| Short | Individual making the request | ||||
| Control | 1..1 | ||||
| Type | Reference(Device, Practitioner, Organization) | ||||
| Summary | true | ||||
| 132. DeviceRequest.requester.agent.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 134. DeviceRequest.requester.agent.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DeviceRequest.requester.agent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 136. DeviceRequest.requester.agent.extension:requester | |||||
| Slice Name | requester | ||||
| Definition | R5: | ||||
| Short | R5: Who/what submitted the device request | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 138. DeviceRequest.requester.agent.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 140. DeviceRequest.requester.agent.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 142. DeviceRequest.requester.agent.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 144. DeviceRequest.requester.onBehalfOf | |||||
| Definition | The organization the device or practitioner was acting on behalf of. | ||||
| Short | Organization agent is acting for | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Summary | true | ||||
| Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. | ||||
| 146. DeviceRequest.performerType | |||||
| Definition | Desired type of performer for doing the diagnostic testing. | ||||
| Short | Fille role | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see Participant Roles (example to http://hl7.org/fhir/ValueSet/participant-role|3.0.2)Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 148. DeviceRequest.performer | |||||
| Definition | The desired perfomer for doing the diagnostic testing. | ||||
| Short | Requested Filler | ||||
| Control | 0..1 | ||||
| Type | Reference(Practitioner, Organization, Patient, Device, RelatedPerson, HealthcareService) | ||||
| Summary | true | ||||
| 150. DeviceRequest.reasonCode | |||||
| Definition | Reason or justification for the use of this device. | ||||
| Short | Coded Reason for request | ||||
| Control | 0..* | ||||
| Binding | For example codes, see Condition/Problem/Diagnosis Codes (example to http://hl7.org/fhir/ValueSet/condition-code|3.0.2)Diagnosis or problem codes justifying the reason for requesting the device. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 152. DeviceRequest.reasonReference | |||||
| Definition | Reason or justification for the use of this device. | ||||
| Short | Linked Reason for request | ||||
| Control | 0..* | ||||
| Type | Reference(Resource) | ||||
| Summary | true | ||||
| 154. DeviceRequest.supportingInfo | |||||
| Definition | Additional clinical information about the patient that may influence the request fulfilment. For example, this may includes body where on the subject's the device will be used ( i.e. the target site). | ||||
| Short | Additional clinical information | ||||
| Control | 0..* | ||||
| Type | Reference(Resource) | ||||
| Requirements | Knowing where the device is targeted is important for tracking if multiple sites are possible. | ||||
| 156. DeviceRequest.supportingInfo.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 158. DeviceRequest.supportingInfo.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DeviceRequest.supportingInfo.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 160. DeviceRequest.supportingInfo.extension:supportingInfo | |||||
| Slice Name | supportingInfo | ||||
| Definition | R5: | ||||
| Short | R5: supportingInfo additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 162. DeviceRequest.supportingInfo.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 164. DeviceRequest.supportingInfo.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 166. DeviceRequest.supportingInfo.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 168. DeviceRequest.note | |||||
| Definition | 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. | ||||
| Short | Notes or comments | ||||
| Control | 0..* | ||||
| Type | Annotation | ||||
| 170. DeviceRequest.relevantHistory | |||||
| Definition | Key events in the history of the request. | ||||
| Short | Request provenance | ||||
| Comments | This may not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. | ||||
| Control | 0..* | ||||
| Type | Reference(Provenance) | ||||
| 172. DeviceRequest.relevantHistory.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 174. DeviceRequest.relevantHistory.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on DeviceRequest.relevantHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 176. DeviceRequest.relevantHistory.extension:relevantHistory | |||||
| Slice Name | relevantHistory | ||||
| Definition | R5: | ||||
| Short | R5: relevantHistory additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 178. DeviceRequest.relevantHistory.reference | |||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||
| Short | Literal reference, Relative, internal or absolute URL | ||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 180. DeviceRequest.relevantHistory.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||
| Short | Logical reference, when literal reference is not known | ||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 182. DeviceRequest.relevantHistory.display | |||||
| Definition | Plain text narrative that identifies the resource in addition to the resource reference. | ||||
| Short | Text alternative for the resource | ||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||