Data Model Libraries
    Preparing search index...

    MedicationRequest Class

    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.

    FHIR Specification

    • Short: Ordering of medication for patient or group
    • Definition: 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.
    • FHIR Version: 4.3.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusReason setStatusReason hasStatusReason getIntentEnumType setIntentEnumType hasIntentEnumType getIntentElement setIntentElement hasIntentElement getIntent setIntent hasIntent getCategory setCategory addCategory hasCategory getPriorityEnumType setPriorityEnumType hasPriorityEnumType getPriorityElement setPriorityElement hasPriorityElement getPriority setPriority hasPriority getDoNotPerformElement setDoNotPerformElement hasDoNotPerformElement getDoNotPerform setDoNotPerform hasDoNotPerform getReported setReported hasReported getReportedBooleanType hasReportedBooleanType getReportedReference hasReportedReference getMedication setMedication hasMedication getMedicationCodeableConcept hasMedicationCodeableConcept getMedicationReference hasMedicationReference getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getSupportingInformation setSupportingInformation addSupportingInformation hasSupportingInformation getAuthoredOnElement setAuthoredOnElement hasAuthoredOnElement getAuthoredOn setAuthoredOn hasAuthoredOn getRequester setRequester hasRequester getPerformer setPerformer hasPerformer getPerformerType setPerformerType hasPerformerType getRecorder setRecorder hasRecorder getReasonCode setReasonCode addReasonCode hasReasonCode getReasonReference setReasonReference addReasonReference hasReasonReference getInstantiatesCanonicalElement setInstantiatesCanonicalElement addInstantiatesCanonicalElement hasInstantiatesCanonicalElement getInstantiatesCanonical setInstantiatesCanonical addInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement addInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri addInstantiatesUri hasInstantiatesUri getBasedOn setBasedOn addBasedOn hasBasedOn getGroupIdentifier setGroupIdentifier hasGroupIdentifier getCourseOfTherapyType setCourseOfTherapyType hasCourseOfTherapyType getInsurance setInsurance addInsurance hasInsurance getNote setNote addNote hasNote getDosageInstruction setDosageInstruction addDosageInstruction hasDosageInstruction getDispenseRequest setDispenseRequest hasDispenseRequest getSubstitution setSubstitution hasSubstitution getPriorPrescription setPriorPrescription hasPriorPrescription getDetectedIssue setDetectedIssue addDetectedIssue hasDetectedIssue getEventHistory setEventHistory addEventHistory hasEventHistory fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initCategory initSupportingInformation initReasonCode initReasonReference initInstantiatesCanonical initInstantiatesUri initBasedOn initInsurance initNote initDosageInstruction initDetectedIssue initEventHistory

    Constructors

    Properties

    identifier?: Identifier[]

    MedicationRequest.identifier Element

    FHIR Specification

    • Short: External ids for this request
    • Definition: 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. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
    • Comment: This is a business identifier, not a resource identifier.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    medicationrequestStatusEnum: MedicationrequestStatusEnum

    FHIR CodeSystem: MedicationrequestStatus

    status: null | EnumCodeType

    MedicationRequest.status Element

    FHIR Specification

    • Short: active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
    • Definition: A code specifying the current state of the order. Generally, this will be active or completed state.
    • Comment: This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: MedicationrequestStatusEnum

    statusReason?: CodeableConcept

    MedicationRequest.statusReason Element

    FHIR Specification

    • Short: Reason for current status
    • Definition: Captures the reason for the current state of the MedicationRequest.
    • Comment: This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the MedicationRequest was created at all is captured in reasonCode, not here.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    medicationrequestIntentEnum: MedicationrequestIntentEnum

    FHIR CodeSystem: MedicationrequestIntent

    intent: null | EnumCodeType

    MedicationRequest.intent Element

    FHIR Specification

    • Short: proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
    • Definition: Whether the request is a proposal, plan, or an original order.
    • Comment: It is expected that the type of requester will be restricted for different stages of a MedicationRequest. For example, Proposals can be created by a patient, relatedPerson, Practitioner or Device. Plans can be created by Practitioners, Patients, RelatedPersons and Devices. Original orders can be created by a Practitioner only. An instance-order is an instantiation of a request or order and may be used to populate Medication Administration Record. This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request
    • isSummary: true

    CodeSystem Enumeration: MedicationrequestIntentEnum

    category?: CodeableConcept[]

    MedicationRequest.category Element

    FHIR Specification

    • Short: Type of medication usage
    • Definition: Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
    • Comment: The category can be used to include where the medication is expected to be consumed or other types of requests.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    requestPriorityEnum: RequestPriorityEnum

    FHIR CodeSystem: RequestPriority

    priority?: EnumCodeType

    MedicationRequest.priority Element

    FHIR Specification

    • Short: routine | urgent | asap | stat
    • Definition: Indicates how quickly the Medication Request should be addressed with respect to other requests.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: RequestPriorityEnum

    doNotPerform?: BooleanType

    MedicationRequest.doNotPerform Element

    FHIR Specification

    • Short: True if request is prohibiting action
    • Definition: If true indicates that the provider is asking for the medication request not to occur.
    • Comment: If do not perform is not specified, the request is a positive request e.g. "do perform".
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because this element negates the request to occur (ie, this is a request for the medication not to be ordered or prescribed, etc)
    • isSummary: true
    reported?: IDataType

    MedicationRequest.reported[x] Element

    @ChoiceDataTypesMeta('MedicationRequest.reported[x]', ['boolean','Reference',]

    FHIR Specification

    • Short: Reported rather than primary record
    • Definition: Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.
    • FHIR Types: 'boolean', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    medication: null | IDataType

    MedicationRequest.medication[x] Element

    @ChoiceDataTypesMeta('MedicationRequest.medication[x]', ['CodeableConcept','Reference',]

    FHIR Specification

    • Short: Medication to be taken
    • Definition: 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.
    • Comment: If only a code is specified, then it needs to be a code for a specific product. If more information is required, then the use of the Medication resource is recommended. For example, if you require form or lot number or if the medication is compounded or extemporaneously prepared, then you must reference the Medication resource.
    • FHIR Types: 'CodeableConcept', 'Reference',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    MedicationRequest.subject Element

    FHIR Specification

    • Short: Who or group medication request is for
    • Definition: A link to a resource representing the person or set of individuals to whom the medication will be given.
    • Comment: The subject on a medication request is mandatory. For the secondary use case where the actual subject is not provided, there still must be an anonymized subject specified.
    • FHIR Type: Reference
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    encounter?: Reference

    MedicationRequest.encounter Element

    FHIR Specification

    • Short: Encounter created as part of encounter/admission/stay
    • Definition: The Encounter during which this [x] was created or to which the creation of this record is tightly associated.
    • Comment: This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter." If there is a need to link to episodes of care they will be handled with an extension.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    supportingInformation?: Reference[]

    MedicationRequest.supportingInformation Element

    FHIR Specification

    • Short: Information to support ordering of the medication
    • Definition: Include additional information (for example, patient height and weight) that supports the ordering of the medication.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    authoredOn?: DateTimeType

    MedicationRequest.authoredOn Element

    FHIR Specification

    • Short: When request was initially authored
    • Definition: The date (and perhaps time) when the prescription was initially written or authored on.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requester?: Reference

    MedicationRequest.requester Element

    FHIR Specification

    performer?: Reference

    MedicationRequest.performer Element

    FHIR Specification

    performerType?: CodeableConcept

    MedicationRequest.performerType Element

    FHIR Specification

    • Short: Desired kind of performer of the medication administration
    • Definition: Indicates the type of performer of the administration of the medication.
    • Comment: If specified without indicating a performer, this indicates that the performer must be of the specified type. If specified with a performer then it indicates the requirements of the performer if the designated performer is not available.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    recorder?: Reference

    MedicationRequest.recorder Element

    FHIR Specification

    reasonCode?: CodeableConcept[]

    MedicationRequest.reasonCode Element

    FHIR Specification

    • Short: Reason or indication for ordering or not ordering the medication
    • Definition: The reason or the indication for ordering or not ordering the medication.
    • Comment: This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonReference.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    reasonReference?: Reference[]

    MedicationRequest.reasonReference Element

    FHIR Specification

    • Short: Condition or observation that supports why the prescription is being written
    • Definition: Condition or observation that supports why the medication was ordered.
    • Comment: This is a reference to a condition or observation that is the reason for the medication order. If only a code exists, use reasonCode.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    instantiatesCanonical?: CanonicalType[]

    MedicationRequest.instantiatesCanonical Element

    FHIR Specification

    • Short: Instantiates FHIR protocol or definition
    • Definition: The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    instantiatesUri?: UriType[]

    MedicationRequest.instantiatesUri Element

    FHIR Specification

    • Short: Instantiates external protocol or definition
    • Definition: The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this MedicationRequest.
    • FHIR Type: uri
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    basedOn?: Reference[]

    MedicationRequest.basedOn Element

    FHIR Specification

    groupIdentifier?: Identifier

    MedicationRequest.groupIdentifier Element

    FHIR Specification

    • Short: Composite request this is part of
    • Definition: 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.
    • Requirements: Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    courseOfTherapyType?: CodeableConcept

    MedicationRequest.courseOfTherapyType Element

    FHIR Specification

    • Short: Overall pattern of medication administration
    • Definition: The description of the overall patte3rn of the administration of the medication to the patient.
    • Comment: This attribute should not be confused with the protocol of the medication.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    insurance?: Reference[]

    MedicationRequest.insurance Element

    FHIR Specification

    note?: Annotation[]

    MedicationRequest.note Element

    FHIR Specification

    • Short: Information about the prescription
    • Definition: Extra information about the prescription that could not be conveyed by the other attributes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    dosageInstruction?: Dosage[]

    MedicationRequest.dosageInstruction Element

    FHIR Specification

    • Short: How the medication should be taken
    • Definition: Indicates how the medication is to be used by the patient.
    • Comment: There are examples where a medication request may include the option of an oral dose or an Intravenous or Intramuscular dose. For example, "Ondansetron 8mg orally or IV twice a day as needed for nausea" or "Compazine(R) (prochlorperazine) 5-10mg PO or 25mg PR bid prn nausea or vomiting". In these cases, two medication requests would be created that could be grouped together. The decision on which dose and route of administration to use is based on the patient's condition at the time the dose is needed.
    • FHIR Type: Dosage
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    MedicationRequest.dispenseRequest Element

    FHIR Specification

    • Short: Medication supply authorization
    • Definition: 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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    MedicationRequest.substitution Element

    FHIR Specification

    • Short: Any restrictions on medication substitution
    • Definition: 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's intent. If nothing is specified substitution may be done.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    priorPrescription?: Reference

    MedicationRequest.priorPrescription Element

    FHIR Specification

    • Short: An order/prescription that is being replaced
    • Definition: A link to a resource representing an earlier order related order or prescription.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    detectedIssue?: Reference[]

    MedicationRequest.detectedIssue Element

    FHIR Specification

    • Short: Clinical Issue with action
    • Definition: 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.
    • Comment: This element can include a detected issue that has been identified either by a decision support system or by a clinician and may include information on the steps that were taken to address the issue.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    eventHistory?: Reference[]

    MedicationRequest.eventHistory Element

    FHIR Specification

    • Short: A list of events of interest in the lifecycle
    • Definition: 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.
    • Comment: This might not include provenances for all versions of the request - only those deemed "relevant" or important. This SHALL NOT include the provenance associated with this current version of the resource. (If that provenance is deemed to be a "relevant" change, it will need to be added as part of a later update. Until then, it can be queried directly as the provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject.).
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided MedicationRequest JSON to instantiate the MedicationRequest data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR MedicationRequest

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to MedicationRequest

      Returns undefined | MedicationRequest

      MedicationRequest data model or undefined for MedicationRequest

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Requester object value to the requester property.

      Parameters

      • value: undefined | Reference

        the requester object value

      Returns this

      this

      @ReferenceTargets('MedicationRequest.requester', ['Practitioner','PractitionerRole','Organization','Patient','RelatedPerson','Device',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided Performer object value to the performer property.

      Parameters

      • value: undefined | Reference

        the performer object value

      Returns this

      this

      @ReferenceTargets('MedicationRequest.performer', ['Practitioner','PractitionerRole','Organization','Patient','Device','RelatedPerson','CareTeam',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise