Profile_R5_DeviceDispense_R4B - Definitions - Extensions for Using Data Elements from FHIR R5 in FHIR R4B v0.1.0

Extensions for Using Data Elements from FHIR R5 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_DeviceDispense_R4B - Detailed Descriptions

Page standards status: Trial-use

Maturity Level: 0

Definitions for the profile-DeviceDispense resource profile.

Key Elements Table
Differential Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. Basic
Definition	Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.
Short	Resource for non-supported content
Control	0..*
Is Modifier	false
Must Support	false
Summary	false
Alternate Names	Z-resource, Extension-resource, Custom-resource
Invariants	dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (`contained.contained.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (`contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`) dom-6: A resource should have narrative for robust management (text.`div`.exists()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. Basic.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
Control	0..1
Type	uri
Is Modifier	true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Must Support	false
Summary	true
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Basic.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
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	10..*
Type	Extension
Is Modifier	false
Must Support	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Basic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
6. Basic.extension:basedOn
Slice Name	basedOn
Definition	R5: `DeviceDispense.basedOn` (new:Reference(CarePlan,DeviceRequest))
Short	R5: The order or request that this dispense is fulfilling (new)
Comments	Element `DeviceDispense.basedOn` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.basedOn` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: The order or request that this dispense is fulfilling (new)) (Extension Type: Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B, CarePlan, Cross-version Profile for R5.DeviceRequest for use in FHIR R4B, DeviceRequest))
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Basic.extension:partOf
Slice Name	partOf
Definition	R5: `DeviceDispense.partOf` (new:Reference(Procedure))
Short	R5: The bigger event that this dispense is a part of (new)
Comments	Element `DeviceDispense.partOf` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.partOf` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: The bigger event that this dispense is a part of (new)) (Extension Type: Reference(Cross-version Profile for R5.Procedure for use in FHIR R4B, Procedure))
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. Basic.extension:statusReason
Slice Name	statusReason
Definition	R5: `DeviceDispense.statusReason` (new:CodeableReference(DetectedIssue))
Short	R5: Why a dispense was or was not performed (new)
Comments	Element `DeviceDispense.statusReason` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.statusReason` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Why a dispense was or was not performed (new)) (Extension Type: CodeableReference(Cross-version Profile for R5.DetectedIssue for use in FHIR R4B, DetectedIssue))
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
12. Basic.extension:category
Slice Name	category
Definition	R5: `DeviceDispense.category` (new:CodeableConcept)
Short	R5: Type of device dispense (new)
Comments	Element `DeviceDispense.category` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.category` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). The category can be used to include where the device is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Type of device dispense (new)) (Extension Type: CodeableConcept)
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. Basic.extension:device
Slice Name	device
Definition	R5: `DeviceDispense.device` (new:CodeableReference(Device,DeviceDefinition))
Short	R5: What device was supplied (new)
Comments	Element `DeviceDispense.device` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.device` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	1..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: What device was supplied (new)) (Extension Type: CodeableReference(Cross-version Profile for R5.Device for use in FHIR R4B, Device, Cross-version Profile for R5.DeviceDefinition for use in FHIR R4B, DeviceDefinition))
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
16. Basic.extension:receiver
Slice Name	receiver
Definition	R5: `DeviceDispense.receiver` (new:Reference(Patient,Practitioner,RelatedPerson,Location,PractitionerRole))
Short	R5: Who collected the device or where the medication was delivered (new)
Comments	Element `DeviceDispense.receiver` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.receiver` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Who collected the device or where the medication was delivered (new)) (Extension Type: Reference(Cross-version Profile for R5.Patient for use in FHIR R4B, Patient, Cross-version Profile for R5.Practitioner for use in FHIR R4B, Practitioner, Cross-version Profile for R5.RelatedPerson for use in FHIR R4B, RelatedPerson, Cross-version Profile for R5.Location for use in FHIR R4B, Location, Cross-version Profile for R5.PractitionerRole for use in FHIR R4B, PractitionerRole))
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. Basic.extension:encounter
Slice Name	encounter
Definition	R5: `DeviceDispense.encounter` (new:Reference(Encounter))
Short	R5: Encounter associated with event (new)
Comments	Element `DeviceDispense.encounter` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.encounter` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Encounter associated with event (new)) (Extension Type: Reference(Cross-version Profile for R5.Encounter for use in FHIR R4B, Encounter))
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
20. Basic.extension:supportingInformation
Slice Name	supportingInformation
Definition	R5: `DeviceDispense.supportingInformation` (new:Reference(Resource))
Short	R5: Information that supports the dispensing of the device (new)
Comments	Element `DeviceDispense.supportingInformation` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.supportingInformation` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Information that supports the dispensing of the device (new)) (Extension Type: Reference(Cross-version Profile for R5.Resource for use in FHIR R4B, Resource))
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. Basic.extension:performer
Slice Name	performer
Definition	R5: `DeviceDispense.performer` (new:BackboneElement)
Short	R5: Who performed event (new)
Comments	Element `DeviceDispense.performer` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.performer` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Who performed event (new)) (Complex Extension)
Is Modifier	false
Must Support	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
24. Basic.extension:location
Slice Name	location
Definition	R5: `DeviceDispense.location` (new:Reference(Location))
Short	R5: Where the dispense occurred (new)
Comments	Element `DeviceDispense.location` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.location` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Where the dispense occurred (new)) (Extension Type: Reference(Cross-version Profile for R5.Location for use in FHIR R4B, Location))
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
26. Basic.extension:type
Slice Name	type
Definition	R5: `DeviceDispense.type` (new:CodeableConcept)
Short	R5: Trial fill, partial fill, emergency fill, etc (new)
Comments	Element `DeviceDispense.type` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.type` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Trial fill, partial fill, emergency fill, etc (new)) (Extension Type: CodeableConcept)
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
28. Basic.extension:quantity
Slice Name	quantity
Definition	R5: `DeviceDispense.quantity` (new:Quantity[SimpleQuantity])
Short	R5: Amount dispensed (new)
Comments	Element `DeviceDispense.quantity` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.quantity` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Amount dispensed (new)) (Extension Type: Quantity(SimpleQuantity))
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
30. Basic.extension:preparedDate
Slice Name	preparedDate
Definition	R5: `DeviceDispense.preparedDate` (new:dateTime)
Short	R5: When product was packaged and reviewed (new)
Comments	Element `DeviceDispense.preparedDate` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.preparedDate` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: When product was packaged and reviewed (new)) (Extension Type: dateTime)
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
32. Basic.extension:whenHandedOver
Slice Name	whenHandedOver
Definition	R5: `DeviceDispense.whenHandedOver` (new:dateTime)
Short	R5: When product was given out (new)
Comments	Element `DeviceDispense.whenHandedOver` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.whenHandedOver` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: When product was given out (new)) (Extension Type: dateTime)
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
34. Basic.extension:destination
Slice Name	destination
Definition	R5: `DeviceDispense.destination` (new:Reference(Location))
Short	R5: Where the device was sent or should be sent (new)
Comments	Element `DeviceDispense.destination` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.destination` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Where the device was sent or should be sent (new)) (Extension Type: Reference(Cross-version Profile for R5.Location for use in FHIR R4B, Location))
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
36. Basic.extension:note
Slice Name	note
Definition	R5: `DeviceDispense.note` (new:Annotation)
Short	R5: Information about the dispense (new)
Comments	Element `DeviceDispense.note` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.note` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..* This element is affected by the following invariants: ele-1
Type	Extension(R5: Information about the dispense (new)) (Extension Type: Annotation)
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
38. Basic.extension:usageInstruction
Slice Name	usageInstruction
Definition	R5: `DeviceDispense.usageInstruction` (new:markdown)
Short	R5: Full representation of the usage instructions (new)
Comments	Element `DeviceDispense.usageInstruction` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.usageInstruction` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: Full representation of the usage instructions (new)) (Extension Type: markdown)
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
40. Basic.extension:eventHistory
Slice Name	eventHistory
Definition	R5: `DeviceDispense.eventHistory` (new:Reference(Provenance))
Short	R5: A list of relevant lifecycle events (new)
Comments	Element `DeviceDispense.eventHistory` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.eventHistory` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This might 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..* This element is affected by the following invariants: ele-1
Type	Extension(R5: A list of relevant lifecycle events (new)) (Extension Type: Reference(Cross-version Profile for R5.Provenance for use in FHIR R4B, Provenance))
Is Modifier	false
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
42. Basic.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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 Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Support	false
Summary	false
Requirements	Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Basic.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
44. Basic.modifierExtension:status
Slice Name	status
Definition	R5: `DeviceDispense.status` (new:code)
Short	R5: preparation \| in-progress \| cancelled \| on-hold \| completed \| entered-in-error \| stopped \| declined \| unknown (new)
Comments	Element `DeviceDispense.status` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.status` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control	1..1 This element is affected by the following invariants: ele-1
Type	Extension(R5: preparation \| in-progress \| cancelled \| on-hold \| completed \| entered-in-error \| stopped \| declined \| unknown (new)) (Extension Type: code)
Is Modifier	true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Must Support	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (`hasValue() or (children().count() > id.count()) or $this is Parameters`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
46. Basic.code
Definition	Identifies the 'type' of resource - equivalent to the resource name for other resources.
Short	Kind of Resource
Comments	Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code. This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.
Control	1..1
Binding	For example codes, see BasicResourceTypeshttp://hl7.org/fhir/ValueSet/basic-resource-type\|4.3.0 (example to `http://hl7.org/fhir/ValueSet/basic-resource-type\|4.3.0`) HL7-maintained set of codes for "Basic" resources
Type	CodeableConcept
Is Modifier	true because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.
Must Support	false
Summary	true
Requirements	Must be able to distinguish different types of Basic resources.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be foundhere

0. Basic
2. Basic.extension
Control	1..*
Slicing	This element introduces a set of slices on `Basic.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
4. Basic.extension:basedOn
Slice Name	basedOn
Definition	R5: `DeviceDispense.basedOn` (new:Reference(CarePlan,DeviceRequest))
Short	R5: The order or request that this dispense is fulfilling (new)
Comments	Element `DeviceDispense.basedOn` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.basedOn` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: The order or request that this dispense is fulfilling (new)) (Extension Type: Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B, CarePlan, Cross-version Profile for R5.DeviceRequest for use in FHIR R4B, DeviceRequest))
6. Basic.extension:partOf
Slice Name	partOf
Definition	R5: `DeviceDispense.partOf` (new:Reference(Procedure))
Short	R5: The bigger event that this dispense is a part of (new)
Comments	Element `DeviceDispense.partOf` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.partOf` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: The bigger event that this dispense is a part of (new)) (Extension Type: Reference(Cross-version Profile for R5.Procedure for use in FHIR R4B, Procedure))
8. Basic.extension:statusReason
Slice Name	statusReason
Definition	R5: `DeviceDispense.statusReason` (new:CodeableReference(DetectedIssue))
Short	R5: Why a dispense was or was not performed (new)
Comments	Element `DeviceDispense.statusReason` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.statusReason` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: Why a dispense was or was not performed (new)) (Extension Type: CodeableReference(Cross-version Profile for R5.DetectedIssue for use in FHIR R4B, DetectedIssue))
10. Basic.extension:category
Slice Name	category
Definition	R5: `DeviceDispense.category` (new:CodeableConcept)
Short	R5: Type of device dispense (new)
Comments	Element `DeviceDispense.category` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.category` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). The category can be used to include where the device is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.
Control	0..*
Type	Extension(R5: Type of device dispense (new)) (Extension Type: CodeableConcept)
12. Basic.extension:device
Slice Name	device
Definition	R5: `DeviceDispense.device` (new:CodeableReference(Device,DeviceDefinition))
Short	R5: What device was supplied (new)
Comments	Element `DeviceDispense.device` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.device` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	1..1
Type	Extension(R5: What device was supplied (new)) (Extension Type: CodeableReference(Cross-version Profile for R5.Device for use in FHIR R4B, Device, Cross-version Profile for R5.DeviceDefinition for use in FHIR R4B, DeviceDefinition))
14. Basic.extension:receiver
Slice Name	receiver
Definition	R5: `DeviceDispense.receiver` (new:Reference(Patient,Practitioner,RelatedPerson,Location,PractitionerRole))
Short	R5: Who collected the device or where the medication was delivered (new)
Comments	Element `DeviceDispense.receiver` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.receiver` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: Who collected the device or where the medication was delivered (new)) (Extension Type: Reference(Cross-version Profile for R5.Patient for use in FHIR R4B, Patient, Cross-version Profile for R5.Practitioner for use in FHIR R4B, Practitioner, Cross-version Profile for R5.RelatedPerson for use in FHIR R4B, RelatedPerson, Cross-version Profile for R5.Location for use in FHIR R4B, Location, Cross-version Profile for R5.PractitionerRole for use in FHIR R4B, PractitionerRole))
16. Basic.extension:encounter
Slice Name	encounter
Definition	R5: `DeviceDispense.encounter` (new:Reference(Encounter))
Short	R5: Encounter associated with event (new)
Comments	Element `DeviceDispense.encounter` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.encounter` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: Encounter associated with event (new)) (Extension Type: Reference(Cross-version Profile for R5.Encounter for use in FHIR R4B, Encounter))
18. Basic.extension:supportingInformation
Slice Name	supportingInformation
Definition	R5: `DeviceDispense.supportingInformation` (new:Reference(Resource))
Short	R5: Information that supports the dispensing of the device (new)
Comments	Element `DeviceDispense.supportingInformation` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.supportingInformation` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: Information that supports the dispensing of the device (new)) (Extension Type: Reference(Cross-version Profile for R5.Resource for use in FHIR R4B, Resource))
20. Basic.extension:performer
Slice Name	performer
Definition	R5: `DeviceDispense.performer` (new:BackboneElement)
Short	R5: Who performed event (new)
Comments	Element `DeviceDispense.performer` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.performer` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: Who performed event (new)) (Complex Extension)
22. Basic.extension:location
Slice Name	location
Definition	R5: `DeviceDispense.location` (new:Reference(Location))
Short	R5: Where the dispense occurred (new)
Comments	Element `DeviceDispense.location` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.location` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: Where the dispense occurred (new)) (Extension Type: Reference(Cross-version Profile for R5.Location for use in FHIR R4B, Location))
24. Basic.extension:type
Slice Name	type
Definition	R5: `DeviceDispense.type` (new:CodeableConcept)
Short	R5: Trial fill, partial fill, emergency fill, etc (new)
Comments	Element `DeviceDispense.type` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.type` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: Trial fill, partial fill, emergency fill, etc (new)) (Extension Type: CodeableConcept)
26. Basic.extension:quantity
Slice Name	quantity
Definition	R5: `DeviceDispense.quantity` (new:Quantity[SimpleQuantity])
Short	R5: Amount dispensed (new)
Comments	Element `DeviceDispense.quantity` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.quantity` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: Amount dispensed (new)) (Extension Type: Quantity(SimpleQuantity))
28. Basic.extension:preparedDate
Slice Name	preparedDate
Definition	R5: `DeviceDispense.preparedDate` (new:dateTime)
Short	R5: When product was packaged and reviewed (new)
Comments	Element `DeviceDispense.preparedDate` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.preparedDate` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: When product was packaged and reviewed (new)) (Extension Type: dateTime)
30. Basic.extension:whenHandedOver
Slice Name	whenHandedOver
Definition	R5: `DeviceDispense.whenHandedOver` (new:dateTime)
Short	R5: When product was given out (new)
Comments	Element `DeviceDispense.whenHandedOver` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.whenHandedOver` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: When product was given out (new)) (Extension Type: dateTime)
32. Basic.extension:destination
Slice Name	destination
Definition	R5: `DeviceDispense.destination` (new:Reference(Location))
Short	R5: Where the device was sent or should be sent (new)
Comments	Element `DeviceDispense.destination` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.destination` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..1
Type	Extension(R5: Where the device was sent or should be sent (new)) (Extension Type: Reference(Cross-version Profile for R5.Location for use in FHIR R4B, Location))
34. Basic.extension:note
Slice Name	note
Definition	R5: `DeviceDispense.note` (new:Annotation)
Short	R5: Information about the dispense (new)
Comments	Element `DeviceDispense.note` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.note` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).
Control	0..*
Type	Extension(R5: Information about the dispense (new)) (Extension Type: Annotation)
36. Basic.extension:usageInstruction
Slice Name	usageInstruction
Definition	R5: `DeviceDispense.usageInstruction` (new:markdown)
Short	R5: Full representation of the usage instructions (new)
Comments	Element `DeviceDispense.usageInstruction` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.usageInstruction` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.
Control	0..1
Type	Extension(R5: Full representation of the usage instructions (new)) (Extension Type: markdown)
38. Basic.extension:eventHistory
Slice Name	eventHistory
Definition	R5: `DeviceDispense.eventHistory` (new:Reference(Provenance))
Short	R5: A list of relevant lifecycle events (new)
Comments	Element `DeviceDispense.eventHistory` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.eventHistory` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This might 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	Extension(R5: A list of relevant lifecycle events (new)) (Extension Type: Reference(Cross-version Profile for R5.Provenance for use in FHIR R4B, Provenance))
40. Basic.modifierExtension
Control	0..*
Slicing	This element introduces a set of slices on `Basic.modifierExtension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
42. Basic.modifierExtension:status
Slice Name	status
Definition	R5: `DeviceDispense.status` (new:code)
Short	R5: preparation \| in-progress \| cancelled \| on-hold \| completed \| entered-in-error \| stopped \| declined \| unknown (new)
Comments	Element `DeviceDispense.status` is not mapped to FHIR R4B, since FHIR R5 `DeviceDispense` is not mapped. Element `DeviceDispense.status` has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Control	1..1
Type	Extension(R5: preparation \| in-progress \| cancelled \| on-hold \| completed \| entered-in-error \| stopped \| declined \| unknown (new)) (Extension Type: code)

