. 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 medicationadministration
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration\"><b>MedicationAdministration</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 - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.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=\"Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.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>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"medication-admin-status.html\">in progress | on hold | completed | entered in error | stopped</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"The person or animal to whom the medication was given.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.patient\"><b>patient</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..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 received medication?</span><span style=\"color: Gray\"> --></span></patient>\r\n <<a title=\"The individual who was responsible for giving the medication to the patient.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.practitioner\"><b>practitioner</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..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 administered substance?</span><span style=\"color: Gray\"> --></span></practitioner>\r\n <<a title=\"The visit or admission the or other contact between patient and health care provider the medication administration was performed as part of.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.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\">Encounter administered as part of</span><span style=\"color: Gray\"> --></span></encounter>\r\n <<a title=\"The original request, instruction or authority to perform the administration.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.prescription\"><b>prescription</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</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 Order administration performed against</span><span style=\"color: Gray\"> --></span></prescription>\r\n <<a title=\"Set this to true if the record is saying that the medication was NOT administered (this element modifies the meaning of other elements)\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.wasNotGiven\"><span style=\"text-decoration: underline\"><b>wasNotGiven</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">True if medication not administered</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A code indicating why the administration was not performed.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.reasonNotGiven\"><b>reasonNotGiven</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: Reason not given is only permitted if wasNotGiven is true\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-reason-medication-not-given-codes.html\">Reason administration not performed</a></span><span style=\"color: Gray\"> --></span></reasonNotGiven>\r\n <<a title=\"An interval of time during which the administration took place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.whenGiven\"><b>whenGiven</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Start and end time of administration</span><span style=\"color: Gray\"> --></span></whenGiven>\r\n <<a title=\"Identifies the medication that was 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=\"medicationadministration-definitions.html#MedicationAdministration.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 was administered?</span><span style=\"color: Gray\"> --></span></medication>\r\n <<a title=\"The device used in administering the medication to the patient. E.g. a particular infusion pump.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.device\"><b>device</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=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">Device used to administer</span><span style=\"color: Gray\"> --></span></device>\r\n <<a title=\"Provides details of how much of the medication was administered.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.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=\"The timing schedule for giving the medication to the patient. This may be a single time point (using dateTime) or it may be a start and end dateTime (Period).\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.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></span> <span style=\"color: navy\">When dose(s) were given</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=\"medicationadministration-definitions.html#MedicationAdministration.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 entered the body. E.g. "left arm".\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.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 administered 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 the patient. E.g. topical, intravenous, etc.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.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\">Path of substance into body</a></span><span style=\"color: Gray\"> --></span></route>\r\n <<a title=\"A coded value indicating the method by which the medication was 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=\"medicationadministration-definitions.html#MedicationAdministration.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\">How drug was administered</a></span><span style=\"color: Gray\"> --></span></method>\r\n <<a title=\"The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.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 administered in one dose</span><span style=\"color: Gray\"> --></span></quantity>\r\n <<a title=\"Identifies the speed with which the medication was introduced into the patient. Typically the rate for an infusion e.g. 200ml in 2 hours. May also expressed as a rate per unit of time such as 100ml per hour - the duration is then not specified, or is specified in the quantity.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.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\">Dose quantity per unit of time</span><span style=\"color: Gray\"> --></span></rate>\r\n <<a title=\"The maximum total quantity of a therapeutic substance that was administered to the patient over the specified period of time. E.g. 1000mg in 24 hours.\" class=\"dict\" href=\"medicationadministration-definitions.html#MedicationAdministration.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\">Total dose that was consumed per unit of time</span><span style=\"color: Gray\"> --></span></maxDosePerPeriod>\r\n </dosage>\r\n</MedicationAdministration>\r\n</pre></div>"
},
"name": "medicationadministration",
"publisher": "FHIR Project",
"description": "Basic Profile. Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage This resource covers the administration of all medications with the exception of vaccines. It will principally be used within inpatient settings to record the capture of medication administrations including self-administrations of oral medications, injections, intra-venous adjustments, etc. It can also be used in out-patient settings to record allergy shots and other non-immunization administrations. In some cases it might be used for home-health reporting, such as recording self-administered or even device-administered insulin.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"structure": [
{
"type": "MedicationAdministration",
"publish": true,
"element": [
{
"path": "MedicationAdministration",
"definition": {
"short": "Administration of medication to a patient",
"formal": "Describes the event of a patient being given a dose of a medication. This may be as simple as swallowing a tablet or it may be a long running infusion.\n\nRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "2",
"name": "Not given reason",
"severity": "error",
"human": "Reason not given is only permitted if wasNotGiven is true",
"xpath": "not(exists(f:reasonNotGiven)) or f:wasNotGiven='true'"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "SubstanceAdministration"
}
]
}
},
{
"path": "MedicationAdministration.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": "MedicationAdministration.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": "MedicationAdministration.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": "MedicationAdministration.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": "MedicationAdministration.identifier",
"definition": {
"short": "External identifier",
"formal": "External identifier - FHIR will generate its own internal IDs (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "id"
},
{
"identity": "v2",
"map": "RXA-25-Administered Barcode Identifier? (V2 def'n of RXA-25 refers to the 'give' occurrence; appears not to discuss 'administer' cardinality which would seem to be 0..*)"
}
]
}
},
{
"path": "MedicationAdministration.status",
"definition": {
"short": "in progress | on hold | completed | entered in error | stopped",
"formal": "Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "MedicationAdministrationStatus",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/medication-admin-status"
}
},
"mapping": [
{
"identity": "rim",
"map": "statusCode"
},
{
"identity": "v2",
"map": "RXA-20-Completion Status"
}
]
}
},
{
"path": "MedicationAdministration.patient",
"definition": {
"short": "Who received medication?",
"formal": "The person or animal to whom the medication was given.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "subject->Patient"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
}
]
}
},
{
"path": "MedicationAdministration.practitioner",
"definition": {
"short": "Who administered substance?",
"formal": "The individual who was responsible for giving the medication to the patient.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "performer->Role"
},
{
"identity": "v2",
"map": "RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)"
}
]
}
},
{
"path": "MedicationAdministration.encounter",
"definition": {
"short": "Encounter administered as part of",
"formal": "The visit or admission the or other contact between patient and health care provider the medication administration was performed as part of.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Encounter"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "component->EncounterEvent"
},
{
"identity": "v2",
"map": "PV1-19-Visit Number"
}
]
}
},
{
"path": "MedicationAdministration.prescription",
"definition": {
"short": "Order administration performed against",
"formal": "The original request, instruction or authority to perform the administration.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/MedicationPrescription"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "InFullfillmentOf->SubstanceAdministration"
},
{
"identity": "v2",
"map": "ORC-3-Filler Order Number / ORC-2-Placer Order Number"
}
]
}
},
{
"path": "MedicationAdministration.wasNotGiven",
"definition": {
"short": "True if medication not administered",
"formal": "Set this to true if the record is saying that the medication was NOT administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "actionNegationInd"
},
{
"identity": "v2",
"map": "RXA-20-Completion Status='NA'"
}
]
}
},
{
"path": "MedicationAdministration.reasonNotGiven",
"definition": {
"short": "Reason administration not performed",
"formal": "A code indicating why the administration was not performed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "MedicationAdministrationNegationReason",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/reason-medication-not-given-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": "Reason->Observation->Value"
},
{
"identity": "v2",
"map": "RXA-9-Administration Notes:RXA-20-Completion Status='NA'"
}
]
}
},
{
"path": "MedicationAdministration.whenGiven",
"definition": {
"short": "Start and end time of administration",
"formal": "An interval of time during which the administration took place. For many administrations, such as swallowing a tablet the lower and upper values of the interval will be the same.",
"min": 1,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime"
},
{
"identity": "v2",
"map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
}
]
}
},
{
"path": "MedicationAdministration.medication",
"definition": {
"short": "What was administered?",
"formal": "Identifies the medication that was 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 administered 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": "Consumeable->AdministerableMedication"
},
{
"identity": "v2",
"map": "RXA-5-Administered Code"
}
]
}
},
{
"path": "MedicationAdministration.device",
"definition": {
"short": "Device used to administer",
"formal": "The device used in administering the medication to the patient. E.g. a particular infusion pump.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "device->Access OR device->AssignedDevice"
},
{
"identity": "v2",
"map": "PRT-10-Participation Device"
}
]
}
},
{
"path": "MedicationAdministration.dosage",
"definition": {
"short": "Medicine administration instructions to the patient/carer",
"formal": "Provides details of how much of the medication was administered.",
"min": 0,
"max": "*",
"constraint": [
{
"key": "1",
"name": "Dose",
"severity": "error",
"human": "SHALL have at least one of dosage.quantity and dosage.rate",
"xpath": "exists(f:quantity) or exists(f:rate)"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "component->SubstanceAdministrationEvent"
}
]
}
},
{
"path": "MedicationAdministration.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": "MedicationAdministration.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": "MedicationAdministration.dosage.timing[x]",
"definition": {
"short": "When dose(s) were given",
"formal": "The timing schedule for giving the medication to the patient. This may be a single time point (using dateTime) or it may be a start and end dateTime (Period).",
"comments": "This is generally only relevant if the administration record represents a summary of multiple administrations.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "effectiveTime[TS or IVL_TS)"
},
{
"identity": "v2",
"map": "RAS:TQ1"
}
]
}
},
{
"path": "MedicationAdministration.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: precondition.negationInd (inversed - so negationInd = true means asNeeded=false\n\nCodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value"
}
]
}
},
{
"path": "MedicationAdministration.dosage.site",
"definition": {
"short": "Body site administered to",
"formal": "A coded specification of the anatomic site where the medication first entered the body. E.g. \"left arm\".",
"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": "MedicationAdministration.dosage.route",
"definition": {
"short": "Path of substance into body",
"formal": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. E.g. topical, intravenous, etc.",
"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": "MedicationAdministration.dosage.method",
"definition": {
"short": "How drug was administered",
"formal": "A coded value indicating the method by which the medication was 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.",
"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": "MedicationAdministration.dosage.quantity",
"definition": {
"short": "Amount administered in one dose",
"formal": "The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.",
"comments": "If the administration is not instantaneous (rate is present or timing has a duration), this can be specified to convey the total amount administered over period of time of a single administration (as indicated by schedule).",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "doseQuantity"
},
{
"identity": "v2",
"map": "RXA-6-Administered Amount / RXA-7.1-Administered Units.code / RXA-7.3-Administered Units.name of coding system (uri<->code system mapping required)"
}
]
}
},
{
"path": "MedicationAdministration.dosage.rate",
"definition": {
"short": "Dose quantity per unit of time",
"formal": "Identifies the speed with which the medication was introduced into the patient. Typically the rate for an infusion e.g. 200ml in 2 hours. May also expressed as a rate per unit of time such as 100ml per hour - the duration is then not specified, or is specified in the quantity.",
"comments": "If the rate changes over time, each change should be captured as a distinct \"dosage\" repetition. This element should *not* be used to convey an average rate.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "rateQuantity"
},
{
"identity": "v2",
"map": "RXA-12-Administered Per (Time Unit)"
}
]
}
},
{
"path": "MedicationAdministration.dosage.maxDosePerPeriod",
"definition": {
"short": "Total dose that was consumed per unit of time",
"formal": "The maximum total quantity of a therapeutic substance that was administered to the patient over the specified 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"
}
]
}
}
],
"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": "device",
"type": "reference",
"documentation": "Return administrations with this administration device identity",
"xpath": "f:MedicationAdministration/f:device"
},
{
"name": "encounter",
"type": "reference",
"documentation": "Return administrations that share this encounter",
"xpath": "f:MedicationAdministration/f:encounter"
},
{
"name": "identifier",
"type": "token",
"documentation": "Return administrations with this external identity",
"xpath": "f:MedicationAdministration/f:identifier"
},
{
"name": "medication",
"type": "reference",
"documentation": "Return administrations of this medication",
"xpath": "f:MedicationAdministration/f:medication"
},
{
"name": "notgiven",
"type": "token",
"documentation": "Administrations that were not made",
"xpath": "f:MedicationAdministration/f:wasNotGiven"
},
{
"name": "patient",
"type": "reference",
"documentation": "The identity of a patient to list administrations for",
"xpath": "f:MedicationAdministration/f:patient"
},
{
"name": "prescription",
"type": "reference",
"documentation": "The identity of a prescription to list administrations from",
"xpath": "f:MedicationAdministration/f:prescription"
},
{
"name": "status",
"type": "token",
"documentation": "MedicationAdministration event status (for example one of active/paused/completed/nullified)",
"xpath": "f:MedicationAdministration/f:status"
},
{
"name": "whengiven",
"type": "date",
"documentation": "Date of administration",
"xpath": "f:MedicationAdministration/f:whenGiven"
}
]
}
]
}
© 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