This 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
Profile for medicationprescription
{ "resourceType": "Profile", "text": { "status": "generated", "div": "<div><pre>\r\n<<a title=\"An order for both supply of the medication and the instructions for administration of the medicine to a patient.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription\"><b>MedicationPrescription</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=\"External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.identifier\"><span style=\"text-decoration: underline\"><b>identifier</b></span></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</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=\"The date (and perhaps time) when the prescription was written.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dateWritten\"><b>dateWritten</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\">When prescription was authorized</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code specifying the state of the order. Generally this will be active or completed state (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.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-prescription-status.html\">active | on hold | completed | entered in error | stopped | superceded</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=\"medicationprescription-definitions.html#MedicationPrescription.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 prescription is for</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The healthcare professional responsible for authorizing the prescription.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.prescriber\"><b>prescriber</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\">Who ordered the medication(s)</span><span style=\"color: Gray\"> --></span></prescriber>\r\n <<a title=\"A link to a resource that identifies the particular occurrence of contact between patient and health care provider.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.encounter\"><b>encounter</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=\"encounter.html#Encounter\">Encounter</a>)</span> <span style=\"color: navy\">Created during encounter / admission / stay</span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"Can be the reason or the indication for writing the prescription.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.reason_x_\"><b>reason[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#CodeableConcept\">CodeableConcept</a>|<a href=\"references.html#Resource\">Resource</a>(<a href=\"condition.html#Condition\">Condition</a>)</span> <span style=\"color: navy\">\r\n Reason or indication for writing the prescription</span><span style=\"color: Gray\"> --></span></reason[x]>\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=\"medicationprescription-definitions.html#MedicationPrescription.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\">Medication to be taken</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"Indicates how the medication is to be used by the patient.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction\"><b>dosageInstruction</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> How medication should be taken --></span>\r\n <<a title=\"Free text dosage instructions for cases where the instructions are too complex to code.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.text\"><b>text</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#string\">string</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Dosage instructions expressed as text</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Additional instructions such as "Swallow with plenty of water" which may or may not be coded.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.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\">\r\n Supplemental instructions - e.g. "with meals"</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=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.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=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.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=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.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 patient.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.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=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.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=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.doseQuantity\"><b>doseQuantity</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></doseQuantity>\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=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.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=\"medicationprescription-definitions.html#MedicationPrescription.dosageInstruction.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 </dosageInstruction>\r\n <<a title=\"Deals with details of the dispense part of the order.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense\"><b>dispense</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Medication supply authorization --></span>\r\n <<a title=\"Identifies the medication that is to be dispensed. This may be a more specifically defined than the medicationPrescription.medication . 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=\"medicationprescription-definitions.html#MedicationPrescription.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\">Product to be supplied</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) \nIt reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. \nRationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.validityPeriod\"><b>validityPeriod</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Time period supply is authorized for</span><span style=\"color: Gray\"> --></span></validityPeriod>\r\n <<a title=\"An integer indicating the number of repeats of the Dispense. \nUsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.numberOfRepeatsAllowed\"><b>numberOfRepeatsAllowed</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#integer\">integer</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\"># of refills authorized</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The amount that is to be dispensed.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.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 of medication to supply per dispense</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. \nIn some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.dispense.expectedSupplyDuration\"><b>expectedSupplyDuration</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Duration\">Duration</a></span> <span style=\"color: navy\">Days supply per dispense</span><span style=\"color: Gray\"> --></span></expectedSupplyDuration>\r\n </dispense>\r\n <<a title=\"Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.substitution\"><b>substitution</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..1</b></span> Any restrictions on medication substitution? --></span>\r\n <<a title=\"A code signifying whether a different drug should be dispensed from what was prescribed.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.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\">generic | formulary +</a><span style=\"color: Gray\"> --></span></type>\r\n <<a title=\"Indicates the reason for the substitution, or why substitution must or must not be performed.\" class=\"dict\" href=\"medicationprescription-definitions.html#MedicationPrescription.substitution.reason\"><b>reason</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/SubstanceAdminSubstitutionReason/index.html\">Why should substitution (not) be made</a><span style=\"color: Gray\"> --></span></reason>\r\n </substitution>\r\n</MedicationPrescription>\r\n</pre></div>" }, "name": "medicationprescription", "publisher": "FHIR Project", "description": "Basic Profile. An order for both supply of the medication and the instructions for administration of the medicine to a patient.", "status": "draft", "date": "2014-09-30", "requirements": "Scope and Usage This resource covers all orders for medications for a patient. This includes in-patient medication orders as well as community orders (whether filled by the prescriber or by a pharmacy). It also includes orders for over-the-counter medications (e.g. Aspirin) and dietary supplements. It may be used to support the order of medication-related devices. It is not intended for use in prescribing particular diets, or for ordering non-medication-related items (eye-glasses, supplies, etc.)", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM" }, { "identity": "v2", "uri": "http://hl7.org/v2", "name": "HL7 v2" } ], "structure": [ { "type": "MedicationPrescription", "publish": true, "element": [ { "path": "MedicationPrescription", "definition": { "short": "Prescription of medication to for patient", "formal": "An order for both supply of the medication and the instructions for administration of the medicine to a patient.", "min": 1, "max": "1", "type": [ { "code": "Resource" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "CombinedMedicationRequest" } ] } }, { "path": "MedicationPrescription.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": "MedicationPrescription.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": "MedicationPrescription.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": "MedicationPrescription.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": "MedicationPrescription.identifier", "definition": { "short": "External identifier", "formal": "External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system.", "min": 0, "max": "*", "type": [ { "code": "Identifier" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "id" }, { "identity": "v2", "map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number" } ] } }, { "path": "MedicationPrescription.dateWritten", "definition": { "short": "When prescription was authorized", "formal": "The date (and perhaps time) when the prescription was written.", "min": 0, "max": "1", "type": [ { "code": "dateTime" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "author.time" }, { "identity": "v2", "map": "RXE-32-Original Order Date/Time / ORC-9-Date/Time of Transaction" } ] } }, { "path": "MedicationPrescription.status", "definition": { "short": "active | on hold | completed | entered in error | stopped | superceded", "formal": "A code specifying the state of the order. Generally this will be active or completed state.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "binding": { "name": "MedicationPrescriptionStatus", "isExtensible": false, "conformance": "required", "referenceResource": { "reference": "http://hl7.org/fhir/vs/medication-prescription-status" } }, "mapping": [ { "identity": "rim", "map": "statusCode" } ] } }, { "path": "MedicationPrescription.patient", "definition": { "short": "Who prescription 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": "subject.role" }, { "identity": "v2", "map": "PID-3-Patient ID List" } ] } }, { "path": "MedicationPrescription.prescriber", "definition": { "short": "Who ordered the medication(s)", "formal": "The healthcare professional responsible for authorizing the prescription.", "min": 0, "max": "1", "type": [ { "code": "ResourceReference", "profile": "http://hl7.org/fhir/profiles/Practitioner" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "author.role" }, { "identity": "v2", "map": "RXE-13-Ordering Provider's DEA Number / RXO-14-Ordering Provider's DEA Number / RXE-14-Pharmacist/Treatment Supplier's Verifier ID / RXO-15-Pharmacist/Treatment Supplier's Verifier ID / ORC-12-Ordering Provider / PRT-5-Participation Person: PRT-4-Participation='OP' (all but last deprecated)" } ] } }, { "path": "MedicationPrescription.encounter", "definition": { "short": "Created during encounter / admission / stay", "formal": "A link to a resource that identifies the particular occurrence of contact between patient and health care provider.", "comments": "SubstanceAdministration->component->EncounterEvent.", "min": 0, "max": "1", "type": [ { "code": "ResourceReference", "profile": "http://hl7.org/fhir/profiles/Encounter" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "componentOf.patientEncounter" }, { "identity": "v2", "map": "PV1-19-Visit Number" } ] } }, { "path": "MedicationPrescription.reason[x]", "definition": { "short": "Reason or indication for writing the prescription", "formal": "Can be the reason or the indication for writing the prescription.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" }, { "code": "ResourceReference", "profile": "http://hl7.org/fhir/profiles/Condition" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "reason.observation\nor\nreason.observation[code=ASSERTION].value" }, { "identity": "v2", "map": "ORC-16-Order Control Code Reason" } ] } }, { "path": "MedicationPrescription.medication", "definition": { "short": "Medication to be taken", "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 prescribed 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": "consumable.administrableMedication" }, { "identity": "v2", "map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code" } ] } }, { "path": "MedicationPrescription.dosageInstruction", "definition": { "short": "How medication should be taken", "formal": "Indicates how the medication is to be used by the patient.", "min": 0, "max": "*", "isModifier": false, "mapping": [ { "identity": "rim", "map": "component.substanceAdministrationRequest" } ] } }, { "path": "MedicationPrescription.dosageInstruction.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": "MedicationPrescription.dosageInstruction.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": "MedicationPrescription.dosageInstruction.text", "definition": { "short": "Dosage instructions expressed as text", "formal": "Free text dosage instructions for cases where the instructions are too complex to code.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "text" }, { "identity": "v2", "map": "RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction" } ] } }, { "path": "MedicationPrescription.dosageInstruction.additionalInstructions", "definition": { "short": "Supplemental instructions - e.g. \"with meals\"", "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": "component.substanceAdministrationRequest.text" }, { "identity": "v2", "map": "RXE-7.2-Provider's Administration Instructions.text / RXO-7.2-Provider's Administration Instructions.text / TQ1-10-Condition Text / TQ1-11-Text Instruction ?" } ] } }, { "path": "MedicationPrescription.dosageInstruction.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": "MedicationPrescription.dosageInstruction.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: precondition.negationInd (inversed - so negationInd = true means asNeeded=false\n\nCodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value" } ] } }, { "path": "MedicationPrescription.dosageInstruction.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": "MedicationPrescription.dosageInstruction.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 patient.", "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": "MedicationPrescription.dosageInstruction.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": "MedicationPrescription.dosageInstruction.doseQuantity", "definition": { "short": "Amount of medication per dose", "formal": "The amount of therapeutic or other substance given at one administration event.", "comments": "Note that this specifies the quantity of the specified medication, not the quantity of active ingredient(s). The prescribed strength can be calculated by multiplying the doseQuantity by the strength of each active ingredient in the prescribed Medication.", "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": "MedicationPrescription.dosageInstruction.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": "MedicationPrescription.dosageInstruction.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.", "comments": "This is intended for use as an adjunct to the dosage when there is an upper cap. For example \"2 tablets ever 4 hours to a maximum of 8/day\".", "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": "MedicationPrescription.dispense", "definition": { "short": "Medication supply authorization", "formal": "Deals with details of the dispense part of the order.", "min": 0, "max": "1", "isModifier": false, "mapping": [ { "identity": "rim", "map": "component.supplyEvent" } ] } }, { "path": "MedicationPrescription.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": "MedicationPrescription.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": "MedicationPrescription.dispense.medication", "definition": { "short": "Product to be supplied", "formal": "Identifies the medication that is to be dispensed. This may be a more specifically defined than the medicationPrescription.medication . 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.", "min": 0, "max": "1", "type": [ { "code": "ResourceReference", "profile": "http://hl7.org/fhir/profiles/Medication" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "consumable.role" }, { "identity": "v2", "map": "RXE-2-Give Code / RXO-1-Requested Give Code / RXD-2-Dispense/Give Code" } ] } }, { "path": "MedicationPrescription.dispense.validityPeriod", "definition": { "short": "Time period supply is authorized for", "formal": "Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) \nIt reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. \nRationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "effectiveTime" }, { "identity": "v2", "map": "RXD-3-Date/Time Dispensed ? / RXD-19-Substance Expiration Date" } ] } }, { "path": "MedicationPrescription.dispense.numberOfRepeatsAllowed", "definition": { "short": "# of refills authorized", "formal": "An integer indicating the number of repeats of the Dispense. \nUsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.", "comments": "If displaying \"number of authorized refills\", subtract 1 from this number.", "min": 0, "max": "1", "type": [ { "code": "integer" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "repeatNumber" }, { "identity": "v2", "map": "RXE-12-Number of Refills" } ] } }, { "path": "MedicationPrescription.dispense.quantity", "definition": { "short": "Amount of medication to supply per dispense", "formal": "The amount that is to be dispensed.", "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": "MedicationPrescription.dispense.expectedSupplyDuration", "definition": { "short": "Days supply per dispense", "formal": "Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. \nIn some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.", "min": 0, "max": "1", "type": [ { "code": "Duration" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "expectedUseTime" } ] } }, { "path": "MedicationPrescription.substitution", "definition": { "short": "Any restrictions on medication substitution?", "formal": "Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.", "min": 0, "max": "1", "isModifier": false, "mapping": [ { "identity": "rim", "map": "subjectOf.substitutionPersmission" } ] } }, { "path": "MedicationPrescription.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": "MedicationPrescription.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": "MedicationPrescription.substitution.type", "definition": { "short": "generic | formulary +", "formal": "A code signifying whether a different drug should be 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": "RXO-9-Allow Substitutions / RXE-9-Substitution Status?" } ] } }, { "path": "MedicationPrescription.substitution.reason", "definition": { "short": "Why should substitution (not) be made", "formal": "Indicates the reason for the substitution, or why substitution must or must not be performed.", "min": 0, "max": "1", "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" } ] } } ], "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": "datewritten", "type": "date", "documentation": "Return prescriptions written on this date", "xpath": "f:MedicationPrescription/f:dateWritten" }, { "name": "encounter", "type": "reference", "documentation": "Return prescriptions with this encounter identity", "xpath": "f:MedicationPrescription/f:encounter" }, { "name": "identifier", "type": "token", "documentation": "Return prescriptions with this external identity", "xpath": "f:MedicationPrescription/f:identifier" }, { "name": "medication", "type": "reference", "documentation": "Code for medicine or text in medicine name", "xpath": "f:MedicationPrescription/f:medication" }, { "name": "patient", "type": "reference", "documentation": "The identity of a patient to list dispenses for", "xpath": "f:MedicationPrescription/f:patient" }, { "name": "status", "type": "token", "documentation": "Status of the prescription", "xpath": "f:MedicationPrescription/f:status" } ] } ] }