au.gov.nehta.model.cda.common.time

Class TimeQuantity

java.lang.Object

au.gov.nehta.model.clinical.common.types.Quantity

au.gov.nehta.model.clinical.common.types.RealQuantity

au.gov.nehta.model.cda.common.time.TimeQuantity

public class TimeQuantity
extends RealQuantity

A class to model time widths as in IVL_TS elements.

Author:

NeHTA

Field Summary

Fields inherited from class au.gov.nehta.model.clinical.common.types.Quantity

unit, value

Constructor Summary

Constructors

Constructor and Description
TimeQuantity(double value, TimeUnitOfMeasure unit) Create a width for the measurement of time.

Method Summary

Modifier and Type	Method and Description
String	getNarrative()
void	setNarrative(String narrativeOverride)

Methods inherited from class au.gov.nehta.model.clinical.common.types.RealQuantity

format

Methods inherited from class au.gov.nehta.model.clinical.common.types.Quantity

getUnit, getValue, setUnit, setValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeQuantity

public TimeQuantity(double value,
                    TimeUnitOfMeasure unit)

Create a width for the measurement of time.

example:

   Width width = new Width(2, TimeUnitOfMeasure.Week);
 

will generate the CDA model of the IVL_TS element

 
   

  <effectiveTime>
    <width unit='wk' value='2' / >...
  

indicating a 2 week interval

Parameters:

unit - a unit of time, eg weeks

value - the amount of time int the width eg 2 weeks

Method Detail

getNarrative

public String getNarrative()

Returns:

a string to use for the narrative, if any

setNarrative

public void setNarrative(String narrativeOverride)

Parameters:

narrativeOverride - a string to use for the narrative text for this time