State.CarePlanStart (synthea API)

java.lang.Object
- org.mitre.synthea.engine.State
- - org.mitre.synthea.engine.State.CarePlanStart

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Enclosing class:

State
```
public static class State.CarePlanStart
extends State
```
The CarePlanStart state type indicates a point in the module where a care plan should be prescribed. CarePlanStart states may only be processed during an Encounter, and so must occur after the target Encounter state and before the EncounterEnd. See the Encounter section above for more details. One or more codes describes the care plan and a list of activities describes what the care plan entails.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.mitre.synthea.engine.State
  State.AllergyEnd, State.AllergyOnset, State.CallSubmodule, State.CarePlanEnd, State.CarePlanStart, State.ConditionEnd, State.ConditionOnset, State.Counter, State.Death, State.Delay, State.Delayable, State.Device, State.DeviceEnd, State.DiagnosticReport, State.Encounter, State.EncounterEnd, State.Guard, State.ImagingStudy, State.Initial, State.LegacyStateWithUnitlessRV, State.MedicationEnd, State.MedicationOrder, State.MultiObservation, State.Observation, State.Physiology, State.Procedure, State.SetAttribute, State.Simple, State.SupplyList, State.Symptom, State.TelemedicinePossibility, State.Terminal, State.Vaccine, State.VitalSign

Field Summary
- Fields inherited from class org.mitre.synthea.engine.State
  ENABLE_PHYSIOLOGY_STATE, entered, entry, exited, module, name, remarks

Constructor Summary

Constructors
Constructor Description

CarePlanStart()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`State.CarePlanStart`	`clone()`	clone() should copy all the necessary variables of this State so that it can be correctly executed and modified without altering the original copy.
`boolean`	`process(Person person, long time)`	Process this State with the given Person at the specified time within the simulation.

Methods inherited from class org.mitre.synthea.engine.State
build, getTransition, initialize, run, toString, transition

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CarePlanStart
```
public CarePlanStart()
```
- Method Detail
  - clone
```
public State.CarePlanStart clone()
```
    Description copied from class: State
    
    clone() should copy all the necessary variables of this State so that it can be correctly executed and modified without altering the original copy. So for example, 'entered' and 'exited' times should not be copied so the clone can be cleanly executed. Implementation note: the base Object.clone() copies over all fields automatically (as a shallow copy), so we don't need to do that ourselves. Instead, we should 1. explicitly null out any fields that should not be copied, such as entered/exited 2. deep copy mutable reference types, if necessary.
    
    Overrides:
    
    clone in class State
  - process
```
public boolean process(Person person,
                       long time)
```
    Description copied from class: State
    
    Process this State with the given Person at the specified time within the simulation. If this State generates a HealthRecord.Entry during processing, then the resulting data will reside in the State.entry field.
    
    Specified by:
    
    process in class State
    
    Parameters:
    
    person - : the person being simulated
    
    time - : the date within the simulated world
    
    Returns:
    
    `true` if processing should continue to the next state, `false` if the processing should halt for this time step.