{
"description": "Indicates that a device is to be or has been dispensed for a named person/patient. This includes a description of the product (supply) provided and the instructions for using the device.",
"_filename": "StructureDefinition-DeviceDispense.json",
"package_name": "hl7.fhir.uv.oo-incubator",
"date": "2026-10-28T13:58:13+11:00",
"derivation": "specialization",
"publisher": "HL7 International / Orders and Observations",
"fhirVersion": "6.0.0-snapshot1",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm"
} ]
} ],
"name": "DeviceDispense",
"mapping": [ {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 V2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "DeviceDispense",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0-snapshot",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Clinical.Device"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "business"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "oo"
}, {
"url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status",
"valueCode": ".status = entered-in-error"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-resource",
"valueBoolean": true
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "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",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust ecosystem and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such ecosystems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "DeviceDispense",
"min": 0,
"definition": "A record of dispensation of a device - i.e., assigning a device to a patient, or to a professional for their use.",
"isModifier": false,
"short": "A record of dispensation of a device",
"mapping": [ {
"map": "Event",
"identity": "workflow"
}, {
"map": "administrative.device",
"identity": "w5"
}, {
"map": "Entity. Role, or Act,Entity, Role, or Act",
"identity": "rim"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/build/StructureDefinition/svg",
"valueCode": "-170,0"
} ],
"max": "*",
"id": "DeviceDispense",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource"
},
"isSummary": false
}, {
"path": "DeviceDispense.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "DeviceDispense.id",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resource id depends on the given use case.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DeviceDispense.meta",
"min": 0,
"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.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "DeviceDispense.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DeviceDispense.implicitRules",
"min": 0,
"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. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "DeviceDispense.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DeviceDispense.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-snapshot1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages|6.0.0-snapshot1"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "DeviceDispense.language",
"comment": "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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DeviceDispense.text",
"min": 0,
"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.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "DeviceDispense.text",
"condition": [ "dom-6" ],
"comment": "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "DeviceDispense.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "DeviceDispense.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"comment": "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. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](http://build.fhir.org/resource.html#additional).",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DeviceDispense.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DeviceDispense.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DeviceDispense.modifierExtension",
"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](http://build.fhir.org/extensibility.html#modifierExtension).",
"min": 0,
"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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DeviceDispense.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"path": "DeviceDispense.identifier",
"min": 0,
"definition": "Business identifier for this dispensation.",
"short": "Business identifier for this dispensation",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "Event.identifier",
"identity": "workflow"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "DeviceDispense.identifier",
"comment": "This is a business identifier, not a resource identifier.",
"base": {
"max": "*",
"min": 0,
"path": "DeviceDispense.identifier"
},
"isSummary": true
}, {
"path": "DeviceDispense.basedOn",
"min": 0,
"definition": "The order or request that this dispense is fulfilling.",
"short": "The order or request that this dispense is fulfilling",
"mapping": [ {
"map": "Event.basedOn",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/DeviceRequest" ]
} ],
"max": "*",
"id": "DeviceDispense.basedOn",
"base": {
"max": "*",
"min": 0,
"path": "DeviceDispense.basedOn"
}
}, {
"path": "DeviceDispense.partOf",
"min": 0,
"definition": "The bigger event that this dispense is a part of.",
"short": "The bigger event that this dispense is a part of",
"mapping": [ {
"map": "Event.partOf",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=COMP]/target[classCode=PROC,moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Procedure" ]
} ],
"max": "*",
"id": "DeviceDispense.partOf",
"base": {
"max": "*",
"min": 0,
"path": "DeviceDispense.partOf"
}
}, {
"path": "DeviceDispense.status",
"min": 1,
"definition": "A code specifying the state of the set of dispense events.",
"isModifier": true,
"short": "preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": ".statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/uv/oo-incubator/ValueSet/devicedispense-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DeviceDispenseStatus"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "A coded concept specifying the state of the dispense event."
}, {
"url": "http://hl7.org/fhir/build/StructureDefinition/v3-map",
"valueString": "ActStatus"
} ],
"description": "Describes the lifecycle of the dispense."
},
"max": "1",
"id": "DeviceDispense.status",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"base": {
"max": "1",
"min": 1,
"path": "DeviceDispense.status"
},
"isModifierReason": "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",
"isSummary": true
}, {
"path": "DeviceDispense.statusReason",
"min": 0,
"definition": "Indicates the reason why a dispense was or was not performed.",
"short": "Why a dispense was or was not performed",
"mapping": [ {
"map": "Event.statusReason",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"not done reason\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DetectedIssue" ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/oo-incubator/ValueSet/devicedispense-status-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DeviceDispenseStatusReason"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "A code describing why a dispense was or was not performed."
} ]
},
"max": "1",
"id": "DeviceDispense.statusReason",
"base": {
"max": "1",
"min": 0,
"path": "DeviceDispense.statusReason"
}
}, {
"path": "DeviceDispense.category",
"min": 0,
"definition": "Indicates the type of device dispense.",
"short": "Type of device dispense",
"mapping": [ {
"map": "Event.category",
"identity": "workflow"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"max": "*",
"id": "DeviceDispense.category",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "DeviceDispense.category"
}
}, {
"path": "DeviceDispense.device",
"min": 1,
"definition": "Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices.",
"short": "What device was supplied",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "Event.product",
"identity": "workflow"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceDefinition" ]
} ],
"max": "1",
"id": "DeviceDispense.device",
"base": {
"max": "1",
"min": 1,
"path": "DeviceDispense.device"
},
"isSummary": true
}, {
"path": "DeviceDispense.subject",
"min": 1,
"definition": "A link to a resource representing the person to whom the device is intended.",
"short": "Who the dispense is for",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject",
"identity": "w5"
}, {
"map": "PID-3-Patient ID List",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].role[classCode=PAT]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"max": "1",
"id": "DeviceDispense.subject",
"comment": "Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.",
"base": {
"max": "1",
"min": 1,
"path": "DeviceDispense.subject"
},
"isSummary": true
}, {
"path": "DeviceDispense.receiver",
"min": 0,
"definition": "Identifies the person who picked up the device or the person or location where the device was delivered. This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.",
"short": "Who collected the device or where the medication was delivered",
"mapping": [ {
"map": ".participation[typeCode=RCV].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Location", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"max": "1",
"id": "DeviceDispense.receiver",
"comment": "Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.",
"base": {
"max": "1",
"min": 0,
"path": "DeviceDispense.receiver"
}
}, {
"path": "DeviceDispense.encounter",
"min": 0,
"definition": "The encounter that establishes the context for this event.",
"short": "Encounter associated with event",
"mapping": [ {
"map": "Event.encounter",
"identity": "workflow"
}, {
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ]
} ],
"max": "1",
"id": "DeviceDispense.encounter",
"base": {
"max": "1",
"min": 0,
"path": "DeviceDispense.encounter"
}
}, {
"path": "DeviceDispense.supportingInformation",
"min": 0,
"definition": "Additional information that supports the device being dispensed.",
"short": "Information that supports the dispensing of the device",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"max": "*",
"id": "DeviceDispense.supportingInformation",
"base": {
"max": "*",
"min": 0,
"path": "DeviceDispense.supportingInformation"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DeviceDispense.performer",
"min": 0,
"definition": "Indicates who or what performed the event.",
"short": "Who performed event",
"mapping": [ {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": ".participation[typeCode=PRF]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "DeviceDispense.performer",
"base": {
"max": "*",
"min": 0,
"path": "DeviceDispense.performer"
}
}, {
"path": "DeviceDispense.performer.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "DeviceDispense.performer.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DeviceDispense.performer.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "DeviceDispense.performer.extension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "DeviceDispense.performer.modifierExtension",
"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](http://build.fhir.org/extensibility.html#modifierExtension).",
"min": 0,
"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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "DeviceDispense.performer.modifierExtension",
"comment": "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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"path": "DeviceDispense.performer.function",
"requirements": "Allows disambiguation of the types of involvement of different performers.",
"min": 0,
"definition": "Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.",
"short": "Who performed the dispense and what they did",
"mapping": [ {
"map": "participation[typeCode=PRF].functionCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "DeviceDispense.performer.function",
"base": {
"max": "1",
"min": 0,
"path": "DeviceDispense.performer.function"
}
}, {
"path": "DeviceDispense.performer.actor",
"min": 1,
"definition": "The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the device.",
"short": "Individual who was performing",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": ".role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"max": "1",
"id": "DeviceDispense.performer.actor",
"comment": "Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.",
"base": {
"max": "1",
"min": 1,
"path": "DeviceDispense.performer.actor"
}
}, {
"path": "DeviceDispense.location",
"min": 0,
"definition": "The principal physical location where the dispense was performed.",
"short": "Where the dispense occurred",
"mapping": [ {
"map": ".participation[typeCode=LOC].role",
"identity": "rim"
}, {
"map": "Event.location",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"max": "1",
"id": "DeviceDispense.location",
"base": {
"max": "1",
"min": 0,
"path": "DeviceDispense.location"
}
}, {
"id": "DeviceDispense.type",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "DeviceDispense.type"
},
"path": "DeviceDispense.type",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Trial fill, partial fill, emergency fill, etc",
"definition": "Indicates the type of dispensing event that is performed."
}, {
"path": "DeviceDispense.quantity",
"min": 0,
"definition": "The number of devices that have been dispensed.",
"short": "Amount dispensed",
"mapping": [ {
"map": ".quantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"max": "1",
"id": "DeviceDispense.quantity",
"base": {
"max": "1",
"min": 0,
"path": "DeviceDispense.quantity"
}
}, {
"path": "DeviceDispense.preparedDate",
"min": 0,
"definition": "The time when the dispensed product was packaged and reviewed.",
"short": "When product was packaged and reviewed",
"mapping": [ {
"map": ".effectiveTime[xmi:type=IVL_TS].low",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
"valueString": "This is time of dispense (preparation). The time of supply to the patient is a separate attribute."
} ],
"max": "1",
"id": "DeviceDispense.preparedDate",
"base": {
"max": "1",
"min": 0,
"path": "DeviceDispense.preparedDate"
},
"isSummary": true
}, {
"path": "DeviceDispense.whenHandedOver",
"min": 0,
"definition": "The time the dispensed product was made available to the patient or their representative.",
"short": "When product was given out",
"mapping": [ {
"map": "Event.occurrence[x]",
"identity": "workflow"
}, {
"map": ".effectiveTime[xmi:type=IVL_TS].high",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
"valueString": "The time of handing over to the patient (pickup/handover in community or supply in inpatient)."
} ],
"max": "1",
"id": "DeviceDispense.whenHandedOver",
"base": {
"max": "1",
"min": 0,
"path": "DeviceDispense.whenHandedOver"
}
}, {
"path": "DeviceDispense.destination",
"min": 0,
"definition": "Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.",
"short": "Where the device was sent or should be sent",
"mapping": [ {
"map": ".participation[typeCode=DST].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
"valueString": "for inpatient setting this is core, but this might not be core for community setting. Also core for internet pharmacy. Core for radioactive materials Will service delivery location be defined by another group?"
} ],
"max": "1",
"id": "DeviceDispense.destination",
"base": {
"max": "1",
"min": 0,
"path": "DeviceDispense.destination"
}
}, {
"path": "DeviceDispense.note",
"min": 0,
"definition": "Extra information about the dispense that could not be conveyed in the other attributes.",
"short": "Information about the dispense",
"mapping": [ {
"map": "Event.note",
"identity": "workflow"
}, {
"map": ".inboundRelationship[typeCode=SUBJ]/source[classCode=ACT,moodCode=EVN]",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "DeviceDispense.note",
"base": {
"max": "*",
"min": 0,
"path": "DeviceDispense.note"
}
}, {
"path": "DeviceDispense.usageInstruction",
"min": 0,
"definition": "The full representation of the instructions.",
"short": "Full representation of the usage instructions",
"type": [ {
"code": "markdown"
} ],
"max": "1",
"id": "DeviceDispense.usageInstruction",
"comment": "The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.",
"base": {
"max": "1",
"min": 0,
"path": "DeviceDispense.usageInstruction"
}
}, {
"path": "DeviceDispense.relevantHistory",
"min": 0,
"definition": "A summary of the events of interest that have occurred, such as when the dispense was verified.",
"short": "A list of relevant lifecycle events",
"mapping": [ {
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]",
"identity": "rim"
}, {
"map": "Event.relevantHistory",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Provenance" ]
} ],
"max": "*",
"id": "DeviceDispense.relevantHistory",
"comment": "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.).",
"base": {
"max": "*",
"min": 0,
"path": "DeviceDispense.relevantHistory"
}
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "6.0.0-snapshot1"
} ]
},
"status": "active",
"id": "02619d9f-abf0-464c-bcf8-0359b3e2e765",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/DeviceDispense",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.40.98.42.3",
"system": "urn:ietf:rfc:3986"
} ],
"version": "0.1.0-snapshot",
"differential": {
"element": [ {
"id": "DeviceDispense",
"max": "*",
"min": 0,
"path": "DeviceDispense",
"short": "A record of dispensation of a device",
"mapping": [ {
"map": "Event",
"identity": "workflow"
}, {
"map": "administrative.device",
"identity": "w5"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/build/StructureDefinition/svg",
"valueCode": "-170,0"
} ],
"definition": "A record of dispensation of a device - i.e., assigning a device to a patient, or to a professional for their use."
}, {
"path": "DeviceDispense.identifier",
"min": 0,
"definition": "Business identifier for this dispensation.",
"short": "Business identifier for this dispensation",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "Event.identifier",
"identity": "workflow"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "DeviceDispense.identifier",
"comment": "This is a business identifier, not a resource identifier.",
"isSummary": true
}, {
"id": "DeviceDispense.basedOn",
"max": "*",
"min": 0,
"path": "DeviceDispense.basedOn",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/DeviceRequest" ]
} ],
"short": "The order or request that this dispense is fulfilling",
"mapping": [ {
"map": "Event.basedOn",
"identity": "workflow"
} ],
"definition": "The order or request that this dispense is fulfilling."
}, {
"id": "DeviceDispense.partOf",
"max": "*",
"min": 0,
"path": "DeviceDispense.partOf",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Procedure" ]
} ],
"short": "The bigger event that this dispense is a part of",
"mapping": [ {
"map": "Event.partOf",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=COMP]/target[classCode=PROC,moodCode=EVN]",
"identity": "rim"
} ],
"definition": "The bigger event that this dispense is a part of."
}, {
"path": "DeviceDispense.status",
"min": 1,
"definition": "A code specifying the state of the set of dispense events.",
"isModifier": true,
"short": "preparation | in-progress | cancelled | on-hold | completed | entered-in-error | stopped | declined | unknown",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": ".statusCode",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/uv/oo-incubator/ValueSet/devicedispense-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DeviceDispenseStatus"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "A coded concept specifying the state of the dispense event."
}, {
"url": "http://hl7.org/fhir/build/StructureDefinition/v3-map",
"valueString": "ActStatus"
} ],
"description": "Describes the lifecycle of the dispense."
},
"max": "1",
"id": "DeviceDispense.status",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"isModifierReason": "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",
"isSummary": true
}, {
"path": "DeviceDispense.statusReason",
"min": 0,
"definition": "Indicates the reason why a dispense was or was not performed.",
"short": "Why a dispense was or was not performed",
"mapping": [ {
"map": "Event.statusReason",
"identity": "workflow"
}, {
"map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"not done reason\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/DetectedIssue" ]
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/uv/oo-incubator/ValueSet/devicedispense-status-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "DeviceDispenseStatusReason"
}, {
"url": "http://hl7.org/fhir/tools/StructureDefinition/binding-definition",
"valueMarkdown": "A code describing why a dispense was or was not performed."
} ]
},
"max": "1",
"id": "DeviceDispense.statusReason"
}, {
"path": "DeviceDispense.category",
"min": 0,
"definition": "Indicates the type of device dispense.",
"short": "Type of device dispense",
"mapping": [ {
"map": "Event.category",
"identity": "workflow"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"max": "*",
"id": "DeviceDispense.category",
"comment": "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."
}, {
"path": "DeviceDispense.device",
"min": 1,
"definition": "Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices.",
"short": "What device was supplied",
"mapping": [ {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "Event.product",
"identity": "workflow"
} ],
"type": [ {
"code": "CodeableReference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/DeviceDefinition" ]
} ],
"max": "1",
"id": "DeviceDispense.device",
"isSummary": true
}, {
"path": "DeviceDispense.subject",
"min": 1,
"definition": "A link to a resource representing the person to whom the device is intended.",
"short": "Who the dispense is for",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject",
"identity": "w5"
}, {
"map": "PID-3-Patient ID List",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].role[classCode=PAT]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"max": "1",
"id": "DeviceDispense.subject",
"comment": "Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead.",
"isSummary": true
}, {
"path": "DeviceDispense.receiver",
"min": 0,
"definition": "Identifies the person who picked up the device or the person or location where the device was delivered. This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.",
"short": "Who collected the device or where the medication was delivered",
"mapping": [ {
"map": ".participation[typeCode=RCV].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Location", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"max": "1",
"id": "DeviceDispense.receiver",
"comment": "Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead."
}, {
"id": "DeviceDispense.encounter",
"max": "1",
"min": 0,
"path": "DeviceDispense.encounter",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Encounter" ]
} ],
"short": "Encounter associated with event",
"mapping": [ {
"map": "Event.encounter",
"identity": "workflow"
}, {
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]",
"identity": "rim"
} ],
"definition": "The encounter that establishes the context for this event."
}, {
"id": "DeviceDispense.supportingInformation",
"max": "*",
"min": 0,
"path": "DeviceDispense.supportingInformation",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"short": "Information that supports the dispensing of the device",
"mapping": [ {
"map": "FiveWs.context",
"identity": "w5"
} ],
"definition": "Additional information that supports the device being dispensed."
}, {
"id": "DeviceDispense.performer",
"max": "*",
"min": 0,
"path": "DeviceDispense.performer",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Who performed event",
"mapping": [ {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": ".participation[typeCode=PRF]",
"identity": "rim"
} ],
"definition": "Indicates who or what performed the event."
}, {
"path": "DeviceDispense.performer.function",
"requirements": "Allows disambiguation of the types of involvement of different performers.",
"min": 0,
"definition": "Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker.",
"short": "Who performed the dispense and what they did",
"mapping": [ {
"map": "participation[typeCode=PRF].functionCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "DeviceDispense.performer.function"
}, {
"path": "DeviceDispense.performer.actor",
"min": 1,
"definition": "The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the device.",
"short": "Individual who was performing",
"mapping": [ {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": ".role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/CareTeam", "http://hl7.org/fhir/StructureDefinition/Group" ]
} ],
"max": "1",
"id": "DeviceDispense.performer.actor",
"comment": "Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners where other more specific resources can be used instead."
}, {
"id": "DeviceDispense.location",
"max": "1",
"min": 0,
"path": "DeviceDispense.location",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"short": "Where the dispense occurred",
"mapping": [ {
"map": ".participation[typeCode=LOC].role",
"identity": "rim"
}, {
"map": "Event.location",
"identity": "workflow"
} ],
"definition": "The principal physical location where the dispense was performed."
}, {
"id": "DeviceDispense.type",
"max": "1",
"min": 0,
"path": "DeviceDispense.type",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Trial fill, partial fill, emergency fill, etc",
"definition": "Indicates the type of dispensing event that is performed."
}, {
"id": "DeviceDispense.quantity",
"max": "1",
"min": 0,
"path": "DeviceDispense.quantity",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"short": "Amount dispensed",
"mapping": [ {
"map": ".quantity",
"identity": "rim"
} ],
"definition": "The number of devices that have been dispensed."
}, {
"path": "DeviceDispense.preparedDate",
"min": 0,
"definition": "The time when the dispensed product was packaged and reviewed.",
"short": "When product was packaged and reviewed",
"mapping": [ {
"map": ".effectiveTime[xmi:type=IVL_TS].low",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
"valueString": "This is time of dispense (preparation). The time of supply to the patient is a separate attribute."
} ],
"max": "1",
"id": "DeviceDispense.preparedDate",
"isSummary": true
}, {
"path": "DeviceDispense.whenHandedOver",
"min": 0,
"definition": "The time the dispensed product was made available to the patient or their representative.",
"short": "When product was given out",
"mapping": [ {
"map": "Event.occurrence[x]",
"identity": "workflow"
}, {
"map": ".effectiveTime[xmi:type=IVL_TS].high",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
"valueString": "The time of handing over to the patient (pickup/handover in community or supply in inpatient)."
} ],
"max": "1",
"id": "DeviceDispense.whenHandedOver"
}, {
"path": "DeviceDispense.destination",
"min": 0,
"definition": "Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.",
"short": "Where the device was sent or should be sent",
"mapping": [ {
"map": ".participation[typeCode=DST].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"extension": [ {
"url": "http://hl7.org/fhir/build/StructureDefinition/committee-notes",
"valueString": "for inpatient setting this is core, but this might not be core for community setting. Also core for internet pharmacy. Core for radioactive materials Will service delivery location be defined by another group?"
} ],
"max": "1",
"id": "DeviceDispense.destination"
}, {
"id": "DeviceDispense.note",
"max": "*",
"min": 0,
"path": "DeviceDispense.note",
"type": [ {
"code": "Annotation"
} ],
"short": "Information about the dispense",
"mapping": [ {
"map": "Event.note",
"identity": "workflow"
}, {
"map": ".inboundRelationship[typeCode=SUBJ]/source[classCode=ACT,moodCode=EVN]",
"identity": "rim"
} ],
"definition": "Extra information about the dispense that could not be conveyed in the other attributes."
}, {
"id": "DeviceDispense.usageInstruction",
"max": "1",
"min": 0,
"path": "DeviceDispense.usageInstruction",
"type": [ {
"code": "markdown"
} ],
"short": "Full representation of the usage instructions",
"comment": "The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.",
"definition": "The full representation of the instructions."
}, {
"path": "DeviceDispense.relevantHistory",
"min": 0,
"definition": "A summary of the events of interest that have occurred, such as when the dispense was verified.",
"short": "A list of relevant lifecycle events",
"mapping": [ {
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]",
"identity": "rim"
}, {
"map": "Event.relevantHistory",
"identity": "workflow"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Provenance" ]
} ],
"max": "*",
"id": "DeviceDispense.relevantHistory",
"comment": "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.)."
} ]
},
"contact": [ {
"name": "HL7 Orders and Observations Workgroup",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/orders",
"system": "url"
}, {
"value": "ord@lists.HL7.org",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}