MedicationRequest

@POJOBoilerplate
class MedicationRequest(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val note: LitSeq[Annotation], val status: MEDICATIONREQUEST_STATUS, val intent: MEDICATIONREQUEST_INTENT, val subject: Reference, val basedOn: LitSeq[Reference], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val priority: Option[REQUEST_PRIORITY], val recorder: Option[Reference], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val encounter: Option[Reference], val requester: Option[Reference], val performer: Option[Reference], val insurance: LitSeq[Reference], val identifier: LitSeq[Identifier], val authoredOn: Option[FHIRDateTime], val reasonCode: LitSeq[CodeableConcept], val reported: Option[ReportedChoice], val statusReason: Option[CodeableConcept], val doNotPerform: Option[Boolean], val eventHistory: LitSeq[Reference], val implicitRules: Option[UriStr], val medication: MedicationChoice, val performerType: Option[CodeableConcept], val detectedIssue: LitSeq[Reference], val reasonReference: LitSeq[Reference], val instantiatesUri: LitSeq[UriStr], val groupIdentifier: Option[Identifier], val modifierExtension: LitSeq[Extension], val dosageInstruction: LitSeq[Dosage], val priorPrescription: Option[Reference], val courseOfTherapyType: Option[CodeableConcept], val supportingInformation: LitSeq[Reference], val instantiatesCanonical: LitSeq[Canonical], val substitution: Option[Substitution], val dispenseRequest: Option[DispenseRequest], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

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.

Subclass of hl7.model.DomainResource (A resource that includes narrative, extensions, and contained resources.)

Value parameters:
authoredOn
  • The date (and perhaps time) when the prescription was initially written or authored on.
basedOn
  • A plan or request that is fulfilled in whole or in part by this medication request.
category
  • Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).
contained
  • 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.
courseOfTherapyType
  • The description of the overall patte3rn of the administration of the medication to the patient.
detectedIssue
  • 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.
dispenseRequest
  • 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.
doNotPerform
  • If true indicates that the provider is asking for the medication request not to occur.
dosageInstruction
  • Indicates how the medication is to be used by the patient.
encounter
  • The Encounter during which this [x] was created or to which the creation of this record is tightly associated.
eventHistory
  • 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.
extension
  • 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.
groupIdentifier
  • 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.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • 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.
implicitRules
  • 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.
instantiatesCanonical
  • The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.
instantiatesUri
  • 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.
insurance
  • Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
intent
  • Whether the request is a proposal, plan, or an original order.
language
  • The base language in which the resource is written.
medication
  • 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.
meta
  • 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.
modifierExtension
  • 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 and/or the understanding of the containing element's descendants. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
note
  • Extra information about the prescription that could not be conveyed by the other attributes.
performer
  • The specified desired performer of the medication treatment (e.g. the performer of the medication administration).
performerType
  • Indicates the type of performer of the administration of the medication.
priorPrescription
  • A link to a resource representing an earlier order related order or prescription.
priority
  • Indicates how quickly the Medication Request should be addressed with respect to other requests.
reasonCode
  • The reason or the indication for ordering or not ordering the medication.
reasonReference
  • Condition or observation that supports why the medication was ordered.
recorder
  • The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
reported
  • 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.
requester
  • The individual, organization, or device that initiated the request and has responsibility for its activation.
status
  • A code specifying the current state of the order. Generally, this will be active or completed state.
statusReason
  • Captures the reason for the current state of the MedicationRequest.
subject
  • A link to a resource representing the person or set of individuals to whom the medication will be given.
substitution
  • 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.
supportingInformation
  • Include additional information (for example, patient height and weight) that supports the ordering of the medication.
text
  • 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.
Constructor:

Introduces the fields note, status, intent, subject, basedOn, category, priority, recorder, encounter, requester, performer, insurance, identifier, authoredOn, reasonCode, reported, statusReason, doNotPerform, eventHistory, medication, performerType, detectedIssue, reasonReference, instantiatesUri, groupIdentifier, dosageInstruction, priorPrescription, courseOfTherapyType, supportingInformation, instantiatesCanonical, substitution, dispenseRequest.

Companion:
object
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from:
FHIRObject
object ids
Inherited from:
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from:
FHIRObject

Value members

Inherited methods

final def >>[T](fn: T => T)(implicit tt: LTag[T]): MedicationRequest

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from:
FHIRObject
final def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[MedicationRequest]
Inherited from:
FHIRObject
final def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from:
FHIRObject
final def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from:
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from:
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from:
Utils
def constructor: Constructor[_]
Inherited from:
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from:
Utils
override def equals(obj: Any): Boolean
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from:
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from:
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from:
FHIRComponent
def getIdentifier: Option[String]
Inherited from:
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from:
Resource
def getVersionedIdentifier: Option[String]
Inherited from:
Resource
override def hashCode(): Int
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def modifyField[T : LTag, Up >: MedicationRequest <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def modifyFieldUnsafe[T, Up >: MedicationRequest <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
final def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from:
FHIRObject
final def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from:
FHIRObject
final def nodalMap[T](klass: Class[T], fn: T => T): MedicationRequest

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from:
FHIRObject
def setFromField[T, UpType >: MedicationRequest <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from:
FHIRObject
def thisClassName: String
Inherited from:
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from:
FHIRObject
override def toString: String
Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from:
FHIRObject
def updateFromField[T, UpType >: MedicationRequest <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): MedicationRequest
Inherited from:
FHIRObject
def withField[T : LTag, Up >: MedicationRequest <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: MedicationRequest <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: MedicationRequest <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): MedicationRequest
Inherited from:
FHIRObject

Concrete fields

val authoredOn: Option[FHIRDateTime]
val basedOn: LitSeq[Reference]
val category: LitSeq[CodeableConcept]
override val contained: LitSeq[Resource]
val courseOfTherapyType: Option[CodeableConcept]
val detectedIssue: LitSeq[Reference]
val doNotPerform: Option[Boolean]
val dosageInstruction: LitSeq[Dosage]
val encounter: Option[Reference]
val eventHistory: LitSeq[Reference]
override val extension: LitSeq[Extension]
val groupIdentifier: Option[Identifier]
override val id: Option[String]
val identifier: LitSeq[Identifier]
override val implicitRules: Option[UriStr]
val instantiatesCanonical: LitSeq[Canonical]
val instantiatesUri: LitSeq[UriStr]
val insurance: LitSeq[Reference]
override val language: Option[LANGUAGES]
override val meta: Option[Meta]
override val modifierExtension: LitSeq[Extension]
val note: LitSeq[Annotation]
val performer: Option[Reference]
val performerType: Option[CodeableConcept]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
val priorPrescription: Option[Reference]
val reasonCode: LitSeq[CodeableConcept]
val reasonReference: LitSeq[Reference]
val recorder: Option[Reference]
val requester: Option[Reference]
val statusReason: Option[CodeableConcept]
val subject: Reference
val supportingInformation: LitSeq[Reference]
override val text: Option[Narrative]
override val thisTypeName: String

Inherited fields

val companion: CompanionFor[MedicationRequest]
Inherited from:
FHIRObject