This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Pharmacy Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Encounter, Patient, Practitioner, RelatedPerson |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for medicationusage
{ "resourceType" : "StructureDefinition", "id" : "MedicationUsage", "meta" : { "lastUpdated" : "2020-05-03T08:43:35.811+10:00" }, "text" : { "status" : "generated", "div" : "<div>!-- Snipped for Brevity --></div>" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-category", "valueString" : "Clinical.Medications" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode" : "trial-use" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger" : 3 }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", "valueCode" : "patient" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "phx" }], "url" : "http://hl7.org/fhir/StructureDefinition/MedicationUsage", "version" : "4.4.0", "name" : "MedicationUsage", "status" : "draft", "date" : "2020-05-03T08:43:35+10: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" : "A record of a medication that is being consumed by a patient. A MedicationUsage may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. \n\nThe primary difference between a medicationusage and a medicationadministration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medicationusage is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the Medication Usage information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.", "fhirVersion" : "4.4.0", "mapping" : [{ "identity" : "workflow", "uri" : "http://hl7.org/fhir/workflow", "name" : "Workflow Pattern" }, { "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" }, { "identity" : "w5", "uri" : "http://hl7.org/fhir/fivews", "name" : "FiveWs Pattern Mapping" }, { "identity" : "v2", "uri" : "http://hl7.org/v2", "name" : "HL7 v2 Mapping" }], "kind" : "resource", "abstract" : false, "type" : "MedicationUsage", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DomainResource", "derivation" : "specialization", "snapshot" : { "element" : [{ "id" : "MedicationUsage", "path" : "MedicationUsage", "short" : "Record of medication being taken by a patient", "definition" : "A record of a medication that is being consumed by a patient. A MedicationUsage may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. \n\nThe primary difference between a medicationusage and a medicationadministration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medicationusage is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the Medication Usage information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.", "min" : 0, "max" : "*", "base" : { "path" : "MedicationUsage", "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" : "http://hl7.org/fhir/StructureDefinition/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 or SHALL refer to the containing resource", "expression" : "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()", "xpath" : "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source" : "http://hl7.org/fhir/StructureDefinition/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" : "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key" : "dom-5", "severity" : "error", "human" : "If a resource is contained in another resource, it SHALL NOT have a security label", "expression" : "contained.meta.security.empty()", "xpath" : "not(exists(f:contained/*/f:meta/f:security))", "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean" : true }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown" : "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." }], "key" : "dom-6", "severity" : "warning", "human" : "A resource should have narrative for robust management", "expression" : "text.`div`.exists()", "xpath" : "exists(f:text/h:div)", "source" : "http://hl7.org/fhir/StructureDefinition/DomainResource" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "Entity. Role, or Act" }, { "identity" : "workflow", "map" : "Event" }, { "identity" : "rim", "map" : "SubstanceAdministration" }] }, { "id" : "MedicationUsage.id", "path" : "MedicationUsage.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" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : true }, { "id" : "MedicationUsage.meta", "path" : "MedicationUsage.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 might 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" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "MedicationUsage.implicitRules", "path" : "MedicationUsage.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min" : 0, "max" : "1", "base" : { "path" : "Resource.implicitRules", "min" : 0, "max" : "1" }, "type" : [{ "code" : "uri" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : true, "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary" : true }, { "id" : "MedicationUsage.language", "path" : "MedicationUsage.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" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical" : "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" : "preferred", "description" : "A human language.", "valueSet" : "http://hl7.org/fhir/ValueSet/languages" } }, { "id" : "MedicationUsage.text", "path" : "MedicationUsage.text", "short" : "Text summary of the resource, for human interpretation", "definition" : "A human-readable narrative that contains a summary of the resource and can 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 information is added later.", "alias" : ["narrative", "html", "xhtml", "display"], "min" : 0, "max" : "1", "base" : { "path" : "DomainResource.text", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Narrative" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "Act.text?" }] }, { "id" : "MedicationUsage.contained", "path" : "MedicationUsage.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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias" : ["inline resources", "anonymous resources", "contained resources"], "min" : 0, "max" : "*", "base" : { "path" : "DomainResource.contained", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Resource" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "MedicationUsage.extension", "path" : "MedicationUsage.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. 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 can 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" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "MedicationUsage.modifierExtension", "path" : "MedicationUsage.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "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.", "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "DomainResource.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "MedicationUsage.identifier", "path" : "MedicationUsage.identifier", "short" : "External identifier", "definition" : "Identifiers associated with this Medication Usage that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", "comment" : "This is a business identifier, not a resource identifier.", "min" : 0, "max" : "*", "base" : { "path" : "MedicationUsage.identifier", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Identifier" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.identifier" }, { "identity" : "w5", "map" : "FiveWs.identifier" }, { "identity" : "rim", "map" : ".id" }] }, { "id" : "MedicationUsage.basedOn", "path" : "MedicationUsage.basedOn", "short" : "Fulfils plan, proposal or order", "definition" : "A plan, proposal or order that is fulfilled in whole or in part by this event.", "requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "min" : 0, "max" : "*", "base" : { "path" : "MedicationUsage.basedOn", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest", "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/ServiceRequest"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.basedOn" }, { "identity" : "rim", "map" : ".outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]" }] }, { "id" : "MedicationUsage.partOf", "path" : "MedicationUsage.partOf", "short" : "Part of referenced event", "definition" : "A larger event of which this particular event is a component or step.", "requirements" : "This should not be used when indicating which resource a MedicationUsage has been derived from. If that is the use case, then MedicationUsage.derivedFrom should be used.", "min" : 0, "max" : "*", "base" : { "path" : "MedicationUsage.partOf", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration", "http://hl7.org/fhir/StructureDefinition/MedicationDispense", "http://hl7.org/fhir/StructureDefinition/MedicationUsage", "http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/Observation"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.partOf" }, { "identity" : "rim", "map" : ".outboundRelationship[typeCode=COMP]/target[classCode=SPLY or SBADM or PROC or OBS,moodCode=EVN]" }] }, { "id" : "MedicationUsage.status", "path" : "MedicationUsage.status", "short" : "active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken", "definition" : "A code representing the patient or other source's judgment about the state of the medication used that this usage is about. Generally, this will be active or completed.", "comment" : "MedicationUsage is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationUsage.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the Medication Usage itself (for example, entered in error).\r\rThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.", "min" : 1, "max" : "1", "base" : { "path" : "MedicationUsage.status", "min" : 1, "max" : "1" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : true, "isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "MedicationUsageStatus" }], "strength" : "required", "description" : "A coded concept indicating the current status of a MedicationUsage.", "valueSet" : "http://hl7.org/fhir/ValueSet/medication-usage-status|4.4.0" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.status" }, { "identity" : "w5", "map" : "FiveWs.status" }, { "identity" : "rim", "map" : ".statusCode" }] }, { "id" : "MedicationUsage.statusReason", "path" : "MedicationUsage.statusReason", "short" : "Reason for current status", "definition" : "Captures the reason for the current state of the MedicationUsage.", "comment" : "This is generally only used for \"exception\" statuses such as \"not-taken\", \"on-hold\", \"cancelled\" or \"entered-in-error\". The reason for performing the event at all is captured in reasonCode, not here.", "min" : 0, "max" : "*", "base" : { "path" : "MedicationUsage.statusReason", "min" : 0, "max" : "*" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "MedicationUsageStatusReason" }], "strength" : "example", "description" : "A coded concept indicating the reason for the status of the statement.", "valueSet" : "http://hl7.org/fhir/ValueSet/reason-medication-status-codes" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.statusReason" }, { "identity" : "rim", "map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde" }] }, { "id" : "MedicationUsage.category", "path" : "MedicationUsage.category", "short" : "Type of medication usage", "definition" : "Type of medication usage (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).", "min" : 0, "max" : "*", "base" : { "path" : "MedicationUsage.category", "min" : 0, "max" : "*" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "MedicationUsageAdministrationLocation" }], "strength" : "example", "description" : "A coded concept identifying where the medication included in the MedicationUsage is expected to be consumed or administered.", "valueSet" : "http://hl7.org/fhir/ValueSet/medication-usage-admin-location" }, "mapping" : [{ "identity" : "w5", "map" : "FiveWs.class" }, { "identity" : "rim", "map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value" }] }, { "id" : "MedicationUsage.medication", "path" : "MedicationUsage.medication", "short" : "What medication was taken", "definition" : "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", "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", "base" : { "path" : "MedicationUsage.medication", "min" : 1, "max" : "1" }, "type" : [{ "code" : "CodeableReference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "MedicationCode" }], "strength" : "example", "description" : "A coded concept identifying the substance or product being taken.", "valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.code" }, { "identity" : "w5", "map" : "FiveWs.what[x]" }, { "identity" : "rim", "map" : ".participation[typeCode=CSM].role[classCode=ADMM or MANU]" }] }, { "id" : "MedicationUsage.subject", "path" : "MedicationUsage.subject", "short" : "Who is/was taking the medication", "definition" : "The person, animal or group who is/was taking the medication.", "min" : 1, "max" : "1", "base" : { "path" : "MedicationUsage.subject", "min" : 1, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.subject" }, { "identity" : "w5", "map" : "FiveWs.subject[x]" }, { "identity" : "v2", "map" : "PID-3-Patient ID List" }, { "identity" : "rim", "map" : ".participation[typeCode=SBJ].role[classCode=PAT]" }, { "identity" : "w5", "map" : "FiveWs.subject" }] }, { "id" : "MedicationUsage.encounter", "path" : "MedicationUsage.encounter", "short" : "Encounter associated with MedicationUsage", "definition" : "The encounter that establishes the context for this MedicationUsage.", "min" : 0, "max" : "1", "base" : { "path" : "MedicationUsage.encounter", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.context" }, { "identity" : "rim", "map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]" }] }, { "id" : "MedicationUsage.effective[x]", "path" : "MedicationUsage.effective[x]", "short" : "The date/time or interval when the medication is/was/will be taken", "definition" : "The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationUsage.status element is NotTaken).", "comment" : "This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Usages. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the \"end\" date will be omitted. If the end date is known, then it is included as the \"end date\". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.", "min" : 0, "max" : "1", "base" : { "path" : "MedicationUsage.effective[x]", "min" : 0, "max" : "1" }, "type" : [{ "code" : "dateTime" }, { "code" : "Period" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.occurrence[x]" }, { "identity" : "w5", "map" : "FiveWs.done[x]" }, { "identity" : "rim", "map" : ".effectiveTime" }] }, { "id" : "MedicationUsage.dateAsserted", "path" : "MedicationUsage.dateAsserted", "short" : "When the usage was asserted?", "definition" : "The date when the Medication Usage was asserted by the information source.", "min" : 0, "max" : "1", "base" : { "path" : "MedicationUsage.dateAsserted", "min" : 0, "max" : "1" }, "type" : [{ "code" : "dateTime" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "w5", "map" : "FiveWs.recorded" }, { "identity" : "rim", "map" : ".participation[typeCode=AUT].time" }] }, { "id" : "MedicationUsage.informationSource", "path" : "MedicationUsage.informationSource", "short" : "Person or organization that provided the information about the taking of this medication", "definition" : "The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationUsage is derived from other resources, e.g. Claim or MedicationRequest.", "min" : 0, "max" : "1", "base" : { "path" : "MedicationUsage.informationSource", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "w5", "map" : "FiveWs.source" }, { "identity" : "rim", "map" : ".participation[typeCode=INF].role[classCode=PAT, or codes for Practitioner or Related Person (if PAT is the informer, then syntax for self-reported =true)" }] }, { "id" : "MedicationUsage.derivedFrom", "path" : "MedicationUsage.derivedFrom", "short" : "Link to information used to derive the MedicationUsage", "definition" : "Allows linking the MedicationUsage to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationUsage.", "comment" : "Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationUsage comes from creating a MedicationUsage from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationUsage from.", "min" : 0, "max" : "*", "base" : { "path" : "MedicationUsage.derivedFrom", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : ".outboundRelationship[typeCode=SPRT]/target[classCode=ACT,moodCode=EVN]" }] }, { "id" : "MedicationUsage.reason", "path" : "MedicationUsage.reason", "short" : "Reason for why the medication is being/was taken", "definition" : "A concept, Condition or observation that supports why the medication is being/was taken.", "comment" : "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.", "min" : 0, "max" : "*", "base" : { "path" : "MedicationUsage.reason", "min" : 0, "max" : "*" }, "type" : [{ "code" : "CodeableReference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "MedicationReason" }], "strength" : "example", "description" : "A coded concept identifying why the medication is being taken.", "valueSet" : "http://hl7.org/fhir/ValueSet/condition-code" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.reason" }, { "identity" : "w5", "map" : "FiveWs.why[x]" }, { "identity" : "rim", "map" : ".reasonCode" }] }, { "id" : "MedicationUsage.note", "path" : "MedicationUsage.note", "short" : "Further information about the usage", "definition" : "Provides extra information about the Medication Usage that is not conveyed by the other attributes.", "min" : 0, "max" : "*", "base" : { "path" : "MedicationUsage.note", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Annotation" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "workflow", "map" : "Event.note" }, { "identity" : "rim", "map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value" }] }, { "id" : "MedicationUsage.renderedDosageInstruction", "path" : "MedicationUsage.renderedDosageInstruction", "short" : "Full representation of the dosage instructions", "definition" : "The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.", "requirements" : "The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.", "min" : 0, "max" : "1", "base" : { "path" : "MedicationUsage.renderedDosageInstruction", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "SubstanceAdministration.text" }] }, { "id" : "MedicationUsage.dosage", "path" : "MedicationUsage.dosage", "short" : "Details of how medication is/was taken or should be taken", "definition" : "Indicates how the medication is/was or should be taken by the patient.", "comment" : "The dates included in the dosage on a Medication Usage reflect the dates for a given dose. For example, \"from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily.\" It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Usage is derived from a MedicationRequest.", "min" : 0, "max" : "*", "base" : { "path" : "MedicationUsage.dosage", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Dosage" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "refer dosageInstruction mapping" }] }, { "id" : "MedicationUsage.takenAsOrdered", "path" : "MedicationUsage.takenAsOrdered", "short" : "Indicates if the medication is being consumed or administered as prescribed", "definition" : "Indicates if the medication is being consumed or administered as prescribed.", "min" : 0, "max" : "1", "base" : { "path" : "MedicationUsage.takenAsOrdered", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "outboundRelationship[typeCode=PERT].target[classCode=OBV,moodCode=EVN].value[xsi:type=BL]" }] }] }, "differential" : { "element" : [{ "id" : "MedicationUsage", "path" : "MedicationUsage", "short" : "Record of medication being taken by a patient", "definition" : "A record of a medication that is being consumed by a patient. A MedicationUsage may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. \n\nThe primary difference between a medicationusage and a medicationadministration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medicationusage is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the Medication Usage information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.", "min" : 0, "max" : "*", "mapping" : [{ "identity" : "workflow", "map" : "Event" }, { "identity" : "rim", "map" : "SubstanceAdministration" }] }, { "id" : "MedicationUsage.identifier", "path" : "MedicationUsage.identifier", "short" : "External identifier", "definition" : "Identifiers associated with this Medication Usage that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.", "comment" : "This is a business identifier, not a resource identifier.", "min" : 0, "max" : "*", "type" : [{ "code" : "Identifier" }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.identifier" }, { "identity" : "w5", "map" : "FiveWs.identifier" }, { "identity" : "rim", "map" : ".id" }] }, { "id" : "MedicationUsage.basedOn", "path" : "MedicationUsage.basedOn", "short" : "Fulfils plan, proposal or order", "definition" : "A plan, proposal or order that is fulfilled in whole or in part by this event.", "requirements" : "Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.", "min" : 0, "max" : "*", "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationRequest", "http://hl7.org/fhir/StructureDefinition/CarePlan", "http://hl7.org/fhir/StructureDefinition/ServiceRequest"] }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.basedOn" }, { "identity" : "rim", "map" : ".outboundRelationship[typeCode=FLFS].target[classCode=SBADM or PROC or PCPR or OBS, moodCode=RQO orPLAN or PRP]" }] }, { "id" : "MedicationUsage.partOf", "path" : "MedicationUsage.partOf", "short" : "Part of referenced event", "definition" : "A larger event of which this particular event is a component or step.", "requirements" : "This should not be used when indicating which resource a MedicationUsage has been derived from. If that is the use case, then MedicationUsage.derivedFrom should be used.", "min" : 0, "max" : "*", "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/MedicationAdministration", "http://hl7.org/fhir/StructureDefinition/MedicationDispense", "http://hl7.org/fhir/StructureDefinition/MedicationUsage", "http://hl7.org/fhir/StructureDefinition/Procedure", "http://hl7.org/fhir/StructureDefinition/Observation"] }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.partOf" }, { "identity" : "rim", "map" : ".outboundRelationship[typeCode=COMP]/target[classCode=SPLY or SBADM or PROC or OBS,moodCode=EVN]" }] }, { "id" : "MedicationUsage.status", "path" : "MedicationUsage.status", "short" : "active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken", "definition" : "A code representing the patient or other source's judgment about the state of the medication used that this usage is about. Generally, this will be active or completed.", "comment" : "MedicationUsage is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for MedicationUsage.status contains codes that assert the status of the use of the medication by the patient (for example, stopped or on hold) as well as codes that assert the status of the Medication Usage itself (for example, entered in error).\r\rThis 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, "isModifierReason" : "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid", "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "MedicationUsageStatus" }], "strength" : "required", "description" : "A coded concept indicating the current status of a MedicationUsage.", "valueSet" : "http://hl7.org/fhir/ValueSet/medication-usage-status|4.4.0" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.status" }, { "identity" : "w5", "map" : "FiveWs.status" }, { "identity" : "rim", "map" : ".statusCode" }] }, { "id" : "MedicationUsage.statusReason", "path" : "MedicationUsage.statusReason", "short" : "Reason for current status", "definition" : "Captures the reason for the current state of the MedicationUsage.", "comment" : "This is generally only used for \"exception\" statuses such as \"not-taken\", \"on-hold\", \"cancelled\" or \"entered-in-error\". The reason for performing the event at all is captured in reasonCode, not here.", "min" : 0, "max" : "*", "type" : [{ "code" : "CodeableConcept" }], "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "MedicationUsageStatusReason" }], "strength" : "example", "description" : "A coded concept indicating the reason for the status of the statement.", "valueSet" : "http://hl7.org/fhir/ValueSet/reason-medication-status-codes" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.statusReason" }, { "identity" : "rim", "map" : ".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde" }] }, { "id" : "MedicationUsage.category", "path" : "MedicationUsage.category", "short" : "Type of medication usage", "definition" : "Type of medication usage (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).", "min" : 0, "max" : "*", "type" : [{ "code" : "CodeableConcept" }], "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "MedicationUsageAdministrationLocation" }], "strength" : "example", "description" : "A coded concept identifying where the medication included in the MedicationUsage is expected to be consumed or administered.", "valueSet" : "http://hl7.org/fhir/ValueSet/medication-usage-admin-location" }, "mapping" : [{ "identity" : "w5", "map" : "FiveWs.class" }, { "identity" : "rim", "map" : ".inboundRelationship[typeCode=COMP].source[classCode=OBS, moodCode=EVN, code=\"type of medication usage\"].value" }] }, { "id" : "MedicationUsage.medication", "path" : "MedicationUsage.medication", "short" : "What medication was taken", "definition" : "Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.", "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" : "CodeableReference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Medication"] }], "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "MedicationCode" }], "strength" : "example", "description" : "A coded concept identifying the substance or product being taken.", "valueSet" : "http://hl7.org/fhir/ValueSet/medication-codes" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.code" }, { "identity" : "w5", "map" : "FiveWs.what[x]" }, { "identity" : "rim", "map" : ".participation[typeCode=CSM].role[classCode=ADMM or MANU]" }] }, { "id" : "MedicationUsage.subject", "path" : "MedicationUsage.subject", "short" : "Who is/was taking the medication", "definition" : "The person, animal or group who is/was taking the medication.", "min" : 1, "max" : "1", "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group"] }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.subject" }, { "identity" : "w5", "map" : "FiveWs.subject[x]" }, { "identity" : "v2", "map" : "PID-3-Patient ID List" }, { "identity" : "rim", "map" : ".participation[typeCode=SBJ].role[classCode=PAT]" }, { "identity" : "w5", "map" : "FiveWs.subject" }] }, { "id" : "MedicationUsage.encounter", "path" : "MedicationUsage.encounter", "short" : "Encounter associated with MedicationUsage", "definition" : "The encounter that establishes the context for this MedicationUsage.", "min" : 0, "max" : "1", "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Encounter"] }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.context" }, { "identity" : "rim", "map" : ".inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN, code=\"type of encounter or episode\"]" }] }, { "id" : "MedicationUsage.effective[x]", "path" : "MedicationUsage.effective[x]", "short" : "The date/time or interval when the medication is/was/will be taken", "definition" : "The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationUsage.status element is NotTaken).", "comment" : "This attribute reflects the period over which the patient consumed the medication and is expected to be populated on the majority of Medication Usages. If the medication is still being taken and is expected to continue indefinitely at the time the usage is recorded, the \"end\" date will be omitted. If the end date is known, then it is included as the \"end date\". The date/time attribute supports a variety of dates - year, year/month and exact date. If something more than this is required, this should be conveyed as text.", "min" : 0, "max" : "1", "type" : [{ "code" : "dateTime" }, { "code" : "Period" }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Event.occurrence[x]" }, { "identity" : "w5", "map" : "FiveWs.done[x]" }, { "identity" : "rim", "map" : ".effectiveTime" }] }, { "id" : "MedicationUsage.dateAsserted", "path" : "MedicationUsage.dateAsserted", "short" : "When the usage was asserted?", "definition" : "The date when the Medication Usage was asserted by the information source.", "min" : 0, "max" : "1", "type" : [{ "code" : "dateTime" }], "isSummary" : true, "mapping" : [{ "identity" : "w5", "map" : "FiveWs.recorded" }, { "identity" : "rim", "map" : ".participation[typeCode=AUT].time" }] }, { "id" : "MedicationUsage.informationSource", "path" : "MedicationUsage.informationSource", "short" : "Person or organization that provided the information about the taking of this medication", "definition" : "The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationUsage is derived from other resources, e.g. Claim or MedicationRequest.", "min" : 0, "max" : "1", "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://hl7.org/fhir/StructureDefinition/Organization"] }], "mapping" : [{ "identity" : "w5", "map" : "FiveWs.source" }, { "identity" : "rim", "map" : ".participation[typeCode=INF].role[classCode=PAT, or codes for Practitioner or Related Person (if PAT is the informer, then syntax for self-reported =true)" }] }, { "id" : "MedicationUsage.derivedFrom", "path" : "MedicationUsage.derivedFrom", "short" : "Link to information used to derive the MedicationUsage", "definition" : "Allows linking the MedicationUsage to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationUsage.", "comment" : "Likely references would be to MedicationRequest, MedicationDispense, Claim, Observation or QuestionnaireAnswers. The most common use cases for deriving a MedicationUsage comes from creating a MedicationUsage from a MedicationRequest or from a lab observation or a claim. it should be noted that the amount of information that is available varies from the type resource that you derive the MedicationUsage from.", "min" : 0, "max" : "*", "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] }], "mapping" : [{ "identity" : "rim", "map" : ".outboundRelationship[typeCode=SPRT]/target[classCode=ACT,moodCode=EVN]" }] }, { "id" : "MedicationUsage.reason", "path" : "MedicationUsage.reason", "short" : "Reason for why the medication is being/was taken", "definition" : "A concept, Condition or observation that supports why the medication is being/was taken.", "comment" : "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonForUseReference.", "min" : 0, "max" : "*", "type" : [{ "code" : "CodeableReference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Condition", "http://hl7.org/fhir/StructureDefinition/Observation", "http://hl7.org/fhir/StructureDefinition/DiagnosticReport"] }], "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "MedicationReason" }], "strength" : "example", "description" : "A coded concept identifying why the medication is being taken.", "valueSet" : "http://hl7.org/fhir/ValueSet/condition-code" }, "mapping" : [{ "identity" : "workflow", "map" : "Event.reason" }, { "identity" : "w5", "map" : "FiveWs.why[x]" }, { "identity" : "rim", "map" : ".reasonCode" }] }, { "id" : "MedicationUsage.note", "path" : "MedicationUsage.note", "short" : "Further information about the usage", "definition" : "Provides extra information about the Medication Usage that is not conveyed by the other attributes.", "min" : 0, "max" : "*", "type" : [{ "code" : "Annotation" }], "mapping" : [{ "identity" : "workflow", "map" : "Event.note" }, { "identity" : "rim", "map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code=\"annotation\"].value" }] }, { "id" : "MedicationUsage.renderedDosageInstruction", "path" : "MedicationUsage.renderedDosageInstruction", "short" : "Full representation of the dosage instructions", "definition" : "The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.", "requirements" : "The content of the renderedDosageInstructions must not be different than the dose represented in the dosageInstruction content.", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }], "mapping" : [{ "identity" : "rim", "map" : "SubstanceAdministration.text" }] }, { "id" : "MedicationUsage.dosage", "path" : "MedicationUsage.dosage", "short" : "Details of how medication is/was taken or should be taken", "definition" : "Indicates how the medication is/was or should be taken by the patient.", "comment" : "The dates included in the dosage on a Medication Usage reflect the dates for a given dose. For example, \"from November 1, 2016 to November 3, 2016, take one tablet daily and from November 4, 2016 to November 7, 2016, take two tablets daily.\" It is expected that this specificity may only be populated where the patient brings in their labeled container or where the Medication Usage is derived from a MedicationRequest.", "min" : 0, "max" : "*", "type" : [{ "code" : "Dosage" }], "mapping" : [{ "identity" : "rim", "map" : "refer dosageInstruction mapping" }] }, { "id" : "MedicationUsage.takenAsOrdered", "path" : "MedicationUsage.takenAsOrdered", "short" : "Indicates if the medication is being consumed or administered as prescribed", "definition" : "Indicates if the medication is being consumed or administered as prescribed.", "min" : 0, "max" : "1", "type" : [{ "code" : "boolean" }], "mapping" : [{ "identity" : "rim", "map" : "outboundRelationship[typeCode=PERT].target[classCode=OBV,moodCode=EVN].value[xsi:type=BL]" }] }] } }
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.