FHIR Release 3 (STU)
MedicationsThis page is part of the FHIR Specification (v3.0.2: STU 3). 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
| Pharmacy Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
StructureDefinition for medicationadministration
{
"resourceType": "StructureDefinition",
"id": "MedicationAdministration",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "phx"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"name": "MedicationAdministration",
"status": "draft",
"date": "2019-10-24T11:53:00+11:00",
"publisher": "Health Level Seven International (Pharmacy)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/medication/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for MedicationAdministration Resource",
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "w3c.prov",
"uri": "http://www.w3.org/ns/prov",
"name": "W3C PROV"
}
],
"kind": "resource",
"abstract": false,
"type": "MedicationAdministration",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "MedicationAdministration",
"path": "MedicationAdministration",
"short": "Administration of medication to a patient",
"definition": "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"comment": "The WG will be updating the MedicationAdministration resource to adjust each affected resource to align with the workflow pattern (see workflow.html).",
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource"
},
{
"key": "mad-2",
"severity": "error",
"human": "Reason not given is only permitted if NotGiven is true",
"expression": "reasonNotGiven.empty() or notGiven = true",
"xpath": "not(exists(f:reasonNotGiven) and f:notGiven/@value=false())"
},
{
"key": "mad-3",
"severity": "error",
"human": "Reason given is only permitted if NotGiven is false",
"expression": "reasonCode.empty() or notGiven.empty() or notGiven = 'false'",
"xpath": "not(exists(f:reasonCode) and f:notGiven/@value=true())"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "..Event"
},
{
"identity": "rim",
"map": "SubstanceAdministration"
},
{
"identity": "w5",
"map": "clinical.medication"
}
]
},
{
"id": "MedicationAdministration.id",
"path": "MedicationAdministration.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "MedicationAdministration.meta",
"path": "MedicationAdministration.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "MedicationAdministration.implicitRules",
"path": "MedicationAdministration.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "MedicationAdministration.language",
"path": "MedicationAdministration.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "MedicationAdministration.text",
"path": "MedicationAdministration.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "MedicationAdministration.contained",
"path": "MedicationAdministration.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationAdministration.extension",
"path": "MedicationAdministration.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationAdministration.modifierExtension",
"path": "MedicationAdministration.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationAdministration.identifier",
"path": "MedicationAdministration.identifier",
"short": "External identifier",
"definition": "External identifier - FHIR will generate its own internal identifiers (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"
}
],
"mapping": [
{
"identity": "workflow",
"map": "…identifier"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "MedicationAdministration.definition",
"path": "MedicationAdministration.definition",
"short": "Instantiates protocol or definition",
"definition": "A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…definition"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target[classCode=unspecified]"
}
]
},
{
"id": "MedicationAdministration.partOf",
"path": "MedicationAdministration.partOf",
"short": "Part of referenced event",
"definition": "A larger event of which this particular event is a component or step.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…part of"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP]/target[classCode=SBADM or PROC,moodCode=EVN]"
}
]
},
{
"id": "MedicationAdministration.status",
"path": "MedicationAdministration.status",
"short": "in-progress | on-hold | completed | entered-in-error | stopped | unknown",
"definition": "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.",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationStatus"
}
],
"strength": "required",
"description": "A set of codes indicating the current status of a MedicationAdministration.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-admin-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "…status"
},
{
"identity": "v2",
"map": "RXA-20-Completion Status"
},
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "MedicationAdministration.category",
"path": "MedicationAdministration.category",
"short": "Type of medication usage",
"definition": "Indicates the type of medication administration and where the medication is expected to be consumed or administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationCategory"
}
],
"strength": "preferred",
"description": "A coded concept describing where the medication administered is expected to occur",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-admin-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value"
}
]
},
{
"id": "MedicationAdministration.medication[x]",
"path": "MedicationAdministration.medication[x]",
"short": "What was administered",
"definition": "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.",
"comment": "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example if you require form or lot number, then you must reference the Medication resource. .",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationCode"
}
],
"strength": "example",
"description": "Codes identifying substance or product that can be administered.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-codes"
}
},
"mapping": [
{
"identity": "workflow",
"map": "…code"
},
{
"identity": "v2",
"map": "RXA-5-Administered Code"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=ADMM]"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "MedicationAdministration.subject",
"path": "MedicationAdministration.subject",
"short": "Who received medication",
"definition": "The person or animal or group receiving the medication.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…subject"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "MedicationAdministration.context",
"path": "MedicationAdministration.context",
"short": "Encounter or Episode of Care administered as part of",
"definition": "The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"mapping": [
{
"identity": "workflow",
"map": "…context"
},
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "MedicationAdministration.supportingInformation",
"path": "MedicationAdministration.supportingInformation",
"short": "Additional information to support administration",
"definition": "Additional information (for example, patient height and weight) that supports the administration of the medication.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "MedicationAdministration.effective[x]",
"path": "MedicationAdministration.effective[x]",
"short": "Start and end time of administration",
"definition": "A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…occurrence[x]"
},
{
"identity": "v2",
"map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
},
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "MedicationAdministration.performer",
"path": "MedicationAdministration.performer",
"short": "Who administered substance",
"definition": "The individual who was responsible for giving the medication to the patient.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…performer"
},
{
"identity": "v2",
"map": "RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF]"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "MedicationAdministration.performer.id",
"path": "MedicationAdministration.performer.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MedicationAdministration.performer.extension",
"path": "MedicationAdministration.performer.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MedicationAdministration.performer.modifierExtension",
"path": "MedicationAdministration.performer.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationAdministration.performer.actor",
"path": "MedicationAdministration.performer.actor",
"short": "Individual who was performing",
"definition": "The device, practitioner, etc. who performed the action.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "….actor"
},
{
"identity": "rim",
"map": ".role"
}
]
},
{
"id": "MedicationAdministration.performer.onBehalfOf",
"path": "MedicationAdministration.performer.onBehalfOf",
"short": "Organization organization was acting for",
"definition": "The organization the device or practitioner was acting on behalf of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "workflow",
"map": "….onBehalfOf"
},
{
"identity": "rim",
"map": ".role.scopingOrganization"
}
]
},
{
"id": "MedicationAdministration.notGiven",
"path": "MedicationAdministration.notGiven",
"short": "True if medication not administered",
"definition": "Set this to true if the record is saying that the medication was NOT administered.",
"comment": "This element is labeled as a modifier because it indicates that a administration didn't happen.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"meaningWhenMissing": "If this is missing, then the medication was administered",
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…notDone"
},
{
"identity": "v2",
"map": "RXA-20-Completion Status='NA'"
},
{
"identity": "rim",
"map": ".actionNegationInd"
}
]
},
{
"id": "MedicationAdministration.reasonNotGiven",
"path": "MedicationAdministration.reasonNotGiven",
"short": "Reason administration not performed",
"definition": "A code indicating why the administration was not performed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"mad-2"
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationNegationReason"
}
],
"strength": "example",
"description": "A set of codes indicating the reason why the MedicationAdministration is negated.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes"
}
},
"mapping": [
{
"identity": "workflow",
"map": "…notDoneReason"
},
{
"identity": "v2",
"map": "RXA-9-Administration Notes / RXA-18 Substance/Treatment Refusal Reason"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason not given\"].value"
}
]
},
{
"id": "MedicationAdministration.reasonCode",
"path": "MedicationAdministration.reasonCode",
"short": "Reason administration performed",
"definition": "A code indicating why the medication was given.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"mad-3"
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationReason"
}
],
"strength": "example",
"description": "A set of codes indicating the reason why the MedicationAdministration was made.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes"
}
},
"mapping": [
{
"identity": "workflow",
"map": "…reasonGivenCodeableConcept"
},
{
"identity": "v2",
"map": "RXE-27 Give Indication"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "MedicationAdministration.reasonReference",
"path": "MedicationAdministration.reasonReference",
"short": "Condition or Observation that supports why the medication was administered",
"definition": "Condition or observation that supports why the medication was administered.",
"comment": "This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"mapping": [
{
"identity": "workflow",
"map": "…reasonReference"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason for use ASSERTION\"].value"
},
{
"identity": "w3c.prov",
"map": "no mapping"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "MedicationAdministration.prescription",
"path": "MedicationAdministration.prescription",
"short": "Request administration performed against",
"definition": "The original request, instruction or authority to perform the administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
}
],
"mapping": [
{
"identity": "workflow",
"map": "…basedOn"
},
{
"identity": "v2",
"map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity": "rim",
"map": "InFullfillmentOf->SubstanceAdministration"
}
]
},
{
"id": "MedicationAdministration.device",
"path": "MedicationAdministration.device",
"short": "Device used to administer",
"definition": "The device used in administering the medication to the patient. For example, a particular infusion pump.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRT-10 Participation Device / RXR-3 Administrative Device"
},
{
"identity": "rim",
"map": "device->Access OR device->AssignedDevice"
}
]
},
{
"id": "MedicationAdministration.note",
"path": "MedicationAdministration.note",
"short": "Information about the administration",
"definition": "Extra information about the medication administration that is not conveyed by the other attributes.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "workflow",
"map": "…note"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"
}
]
},
{
"id": "MedicationAdministration.dosage",
"path": "MedicationAdministration.dosage",
"short": "Details of how medication was taken",
"definition": "Describes the medication dosage information details e.g. dose, rate, site, route, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
},
{
"key": "mad-1",
"severity": "error",
"human": "SHALL have at least one of dosage.dose or dosage.rate[x]",
"expression": "dose.exists() or rate.exists()",
"xpath": "exists(f:dose) or exists(f:*[starts-with(local-name(.), 'rate')])"
}
],
"mapping": [
{
"identity": "rim",
"map": "component->SubstanceAdministrationEvent"
}
]
},
{
"id": "MedicationAdministration.dosage.id",
"path": "MedicationAdministration.dosage.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MedicationAdministration.dosage.extension",
"path": "MedicationAdministration.dosage.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "MedicationAdministration.dosage.modifierExtension",
"path": "MedicationAdministration.dosage.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "MedicationAdministration.dosage.text",
"path": "MedicationAdministration.dosage.text",
"short": "Free text dosage instructions e.g. SIG",
"definition": "Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.\r\rThe dosage instructions should reflect the dosage of the medication that was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"id": "MedicationAdministration.dosage.site",
"path": "MedicationAdministration.dosage.site",
"short": "Body site administered to",
"definition": "A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\".",
"comment": "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [body-site-instance](extension-body-site-instance.html). May be a summary code, or a reference to a very precise definition of the location, or both.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationSite"
}
],
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-2 Administration Site / RXR-6 Administration Site Modifier"
},
{
"identity": "rim",
"map": ".approachSiteCode"
}
]
},
{
"id": "MedicationAdministration.dosage.route",
"path": "MedicationAdministration.dosage.route",
"short": "Path of substance into body",
"definition": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RouteOfAdministration"
}
],
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1-Route"
},
{
"identity": "rim",
"map": ".routeCode"
}
]
},
{
"id": "MedicationAdministration.dosage.method",
"path": "MedicationAdministration.dosage.method",
"short": "How drug was administered",
"definition": "A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.",
"comment": "One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationMethod"
}
],
"strength": "example",
"description": "A coded concept describing the technique by which the medicine is administered.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administration-method-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-4-Administration Method"
},
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"id": "MedicationAdministration.dosage.dose",
"path": "MedicationAdministration.dosage.dose",
"short": "Amount of medication per dose",
"definition": "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.",
"comment": "If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-6 Administered Amount / RXA-7 Administered Units"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"id": "MedicationAdministration.dosage.rate[x]",
"path": "MedicationAdministration.dosage.rate[x]",
"short": "Dose quantity per unit of time",
"definition": "Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.",
"comment": "If the rate changes over time, and you want to capture this in MedicationAdministration, then each change should be captured as a distinct MedicationAdministration, with a specific MedicationAdministration.dosage.rate, and the date time when the rate change occurred. Typically, the MedicationAdministration.dosage.rate element is not used to convey an average rate.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
},
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-12-Administered Per (Time Unit)"
},
{
"identity": "rim",
"map": ".rateQuantity"
}
]
},
{
"id": "MedicationAdministration.eventHistory",
"path": "MedicationAdministration.eventHistory",
"short": "A list of events of interest in the lifecycle",
"definition": "A summary of the events of interest that have occurred, such as when the administration was verified.",
"comment": "This may not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Provenance"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}
]
}
]
},
"differential": {
"element": [
{
"id": "MedicationAdministration",
"path": "MedicationAdministration",
"short": "Administration of medication to a patient",
"definition": "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"comment": "The WG will be updating the MedicationAdministration resource to adjust each affected resource to align with the workflow pattern (see workflow.html).",
"min": 0,
"max": "*",
"constraint": [
{
"key": "mad-2",
"severity": "error",
"human": "Reason not given is only permitted if NotGiven is true",
"expression": "reasonNotGiven.empty() or notGiven = true",
"xpath": "not(exists(f:reasonNotGiven) and f:notGiven/@value=false())"
},
{
"key": "mad-3",
"severity": "error",
"human": "Reason given is only permitted if NotGiven is false",
"expression": "reasonCode.empty() or notGiven.empty() or notGiven = 'false'",
"xpath": "not(exists(f:reasonCode) and f:notGiven/@value=true())"
}
],
"mapping": [
{
"identity": "workflow",
"map": "..Event"
},
{
"identity": "rim",
"map": "SubstanceAdministration"
},
{
"identity": "w5",
"map": "clinical.medication"
}
]
},
{
"id": "MedicationAdministration.identifier",
"path": "MedicationAdministration.identifier",
"short": "External identifier",
"definition": "External identifier - FHIR will generate its own internal identifiers (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"
}
],
"mapping": [
{
"identity": "workflow",
"map": "…identifier"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "MedicationAdministration.definition",
"path": "MedicationAdministration.definition",
"short": "Instantiates protocol or definition",
"definition": "A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…definition"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=DEFN].target[classCode=unspecified]"
}
]
},
{
"id": "MedicationAdministration.partOf",
"path": "MedicationAdministration.partOf",
"short": "Part of referenced event",
"definition": "A larger event of which this particular event is a component or step.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationAdministration"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Procedure"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…part of"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP]/target[classCode=SBADM or PROC,moodCode=EVN]"
}
]
},
{
"id": "MedicationAdministration.status",
"path": "MedicationAdministration.status",
"short": "in-progress | on-hold | completed | entered-in-error | stopped | unknown",
"definition": "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.",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationStatus"
}
],
"strength": "required",
"description": "A set of codes indicating the current status of a MedicationAdministration.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-admin-status"
}
},
"mapping": [
{
"identity": "workflow",
"map": "…status"
},
{
"identity": "v2",
"map": "RXA-20-Completion Status"
},
{
"identity": "rim",
"map": ".statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "MedicationAdministration.category",
"path": "MedicationAdministration.category",
"short": "Type of medication usage",
"definition": "Indicates the type of medication administration and where the medication is expected to be consumed or administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationCategory"
}
],
"strength": "preferred",
"description": "A coded concept describing where the medication administered is expected to occur",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-admin-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value"
}
]
},
{
"id": "MedicationAdministration.medication[x]",
"path": "MedicationAdministration.medication[x]",
"short": "What was administered",
"definition": "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.",
"comment": "If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the medication resource is recommended. For example if you require form or lot number, then you must reference the Medication resource. .",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationCode"
}
],
"strength": "example",
"description": "Codes identifying substance or product that can be administered.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-codes"
}
},
"mapping": [
{
"identity": "workflow",
"map": "…code"
},
{
"identity": "v2",
"map": "RXA-5-Administered Code"
},
{
"identity": "rim",
"map": ".participation[typeCode=CSM].role[classCode=ADMM]"
},
{
"identity": "w5",
"map": "what"
}
]
},
{
"id": "MedicationAdministration.subject",
"path": "MedicationAdministration.subject",
"short": "Who received medication",
"definition": "The person or animal or group receiving the medication.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…subject"
},
{
"identity": "v2",
"map": "PID-3-Patient ID List"
},
{
"identity": "rim",
"map": ".participation[typeCode=SBJ].role[classCode=PAT]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "MedicationAdministration.context",
"path": "MedicationAdministration.context",
"short": "Encounter or Episode of Care administered as part of",
"definition": "The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"mapping": [
{
"identity": "workflow",
"map": "…context"
},
{
"identity": "v2",
"map": "PV1-19-Visit Number"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "MedicationAdministration.supportingInformation",
"path": "MedicationAdministration.supportingInformation",
"short": "Additional information to support administration",
"definition": "Additional information (for example, patient height and weight) that supports the administration of the medication.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=PERT].target[A_SupportingClinicalStatement CMET minimal with many different choices of classCodes(ORG, ENC, PROC, SPLY, SBADM, OBS) and each of the act class codes draws from one or more of the following moodCodes (EVN, DEF, INT PRMS, RQO, PRP, APT, ARQ, GOL)]"
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "MedicationAdministration.effective[x]",
"path": "MedicationAdministration.effective[x]",
"short": "Start and end time of administration",
"definition": "A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
},
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…occurrence[x]"
},
{
"identity": "v2",
"map": "RXA-3-Date/Time Start of Administration / RXA-4-Date/Time End of Administration"
},
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "MedicationAdministration.performer",
"path": "MedicationAdministration.performer",
"short": "Who administered substance",
"definition": "The individual who was responsible for giving the medication to the patient.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…performer"
},
{
"identity": "v2",
"map": "RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRF]"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "MedicationAdministration.performer.actor",
"path": "MedicationAdministration.performer.actor",
"short": "Individual who was performing",
"definition": "The device, practitioner, etc. who performed the action.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "….actor"
},
{
"identity": "rim",
"map": ".role"
}
]
},
{
"id": "MedicationAdministration.performer.onBehalfOf",
"path": "MedicationAdministration.performer.onBehalfOf",
"short": "Organization organization was acting for",
"definition": "The organization the device or practitioner was acting on behalf of.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "workflow",
"map": "….onBehalfOf"
},
{
"identity": "rim",
"map": ".role.scopingOrganization"
}
]
},
{
"id": "MedicationAdministration.notGiven",
"path": "MedicationAdministration.notGiven",
"short": "True if medication not administered",
"definition": "Set this to true if the record is saying that the medication was NOT administered.",
"comment": "This element is labeled as a modifier because it indicates that a administration didn't happen.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"meaningWhenMissing": "If this is missing, then the medication was administered",
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "…notDone"
},
{
"identity": "v2",
"map": "RXA-20-Completion Status='NA'"
},
{
"identity": "rim",
"map": ".actionNegationInd"
}
]
},
{
"id": "MedicationAdministration.reasonNotGiven",
"path": "MedicationAdministration.reasonNotGiven",
"short": "Reason administration not performed",
"definition": "A code indicating why the administration was not performed.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"mad-2"
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationNegationReason"
}
],
"strength": "example",
"description": "A set of codes indicating the reason why the MedicationAdministration is negated.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/reason-medication-not-given-codes"
}
},
"mapping": [
{
"identity": "workflow",
"map": "…notDoneReason"
},
{
"identity": "v2",
"map": "RXA-9-Administration Notes / RXA-18 Substance/Treatment Refusal Reason"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason not given\"].value"
}
]
},
{
"id": "MedicationAdministration.reasonCode",
"path": "MedicationAdministration.reasonCode",
"short": "Reason administration performed",
"definition": "A code indicating why the medication was given.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"mad-3"
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationReason"
}
],
"strength": "example",
"description": "A set of codes indicating the reason why the MedicationAdministration was made.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/reason-medication-given-codes"
}
},
"mapping": [
{
"identity": "workflow",
"map": "…reasonGivenCodeableConcept"
},
{
"identity": "v2",
"map": "RXE-27 Give Indication"
},
{
"identity": "rim",
"map": ".reasonCode"
}
]
},
{
"id": "MedicationAdministration.reasonReference",
"path": "MedicationAdministration.reasonReference",
"short": "Condition or Observation that supports why the medication was administered",
"definition": "Condition or observation that supports why the medication was administered.",
"comment": "This is a reference to a condition that is the reason for the medication request. If only a code exists, use reasonCode.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"mapping": [
{
"identity": "workflow",
"map": "…reasonReference"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=RSON]/target[classCode=OBS,moodCode=EVN, code=\"reason for use ASSERTION\"].value"
},
{
"identity": "w3c.prov",
"map": "no mapping"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "MedicationAdministration.prescription",
"path": "MedicationAdministration.prescription",
"short": "Request administration performed against",
"definition": "The original request, instruction or authority to perform the administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
}
],
"mapping": [
{
"identity": "workflow",
"map": "…basedOn"
},
{
"identity": "v2",
"map": "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity": "rim",
"map": "InFullfillmentOf->SubstanceAdministration"
}
]
},
{
"id": "MedicationAdministration.device",
"path": "MedicationAdministration.device",
"short": "Device used to administer",
"definition": "The device used in administering the medication to the patient. For example, a particular infusion pump.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Device"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRT-10 Participation Device / RXR-3 Administrative Device"
},
{
"identity": "rim",
"map": "device->Access OR device->AssignedDevice"
}
]
},
{
"id": "MedicationAdministration.note",
"path": "MedicationAdministration.note",
"short": "Information about the administration",
"definition": "Extra information about the medication administration that is not conveyed by the other attributes.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "workflow",
"map": "…note"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value"
}
]
},
{
"id": "MedicationAdministration.dosage",
"path": "MedicationAdministration.dosage",
"short": "Details of how medication was taken",
"definition": "Describes the medication dosage information details e.g. dose, rate, site, route, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "mad-1",
"severity": "error",
"human": "SHALL have at least one of dosage.dose or dosage.rate[x]",
"expression": "dose.exists() or rate.exists()",
"xpath": "exists(f:dose) or exists(f:*[starts-with(local-name(.), 'rate')])"
}
],
"mapping": [
{
"identity": "rim",
"map": "component->SubstanceAdministrationEvent"
}
]
},
{
"id": "MedicationAdministration.dosage.text",
"path": "MedicationAdministration.dosage.text",
"short": "Free text dosage instructions e.g. SIG",
"definition": "Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.\r\rThe dosage instructions should reflect the dosage of the medication that was administered.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": ".text"
}
]
},
{
"id": "MedicationAdministration.dosage.site",
"path": "MedicationAdministration.dosage.site",
"short": "Body site administered to",
"definition": "A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\".",
"comment": "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [body-site-instance](extension-body-site-instance.html). May be a summary code, or a reference to a very precise definition of the location, or both.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationSite"
}
],
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-2 Administration Site / RXR-6 Administration Site Modifier"
},
{
"identity": "rim",
"map": ".approachSiteCode"
}
]
},
{
"id": "MedicationAdministration.dosage.route",
"path": "MedicationAdministration.dosage.route",
"short": "Path of substance into body",
"definition": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "RouteOfAdministration"
}
],
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-1-Route"
},
{
"identity": "rim",
"map": ".routeCode"
}
]
},
{
"id": "MedicationAdministration.dosage.method",
"path": "MedicationAdministration.dosage.method",
"short": "How drug was administered",
"definition": "A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.",
"comment": "One of the reasons this attribute is not used often, is that the method is often pre-coordinated with the route and/or form of administration. This means the codes used in route or form may pre-coordinate the method in the route code or the form code. The implementation decision about what coding system to use for route or form code will determine how frequently the method code will be populated e.g. if route or form code pre-coordinate method code, then this attribute will not be populated often; if there is no pre-coordination then method code may be used frequently.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationAdministrationMethod"
}
],
"strength": "example",
"description": "A coded concept describing the technique by which the medicine is administered.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administration-method-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXR-4-Administration Method"
},
{
"identity": "rim",
"map": ".methodCode"
}
]
},
{
"id": "MedicationAdministration.dosage.dose",
"path": "MedicationAdministration.dosage.dose",
"short": "Amount of medication per dose",
"definition": "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.",
"comment": "If the administration is not instantaneous (rate is present), this can be specified to convey the total amount administered over period of time of a single administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-6 Administered Amount / RXA-7 Administered Units"
},
{
"identity": "rim",
"map": ".doseQuantity"
}
]
},
{
"id": "MedicationAdministration.dosage.rate[x]",
"path": "MedicationAdministration.dosage.rate[x]",
"short": "Dose quantity per unit of time",
"definition": "Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.",
"comment": "If the rate changes over time, and you want to capture this in MedicationAdministration, then each change should be captured as a distinct MedicationAdministration, with a specific MedicationAdministration.dosage.rate, and the date time when the rate change occurred. Typically, the MedicationAdministration.dosage.rate element is not used to convey an average rate.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
},
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXA-12-Administered Per (Time Unit)"
},
{
"identity": "rim",
"map": ".rateQuantity"
}
]
},
{
"id": "MedicationAdministration.eventHistory",
"path": "MedicationAdministration.eventHistory",
"short": "A list of events of interest in the lifecycle",
"definition": "A summary of the events of interest that have occurred, such as when the administration was verified.",
"comment": "This may not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Provenance"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship(typeCode=SUBJ].source[classCode=CACT, moodCode=EVN]"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®© HL7.org 2011+. FHIR Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change