Guidance on how to interpret the contents of this table can be foundhere

0. Basic

Definition

Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

Short Resource for non-supported content

Control 0..*

Is Modifier false

Must Support false

Summary false

Alternate Names Z-resource, Extension-resource, Custom-resource

Invariants dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())

2. Basic.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

Is Modifier false

Must Support false

Summary true

4. Basic.meta

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short Metadata about the resource

Control 0..1

Type

Meta

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. Basic.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control 0..1

Type

uri

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. Basic.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

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.3.0)

IETF language tag

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. Basic.text

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

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 information is added later.

Control 0..1

Type

Narrative

Is Modifier false

Must Support false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. Basic.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control 0..*

Type

Resource

Is Modifier false

Must Support false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

Invariants dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))

14. Basic.extension

Definition

An Extension

Short Extension

Control 1..*

Type

Extension

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

Slicing

This element introduces a set of slices on Basic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. Basic.extension:basedOn

Slice Name basedOn

Definition

R5: DeviceDispense.basedOn (new:Reference(CarePlan,DeviceRequest))

Short R5: The order or request that this dispense is fulfilling (new)

Comments

Element DeviceDispense.basedOn is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.basedOn has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: The order or request that this dispense is fulfilling (new)) (Extension Type: Reference(Cross-version Profile for R5.CarePlan for use in FHIR R4B, CarePlan, Cross-version Profile for R5.DeviceRequest for use in FHIR R4B, DeviceRequest))

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

18. Basic.extension:partOf

Slice Name partOf

Definition

R5: DeviceDispense.partOf (new:Reference(Procedure))

Short R5: The bigger event that this dispense is a part of (new)

Comments

Element DeviceDispense.partOf is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.partOf has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: The bigger event that this dispense is a part of (new)) (Extension Type: Reference(Cross-version Profile for R5.Procedure for use in FHIR R4B, Procedure))

Is Modifier false

Must Support false

Summary false

20. Basic.extension:statusReason

Slice Name statusReason

Definition

R5: DeviceDispense.statusReason (new:CodeableReference(DetectedIssue))

Short R5: Why a dispense was or was not performed (new)

Comments

Element DeviceDispense.statusReason is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.statusReason has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Why a dispense was or was not performed (new)) (Extension Type: CodeableReference(Cross-version Profile for R5.DetectedIssue for use in FHIR R4B, DetectedIssue))

Is Modifier false

Must Support false

Summary false

22. Basic.extension:category

Slice Name category

Definition

R5: DeviceDispense.category (new:CodeableConcept)

Short R5: Type of device dispense (new)

Comments

Element DeviceDispense.category is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.category has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). The category can be used to include where the device is expected to be consumed or other types of dispenses. Invariants can be used to bind to different value sets when profiling to bind.

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Type of device dispense (new)) (Extension Type: CodeableConcept)

