DSTU2 Ballot Source
This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 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 
. Page versions: R5 R4B R4 R3 R2
StructureDefinition for medication
{
"resourceType": "StructureDefinition",
"id": "Medication",
"meta": {
"lastUpdated": "2015-04-03T14:24:32.000+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/Medication",
"name": "Medication",
"publisher": "HL7 FHIR Project (Pharmacy)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/medication/index.cfm"
}
]
}
],
"description": "Base StructureDefinition for Medication Resource",
"status": "draft",
"date": "2015-04-03T14:24:32+11:00",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
}
],
"type": "resource",
"abstract": true,
"snapshot": {
"element": [
{
"path": "Medication",
"short": "Definition of a Medication",
"definition": "Primarily used for identification and definition of Medication, but also covers ingredients and packaging.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "ManufacturedProduct[classCode=ADMM]"
}
]
},
{
"path": "Medication.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. 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. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
]
},
{
"path": "Medication.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",
"type": [
{
"code": "Meta"
}
]
},
{
"path": "Medication.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",
"type": [
{
"code": "uri"
}
],
"isModifier": true
},
{
"path": "Medication.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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"path": "Medication.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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"path": "Medication.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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.name",
"short": "Common / Commercial name",
"definition": "The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RXO-1.2-Requested Give Code.text / RXE-2.2-Give Code.text / RXD-2.2-Dispense/Give Code.text / RXG-4.2-Give Code.text / RXA-5.2-Administered Code.text"
},
{
"identity": "rim",
"map": ".name"
}
]
},
{
"path": "Medication.code",
"short": "Codes that identify this medication",
"definition": "A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes.",
"comments": "When defining a medication, the code is the \"identifying\" code for the medication. All the codings provided should be at the same level in the hierarchy (generic, formulation, generic strength, etc.). Codes that relate the medication across the hierarchy should be conveyed using the relationships inherent in Medication.package and Medication.product.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "MedicationFormalRepresentation",
"strength": "example",
"description": "A code that defines the type of a medication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Medication.isBrand",
"short": "True if a brand",
"definition": "Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is).",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "true if .player.scopingRole[typeCode=MANU] exists"
}
]
},
{
"path": "Medication.manufacturer",
"short": "Manufacturer of the item",
"definition": "Describes the details of the manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"
},
{
"identity": "rim",
"map": ".player.scopingRole[typeCode=MANU].scoper"
}
]
},
{
"path": "Medication.kind",
"short": "product | package",
"definition": "Medications are either a single administrable product or a package that contains one or more products.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "MedicationKind",
"strength": "required",
"description": "Whether the medication is a product or a package",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-kind"
}
},
"mapping": [
{
"identity": "rim",
"map": ".player.classCode\r(CONT or not)"
}
]
},
{
"path": "Medication.product",
"short": "Administrable medication details",
"definition": "Information that only applies to products (not packages).",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player [classCode != CONT]"
}
]
},
{
"path": "Medication.product.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.product.form",
"short": "powder | tablets | carton +",
"definition": "Describes the form of the item. Powder; tables; carton.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationForm",
"strength": "example",
"description": "The form of a medication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-form-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form"
},
{
"identity": "rim",
"map": ".formCode"
}
]
},
{
"path": "Medication.product.ingredient",
"short": "Active or inactive ingredient",
"definition": "Identifies a particular constituent of interest in the product.",
"comments": "The ingredients need not be a complete list; usually only active ingredients are listed.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[typeCode=INGR]"
}
]
},
{
"path": "Medication.product.ingredient.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.ingredient.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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.ingredient.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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.product.ingredient.item",
"short": "The product contained",
"definition": "The actual ingredient - either a substance (simple ingredient) or another medication.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "if substance: RXC-2-Component Code\rif medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code"
},
{
"identity": "rim",
"map": ".player"
}
]
},
{
"path": "Medication.product.ingredient.amount",
"short": "How much ingredient in product",
"definition": "Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "if substance: RXC-3-Component Amount & RXC-4-Component Units\rif medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "Medication.product.batch",
"short": "Information about a group of medication produced or packaged from one production run.",
"definition": "Information about a group of medication produced or packaged from one production run.",
"min": 0,
"max": "*"
},
{
"path": "Medication.product.batch.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.batch.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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.product.batch.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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.product.batch.lotNumber",
"short": "The assigned lot number of a batch of the specified product.",
"definition": "The assigned lot number of a batch of the specified product.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Medication.product.batch.expirationDate",
"short": "When this specific batch of product will expire.",
"definition": "When this specific batch of product will expire.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Medication.package",
"short": "Details about packaged medications",
"definition": "Information that only applies to packages (not products).",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player[classCode=CONT]"
}
]
},
{
"path": "Medication.package.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.package.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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.package.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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.package.container",
"short": "E.g. box, vial, blister-pack",
"definition": "The kind of container that this package comes as.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationContainer",
"strength": "example",
"description": "Kind of container a medication package is packaged in",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-package-form-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Medication.package.content",
"short": "What is in the package?",
"definition": "A set of components that go to make up the described item.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[typeCode=CONT]"
}
]
},
{
"path": "Medication.package.content.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.package.content.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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Medication.package.content.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": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Medication.package.content.item",
"short": "A product in the package",
"definition": "Identifies one of the items in the package.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player"
}
]
},
{
"path": "Medication.package.content.amount",
"short": "How many are in the package?",
"definition": "The amount of the product that is in the package.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": ".quantity"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Medication",
"short": "Definition of a Medication",
"definition": "Primarily used for identification and definition of Medication, but also covers ingredients and packaging.",
"min": 1,
"max": "1",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "ManufacturedProduct[classCode=ADMM]"
}
]
},
{
"path": "Medication.name",
"short": "Common / Commercial name",
"definition": "The common/commercial name of the medication absent information such as strength, form, etc. E.g. Acetaminophen, Tylenol 3, etc. The fully coordinated name is communicated as the display of Medication.code.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RXO-1.2-Requested Give Code.text / RXE-2.2-Give Code.text / RXD-2.2-Dispense/Give Code.text / RXG-4.2-Give Code.text / RXA-5.2-Administered Code.text"
},
{
"identity": "rim",
"map": ".name"
}
]
},
{
"path": "Medication.code",
"short": "Codes that identify this medication",
"definition": "A code (or set of codes) that identify this medication. Usage note: This could be a standard drug code such as a drug regulator code, RxNorm code, SNOMED CT code, etc. It could also be a local formulary code, optionally with translations to the standard drug codes.",
"comments": "When defining a medication, the code is the \"identifying\" code for the medication. All the codings provided should be at the same level in the hierarchy (generic, formulation, generic strength, etc.). Codes that relate the medication across the hierarchy should be conveyed using the relationships inherent in Medication.package and Medication.product.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "MedicationFormalRepresentation",
"strength": "example",
"description": "A code that defines the type of a medication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-1.1-Requested Give Code.code / RXE-2.1-Give Code.code / RXD-2.1-Dispense/Give Code.code / RXG-4.1-Give Code.code /RXA-5.1-Administered Code.code"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Medication.isBrand",
"short": "True if a brand",
"definition": "Set to true if the item is attributable to a specific manufacturer (even if we don't know who that is).",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "true if .player.scopingRole[typeCode=MANU] exists"
}
]
},
{
"path": "Medication.manufacturer",
"short": "Manufacturer of the item",
"definition": "Describes the details of the manufacturer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "RXD-20-Substance Manufacturer Name / RXG-21-Substance Manufacturer Name / RXA-17-Substance Manufacturer Name"
},
{
"identity": "rim",
"map": ".player.scopingRole[typeCode=MANU].scoper"
}
]
},
{
"path": "Medication.kind",
"short": "product | package",
"definition": "Medications are either a single administrable product or a package that contains one or more products.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"name": "MedicationKind",
"strength": "required",
"description": "Whether the medication is a product or a package",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-kind"
}
},
"mapping": [
{
"identity": "rim",
"map": ".player.classCode\r(CONT or not)"
}
]
},
{
"path": "Medication.product",
"short": "Administrable medication details",
"definition": "Information that only applies to products (not packages).",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player [classCode != CONT]"
}
]
},
{
"path": "Medication.product.form",
"short": "powder | tablets | carton +",
"definition": "Describes the form of the item. Powder; tables; carton.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationForm",
"strength": "example",
"description": "The form of a medication",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-form-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXO-5-Requested Dosage Form / RXE-6-Give Dosage Form / RXD-6-Actual Dosage Form / RXG-8-Give Dosage Form / RXA-8-Administered Dosage Form"
},
{
"identity": "rim",
"map": ".formCode"
}
]
},
{
"path": "Medication.product.ingredient",
"short": "Active or inactive ingredient",
"definition": "Identifies a particular constituent of interest in the product.",
"comments": "The ingredients need not be a complete list; usually only active ingredients are listed.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[typeCode=INGR]"
}
]
},
{
"path": "Medication.product.ingredient.item",
"short": "The product contained",
"definition": "The actual ingredient - either a substance (simple ingredient) or another medication.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "v2",
"map": "if substance: RXC-2-Component Code\rif medication: RXO-1-Requested Give Code / RXE-2-Give Code / RXD-2-Dispense/Give Code / RXG-4-Give Code / RXA-5-Administered Code"
},
{
"identity": "rim",
"map": ".player"
}
]
},
{
"path": "Medication.product.ingredient.amount",
"short": "How much ingredient in product",
"definition": "Specifies how many (or how much) of the items there are in this Medication. E.g. 250 mg per tablet.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"mapping": [
{
"identity": "v2",
"map": "if substance: RXC-3-Component Amount & RXC-4-Component Units\rif medication: RXO-2-Requested Give Amount - Minimum & RXO-4-Requested Give Units / RXO-3-Requested Give Amount - Maximum & RXO-4-Requested Give Units / RXO-11-Requested Dispense Amount & RXO-12-Requested Dispense Units / RXE-3-Give Amount - Minimum & RXE-5-Give Units / RXE-4-Give Amount - Maximum & RXE-5-Give Units / RXE-10-Dispense Amount & RXE-10-Dispense Units"
},
{
"identity": "rim",
"map": ".quantity"
}
]
},
{
"path": "Medication.product.batch",
"short": "Information about a group of medication produced or packaged from one production run.",
"definition": "Information about a group of medication produced or packaged from one production run.",
"min": 0,
"max": "*"
},
{
"path": "Medication.product.batch.lotNumber",
"short": "The assigned lot number of a batch of the specified product.",
"definition": "The assigned lot number of a batch of the specified product.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"path": "Medication.product.batch.expirationDate",
"short": "When this specific batch of product will expire.",
"definition": "When this specific batch of product will expire.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"path": "Medication.package",
"short": "Details about packaged medications",
"definition": "Information that only applies to packages (not products).",
"min": 0,
"max": "1",
"mapping": [
{
"identity": "rim",
"map": ".player[classCode=CONT]"
}
]
},
{
"path": "Medication.package.container",
"short": "E.g. box, vial, blister-pack",
"definition": "The kind of container that this package comes as.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"name": "MedicationContainer",
"strength": "example",
"description": "Kind of container a medication package is packaged in",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/medication-package-form-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
},
{
"path": "Medication.package.content",
"short": "What is in the package?",
"definition": "A set of components that go to make up the described item.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": ".scopesRole[typeCode=CONT]"
}
]
},
{
"path": "Medication.package.content.item",
"short": "A product in the package",
"definition": "Identifies one of the items in the package.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
}
],
"mapping": [
{
"identity": "rim",
"map": ".player"
}
]
},
{
"path": "Medication.package.content.amount",
"short": "How many are in the package?",
"definition": "The amount of the product that is in the package.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity"
}
],
"mapping": [
{
"identity": "rim",
"map": ".quantity"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU (v0.5.0-5149) generated on Fri, Apr 3, 2015 14:33+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change