. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). 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
Profile for medicationdispense
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense\"><b>MedicationDispense</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.identifier\"><span style=\"text-decoration: underline\"><b>identifier</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A code specifying the state of the set of dispense events (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-dispense-status.html\">in progress | on hold | completed | entered in error | stopped</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A link to a resource representing the person to whom the medication will be given.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>)</span> <span style=\"color: navy\">Who the dispense is for</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The individual responsible for dispensing the medication.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispenser\"><b>dispenser</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Practitioner responsible for dispensing medication</span><span style=\"color: Gray\"> --></span></dispenser>\r\n <<a title=\"Indicates the medication order that is being dispensed against.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.authorizingPrescription\"><b>authorizingPrescription</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medicationprescription.html#MedicationPrescription\">MedicationPrescription</a>)</span> <span style=\"color: navy\">\r\n Medication order that authorizes the dispense</span><span style=\"color: Gray\"> --></span></authorizingPrescription>\r\n <<a title=\"Indicates the details of the dispense event such as the days supply and quantity of medication dispensed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense\"><b>dispense</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Details for individual dispensed medicationdetails --></span>\r\n <<a title=\"Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">External identifier for individual item</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A code specifying the state of the dispense event (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.status\"><span style=\"text-decoration: underline\"><b>status</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-dispense-status.html\">in progress | on hold | completed | entered in error | stopped</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/ActPharmacySupplyType/index.html\">Trial fill, partial fill, emergency fill, etc.</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"The amount of medication that has been dispensed. Includes unit of measure.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount dispensed</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"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.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.medication\"><b>medication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"medication.html#Medication\">Medication</a>)</span> <span style=\"color: navy\">What medication was supplied</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"The time when the dispensed product was packaged and reviewed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.whenPrepared\"><b>whenPrepared</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Dispense processing time</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The time the dispensed product was provided to the patient or their representative.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.whenHandedOver\"><b>whenHandedOver</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Handover time</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Identification of the facility/location where the medication was shipped to, as part of the dispense event.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.destination\"><b>destination</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">Where the medication was sent</span><span style=\"color: Gray\"> --></span></destination>\r\n <<a title=\"Identifies the person who picked up the medication. This will usually be a patient or their carer, but some cases exist where it can be a healthcare professional.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.receiver\"><b>receiver</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">Who collected the medication</span><span style=\"color: Gray\"> --></span></receiver>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage\"><b>dosage</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Medicine administration instructions to the patient/carer --></span>\r\n <<a title=\"Additional instructions such as "Swallow with plenty of water" which may or may not be coded.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.additionalInstructions\"><b>additionalInstructions</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">E.g. "Take with food"</span><span style=\"color: Gray\"> --></span></additionalInstructions>\r\n <<a title=\"The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.timing_x_\"><b>timing[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a>|<a href=\"datatypes.html#Period\">Period</a>|<a href=\"datatypes.html#Schedule\">Schedule</a></span> <span style=\"color: navy\">When medication should be administered</span><span style=\"color: Gray\"> --></span></timing[x]>\r\n <<a title=\"If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.asNeeded_x_\"><b>asNeeded[x]</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a>|<a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\">Take "as needed" f(or x)</span><span style=\"color: Gray\"> --></span></asNeeded[x]>\r\n <<a title=\"A coded specification of the anatomic site where the medication first enters the body.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.site\"><b>site</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-approach-site-codes.html\">Body site to administer to</a></span><span style=\"color: Gray\"> --></span></site>\r\n <<a title=\"A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.route\"><b>route</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-route-codes.html\">How drug should enter body</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.method\"><b>method</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administration-method-codes.html\">Technique for administering medication</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"The amount of therapeutic or other substance given at one administration event.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.quantity\"><b>quantity</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Quantity\">Quantity</a></span> <span style=\"color: navy\">Amount of medication per dose</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.rate\"><b>rate</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Amount of medication per unit of time</span><span style=\"color: Gray\"> --></span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.dispense.dosage.maxDosePerPeriod\"><b>maxDosePerPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Ratio\">Ratio</a></span> <span style=\"color: navy\">Upper limit on medication per unit of time</span><span style=\"color: Gray\"> --></span></maxDosePerPeriod>\r\n </dosage>\r\n </dispense>\r\n <<a title=\"Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but doesn't happen, in other cases substitution is not expected but does happen. This block explains what substitition did or did not happen and why.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution\"><b>substitution</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Deals with substitution of one medicine for another --></span>\r\n <<a title=\"A code signifying whether a different drug was dispensed from what was prescribed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution.type\"><b>type</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/ActSubstanceAdminSubstitutionCode/index.html\">Type of substitiution</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution.reason\"><b>reason</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <a style=\"color: navy\" href=\"v3/vs/SubstanceAdminSubstitutionReason/index.html\">Why was substitution made</a><span style=\"color: Gray\"> --></span></reason>\r\n <<a title=\"The person or organization that has primary responsibility for the substitution.\" class=\"dict\" href=\"medicationdispense-definitions.html#MedicationDispense.substitution.responsibleParty\"><b>responsibleParty</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>)</span> <span style=\"color: navy\">\r\n Who is responsible for the substitution</span><span style=\"color: Gray\"> --></span></responsibleParty>\r\n </substitution>\r\n</MedicationDispense>\r\n</pre></div>"
},
"name": "medicationdispense",
"publisher": "FHIR Project",
"description": "Basic Profile. Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource covers the supply of all medications to a patient. Examples include dispensing and pick-up from an out-patient pharmacy, dispensing patient-specific medications from in-patient pharmacy to ward as well as issuing a single dose from ward stock to a patient for consumption.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "MedicationDispense",
"publish": true,
"element": [
{
"path": "MedicationDispense",
"definition": {
"short": "Dispensing a medication to a named patient",
"formal": "Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Supply[moodCode=EVN]"
}
]
}
},
{
"path": "MedicationDispense.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "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.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.identifier",
"definition": {
"short": "External identifier",
"formal": "Identifier assigned by the dispensing facility - this is an identifier assigned outside FHIR.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "MedicationDispense.status",
"definition": {
"short": "in progress | on hold | completed | entered in error | stopped",
"formal": "A code specifying the state of the set of dispense events.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "MedicationDispenseStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/medication-dispense-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status"
},
{
"identity": "v2",
"map": "(Not clear whether or how V2 provides for a snapshot of dispense status)"
}
]
}
},
{
"path": "MedicationDispense.patient",
"definition": {
"short": "Who the dispense is for",
"formal": "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": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
}
},
{
"path": "MedicationDispense.dispenser",
"definition": {
"short": "Practitioner responsible for dispensing medication",
"formal": "The individual responsible for dispensing the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
},
{
"identity": "v2",
"map": "RXD-10-Dispensing Provider / PRT-5-Participation Person: PRT-4-Participation='DP' (RXD-10 is deprecated)"
}
]
}
},
{
"path": "MedicationDispense.authorizingPrescription",
"definition": {
"short": "Medication order that authorizes the dispense",
"formal": "Indicates the medication order that is being dispensed against.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/MedicationPrescription"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=FLFS].target[moodCode=RQO]"
},
{
"identity": "v2",
"map": "ORC-3-Filler Order Number / ORC-2-Placer Order Number"
}
]
}
},
{
"path": "MedicationDispense.dispense",
"definition": {
"short": "Details for individual dispensed medicationdetails",
"formal": "Indicates the details of the dispense event such as the days supply and quantity of medication dispensed.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "1",
"name": "Timing",
"severity": "error",
"human": "whenHandedOver cannot be before whenPrepared",
"xpath": "not(exists(f:whenHandedOver/@value)) or not(exists(f:whenPrepared/@value)) or ( f:whenHandedOver/@value >= f:whenPrepared/@value)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SPLY, moodCode=EVN]"
}
]
}
},
{
"path": "MedicationDispense.dispense.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.dispense.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.dispense.identifier",
"definition": {
"short": "External identifier for individual item",
"formal": "Identifier assigned by the dispensing facility. This is an identifier assigned outside FHIR.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "MedicationDispense.dispense.status",
"definition": {
"short": "in progress | on hold | completed | entered in error | stopped",
"formal": "A code specifying the state of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "MedicationDispenseStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/medication-dispense-status"
}
},
"mapping": [
{
"identity": "rim",
"map": ".status"
}
]
}
},
{
"path": "MedicationDispense.dispense.type",
"definition": {
"short": "Trial fill, partial fill, emergency fill, etc.",
"formal": "Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationDispenseType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/ActPharmacySupplyType"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "RXD-33-Dispense Type"
}
]
}
},
{
"path": "MedicationDispense.dispense.quantity",
"definition": {
"short": "Amount dispensed",
"formal": "The amount of medication that has been dispensed. Includes unit of measure.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".quantity"
},
{
"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"
}
]
}
},
{
"path": "MedicationDispense.dispense.medication",
"definition": {
"short": "What medication was supplied",
"formal": "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": "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": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Medication"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
},
{
"identity": "v2",
"map": "RXD-2-Dispense/Give Code"
}
]
}
},
{
"path": "MedicationDispense.dispense.whenPrepared",
"definition": {
"short": "Dispense processing time",
"formal": "The time when the dispensed product was packaged and reviewed.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].low"
},
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
}
]
}
},
{
"path": "MedicationDispense.dispense.whenHandedOver",
"definition": {
"short": "Handover time",
"formal": "The time the dispensed product was provided to the patient or their representative.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime[xmi:type=IVL_TS].high"
},
{
"identity": "v2",
"map": "RXD-3-Date/Time Dispensed"
}
]
}
},
{
"path": "MedicationDispense.dispense.destination",
"definition": {
"short": "Where the medication was sent",
"formal": "Identification of the facility/location where the medication was shipped to, as part of the dispense event.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=DST].role"
},
{
"identity": "v2",
"map": "RXD-13-Dispense-to Location; RXD-30-Dispense to Pharmacy; RXD-31-Dispense to Pharmacy Address (V2 (in definition of RXD-13, RXD-30 and RXD-31) directs use of the PRT segment but there doesn't appear to be a standard code in Table 0912 suitable for PRT-4-Participation)"
}
]
}
},
{
"path": "MedicationDispense.dispense.receiver",
"definition": {
"short": "Who collected the medication",
"formal": "Identifies the person who picked up the medication. This will usually be a patient or their carer, but some cases exist where it can be a healthcare professional.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=RCV].role"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage",
"definition": {
"short": "Medicine administration instructions to the patient/carer",
"formal": "Indicates how the medication is to be used by the patient.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SBADM, moodCode=INT]"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.dispense.dosage.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.dispense.dosage.additionalInstructions",
"definition": {
"short": "E.g. \"Take with food\"",
"formal": "Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.timing[x]",
"definition": {
"short": "When medication should be administered",
"formal": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions, for example. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
},
{
"code": "Schedule"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "v2",
"map": "RDS:TQ1"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.asNeeded[x]",
"definition": {
"short": "Take \"as needed\" f(or x)",
"formal": "If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose. If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAsNeededReason",
"isExtensible": true,
"conformance": "preferred",
"description": "A coded concept identifying the pre-condition that should hold prior to consuming a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\", etc."
},
"mapping": [
{
"identity": "rim",
"map": "boolean: .outboundRelationship[typeCode=PRCN].negationInd (inversed - so negationInd = true means asNeeded=false\n\nCodeableConcept: .outboundRelationship[typCode=PRCN].target[classCode=OBS, moodCode=EVN, isCriterionInd=true, code=\"Assertion\"].value"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.site",
"definition": {
"short": "Body site to administer to",
"formal": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationSite",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/approach-site-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".approachSiteCode"
},
{
"identity": "v2",
"map": "RXR-2-Administration Site"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.route",
"definition": {
"short": "How drug should enter body",
"formal": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a subject.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "RouteOfAdministration",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/route-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".routeCode"
},
{
"identity": "v2",
"map": "RXR-1-Route"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.method",
"definition": {
"short": "Technique for administering medication",
"formal": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. Examples: Slow Push; Deep IV.\n\nTerminologies used often pre-coordinate this term with the route and or form of administration.",
"comments": "SubstanceAdministration.methodCode.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationMethod",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administration-method-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".methodCode"
},
{
"identity": "v2",
"map": "RXR-4-Administration Method"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.quantity",
"definition": {
"short": "Amount of medication per dose",
"formal": "The amount of therapeutic or other substance given at one administration event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".doseQuantity"
},
{
"identity": "v2",
"map": "RXE-23-Give Rate Amount / RXE-24.1-Give Rate Units.code / RXE-24.3-Give Rate Units.name of coding system"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.rate",
"definition": {
"short": "Amount of medication per unit of time",
"formal": "Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".rateQuantity"
},
{
"identity": "v2",
"map": "RXE-22-Give Per (Time Unit)"
}
]
}
},
{
"path": "MedicationDispense.dispense.dosage.maxDosePerPeriod",
"definition": {
"short": "Upper limit on medication per unit of time",
"formal": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time, e.g. 1000mg in 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".maxDoseQuantity"
},
{
"identity": "v2",
"map": "RXE-4-Give Amount - Maximum / RXE-5-Give Units"
}
]
}
},
{
"path": "MedicationDispense.substitution",
"definition": {
"short": "Deals with substitution of one medicine for another",
"formal": "Indicates whether or not substitution was made as part of the dispense. In some cases substitution will be expected but doesn't happen, in other cases substitution is not expected but does happen. This block explains what substitition did or did not happen and why.",
"min": 0,
"max": "1",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target[classCode=SUBST, moodCode=EVN]"
}
]
}
},
{
"path": "MedicationDispense.substitution.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.substitution.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "MedicationDispense.substitution.type",
"definition": {
"short": "Type of substitiution",
"formal": "A code signifying whether a different drug was dispensed from what was prescribed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationIntendedSubstitutionType",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/ActSubstanceAdminSubstitutionCode"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
},
{
"identity": "v2",
"map": "RXE-9-Substitution Status? (perhaps RXO-9-Allow Substitutions?)"
}
]
}
},
{
"path": "MedicationDispense.substitution.reason",
"definition": {
"short": "Why was substitution made",
"formal": "Indicates the reason for the substitution of (or lack of substitution) from what was prescribed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationIntendedSubstitutionReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/v3/vs/SubstanceAdminSubstitutionReason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".reasonCode"
}
]
}
},
{
"path": "MedicationDispense.substitution.responsibleParty",
"definition": {
"short": "Who is responsible for the substitution",
"formal": "The person or organization that has primary responsibility for the substitution.",
"comments": "rename.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode=PFM].role[classCode=ASSIGN]"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "destination",
"type": "reference",
"documentation": "Return dispenses that should be sent to a secific destination",
"xpath": "f:MedicationDispense/f:dispense/f:destination"
},
{
"name": "dispenser",
"type": "reference",
"documentation": "Return all dispenses performed by a specific indiividual",
"xpath": "f:MedicationDispense/f:dispenser"
},
{
"name": "identifier",
"type": "token",
"documentation": "Return dispenses with this external identity",
"xpath": "f:MedicationDispense/f:identifier"
},
{
"name": "medication",
"type": "reference",
"documentation": "Returns dispenses of this medicine",
"xpath": "f:MedicationDispense/f:dispense/f:medication"
},
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list dispenses for",
"xpath": "f:MedicationDispense/f:patient"
},
{
"name": "prescription",
"type": "reference",
"documentation": "The identity of a prescription to list dispenses from",
"xpath": "f:MedicationDispense/f:authorizingPrescription"
},
{
"name": "responsibleparty",
"type": "reference",
"documentation": "Return all dispenses with the specified responsible party",
"xpath": "f:MedicationDispense/f:substitution/f:responsibleParty"
},
{
"name": "status",
"type": "token",
"documentation": "Status of the dispense",
"xpath": "f:MedicationDispense/f:dispense/f:status"
},
{
"name": "type",
"type": "token",
"documentation": "Return all dispenses of a specific type",
"xpath": "f:MedicationDispense/f:dispense/f:type"
},
{
"name": "whenhandedover",
"type": "date",
"documentation": "Date when medication handed over to patient (outpatient setting), or supplied to ward or clinic (inpatient setting)",
"xpath": "f:MedicationDispense/f:dispense/f:whenHandedOver"
},
{
"name": "whenprepared",
"type": "date",
"documentation": "Date when medication prepared",
"xpath": "f:MedicationDispense/f:dispense/f:whenPrepared"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change