STU3 Candidate
FoundationThis page is part of the FHIR Specification (v1.8.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
StructureDefinition for DosageInstruction
{
"resourceType": "StructureDefinition",
"id": "DosageInstruction",
"meta": {
"lastUpdated": "2016-12-06T12:22:34.981+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/DosageInstruction",
"name": "DosageInstruction",
"status": "draft",
"publisher": "HL7 FHIR Standard",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"date": "2016-12-06T12:22:34+11:00",
"description": "Base StructureDefinition for DosageInstruction Type",
"fhirVersion": "1.8.0",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"type": "DosageInstruction",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Element",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "DosageInstruction",
"path": "DosageInstruction",
"short": "How medication should be taken",
"definition": "Indicates how the medication is to be used by the patient.",
"min": 0,
"max": "*",
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DosageInstruction.id",
"path": "DosageInstruction.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "DosageInstruction.extension",
"path": "DosageInstruction.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": "DosageInstruction.sequence",
"path": "DosageInstruction.sequence",
"short": "The order of the dosage instructions",
"definition": "Indicates the order in which the dosage instructions should be applied or interpreted.",
"requirements": "If the sequence number of multiple dosageInstructions is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the dosageInstructions are intended to be sequential.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true
},
{
"id": "DosageInstruction.text",
"path": "DosageInstruction.text",
"short": "Free text dosage instructions e.g. SIG",
"definition": "Free text dosage instructions e.g. SIG.",
"requirements": "Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "text"
}
]
},
{
"id": "DosageInstruction.additionalInstructions",
"path": "DosageInstruction.additionalInstructions",
"short": "Supplemental instructions - e.g. \"with meals\"",
"definition": "Supplemental instructions - e.g. \"with meals\".",
"requirements": "Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept identifying additional instructions such as \"take with water\" or \"avoid operating heavy machinery\".",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/additional-instructions-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "component.substanceAdministrationRequest.text"
}
]
},
{
"id": "DosageInstruction.timing",
"path": "DosageInstruction.timing",
"short": "When medication should be administered",
"definition": "When medication should be administered.",
"requirements": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions. For example: \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "effectiveTime"
}
]
},
{
"id": "DosageInstruction.asNeeded[x]",
"path": "DosageInstruction.asNeeded[x]",
"short": "Take \"as needed\" (for x)",
"definition": "Take \"as needed\" (for x).",
"requirements": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\" etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-as-needed-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value"
}
]
},
{
"id": "DosageInstruction.site",
"path": "DosageInstruction.site",
"short": "Body site to administer to",
"definition": "Body site to administer to.",
"comments": "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [body-site-instance](extension-body-site-instance.html). May be a summary code, or a reference to a very precise definition of the location, or both.",
"requirements": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "approachSiteCode"
}
]
},
{
"id": "DosageInstruction.route",
"path": "DosageInstruction.route",
"short": "How drug should enter body",
"definition": "How drug should enter body.",
"requirements": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "routeCode"
}
]
},
{
"id": "DosageInstruction.method",
"path": "DosageInstruction.method",
"short": "Technique for administering medication",
"definition": "Technique for administering medication.",
"requirements": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"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": "methodCode"
}
]
},
{
"id": "DosageInstruction.dose[x]",
"path": "DosageInstruction.dose[x]",
"short": "Amount of medication per dose",
"definition": "Amount of medication per dose.",
"requirements": "The amount of therapeutic or other substance given at one administration event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
},
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "doseQuantity"
}
]
},
{
"id": "DosageInstruction.maxDosePerPeriod",
"path": "DosageInstruction.maxDosePerPeriod",
"short": "Upper limit on medication per unit of time",
"definition": "Upper limit on medication per unit of time.",
"requirements": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "maxDoseQuantity"
}
]
},
{
"id": "DosageInstruction.maxDosePerAdministration",
"path": "DosageInstruction.maxDosePerAdministration",
"short": "Upper limit on medication per administration",
"definition": "Upper limit on medication per administration.",
"requirements": "The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "no mapping"
}
]
},
{
"id": "DosageInstruction.maxDosePerLifetime",
"path": "DosageInstruction.maxDosePerLifetime",
"short": "Upper limit on medication per lifetime of the patient",
"definition": "Upper limit on medication per lifetime of the patient.",
"requirements": "The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "no mapping"
}
]
},
{
"id": "DosageInstruction.rate[x]",
"path": "DosageInstruction.rate[x]",
"short": "Amount of medication per unit of time",
"definition": "Amount of medication per unit of time.",
"requirements": "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. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
},
{
"code": "Range"
},
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "rateQuantity"
}
]
}
]
},
"differential": {
"element": [
{
"id": "DosageInstruction",
"path": "DosageInstruction",
"short": "How medication should be taken",
"definition": "Indicates how the medication is to be used by the patient.",
"min": 0,
"max": "*"
},
{
"id": "DosageInstruction.sequence",
"path": "DosageInstruction.sequence",
"short": "The order of the dosage instructions",
"definition": "Indicates the order in which the dosage instructions should be applied or interpreted.",
"requirements": "If the sequence number of multiple dosageInstructions is the same, then it is implied that the instructions are to be treated as concurrent. If the sequence number is different, then the dosageInstructions are intended to be sequential.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
],
"isSummary": true
},
{
"id": "DosageInstruction.text",
"path": "DosageInstruction.text",
"short": "Free text dosage instructions e.g. SIG",
"definition": "Free text dosage instructions e.g. SIG.",
"requirements": "Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "text"
}
]
},
{
"id": "DosageInstruction.additionalInstructions",
"path": "DosageInstruction.additionalInstructions",
"short": "Supplemental instructions - e.g. \"with meals\"",
"definition": "Supplemental instructions - e.g. \"with meals\".",
"requirements": "Additional instructions such as \"Swallow with plenty of water\" which may or may not be coded.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept identifying additional instructions such as \"take with water\" or \"avoid operating heavy machinery\".",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/additional-instructions-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "component.substanceAdministrationRequest.text"
}
]
},
{
"id": "DosageInstruction.timing",
"path": "DosageInstruction.timing",
"short": "When medication should be administered",
"definition": "When medication should be administered.",
"requirements": "The timing schedule for giving the medication to the patient. The Schedule data type allows many different expressions. For example: \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\". Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "effectiveTime"
}
]
},
{
"id": "DosageInstruction.asNeeded[x]",
"path": "DosageInstruction.asNeeded[x]",
"short": "Take \"as needed\" (for x)",
"definition": "Take \"as needed\" (for x).",
"requirements": "Indicates whether the Medication is only taken when needed within a specific dosing schedule (Boolean option), or it indicates the precondition for taking the Medication (CodeableConcept).",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept identifying the precondition that should be met or evaluated prior to consuming or administering a medication dose. For example \"pain\", \"30 minutes prior to sexual intercourse\", \"on flare-up\" etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-as-needed-reason"
}
},
"mapping": [
{
"identity": "v2",
"map": "boolean: precondition.negationInd (inversed - so negationInd = true means asNeeded=false CodeableConcept: precondition.observationEventCriterion[code=\"Assertion\"].value"
}
]
},
{
"id": "DosageInstruction.site",
"path": "DosageInstruction.site",
"short": "Body site to administer to",
"definition": "Body site to administer to.",
"comments": "If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension [body-site-instance](extension-body-site-instance.html). May be a summary code, or a reference to a very precise definition of the location, or both.",
"requirements": "A coded specification of the anatomic site where the medication first enters the body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept describing the site location the medicine enters into or onto the body.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/approach-site-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "approachSiteCode"
}
]
},
{
"id": "DosageInstruction.route",
"path": "DosageInstruction.route",
"short": "How drug should enter body",
"definition": "How drug should enter body.",
"requirements": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/route-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "routeCode"
}
]
},
{
"id": "DosageInstruction.method",
"path": "DosageInstruction.method",
"short": "Technique for administering medication",
"definition": "Technique for administering medication.",
"requirements": "A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"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": "methodCode"
}
]
},
{
"id": "DosageInstruction.dose[x]",
"path": "DosageInstruction.dose[x]",
"short": "Amount of medication per dose",
"definition": "Amount of medication per dose.",
"requirements": "The amount of therapeutic or other substance given at one administration event.",
"min": 0,
"max": "1",
"type": [
{
"code": "Range"
},
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "doseQuantity"
}
]
},
{
"id": "DosageInstruction.maxDosePerPeriod",
"path": "DosageInstruction.maxDosePerPeriod",
"short": "Upper limit on medication per unit of time",
"definition": "Upper limit on medication per unit of time.",
"requirements": "The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. For example, 1000mg in 24 hours.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "maxDoseQuantity"
}
]
},
{
"id": "DosageInstruction.maxDosePerAdministration",
"path": "DosageInstruction.maxDosePerAdministration",
"short": "Upper limit on medication per administration",
"definition": "Upper limit on medication per administration.",
"requirements": "The maximum total quantity of a therapeutic substance that may be administered to a subject per administration.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "no mapping"
}
]
},
{
"id": "DosageInstruction.maxDosePerLifetime",
"path": "DosageInstruction.maxDosePerLifetime",
"short": "Upper limit on medication per lifetime of the patient",
"definition": "Upper limit on medication per lifetime of the patient.",
"requirements": "The maximum total quantity of a therapeutic substance that may be administered per lifetime of the subject.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "no mapping"
}
]
},
{
"id": "DosageInstruction.rate[x]",
"path": "DosageInstruction.rate[x]",
"short": "Amount of medication per unit of time",
"definition": "Amount of medication per unit of time.",
"requirements": "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. Sometimes, a rate can imply duration when expressed as total volume / duration (e.g. 500mL/2 hours implies a duration of 2 hours). However, when rate doesn't imply duration (e.g. 250mL/hour), then the timing.repeat.duration is needed to convey the infuse over time period.",
"min": 0,
"max": "1",
"type": [
{
"code": "Ratio"
},
{
"code": "Range"
},
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "rateQuantity"
}
]
}
]
}
}
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 STU3 Candidate (v1.8.0-10521) generated on Tue, Dec 6, 2016 12:26+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change