Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build
Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-04-09 |
Definitions for the zib-MedicalDeviceRequest resource profile.
Guidance on how to interpret the contents of this table can be found here
0. DeviceRequest | |
2. DeviceRequest.identifier | |
Note | This is a business identifier, not a resource identifier (see discussion) |
4. DeviceRequest.status | |
6. DeviceRequest.status.extension | |
Slicing | This element introduces a set of slices on DeviceRequest.status.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
8. DeviceRequest.status.extension:orderStatus | |
Slice Name | orderStatus |
Definition | The status of the order. |
Short | OrderStatus |
Control | 0..1 |
Type | Extension(HCIM extension code-specification) (Extension Type: CodeableConcept) |
Alternate Names | OrderStatus |
10. DeviceRequest.status.extension:orderStatus.valueCodeableConcept:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
Binding | Unless not suitable, these codes SHALL be taken from OrderStatusCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000 )The status of the order. |
12. DeviceRequest.code[x] | |
Definition | The code of the type of product. |
Short | ProductType |
Binding | Unless not suitable, these codes SHALL be taken from ProductTypeCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20171231000000 )ProductTypeCodelist |
Type | Choice of: Reference(HCIM MedicalDevice Product), CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Alternate Names | ProductType |
14. DeviceRequest.subject | |
Type | Reference(nl-core-patient, Group, nl-core-location, HCIM MedicalDevice Product) |
16. DeviceRequest.context | |
Type | Reference(HCIM Encounter, nl-core-episodeofcare) |
18. DeviceRequest.occurrence[x] | |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on DeviceRequest.occurrence[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
20. DeviceRequest.occurrence[x]:occurrencePeriod | |
Slice Name | occurrencePeriod |
Type | Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
22. DeviceRequest.occurrence[x]:occurrencePeriod.start | |
Definition | Planned or requested date. Clinical reminders can be used to indicate from when the procedure can take place. A vague date (such as only the month and year) is permitted. |
Short | StartDate |
Alternate Names | BeginDatum |
24. DeviceRequest.occurrence[x]:occurrencePeriod.end | |
Definition | The planned end date of the procedure can be included as well if needed. Depending on the type of procedure, this can also be used to indicate before which time it has to have been completed. |
Short | EndDate |
Alternate Names | EindDatum |
26. DeviceRequest.occurrence[x]:occurrenceDateTime | |
Slice Name | occurrenceDateTime |
Type | dateTime |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. DeviceRequest.occurrence[x]:occurrenceTiming | |
Slice Name | occurrenceTiming |
Type | Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
30. DeviceRequest.requester | |
32. DeviceRequest.requester.agent | |
Type | Reference(HCIM MedicalDevice Product, nl-core-practitioner, nl-core-organization) |
34. DeviceRequest.requester.agent.extension | |
Slicing | This element introduces a set of slices on DeviceRequest.requester.agent.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
36. DeviceRequest.requester.agent.extension:practitionerRole | |
Slice Name | practitionerRole |
Control | 0..1 |
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) |
38. DeviceRequest.requester.onBehalfOf | |
Type | Reference(nl-core-organization) |
40. DeviceRequest.performerType | |
42. DeviceRequest.performerType.coding | |
Slicing | This element introduces a set of slices on DeviceRequest.performerType.coding . The slices are unordered and Open, and can be differentiated using the following discriminators: |
44. DeviceRequest.performerType.coding:healthProfessionalRole | |
Slice Name | healthProfessionalRole |
Definition | The role the healthcare provider fulfils in the healthcare process. For healthcare providers, this could be for example main practitioner, referrer or general practitioner. |
Short | HealthProfessionalRole |
Binding | Unless not suitable, these codes SHALL be taken from ZorgverlenerRolCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000 ) |
Alternate Names | ZorgverlenerRol |
46. DeviceRequest.performer | |
Type | Reference(nl-core-practitioner, nl-core-organization, nl-core-patient, HCIM MedicalDevice Product, nl-core-relatedperson, nl-core-healthcareservice) |
48. DeviceRequest.performer.extension | |
Slicing | This element introduces a set of slices on DeviceRequest.performer.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
50. DeviceRequest.performer.extension:practitionerRole | |
Slice Name | practitionerRole |
Control | 0..1 |
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) |
52. DeviceRequest.note | |
54. DeviceRequest.note.author[x] | |
Type | Choice of: Reference(nl-core-practitioner, nl-core-patient, nl-core-relatedperson), string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Slicing | This element introduces a set of slices on DeviceRequest.note.author[x] . The slices are unordered and Open, and can be differentiated using the following discriminators: |
56. DeviceRequest.note.author[x]:authorReference | |
Slice Name | authorReference |
Type | Reference(Practitioner, Patient, RelatedPerson) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
58. DeviceRequest.note.author[x]:authorReference.extension | |
Slicing | This element introduces a set of slices on DeviceRequest.note.author[x].extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
60. DeviceRequest.note.author[x]:authorReference.extension:practitionerRole | |
Slice Name | practitionerRole |
Comments | Relevant only in combination with Reference(Practitioner) |
Control | 0..1 |
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) |
62. DeviceRequest.note.author[x]:authorString | |
Slice Name | authorString |
Type | string |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
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.modifierExtension | |
Definition | 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 | 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 |
Alternate Names | extensions, user content |
6. 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 |
8. 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 (required to http://hl7.org/fhir/ValueSet/request-status )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 |
10. DeviceRequest.status.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.status.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
12. DeviceRequest.status.extension:orderStatus | |
Slice Name | orderStatus |
Definition | The status of the order. |
Short | OrderStatus |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HCIM extension code-specification) (Extension Type: CodeableConcept) |
Alternate Names | Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet., OrderStatus |
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.status.extension:orderStatus.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Short | identifies the meaning of the extension |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Control | 1..1 |
Type | uri |
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. |
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/code-specification |
16. DeviceRequest.status.extension:orderStatus.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 10..1 |
Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Slicing | This element introduces a set of slices on DeviceRequest.status.extension.value[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: |
18. DeviceRequest.status.extension:orderStatus.value[x]:valueCodeableConcept | |
Slice Name | valueCodeableConcept |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Short | Value of extension |
Control | 10..1 |
Binding | Unless not suitable, these codes SHALL be taken from For codes, see OrderStatusCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000 )The status of the order. |
Type | CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal |
[x] Note | See Choice of Data Types for further information about how to use [x] |
20. 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 (required to http://hl7.org/fhir/ValueSet/request-intent )The kind of diagnostic request |
Type | CodeableConcept |
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
Summary | true |
22. DeviceRequest.code[x] | |
Definition | The code of the type of product. The details of the device to be used. |
Short | ProductTypeDevice requested |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from For example codes, see ProductTypeCodelijsthttp://hl7.org/fhir/ValueSet/device-kind (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20171231000000 )ProductTypeCodelist Codes for devices that can be requested |
Type | Choice of: Reference(HCIM MedicalDevice Product, Device), CodeableConcept |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Alternate Names | ProductType |
24. DeviceRequest.subject | |
Definition | The patient who will use the device. |
Short | Focus of request |
Control | 1..1 |
Type | Reference(nl-core-patient, Group, nl-core-location, HCIM MedicalDevice Product, Patient, Location, Device) |
Summary | true |
26. 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(HCIM Encounter, nl-core-episodeofcare, Encounter, EpisodeOfCare) |
Summary | true |
28. 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 | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Slicing | This element introduces a set of slices on DeviceRequest.occurrence[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: |
30. DeviceRequest.occurrence[x]:occurrencePeriod | |
Slice Name | occurrencePeriod |
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 | Period, dateTime, Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
32. DeviceRequest.occurrence[x]:occurrencePeriod.start | |
Definition | Planned or requested date. Clinical reminders can be used to indicate from when the procedure can take place. A vague date (such as only the month and year) is permitted. The start of the period. The boundary is inclusive. |
Short | StartDateStarting time with inclusive boundary |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Control | 0..1 This element is affected by the following invariants: per-1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | BeginDatum |
34. DeviceRequest.occurrence[x]:occurrencePeriod.end | |
Definition | The planned end date of the procedure can be included as well if needed. Depending on the type of procedure, this can also be used to indicate before which time it has to have been completed. The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Short | EndDateEnd time with inclusive boundary, if not ongoing |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Control | 0..1 This element is affected by the following invariants: per-1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
Alternate Names | EindDatum |
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing |
36. DeviceRequest.occurrence[x]:occurrenceDateTime | |
Slice Name | occurrenceDateTime |
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 | dateTime, Period, Timing |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Summary | true |
38. DeviceRequest.occurrence[x]:occurrenceTiming | |
Slice Name | occurrenceTiming |
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 | Timing, dateTime, Period |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
40. 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()) )ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) |
42. 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 |
44. DeviceRequest.requester.agent | |
Definition | The device, practitioner, etc. who initiated the request. |
Short | Individual making the request |
Control | 1..1 |
Type | Reference(HCIM MedicalDevice Product, nl-core-practitioner, nl-core-organization, Device, Practitioner, Organization) |
Summary | true |
46. DeviceRequest.requester.agent.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.requester.agent.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
48. DeviceRequest.requester.agent.extension:practitionerRole | |
Slice Name | practitionerRole |
Definition | Optional Extension Element - found in all resources. |
Short | Optional Extensions Element |
Control | 0..1 |
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) |
50. 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(nl-core-organization, 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. |
52. DeviceRequest.performer | |
Definition | The desired perfomer for doing the diagnostic testing. |
Short | Requested Filler |
Control | 0..1 |
Type | Reference(nl-core-practitioner, nl-core-organization, nl-core-patient, HCIM MedicalDevice Product, nl-core-relatedperson, nl-core-healthcareservice, Practitioner, Organization, Patient, Device, RelatedPerson, HealthcareService) |
Summary | true |
54. DeviceRequest.performer.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.performer.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: |
56. DeviceRequest.performer.extension:practitionerRole | |
Slice Name | practitionerRole |
Definition | Optional Extension Element - found in all resources. |
Short | Optional Extensions Element |
Control | 0..1 |
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) |
Guidance on how to interpret the contents of this table can be found here
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 )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 | 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 | 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 | ||||
16. DeviceRequest.modifierExtension | |||||
Definition | 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 | 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 | ||||
Alternate Names | extensions, user content | ||||
18. 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 | ||||
20. 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 | ||||
22. DeviceRequest.basedOn | |||||
Definition | Plan/proposal/order fulfilled by this request. | ||||
Short | What request fulfills | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
Summary | true | ||||
24. 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 | ||||
26. DeviceRequest.groupIdentifier | |||||
Definition | Composite request this is part of. | ||||
Short | Identifier of composite request | ||||
Control | 0..1 | ||||
Type | Identifier | ||||
Summary | true | ||||
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 RequestStatus (required to http://hl7.org/fhir/ValueSet/request-status )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.status.id | |||||
Definition | unique id for the element within a resource (for internal references) | ||||
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. | ||||
32. DeviceRequest.status.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on DeviceRequest.status.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
34. DeviceRequest.status.extension:orderStatus | |||||
Slice Name | orderStatus | ||||
Definition | The status of the order. | ||||
Short | OrderStatus | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HCIM extension code-specification) (Extension Type: CodeableConcept) | ||||
Alternate Names | Bevat de specifieke code conform de zib, bij een FHIR-element die een verplichte koppeling heeft met een bepaalde FHIR waardelijst of een FHIR element die niet gecodeerd is gedefinieerd, terwijl de zib dit wel doet., OrderStatus | ||||
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() ) | ||||
36. DeviceRequest.status.extension:orderStatus.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. | ||||
38. DeviceRequest.status.extension:orderStatus.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 | ||||
Slicing | This element introduces a set of slices on DeviceRequest.status.extension.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
40. DeviceRequest.status.extension:orderStatus.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Short | identifies the meaning of the extension | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Control | 1..1 | ||||
Type | uri | ||||
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. | ||||
Fixed Value | http://nictiz.nl/fhir/StructureDefinition/code-specification | ||||
42. DeviceRequest.status.extension:orderStatus.value[x] | |||||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||||
Short | Value of extension | ||||
Control | 1..1 | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Slicing | This element introduces a set of slices on DeviceRequest.status.extension.value[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: | ||||
44. DeviceRequest.status.extension:orderStatus.value[x]:valueCodeableConcept | |||||
Slice Name | valueCodeableConcept | ||||
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). | ||||
Short | Value of extension | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from OrderStatusCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.16.1.2--20171231000000 )The status of the order. | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
46. DeviceRequest.status.value | |||||
Definition | Primitive value for code | ||||
Short | Primitive value for code | ||||
Control | 0..1 | ||||
Type | code | ||||
XML Format | In the XML format, this property is represented as an attribute. | ||||
48. 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 )The kind of diagnostic request | ||||
Type | CodeableConcept | ||||
Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
Summary | true | ||||
50. 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 )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 | ||||
52. DeviceRequest.code[x] | |||||
Definition | The code of the type of product. | ||||
Short | ProductType | ||||
Control | 1..1 | ||||
Binding | Unless not suitable, these codes SHALL be taken from ProductTypeCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.10.1.1--20171231000000 )ProductTypeCodelist | ||||
Type | Choice of: Reference(HCIM MedicalDevice Product), CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
Alternate Names | ProductType | ||||
54. DeviceRequest.subject | |||||
Definition | The patient who will use the device. | ||||
Short | Focus of request | ||||
Control | 1..1 | ||||
Type | Reference(nl-core-patient, Group, nl-core-location, HCIM MedicalDevice Product) | ||||
Summary | true | ||||
56. 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(HCIM Encounter, nl-core-episodeofcare) | ||||
Summary | true | ||||
58. 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 | See Choice of Data Types for further information about how to use [x] | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Slicing | This element introduces a set of slices on DeviceRequest.occurrence[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: | ||||
60. DeviceRequest.occurrence[x]:occurrencePeriod | |||||
Slice Name | occurrencePeriod | ||||
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 | Period | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
62. DeviceRequest.occurrence[x]:occurrencePeriod.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. | ||||
64. DeviceRequest.occurrence[x]:occurrencePeriod.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 | ||||
Slicing | This element introduces a set of slices on DeviceRequest.occurrence[x].extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
66. DeviceRequest.occurrence[x]:occurrencePeriod.start | |||||
Definition | Planned or requested date. Clinical reminders can be used to indicate from when the procedure can take place. A vague date (such as only the month and year) is permitted. | ||||
Short | StartDate | ||||
Comments | If the low element is missing, the meaning is that the low boundary is not known. | ||||
Control | 0..1 This element is affected by the following invariants: per-1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | BeginDatum | ||||
68. DeviceRequest.occurrence[x]:occurrencePeriod.end | |||||
Definition | The planned end date of the procedure can be included as well if needed. Depending on the type of procedure, this can also be used to indicate before which time it has to have been completed. | ||||
Short | EndDate | ||||
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. | ||||
Control | 0..1 This element is affected by the following invariants: per-1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Alternate Names | EindDatum | ||||
Meaning if Missing | If the end of the period is missing, it means that the period is ongoing | ||||
70. DeviceRequest.occurrence[x]:occurrenceDateTime | |||||
Slice Name | occurrenceDateTime | ||||
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 | dateTime | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
72. DeviceRequest.occurrence[x]:occurrenceTiming | |||||
Slice Name | occurrenceTiming | ||||
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 | Timing | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
74. 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 | ||||
76. 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()) ) | ||||
78. 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. | ||||
80. 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 | ||||
82. 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 | ||||
84. DeviceRequest.requester.agent | |||||
Definition | The device, practitioner, etc. who initiated the request. | ||||
Short | Individual making the request | ||||
Control | 1..1 | ||||
Type | Reference(HCIM MedicalDevice Product, nl-core-practitioner, nl-core-organization) | ||||
Summary | true | ||||
86. 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. | ||||
88. 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 are unordered and Open, and can be differentiated using the following discriminators: | ||||
90. DeviceRequest.requester.agent.extension:practitionerRole | |||||
Slice Name | practitionerRole | ||||
Definition | Optional Extension Element - found in all resources. | ||||
Short | Optional Extensions Element | ||||
Control | 0..1 | ||||
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) | ||||
92. 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 | ||||
94. 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 | ||||
96. 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 | ||||
98. 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(nl-core-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. | ||||
100. 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 )Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
102. DeviceRequest.performerType.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. | ||||
104. DeviceRequest.performerType.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 | ||||
Slicing | This element introduces a set of slices on DeviceRequest.performerType.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
106. DeviceRequest.performerType.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. | ||||
Slicing | This element introduces a set of slices on DeviceRequest.performerType.coding . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
108. DeviceRequest.performerType.coding:healthProfessionalRole | |||||
Slice Name | healthProfessionalRole | ||||
Definition | The role the healthcare provider fulfils in the healthcare process. For healthcare providers, this could be for example main practitioner, referrer or general practitioner. | ||||
Short | HealthProfessionalRole | ||||
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..* | ||||
Binding | Unless not suitable, these codes SHALL be taken from ZorgverlenerRolCodelijst (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20171231000000 ) | ||||
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. | ||||
Alternate Names | ZorgverlenerRol | ||||
110. DeviceRequest.performerType.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. | ||||
112. DeviceRequest.performer | |||||
Definition | The desired perfomer for doing the diagnostic testing. | ||||
Short | Requested Filler | ||||
Control | 0..1 | ||||
Type | Reference(nl-core-practitioner, nl-core-organization, nl-core-patient, HCIM MedicalDevice Product, nl-core-relatedperson, nl-core-healthcareservice) | ||||
Summary | true | ||||
114. DeviceRequest.performer.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. | ||||
116. DeviceRequest.performer.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on DeviceRequest.performer.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
118. DeviceRequest.performer.extension:practitionerRole | |||||
Slice Name | practitionerRole | ||||
Definition | Optional Extension Element - found in all resources. | ||||
Short | Optional Extensions Element | ||||
Control | 0..1 | ||||
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) | ||||
120. DeviceRequest.performer.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 | ||||
122. DeviceRequest.performer.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 | ||||
124. DeviceRequest.performer.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 | ||||
126. 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 )Diagnosis or problem codes justifying the reason for requesting the device. | ||||
Type | CodeableConcept | ||||
Summary | true | ||||
128. DeviceRequest.reasonReference | |||||
Definition | Reason or justification for the use of this device. | ||||
Short | Linked Reason for request | ||||
Control | 0..* | ||||
Type | Reference(Resource) | ||||
Summary | true | ||||
130. 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. | ||||
132. 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 | ||||
134. DeviceRequest.note.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. | ||||
136. DeviceRequest.note.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 | ||||
Slicing | This element introduces a set of slices on DeviceRequest.note.extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
138. DeviceRequest.note.author[x] | |||||
Definition | The individual responsible for making the annotation. | ||||
Short | Individual responsible for the annotation | ||||
Control | 0..1 | ||||
Type | Choice of: Reference(nl-core-practitioner, nl-core-patient, nl-core-relatedperson), string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
Slicing | This element introduces a set of slices on DeviceRequest.note.author[x] . The slices are unordered and Closed, and can be differentiated using the following discriminators: | ||||
140. DeviceRequest.note.author[x]:authorReference | |||||
Slice Name | authorReference | ||||
Definition | The individual responsible for making the annotation. | ||||
Short | Individual responsible for the annotation | ||||
Control | 0..1 | ||||
Type | Reference(Practitioner, Patient, RelatedPerson) | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Summary | true | ||||
142. DeviceRequest.note.author[x]:authorReference.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. | ||||
144. DeviceRequest.note.author[x]:authorReference.extension | |||||
Definition | An Extension | ||||
Short | Extension | ||||
Control | 0..* | ||||
Type | Extension | ||||
Slicing | This element introduces a set of slices on DeviceRequest.note.author[x].extension . The slices are unordered and Open, and can be differentiated using the following discriminators: | ||||
146. DeviceRequest.note.author[x]:authorReference.extension:practitionerRole | |||||
Slice Name | practitionerRole | ||||
Definition | Optional Extension Element - found in all resources. | ||||
Short | Optional Extensions Element | ||||
Comments | Relevant only in combination with Reference(Practitioner) | ||||
Control | 0..1 | ||||
Type | Extension(PractitionerRole Reference) (Extension Type: Reference) | ||||
148. DeviceRequest.note.author[x]:authorReference.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 | ||||
150. DeviceRequest.note.author[x]:authorReference.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 | ||||
152. DeviceRequest.note.author[x]:authorReference.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 | ||||
154. DeviceRequest.note.author[x]:authorString | |||||
Slice Name | authorString | ||||
Definition | The individual responsible for making the annotation. | ||||
Short | Individual responsible for the annotation | ||||
Control | 0..1 | ||||
Type | string | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
156. DeviceRequest.note.time | |||||
Definition | Indicates when this particular annotation was made. | ||||
Short | When the annotation was made | ||||
Control | 0..1 | ||||
Type | dateTime | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
Summary | true | ||||
158. DeviceRequest.note.text | |||||
Definition | The text of the annotation. | ||||
Short | The annotation - text content | ||||
Control | 1..1 | ||||
Type | string | ||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
160. 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) |