R4 Ballot #2 (Mixed Normative/Trial use)
MedicationsThis 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: Encounter, Patient, Practitioner |
This is a representation of the json schema for MedicationRequest, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/MedicationRequest",
"$ref": "#/definitions/MedicationRequest",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"MedicationRequest": {
"description": "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.",
"properties": {
"resourceType": {
"description": "This is a MedicationRequest resource",
"const": "MedicationRequest"
},
"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": "This records identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. For example a reimbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "A code specifying the current state of the order. Generally, this will be active or completed state.",
"enum": [
"active",
"on-hold",
"cancelled",
"completed",
"entered-in-error",
"stopped",
"draft",
"unknown"
]
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"intent": {
"description": "Whether the request is a proposal, plan, or an original order.",
"enum": [
"proposal",
"plan",
"order",
"original-order",
"instance-order",
"option"
]
},
"_intent": {
"description": "Extensions for intent",
"$ref": "Element.schema.json#/definitions/Element"
},
"category": {
"description": "Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"priority": {
"description": "Indicates how quickly the Medication Request should be addressed with respect to other requests.",
"$ref": "#/definitions/code"
},
"_priority": {
"description": "Extensions for priority",
"$ref": "Element.schema.json#/definitions/Element"
},
"doNotPerform": {
"description": "If true indicates that the provider is asking for the medication request not to occur.",
"$ref": "#/definitions/boolean"
},
"_doNotPerform": {
"description": "Extensions for doNotPerform",
"$ref": "Element.schema.json#/definitions/Element"
},
"medicationCodeableConcept": {
"description": "Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an 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 being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"subject": {
"description": "A link to a resource representing the person or set of individuals to whom the medication will be given.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"context": {
"description": "A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"supportingInformation": {
"description": "Include additional information (for example, patient height and weight) that supports the ordering of the medication.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"authoredOn": {
"description": "The date (and perhaps time) when the prescription was initially written or authored on.",
"$ref": "#/definitions/dateTime"
},
"_authoredOn": {
"description": "Extensions for authoredOn",
"$ref": "Element.schema.json#/definitions/Element"
},
"requester": {
"description": "The individual, organization, or device that initiated the request and has responsibility for its activation.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"performer": {
"description": "The specified desired performer of the medication treatment (e.g. the performer of the medication administration).",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"performerType": {
"description": "Indicates the type of performer of the administration of the medication.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"recorder": {
"description": "The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"reasonCode": {
"description": "The reason or the indication for ordering or not ordering the medication.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"reasonReference": {
"description": "Condition or observation that supports why the medication was ordered.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"instantiates": {
"description": "The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.",
"items": {
"$ref": "#/definitions/uri"
},
"type": "array"
},
"_instantiates": {
"description": "Extensions for instantiates",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"basedOn": {
"description": "A plan or request that is fulfilled in whole or in part by this medication request.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"groupIdentifier": {
"description": "A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"statusReason": {
"description": "Captures the reason for the current state of the MedicationRequest.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"courseOfTherapyType": {
"description": "The description of the overall patte3rn of the administration of the medication to the patient.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"insurance": {
"description": "Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"note": {
"description": "Extra information about the prescription that could not be conveyed by the other attributes.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
},
"dosageInstruction": {
"description": "Indicates how the medication is to be used by the patient.",
"items": {
"$ref": "Dosage.schema.json#/definitions/Dosage"
},
"type": "array"
},
"dispenseRequest": {
"description": "Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.",
"$ref": "#/definitions/MedicationRequest_DispenseRequest"
},
"substitution": {
"description": "Indicates whether or not substitution can or should be part of the dispense. In some cases substitution must happen, in other cases substitution must not happen. This block explains the prescriber\u0027s intent. If nothing is specified substitution may be done.",
"$ref": "#/definitions/MedicationRequest_Substitution"
},
"priorPrescription": {
"description": "A link to a resource representing an earlier order related order or prescription.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"detectedIssue": {
"description": "Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"eventHistory": {
"description": "Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"subject",
"resourceType"
]
},
"MedicationRequest_DispenseRequest": {
"description": "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.",
"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"
},
"initialFill": {
"description": "Indicates the quantity or duration for the first dispense of the medication.",
"$ref": "#/definitions/MedicationRequest_InitialFill"
},
"dispenseInterval": {
"description": "The minimum period of time that must occur between dispenses of the medication.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"validityPeriod": {
"description": "This indicates the validity period of a prescription (stale dating the Prescription).",
"$ref": "Period.schema.json#/definitions/Period"
},
"numberOfRepeatsAllowed": {
"description": "An integer indicating the number of times, in addition to the original dispense, (aka refills or repeats) that the patient can receive the prescribed medication. Usage Notes: This integer does not include the original order dispense. This means that if an order indicates dispense 30 tablets plus \"3 repeats\", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. A prescriber may explicitly say that zero refills are permitted after the initial dispense.",
"$ref": "#/definitions/unsignedInt"
},
"_numberOfRepeatsAllowed": {
"description": "Extensions for numberOfRepeatsAllowed",
"$ref": "Element.schema.json#/definitions/Element"
},
"quantity": {
"description": "The amount that is to be dispensed for one fill.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"expectedSupplyDuration": {
"description": "Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"performer": {
"description": "Indicates the intended dispensing Organization specified by the prescriber.",
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"additionalProperties": false
},
"MedicationRequest_InitialFill": {
"description": "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.",
"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"
},
"quantity": {
"description": "The amount or quantity to provide as part of the first dispense.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"duration": {
"description": "The length of time that the first dispense is expected to last.",
"$ref": "Duration.schema.json#/definitions/Duration"
}
},
"additionalProperties": false
},
"MedicationRequest_Substitution": {
"description": "An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called \"MedicationRequest\" rather than \"MedicationPrescription\" or \"MedicationOrder\" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.",
"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"
},
"allowed": {
"description": "True if the prescriber allows a different drug to be dispensed from what was prescribed.",
"$ref": "#/definitions/boolean"
},
"_allowed": {
"description": "Extensions for allowed",
"$ref": "Element.schema.json#/definitions/Element"
},
"reason": {
"description": "Indicates the reason for the substitution, or why substitution must or must not be performed.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"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