Is Modifier false

Must Support false

Summary false

24. Basic.extension:device

Slice Name device

Definition

R5: DeviceDispense.device (new:CodeableReference(Device,DeviceDefinition))

Short R5: What device was supplied (new)

Comments

Element DeviceDispense.device is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.device has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 1..1
This element is affected by the following invariants: ele-1

Type Extension(R5: What device was supplied (new)) (Extension Type: CodeableReference(Cross-version Profile for R5.Device for use in FHIR R4B, Device, Cross-version Profile for R5.DeviceDefinition for use in FHIR R4B, DeviceDefinition))

Is Modifier false

Must Support false

Summary false

26. Basic.extension:receiver

Slice Name receiver

Definition

R5: DeviceDispense.receiver (new:Reference(Patient,Practitioner,RelatedPerson,Location,PractitionerRole))

Short R5: Who collected the device or where the medication was delivered (new)

Comments

Element DeviceDispense.receiver is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.receiver has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Who collected the device or where the medication was delivered (new)) (Extension Type: Reference(Cross-version Profile for R5.Patient for use in FHIR R4B, Patient, Cross-version Profile for R5.Practitioner for use in FHIR R4B, Practitioner, Cross-version Profile for R5.RelatedPerson for use in FHIR R4B, RelatedPerson, Cross-version Profile for R5.Location for use in FHIR R4B, Location, Cross-version Profile for R5.PractitionerRole for use in FHIR R4B, PractitionerRole))

