R4 Ballot #2 (Mixed Normative/Trial use)
This page is part of the FHIR Specification (v3.5.0: R4 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
| Pharmacy Work Group | Maturity Level: N/A | Ballot Status: Informative | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
This is a representation of the json schema for MedicationAdministration, which is just a part of the full JSON Schema.
Medications
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/MedicationAdministration",
"$ref": "#/definitions/MedicationAdministration",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"MedicationAdministration": {
"description": "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"properties": {
"resourceType": {
"description": "This is a MedicationAdministration resource",
"const": "MedicationAdministration"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "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. This identifier is particularly important when these records require updates.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"instantiates": {
"description": "A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_instantiates": {
"description": "Extensions for instantiates",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"partOf": {
"description": "A larger event of which this particular event is a component or step.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"status": {
"description": "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.",
"enum": [
"in-progress",
"not-done",
"on-hold",
"completed",
"entered-in-error",
"stopped",
"unknown"
]
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"category": {
"description": "Indicates where the medication is expected to be consumed or administered.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"medicationCodeableConcept": {
"description": "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.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"medicationReference": {
"description": "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.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"subject": {
"description": "The person or animal or group receiving the medication.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"context": {
"description": "The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"supportingInformation": {
"description": "Additional information (for example, patient height and weight) that supports the administration of the medication.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"effectiveDateTime": {
"description": "A specific date/time or interval of time during which the administration took place (or did not take place, when the \u0027notGiven\u0027 attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$",
"type": "string"
},
"_effectiveDateTime": {
"description": "Extensions for effectiveDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"effectivePeriod": {
"description": "A specific date/time or interval of time during which the administration took place (or did not take place, when the \u0027notGiven\u0027 attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.",
"$ref": "Period.schema.json#/definitions/Period"
},
"performer": {
"description": "Indicates who or what performed the medication administration and how they were involved.",
"items": {
"$ref": "#/definitions/MedicationAdministration_Performer"
},
"type": "array"
},
"statusReason": {
"description": "A code indicating why the administration was not performed.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"reasonCode": {
"description": "A code indicating why the medication was given.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"reasonReference": {
"description": "Condition or observation that supports why the medication was administered.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"request": {
"description": "The original request, instruction or authority to perform the administration.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"device": {
"description": "The device used in administering the medication to the patient. For example, a particular infusion pump.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"note": {
"description": "Extra information about the medication administration that is not conveyed by the other attributes.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
},
"dosage": {
"description": "Describes the medication dosage information details e.g. dose, rate, site, route, etc.",
"$ref": "#/definitions/MedicationAdministration_Dosage"
},
"eventHistory": {
"description": "A summary of the events of interest that have occurred, such as when the administration was verified.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"subject",
"resourceType"
]
},
"MedicationAdministration_Performer": {
"description": "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"function": {
"description": "Distinguishes the type of involvement of the performer in the medication administration.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"actor": {
"description": "Indicates who or what performed the medication administration.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"additionalProperties": false,
"required": [
"actor"
]
},
"MedicationAdministration_Dosage": {
"description": "Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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 in which it is contained. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"text": {
"description": "Free text dosage can be used for cases where the dosage administered is too complex to code. When coded dosage is present, the free text dosage may still be present for display to humans.\r\rThe dosage instructions should reflect the dosage of the medication that was administered.",
"$ref": "#/definitions/string"
},
"_text": {
"description": "Extensions for text",
"$ref": "Element.schema.json#/definitions/Element"
},
"site": {
"description": "A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\".",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"route": {
"description": "A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"method": {
"description": "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.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"dose": {
"description": "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.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"rateRatio": {
"description": "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.",
"$ref": "Ratio.schema.json#/definitions/Ratio"
},
"rateQuantity": {
"description": "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.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
}
},
"additionalProperties": false
}
}
}
®© HL7.org 2011+. FHIR Mixed Nomative/Trial Use Ballot #2 (v3.5.0-14907) generated on Sun, Aug 19, 2018 21:53+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU3 |
Ballot Comparison |
|
Propose a change