STU3 Candidate
MedicationsThis page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
StructureDefinition for medicationdispense
{
"resourceType": "StructureDefinition",
"id": "MedicationDispense",
"meta": {
"lastUpdated": "2016-12-06T12:22:34.981+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "phx"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"name": "MedicationDispense",
"status": "draft",
"publisher": "Health Level Seven International (Pharmacy)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/medication/index.cfm"
}
]
}
],
"date": "2016-12-06T12:22:34+11:00",
"description": "Base StructureDefinition for MedicationDispense Resource",
"fhirVersion": "1.8.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "MedicationDispense",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "MedicationDispense",
"path": "MedicationDispense",
"short": "Dispensing a medication to a named patient",
"definition": "Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.",
"comments": "The WG will be updating the MedicationDispense resource to adjust each affected resource to align with the workflow pattern (see workflow.html).",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
},
{
"key": "mdd-1",
"severity": "error",
"human": "whenHandedOver cannot be before whenPrepared",
"expression": "whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared",
"xpath": "not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "Supply[moodCode=EVN]"
},
{
"identity": "w5",
"map": "clinical.medication"
}
]
},
{
"id": "MedicationDispense.id",
"path": "MedicationDispense.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "MedicationDispense.meta",
"path": "MedicationDispense.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "MedicationDispense.implicitRules",
"path": "MedicationDispense.implicitRules",
"short": "A set of rules under which this content was created",
"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.",
"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 as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "MedicationDispense.language",
"path": "MedicationDispense.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "MedicationDispense.text",
"path": "MedicationDispense.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "MedicationDispense.contained",
"path": "MedicationDispense.contained",
"short": "Contained, inline Resources",
"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.",
"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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationDispense.extension",
"path": "MedicationDispense.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationDispense.modifierExtension",
"path": "MedicationDispense.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationDispense.identifier",
"path": "MedicationDispense.identifier",
"short": "External identifier",
"definition": "Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "MedicationDispense.status",
"path": "MedicationDispense.status",
"short": "in-progress | on-hold | completed | entered-in-error | stopped",
"definition": "A code specifying the state of the set of dispense events.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "A coded concept specifying the state of the dispense event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-dispense-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "MedicationDispense.medication[x]",
"path": "MedicationDispense.medication[x]",
"short": "What medication was supplied",
"definition": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. Note: do not use Medication.name to describe the dispensed medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept identifying which substance or product can be dispensed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "MedicationDispense.patient",
"path": "MedicationDispense.patient",
"short": "Who the dispense is for",
"definition": "A link to a resource representing the person to whom the medication will be given.",
"comments": "SubstanceAdministration->subject->Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "MedicationDispense.supportingInformation",
"path": "MedicationDispense.supportingInformation",
"short": "Information that supports the dispensing of the medication",
"definition": "Additional information that supports the medication being dispensed.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "MedicationDispense.dispenser",
"path": "MedicationDispense.dispenser",
"short": "Practitioner responsible for dispensing medication",
"definition": "The individual responsible for dispensing the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-10-Dispensing Provider / PRT-5-Participation Person: PRT-4-Participation='DP' (RXD-10 is deprecated)"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "MedicationDispense.dispensingOrganization",
"path": "MedicationDispense.dispensingOrganization",
"short": "Organization responsible for the dispense of the medication",
"definition": "The organizaation responsible for the dispense of the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RESP].role[classCode=ASSIGNED]"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "MedicationDispense.authorizingPrescription",
"path": "MedicationDispense.authorizingPrescription",
"short": "Medication order that authorizes the dispense",
"definition": "Indicates the medication order that is being dispensed against.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-2 Placer Order Number"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[moodCode=RQO]"
}
]
},
{
"id": "MedicationDispense.type",
"path": "MedicationDispense.type",
"short": "Trial fill, partial fill, emergency fill, etc.",
"definition": "Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ActPharmacySupplyType"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXD-33-Dispense Type"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "MedicationDispense.quantity",
"path": "MedicationDispense.quantity",
"short": "Amount dispensed",
"definition": "The amount of medication that has been dispensed. Includes unit of measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"id": "MedicationDispense.daysSupply",
"path": "MedicationDispense.daysSupply",
"short": "Amount of medication expressed as a timing amount",
"definition": "The amount of medication expressed as a timing amount.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "rim",
"map": "effectiveUseTime"
}
]
},
{
"id": "MedicationDispense.whenPrepared",
"path": "MedicationDispense.whenPrepared",
"short": "When product was packaged and reviewed",
"definition": "The time when the dispensed product was packaged and reviewed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
},
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].low"
}
]
},
{
"id": "MedicationDispense.whenHandedOver",
"path": "MedicationDispense.whenHandedOver",
"short": "When product was given out",
"definition": "The time the dispensed product was provided to the patient or their representative.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
},
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].high"
}
]
},
{
"id": "MedicationDispense.destination",
"path": "MedicationDispense.destination",
"short": "Where the medication was sent",
"definition": "Identification of the facility/location where the medication was shipped to, as part of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-13 Dispense-to Location; RXD-30 Dispense to Pharmacy; RXD-31 Dispense to Pharmacy Address"
},
{
"identity": "rim",
"map": ".participation[typeCode=DST].role"
}
]
},
{
"id": "MedicationDispense.receiver",
"path": "MedicationDispense.receiver",
"short": "Who collected the medication",
"definition": "Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RCV].role"
}
]
},
{
"id": "MedicationDispense.note",
"path": "MedicationDispense.note",
"short": "Information about the dispense",
"definition": "Extra information about the dispense that could not be conveyed in the other attributes.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-9 Dispense Notes"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ]/source[classCode=ACT,moodCode=EVN]"
}
]
},
{
"id": "MedicationDispense.dosageInstruction",
"path": "MedicationDispense.dosageInstruction",
"short": "Medicine administration instructions to the patient/caregiver",
"definition": "Indicates how the medication is to be used by the patient. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.",
"comments": "When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates.",
"min": 0,
"max": "*",
"type": [
{
"code": "DosageInstruction"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]"
}
]
},
{
"id": "MedicationDispense.substitution",
"path": "MedicationDispense.substitution",
"short": "Deals with substitution of one medicine for another",
"definition": "Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN]"
}
]
},
{
"id": "MedicationDispense.substitution.id",
"path": "MedicationDispense.substitution.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MedicationDispense.substitution.extension",
"path": "MedicationDispense.substitution.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MedicationDispense.substitution.modifierExtension",
"path": "MedicationDispense.substitution.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationDispense.substitution.type",
"path": "MedicationDispense.substitution.type",
"short": "Code signifying whether a different drug was dispensed from what was prescribed",
"definition": "A code signifying whether a different drug was dispensed from what was prescribed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ActSubstanceAdminSubstitutionCode"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-9-Allow Substitutions / RXE-9-Substitution Status"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "MedicationDispense.substitution.reason",
"path": "MedicationDispense.substitution.reason",
"short": "Why was substitution made",
"definition": "Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitutionReason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "MedicationDispense.substitution.responsibleParty",
"path": "MedicationDispense.substitution.responsibleParty",
"short": "Who is responsible for the substitution",
"definition": "The person or organization that has primary responsibility for the substitution.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
}
]
},
{
"id": "MedicationDispense.eventHistory",
"path": "MedicationDispense.eventHistory",
"short": "A list of events of interest in the lifecycle",
"definition": "A summary of the events of interest that have occurred, such as when the dispense was verified.",
"comments": "See usage notes in Request pattern in request history.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Provenance"
}
]
}
]
},
"differential": {
"element": [
{
"id": "MedicationDispense",
"path": "MedicationDispense",
"short": "Dispensing a medication to a named patient",
"definition": "Indicates that a medication product is to be or has been dispensed for a named person/patient. This includes a description of the medication product (supply) provided and the instructions for administering the medication. The medication dispense is the result of a pharmacy system responding to a medication order.",
"comments": "The WG will be updating the MedicationDispense resource to adjust each affected resource to align with the workflow pattern (see workflow.html).",
"min": 0,
"max": "*",
"constraint": [
{
"key": "mdd-1",
"severity": "error",
"human": "whenHandedOver cannot be before whenPrepared",
"expression": "whenHandedOver.empty() or whenPrepared.empty() or whenHandedOver >= whenPrepared",
"xpath": "not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)"
}
],
"mapping": [
{
"identity": "rim",
"map": "Supply[moodCode=EVN]"
},
{
"identity": "w5",
"map": "clinical.medication"
}
]
},
{
"id": "MedicationDispense.identifier",
"path": "MedicationDispense.identifier",
"short": "External identifier",
"definition": "Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "MedicationDispense.status",
"path": "MedicationDispense.status",
"short": "in-progress | on-hold | completed | entered-in-error | stopped",
"definition": "A code specifying the state of the set of dispense events.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "A coded concept specifying the state of the dispense event.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-dispense-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "MedicationDispense.medication[x]",
"path": "MedicationDispense.medication[x]",
"short": "What medication was supplied",
"definition": "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.",
"comments": "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. Note: do not use Medication.name to describe the dispensed medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept identifying which substance or product can be dispensed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXD-2-Dispense/Give Code"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "MedicationDispense.patient",
"path": "MedicationDispense.patient",
"short": "Who the dispense is for",
"definition": "A link to a resource representing the person to whom the medication will be given.",
"comments": "SubstanceAdministration->subject->Patient.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "MedicationDispense.supportingInformation",
"path": "MedicationDispense.supportingInformation",
"short": "Information that supports the dispensing of the medication",
"definition": "Additional information that supports the medication being dispensed.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "MedicationDispense.dispenser",
"path": "MedicationDispense.dispenser",
"short": "Practitioner responsible for dispensing medication",
"definition": "The individual responsible for dispensing the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-10-Dispensing Provider / PRT-5-Participation Person: PRT-4-Participation='DP' (RXD-10 is deprecated)"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "MedicationDispense.dispensingOrganization",
"path": "MedicationDispense.dispensingOrganization",
"short": "Organization responsible for the dispense of the medication",
"definition": "The organizaation responsible for the dispense of the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RESP].role[classCode=ASSIGNED]"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "MedicationDispense.authorizingPrescription",
"path": "MedicationDispense.authorizingPrescription",
"short": "Medication order that authorizes the dispense",
"definition": "Indicates the medication order that is being dispensed against.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
}
],
"mapping": [
{
"identity": "v2",
"map": "ORC-2 Placer Order Number"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[moodCode=RQO]"
}
]
},
{
"id": "MedicationDispense.type",
"path": "MedicationDispense.type",
"short": "Trial fill, partial fill, emergency fill, etc.",
"definition": "Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Indicates the type of dispensing event that is performed. For example, Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ActPharmacySupplyType"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXD-33-Dispense Type"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "MedicationDispense.quantity",
"path": "MedicationDispense.quantity",
"short": "Amount dispensed",
"definition": "The amount of medication that has been dispensed. Includes unit of measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-4-Actual Dispense Amount / RXD-5.1-Actual Dispense Units.code / RXD-5.3-Actual Dispense Units.name of coding system"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"id": "MedicationDispense.daysSupply",
"path": "MedicationDispense.daysSupply",
"short": "Amount of medication expressed as a timing amount",
"definition": "The amount of medication expressed as a timing amount.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "rim",
"map": "effectiveUseTime"
}
]
},
{
"id": "MedicationDispense.whenPrepared",
"path": "MedicationDispense.whenPrepared",
"short": "When product was packaged and reviewed",
"definition": "The time when the dispensed product was packaged and reviewed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
},
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].low"
}
]
},
{
"id": "MedicationDispense.whenHandedOver",
"path": "MedicationDispense.whenHandedOver",
"short": "When product was given out",
"definition": "The time the dispensed product was provided to the patient or their representative.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
},
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].high"
}
]
},
{
"id": "MedicationDispense.destination",
"path": "MedicationDispense.destination",
"short": "Where the medication was sent",
"definition": "Identification of the facility/location where the medication was shipped to, as part of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-13 Dispense-to Location; RXD-30 Dispense to Pharmacy; RXD-31 Dispense to Pharmacy Address"
},
{
"identity": "rim",
"map": ".participation[typeCode=DST].role"
}
]
},
{
"id": "MedicationDispense.receiver",
"path": "MedicationDispense.receiver",
"short": "Who collected the medication",
"definition": "Identifies the person who picked up the medication. This will usually be a patient or their caregiver, but some cases exist where it can be a healthcare professional.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RCV].role"
}
]
},
{
"id": "MedicationDispense.note",
"path": "MedicationDispense.note",
"short": "Information about the dispense",
"definition": "Extra information about the dispense that could not be conveyed in the other attributes.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXD-9 Dispense Notes"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ]/source[classCode=ACT,moodCode=EVN]"
}
]
},
{
"id": "MedicationDispense.dosageInstruction",
"path": "MedicationDispense.dosageInstruction",
"short": "Medicine administration instructions to the patient/caregiver",
"definition": "Indicates how the medication is to be used by the patient. The pharmacist reviews the medication order prior to dispense and updates the dosageInstruction based on the actual product being dispensed.",
"comments": "When the dose or rate is intended to change over the entire administration period (e.g. Tapering dose prescriptions), multiple instances of dosage instructions will need to be supplied to convey the different doses/rates.",
"min": 0,
"max": "*",
"type": [
{
"code": "DosageInstruction"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]"
}
]
},
{
"id": "MedicationDispense.substitution",
"path": "MedicationDispense.substitution",
"short": "Deals with substitution of one medicine for another",
"definition": "Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but does not happen, in other cases substitution is not expected but does happen. This block explains what substitution did or did not happen and why.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN]"
}
]
},
{
"id": "MedicationDispense.substitution.type",
"path": "MedicationDispense.substitution.type",
"short": "Code signifying whether a different drug was dispensed from what was prescribed",
"definition": "A code signifying whether a different drug was dispensed from what was prescribed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "A coded concept describing whether a different medicinal product may be dispensed other than the product as specified exactly in the prescription",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-ActSubstanceAdminSubstitutionCode"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-9-Allow Substitutions / RXE-9-Substitution Status"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "MedicationDispense.substitution.reason",
"path": "MedicationDispense.substitution.reason",
"short": "Why was substitution made",
"definition": "Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "A coded concept describing the reason that a different medication should (or should not) be substituted from what was prescribed",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitutionReason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "MedicationDispense.substitution.responsibleParty",
"path": "MedicationDispense.substitution.responsibleParty",
"short": "Who is responsible for the substitution",
"definition": "The person or organization that has primary responsibility for the substitution.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
}
]
},
{
"id": "MedicationDispense.eventHistory",
"path": "MedicationDispense.eventHistory",
"short": "A list of events of interest in the lifecycle",
"definition": "A summary of the events of interest that have occurred, such as when the dispense was verified.",
"comments": "See usage notes in Request pattern in request history.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Provenance"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Candidate (v1.8.0-10521) generated on Tue, Dec 6, 2016 12:26+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change