Is Modifier false

Must Support false

Summary false

28. Basic.extension:encounter

Slice Name encounter

Definition

R5: DeviceDispense.encounter (new:Reference(Encounter))

Short R5: Encounter associated with event (new)

Comments

Element DeviceDispense.encounter is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.encounter has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Encounter associated with event (new)) (Extension Type: Reference(Cross-version Profile for R5.Encounter for use in FHIR R4B, Encounter))

Is Modifier false

Must Support false

Summary false

30. Basic.extension:supportingInformation

Slice Name supportingInformation

Definition

R5: DeviceDispense.supportingInformation (new:Reference(Resource))

Short R5: Information that supports the dispensing of the device (new)

Comments

Element DeviceDispense.supportingInformation is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.supportingInformation has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Information that supports the dispensing of the device (new)) (Extension Type: Reference(Cross-version Profile for R5.Resource for use in FHIR R4B, Resource))

Is Modifier false

Must Support false

Summary false

32. Basic.extension:performer

Slice Name performer

Definition

R5: DeviceDispense.performer (new:BackboneElement)

Short R5: Who performed event (new)

Comments

Element DeviceDispense.performer is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.performer has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Who performed event (new)) (Complex Extension)

Is Modifier false

Must Support false

34. Basic.extension:location

Slice Name location

Definition

R5: DeviceDispense.location (new:Reference(Location))

Short R5: Where the dispense occurred (new)

Comments

Element DeviceDispense.location is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.location has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Where the dispense occurred (new)) (Extension Type: Reference(Cross-version Profile for R5.Location for use in FHIR R4B, Location))

Is Modifier false

Must Support false

Summary false

36. Basic.extension:type

Slice Name type

Definition

R5: DeviceDispense.type (new:CodeableConcept)

Short R5: Trial fill, partial fill, emergency fill, etc (new)

Comments

Element DeviceDispense.type is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.type has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Trial fill, partial fill, emergency fill, etc (new)) (Extension Type: CodeableConcept)

Is Modifier false

Must Support false

Summary false

38. Basic.extension:quantity

Slice Name quantity

Definition

R5: DeviceDispense.quantity (new:Quantity[SimpleQuantity])

Short R5: Amount dispensed (new)

Comments

Element DeviceDispense.quantity is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.quantity has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Amount dispensed (new)) (Extension Type: Quantity(SimpleQuantity))

Is Modifier false

Must Support false

Summary false

40. Basic.extension:preparedDate

Slice Name preparedDate

Definition

R5: DeviceDispense.preparedDate (new:dateTime)

Short R5: When product was packaged and reviewed (new)

Comments

Element DeviceDispense.preparedDate is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.preparedDate has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: When product was packaged and reviewed (new)) (Extension Type: dateTime)

Is Modifier false

Must Support false

Summary false

42. Basic.extension:whenHandedOver

Slice Name whenHandedOver

Definition

R5: DeviceDispense.whenHandedOver (new:dateTime)

