This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions
{
"resourceType" : "StructureDefinition",
"id" : "daf-medicationadministration",
"url" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-medicationadministration",
"name" : "Profile daf-medicationadministration",
"status" : "draft",
"publisher" : "Health Level Seven International (Infrastructure and Messaging - Data Access Framework)",
"contact" : [
{
"telecom" : [
{
"system" : "other",
"value" : "http://www.healthit.gov"
}
}
}
},
"date" : "2014-08-21",
"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"
}
},
"kind" : "resource",
"abstract" : false,
"type" : "MedicationAdministration",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/MedicationAdministration",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "MedicationAdministration:dafmedicationadministration",
"path" : "MedicationAdministration",
"name" : "DAFMedicationAdministration",
"short" : "Administration of medication to a patient",
"definition" : "Profile of MedicationAdministration for clinical quality rules and measures.",
"comments" : "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" : "*",
"base" : {
"path" : "MedicationAdministration",
"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)"
},
{
"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)"
},
{
"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))"
},
{
"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))]))"
},
{
"key" : "mad-2",
"severity" : "error",
"human" : "Reason not given is only permitted if wasNotGiven is true",
"expression" : "reasonNotGiven.empty() or wasNotGiven = true",
"xpath" : "not(exists(f:reasonNotGiven) and f:wasNotGiven/@value=false())"
},
{
"key" : "mad-3",
"severity" : "error",
"human" : "Reason given is only permitted if wasNotGiven is false",
"expression" : "reasonGiven.empty() or wasNotGiven.empty() or wasNotGiven = 'false'",
"xpath" : "not(exists(f:reasonGiven) and f:wasNotGiven/@value=true())"
}
},
"mustSupport" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "SubstanceAdministration"
},
{
"identity" : "w5",
"map" : "clinical.medication"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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.",
"comments" : "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" : "*"
},
"type" : [
{
"code" : "id"
}
},
"isSummary" : true
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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" : "*"
},
"type" : [
{
"code" : "Meta"
}
},
"isSummary" : true
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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.",
"comments" : "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 as much as possible.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "uri"
}
},
"isModifier" : true,
"isSummary" : true
},
{
"id" : "MedicationAdministration:dafmedicationadministration.language",
"path" : "MedicationAdministration.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comments" : "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" : "*"
},
"type" : [
{
"code" : "code"
}
},
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/all-languages"
}
}
},
"strength" : "extensible",
"description" : "A human language.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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.",
"comments" : "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" : "*"
},
"type" : [
{
"code" : "Narrative"
}
},
"condition" : [
"dom-1"
},
"mapping" : [
{
"identity" : "rim",
"map" : "Act.text?"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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.",
"comments" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"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:dafmedicationadministration.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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core 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:dafmedicationadministration.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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core 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:dafmedicationadministration.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" : "*",
"base" : {
"path" : "MedicationAdministration.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
},
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "id"
},
{
"identity" : "w5",
"map" : "id"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.status",
"path" : "MedicationAdministration.status",
"short" : "in-progress | on-hold | completed | entered-in-error | stopped",
"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.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.status",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
},
"mustSupport" : true,
"isModifier" : true,
"isSummary" : false,
"binding" : {
"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" : "v2",
"map" : "RXA-20-Completion Status"
},
{
"identity" : "rim",
"map" : "statusCode"
},
{
"identity" : "w5",
"map" : "status"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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.",
"comments" : "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. Note: do not use Medication.name to describe the administered medication. When the only available information is a text description of the medication, Medication.code.text should be used.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.medication[x]",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-medication"
}
},
"mustSupport" : true,
"isSummary" : false,
"binding" : {
"strength" : "extensible",
"description" : "Prescribable medications",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/daf/ValueSet/daf-medication-codes"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-5-Administered Code"
},
{
"identity" : "rim",
"map" : "Consumeable->AdministerableMedication"
},
{
"identity" : "w5",
"map" : "what"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.patient",
"path" : "MedicationAdministration.patient",
"short" : "Who received medication",
"definition" : "The person or animal receiving the medication.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.patient",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-patient"
}
},
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "PID-3-Patient ID List"
},
{
"identity" : "rim",
"map" : "subject->Patient"
},
{
"identity" : "w5",
"map" : "who.focus"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.encounter",
"path" : "MedicationAdministration.encounter",
"short" : "An interaction during which services are provided to the patient",
"definition" : "An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.",
"alias" : [
"Visit"
},
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.encounter",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-encounter"
}
},
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Encounter[@moodCode='EVN']"
},
{
"identity" : "w5",
"map" : "workflow.encounter"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.effectiveTime[x]",
"path" : "MedicationAdministration.effectiveTime[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",
"base" : {
"path" : "MedicationAdministration.effectiveTime[x]",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
},
{
"code" : "Period"
}
},
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"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:dafmedicationadministration.performer",
"path" : "MedicationAdministration.performer",
"short" : "Who administered substance",
"definition" : "The individual who was responsible for giving the medication to the patient.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.performer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-pract"
}
},
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-10-Administering Provider / PRT-5-Participation Person: PRT-4-Participation='AP' (RXA-10 is deprecated)"
},
{
"identity" : "rim",
"map" : "performer->Role"
},
{
"identity" : "w5",
"map" : "who.actor"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.prescription",
"path" : "MedicationAdministration.prescription",
"short" : "Order administration performed against",
"definition" : "The original request, instruction or authority to perform the administration.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.prescription",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-medicationorder"
}
},
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "ORC-2-Placer Order Number / ORC-3-Filler Order Number"
},
{
"identity" : "rim",
"map" : "InFullfillmentOf->SubstanceAdministration"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.wasNotGiven",
"path" : "MedicationAdministration.wasNotGiven",
"short" : "True if medication not administered",
"definition" : "Set this to true if the record is saying that the medication was NOT administered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.wasNotGiven",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
},
"meaningWhenMissing" : "If this is missing, then the medication was administered",
"mustSupport" : true,
"isModifier" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-20-Completion Status='NA'"
},
{
"identity" : "rim",
"map" : "actionNegationInd"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.reasonNotGiven",
"path" : "MedicationAdministration.reasonNotGiven",
"short" : "Reason administration not performed",
"definition" : "A code indicating why the administration was not performed.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.reasonNotGiven",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
},
"condition" : [
"mad-2"
},
"mustSupport" : true,
"isSummary" : false,
"binding" : {
"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" : "v2",
"map" : "RXA-9-Administration Notes / RXA-18 Substance/Treatment Refusal Reason"
},
{
"identity" : "rim",
"map" : "Reason->Observation->Value"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.reasonGiven",
"path" : "MedicationAdministration.reasonGiven",
"short" : "Reason administration performed",
"definition" : "A code indicating why the medication was given.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.reasonGiven",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
},
"condition" : [
"mad-3"
},
"binding" : {
"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" : "v2",
"map" : "RXE-27 Give Indication"
},
{
"identity" : "rim",
"map" : ". reasonCode"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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" : "*",
"base" : {
"path" : "MedicationAdministration.device",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/StructureDefinition/Device"
}
},
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "PRT-10 Participation Device / RXR-3 Administrative Device"
},
{
"identity" : "rim",
"map" : "device->Access OR device->AssignedDevice"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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" : "*",
"base" : {
"path" : "MedicationAdministration.note",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Annotation"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".inboundRelationship[typeCode=SUBJ]/source[classCode=OBS,moodCode=EVN,code="annotation"].value"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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",
"base" : {
"path" : "MedicationAdministration.dosage",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "BackboneElement"
}
},
"constraint" : [
{
"key" : "mad-1",
"severity" : "error",
"human" : "SHALL have at least one of dosage.dose and dosage.rate[x]",
"expression" : "dose.exists() or rate.exists()",
"xpath" : "exists(f:dose) or exists(f:rateRatio) or exists(f:rateRange)"
}
},
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "component->SubstanceAdministrationEvent"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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" : "*"
},
"type" : [
{
"code" : "string"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core 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:dafmedicationadministration.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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core 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:dafmedicationadministration.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. The dosage instructions should reflect the dosage of the medication that was administered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".text"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.dosage.siteCodeableConcept",
"path" : "MedicationAdministration.dosage.siteCodeableConcept",
"short" : "Body site administered to",
"definition" : "A coded specification of the anatomic site where the medication first entered the body. For example, "left arm".",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.dosage.site[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
},
"mustSupport" : true,
"isSummary" : false,
"binding" : {
"strength" : "preferred",
"description" : "This identifies the body site at which the substance was administered",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/daf/ValueSet/daf-bodysite"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "RXR-2 Administration Site / RXR-6 Administration Site Modifier"
},
{
"identity" : "rim",
"map" : "approachSiteCode"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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",
"base" : {
"path" : "MedicationAdministration.dosage.route",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
},
"mustSupport" : true,
"isSummary" : false,
"binding" : {
"strength" : "preferred",
"description" : "This identifies the route of substance administration.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/daf/ValueSet/daf-medication-route"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "RXR-1-Route"
},
{
"identity" : "rim",
"map" : "routeCode"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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.",
"comments" : "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",
"base" : {
"path" : "MedicationAdministration.dosage.method",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
},
"binding" : {
"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:dafmedicationadministration.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.",
"comments" : "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",
"base" : {
"path" : "MedicationAdministration.dosage.dose",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Quantity",
"profile" : "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
},
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-6 Administered Amount / RXA-7 Administered Units"
},
{
"identity" : "rim",
"map" : "doseQuantity"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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.",
"comments" : "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",
"base" : {
"path" : "MedicationAdministration.dosage.rate[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Ratio"
},
{
"code" : "Quantity",
"profile" : "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
},
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-12-Administered Per (Time Unit)"
},
{
"identity" : "rim",
"map" : "rateQuantity"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.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.",
"comments" : "This is not the same as an audit trail. It is a view of the important things that happened in the past. Typically, there would only be one entry for any given status, and systems may not record all the status events.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "MedicationAdministration.eventHistory",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "Not Mapped"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.eventHistory.id",
"path" : "MedicationAdministration.eventHistory.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" : "*"
},
"type" : [
{
"code" : "string"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.eventHistory.extension",
"path" : "MedicationAdministration.eventHistory.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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core 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:dafmedicationadministration.eventHistory.modifierExtension",
"path" : "MedicationAdministration.eventHistory.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.",
"comments" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core 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:dafmedicationadministration.eventHistory.status",
"path" : "MedicationAdministration.eventHistory.status",
"short" : "in-progress | on-hold | completed | entered-in-error | stopped",
"definition" : "The status for the event.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.eventHistory.status",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
},
"binding" : {
"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" : "rim",
"map" : "Not Mapped"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.eventHistory.action",
"path" : "MedicationAdministration.eventHistory.action",
"short" : "Action taken (e.g. verify)",
"definition" : "The action that was taken (e.g. verify).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.eventHistory.action",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
},
"binding" : {
"strength" : "example",
"description" : "A coded concept describing an action taken on a medication administration."
},
"mapping" : [
{
"identity" : "rim",
"map" : "Not Mapped"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.eventHistory.dateTime",
"path" : "MedicationAdministration.eventHistory.dateTime",
"short" : "The date at which the event happened",
"definition" : "The date/time at which the event occurred.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.eventHistory.dateTime",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "Not Mapped"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.eventHistory.actor",
"path" : "MedicationAdministration.eventHistory.actor",
"short" : "Who took the action",
"definition" : "The person responsible for taking the action.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.eventHistory.actor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "Not Mapped"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.eventHistory.reason",
"path" : "MedicationAdministration.eventHistory.reason",
"short" : "Reason the action was taken",
"definition" : "The reason why the action was taken.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "MedicationAdministration.eventHistory.reason",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
},
"binding" : {
"strength" : "example",
"description" : "A coded concept describing the reason for an action taken on a medication administration."
},
"mapping" : [
{
"identity" : "rim",
"map" : "Not Mapped"
}
}
}
}
},
"differential" : {
"element" : [
{
"id" : "MedicationAdministration:dafmedicationadministration",
"path" : "MedicationAdministration",
"name" : "DAFMedicationAdministration",
"definition" : "Profile of MedicationAdministration for clinical quality rules and measures.",
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.identifier",
"path" : "MedicationAdministration.identifier",
"min" : 0,
"max" : "*",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.status",
"path" : "MedicationAdministration.status",
"min" : 1,
"max" : "1",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.medication[x]",
"path" : "MedicationAdministration.medication[x]",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "CodeableConcept"
},
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-medication"
}
},
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"strength" : "extensible",
"description" : "Prescribable medications",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/daf/ValueSet/daf-medication-codes"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.patient",
"path" : "MedicationAdministration.patient",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-patient"
}
},
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.encounter",
"path" : "MedicationAdministration.encounter",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-encounter"
}
},
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.effectiveTime[x]",
"path" : "MedicationAdministration.effectiveTime[x]",
"min" : 1,
"max" : "1",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.performer",
"path" : "MedicationAdministration.performer",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-pract"
}
},
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.prescription",
"path" : "MedicationAdministration.prescription",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Reference",
"profile" : "http://hl7.org/fhir/us/daf/StructureDefinition/daf-medicationorder"
}
},
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.wasNotGiven",
"path" : "MedicationAdministration.wasNotGiven",
"min" : 0,
"max" : "1",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.reasonNotGiven",
"path" : "MedicationAdministration.reasonNotGiven",
"min" : 0,
"max" : "1",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.device",
"path" : "MedicationAdministration.device",
"min" : 0,
"max" : "*",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.dosage",
"path" : "MedicationAdministration.dosage",
"min" : 0,
"max" : "1",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.dosage.siteCodeableConcept",
"path" : "MedicationAdministration.dosage.siteCodeableConcept",
"type" : [
{
"code" : "CodeableConcept"
}
},
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"strength" : "preferred",
"description" : "This identifies the body site at which the substance was administered",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/daf/ValueSet/daf-bodysite"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.dosage.route",
"path" : "MedicationAdministration.dosage.route",
"min" : 0,
"max" : "1",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"strength" : "preferred",
"description" : "This identifies the route of substance administration.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/daf/ValueSet/daf-medication-route"
}
}
},
{
"id" : "MedicationAdministration:dafmedicationadministration.dosage.dose",
"path" : "MedicationAdministration.dosage.dose",
"min" : 0,
"max" : "1",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "MedicationAdministration:dafmedicationadministration.dosage.rate[x]",
"path" : "MedicationAdministration.dosage.rate[x]",
"min" : 0,
"max" : "1",
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
}
}
}
}
© HL7.org 2011+. DAF STU 2 Ballot (v1.6.0-9635) generated on Thu, Aug 11, 2016 20:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
|
Propose a change