All files / src/fhir medicationprescription.coffee

76.19% Statements 32/42
100% Branches 2/2
2.7% Functions 1/37
75.61% Lines 31/41

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292                                                    37x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x             1x                                                                                                                                                                           1x                                                                                     1x                                       1x                                                                                                                                                                     1x  
 
# Copyright (c) 2014 The MITRE Corporation
# All rights reserved.
# 
# Redistribution and use in source and binary forms, with or without modification, 
# are permitted provided that the following conditions are met:
# 
#     * Redistributions of source code must retain the above copyright notice, this 
#       list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright notice, 
#       this list of conditions and the following disclaimer in the documentation 
#       and/or other materials provided with the distribution.
#     * Neither the name of HL7 nor the names of its contributors may be used to 
#       endorse or promote products derived from this software without specific 
#       prior written permission.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
# POSSIBILITY OF SUCH DAMAGE.
DT = require '../cql-datatypes'
CORE = require('./core')
Element = CORE.Element
Resource = CORE.Resource
Timing = CORE.Timing
Period = CORE.Period
Parameters = CORE.Parameters
Coding = CORE.Coding
Resource = CORE.Resource
Range = CORE.Range
Quantity = CORE.Quantity
Attachment = CORE.Attachment
BackboneElement = CORE.BackboneElement
DomainResource = CORE.DomainResource
ContactPoint = CORE.ContactPoint
ElementDefinition = CORE.ElementDefinition
Extension = CORE.Extension
HumanName = CORE.HumanName
Address = CORE.Address
Ratio = CORE.Ratio
SampledData = CORE.SampledData
Reference = CORE.Reference
CodeableConcept = CORE.CodeableConcept
Identifier = CORE.Identifier
Narrative = CORE.Narrative
Element = CORE.Element
 
###* 
Embedded class
@class MedicationPrescriptionDosageInstructionComponent
@exports  MedicationPrescriptionDosageInstructionComponent as MedicationPrescriptionDosageInstructionComponent
###
class MedicationPrescriptionDosageInstructionComponent extends BackboneElement
  constructor: (@json) ->
    super(@json)
  ###*
  Free text dosage instructions for cases where the instructions are too complex to code.
  @returns {Array} an array of {@link String} objects
  ###
  text:-> @json['text']
  
  ###*
  Additional instructions such as "Swallow with plenty of water" which may or may not be coded.
  @returns {CodeableConcept}
  ###
  additionalInstructions: -> if @json['additionalInstructions'] then new CodeableConcept(@json['additionalInstructions'])
  
  ###*
  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".
  @returns {Array} an array of {@link Date} objects
  ###
  scheduledDateTime:-> if @json['scheduledDateTime'] then DT.DateTime.parse(@json['scheduledDateTime'])
  ###*
  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".
  @returns {Period}
  ###
  scheduledPeriod: -> if @json['scheduledPeriod'] then new Period(@json['scheduledPeriod'])
  ###*
  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".
  @returns {Timing}
  ###
  scheduledTiming: -> if @json['scheduledTiming'] then new Timing(@json['scheduledTiming'])
  
  ###*
  If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose.  If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.
  @returns {Array} an array of {@link boolean} objects
  ###
  asNeededBoolean:-> @json['asNeededBoolean']
  ###*
  If set to true or if specified as a CodeableConcept, indicates that the medication is only taken when needed within the specified schedule rather than at every scheduled dose.  If a CodeableConcept is present, it indicates the pre-condition for taking the Medication.
  @returns {CodeableConcept}
  ###
  asNeededCodeableConcept: -> if @json['asNeededCodeableConcept'] then new CodeableConcept(@json['asNeededCodeableConcept'])
  
  ###*
  A coded specification of the anatomic site where the medication first enters the body.
  @returns {CodeableConcept}
  ###
  site: -> if @json['site'] then new CodeableConcept(@json['site'])
  
  ###*
  A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient.
  @returns {CodeableConcept}
  ###
  route: -> if @json['route'] then new CodeableConcept(@json['route'])
  
  ###*
  A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections.  Examples:  Slow Push; Deep IV.
 
Terminologies used often pre-coordinate this term with the route and or form of administration.
  @returns {CodeableConcept}
  ###
  method: -> if @json['method'] then new CodeableConcept(@json['method'])
  
  ###*
  The amount of therapeutic or other substance given at one administration event.
  @returns {Quantity}
  ###
  doseQuantity: -> if @json['doseQuantity'] then new Quantity(@json['doseQuantity'])
  
  ###*
  Identifies the speed with which the substance is introduced into the subject. Typically the rate for an infusion. 200ml in 2 hours.
  @returns {Ratio}
  ###
  rate: -> if @json['rate'] then new Ratio(@json['rate'])
  
  ###*
  The maximum total quantity of a therapeutic substance that may be administered to a subject over the period of time. E.g. 1000mg in 24 hours.
  @returns {Ratio}
  ###
  maxDosePerPeriod: -> if @json['maxDosePerPeriod'] then new Ratio(@json['maxDosePerPeriod'])
  
 
###* 
Embedded class
@class MedicationPrescriptionDispenseComponent
@exports  MedicationPrescriptionDispenseComponent as MedicationPrescriptionDispenseComponent
###
class MedicationPrescriptionDispenseComponent extends BackboneElement
  constructor: (@json) ->
    super(@json)
  ###*
  Identifies the medication that is to be dispensed.  This may be a more specifically defined than the medicationPrescription.medication . 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.
  @returns {Reference}
  ###
  medication: -> if @json['medication'] then new Reference(@json['medication'])
  
  ###*
  Design Comments: This indicates the validity period of a prescription (stale dating the Prescription) 
It reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Dispensing Window signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. 
Rationale: Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription.
  @returns {Period}
  ###
  validityPeriod: -> if @json['validityPeriod'] then new Period(@json['validityPeriod'])
  
  ###*
  An integer indicating the number of repeats of the Dispense. 
UsageNotes: For example, the number of times the prescribed quantity is to be supplied including the initial standard fill.
  @returns {Array} an array of {@link Number} objects
  ###
  numberOfRepeatsAllowed:-> @json['numberOfRepeatsAllowed']
  
  ###*
  The amount that is to be dispensed.
  @returns {Quantity}
  ###
  quantity: -> if @json['quantity'] then new Quantity(@json['quantity'])
  
  ###*
  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. 
In some situations, this attribute may be used instead of quantity to identify the amount supplied by how long it is expected to last, rather than the physical quantity issued, e.g. 90 days supply of medication (based on an ordered dosage) When possible, it is always better to specify quantity, as this tends to be more precise. expectedSupplyDuration will always be an estimate that can be influenced by external factors.
  @returns {Duration}
  ###
  expectedSupplyDuration: -> if @json['expectedSupplyDuration'] then new Duration(@json['expectedSupplyDuration'])
  
 
###* 
Embedded class
@class MedicationPrescriptionSubstitutionComponent
@exports  MedicationPrescriptionSubstitutionComponent as MedicationPrescriptionSubstitutionComponent
###
class MedicationPrescriptionSubstitutionComponent extends BackboneElement
  constructor: (@json) ->
    super(@json)
  ###*
  A code signifying whether a different drug should be dispensed from what was prescribed.
  @returns {CodeableConcept}
  ###
  type: -> if @json['type'] then new CodeableConcept(@json['type'])
  
  ###*
  Indicates the reason for the substitution, or why substitution must or must not be performed.
  @returns {CodeableConcept}
  ###
  reason: -> if @json['reason'] then new CodeableConcept(@json['reason'])
  
###*
An order for both supply of the medication and the instructions for administration of the medicine to a patient.
@class MedicationPrescription
@exports MedicationPrescription as MedicationPrescription
###
class MedicationPrescription extends DomainResource
  constructor: (@json) ->
    super(@json)
  ###*
  External identifier - one that would be used by another non-FHIR system - for example a re-imbursement system might issue its own id for each prescription that is created.  This is particularly important where FHIR only provides part of an erntire workflow process where records have to be tracked through an entire system.
  @returns {Array} an array of {@link Identifier} objects
  ###
  identifier: ->
    if @json['identifier']
      for item in @json['identifier']
        new Identifier(item)
  
  ###*
  The date (and perhaps time) when the prescription was written.
  @returns {Array} an array of {@link Date} objects
  ###
  dateWritten:-> if @json['dateWritten'] then DT.DateTime.parse(@json['dateWritten'])
  
  ###*
  A code specifying the state of the order.  Generally this will be active or completed state.
  @returns {Array} an array of {@link String} objects
  ###
  status:-> @json['status']
  
  ###*
  A link to a resource representing the person to whom the medication will be given.
  @returns {Reference}
  ###
  patient: -> if @json['patient'] then new Reference(@json['patient'])
  
  ###*
  The healthcare professional responsible for authorizing the prescription.
  @returns {Reference}
  ###
  prescriber: -> if @json['prescriber'] then new Reference(@json['prescriber'])
  
  ###*
  A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
  @returns {Reference}
  ###
  encounter: -> if @json['encounter'] then new Reference(@json['encounter'])
  
  ###*
  Can be the reason or the indication for writing the prescription.
  @returns {CodeableConcept}
  ###
  reasonCodeableConcept: -> if @json['reasonCodeableConcept'] then new CodeableConcept(@json['reasonCodeableConcept'])
  ###*
  Can be the reason or the indication for writing the prescription.
  @returns {Reference}
  ###
  reasonReference: -> if @json['reasonReference'] then new Reference(@json['reasonReference'])
  
  ###*
  Identifies the medication being 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.
  @returns {Reference}
  ###
  medication: -> if @json['medication'] then new Reference(@json['medication'])
  
  ###*
  Indicates how the medication is to be used by the patient.
  @returns {Array} an array of {@link MedicationPrescriptionDosageInstructionComponent} objects
  ###
  dosageInstruction: ->
    if @json['dosageInstruction']
      for item in @json['dosageInstruction']
        new MedicationPrescriptionDosageInstructionComponent(item)
  
  ###*
  Deals with details of the dispense part of the order.
  @returns {MedicationPrescriptionDispenseComponent}
  ###
  dispense: -> if @json['dispense'] then new MedicationPrescriptionDispenseComponent(@json['dispense'])
  
  ###*
  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, and in others it does not matter. This block explains the prescriber's intent. If nothing is specified substitution may be done.
  @returns {MedicationPrescriptionSubstitutionComponent}
  ###
  substitution: -> if @json['substitution'] then new MedicationPrescriptionSubstitutionComponent(@json['substitution'])
  
 
 
 
module.exports.MedicationPrescription = MedicationPrescription