Short R5: When product was given out (new)

Comments

Element DeviceDispense.whenHandedOver is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.whenHandedOver has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: When product was given out (new)) (Extension Type: dateTime)

Is Modifier false

Must Support false

Summary false

44. Basic.extension:destination

Slice Name destination

Definition

R5: DeviceDispense.destination (new:Reference(Location))

Short R5: Where the device was sent or should be sent (new)

Comments

Element DeviceDispense.destination is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.destination has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Where the device was sent or should be sent (new)) (Extension Type: Reference(Cross-version Profile for R5.Location for use in FHIR R4B, Location))

Is Modifier false

Must Support false

Summary false

46. Basic.extension:note

Slice Name note

Definition

R5: DeviceDispense.note (new:Annotation)

Short R5: Information about the dispense (new)

Comments

Element DeviceDispense.note is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.note has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R5: Information about the dispense (new)) (Extension Type: Annotation)

Is Modifier false

Must Support false

Summary false

48. Basic.extension:usageInstruction

Slice Name usageInstruction

Definition

R5: DeviceDispense.usageInstruction (new:markdown)

Short R5: Full representation of the usage instructions (new)

Comments

Element DeviceDispense.usageInstruction is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.usageInstruction has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R5: Full representation of the usage instructions (new)) (Extension Type: markdown)

Is Modifier false

Must Support false

Summary false

50. Basic.extension:eventHistory

Slice Name eventHistory

Definition

R5: DeviceDispense.eventHistory (new:Reference(Provenance))

Short R5: A list of relevant lifecycle events (new)

Comments

Element DeviceDispense.eventHistory is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.eventHistory has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This might 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..*
This element is affected by the following invariants: ele-1

Type Extension(R5: A list of relevant lifecycle events (new)) (Extension Type: Reference(Cross-version Profile for R5.Provenance for use in FHIR R4B, Provenance))

Is Modifier false

Must Support false

Summary false

52. Basic.modifierExtension

Definition

An Extension

Short Extension

Control 0..*

Type

Extension

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Must Support false

Summary false

Slicing

This element introduces a set of slices on Basic.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

54. Basic.modifierExtension:status

Slice Name status

Definition

R5: DeviceDispense.status (new:code)

Comments

Element DeviceDispense.status is not mapped to FHIR R4B, since FHIR R5 DeviceDispense is not mapped. Element DeviceDispense.status has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element). This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control 1..1
This element is affected by the following invariants: ele-1

Is Modifier true because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid

Must Support false

Summary false

56. Basic.identifier

Definition

Identifier assigned to the resource for business purposes, outside the context of FHIR.

Short Business identifier

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Type

Identifier

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

58. Basic.code

Definition

Identifies the 'type' of resource - equivalent to the resource name for other resources.

Short Kind of Resource

Comments

Because resource references will only be able to indicate 'Basic', the type of reference will need to be specified in a Profile identified as part of the resource. Refer to the resource notes section for information on appropriate terminologies for this code.

This element is labeled as a modifier because it defines the meaning of the resource and cannot be ignored.

Control 1..1

Binding

For example codes, see BasicResourceTypes
(example to http://hl7.org/fhir/ValueSet/basic-resource-type|4.3.0)

HL7-maintained set of codes for "Basic" resources

Type

CodeableConcept

Is Modifier true because This element determines what kind of resource is being represented which drives the meaning of all of the other elements.

Must Support false

Summary true

Requirements

Must be able to distinguish different types of Basic resources.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

60. Basic.subject

Definition

Identifies the patient, practitioner, device or any other resource that is the "focus" of this resource.

Short Identifies the focus of this resource

Comments

Optional as not all potential resources will have subjects. Resources associated with multiple subjects can handle this via extension.

Control 0..1

Type Reference(Resource)

Is Modifier false

Must Support false

Summary true

Requirements

Needed for partitioning the resource by Patient.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

62. Basic.created

Definition

Identifies when the resource was first created.

Short When created

Control 0..1

Type

date

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Requirements

Allows ordering resource instances by time.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

64. Basic.author

Definition

Indicates who was responsible for creating the resource instance.

Short Who created

Control 0..1

Type Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization)

Is Modifier false

Must Support false

Summary true

Requirements

Needed for partitioning the resource.

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))