ukcore/com.babylonhealth.lit.ukcore.model/UKCore_CarePlan

UKCore_CarePlan

class UKCore_CarePlan(val id: Option[String], val meta: Option[Meta], val text: Option[Narrative], val title: Option[String], val status: REQUEST_STATUS, val intent: CARE_PLAN_INTENT, val period: Option[Period], val created: Option[FHIRDateTime], val language: Option[LANGUAGES], val category: LitSeq[CodeableConcept], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val description: Option[String], val implicitRules: Option[UriStr], val note: LitSeq[Annotation], val instantiatesUri: LitSeq[UriStr], val modifierExtension: LitSeq[Extension], val identifier: LitSeq[Identifier], val instantiatesCanonical: LitSeq[Canonical], val goal: LitSeq[Reference], val partOf: LitSeq[Reference], val author: Option[Reference], val basedOn: LitSeq[Reference], val subject: Reference, val replaces: LitSeq[Reference], val careTeam: LitSeq[Reference], val encounter: Option[Reference], val addresses: LitSeq[Reference], val contributor: LitSeq[Reference], val supportingInfo: LitSeq[Reference], val activity: LitSeq[Activity], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends CarePlan

Defines the UK Core constraints and extensions on the CarePlan resource for the minimal set of data to query and retrieve a patient’s Care Plan.

Subclass of hl7.model.CarePlan (Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.)

Value parameters:
activity

- Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

addresses

- Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

author

- When populated, the author is responsible for the care plan. The care plan is attributed to the author.

basedOn

- A care plan that is fulfilled in whole or in part by this care plan.

careTeam

- Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

category

- Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.

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.

contributor

- Identifies the individual(s) or organization who provided the contents of the care plan.

created

- Represents when this particular CarePlan record was created in the system, which is often a system-generated date.

description

- A description of the scope and nature of the plan.

encounter

- The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.

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.

goal

- Describes the intended objective(s) of carrying out the care plan.

id

- The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

identifier

- Business identifiers assigned to this care plan by the performer or other systems which 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 FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

instantiatesUri

- The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

intent

- Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

language

- The base language in which the resource is written.

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

- General notes about the care plan not covered elsewhere.

partOf

- A larger care plan of which this particular care plan is a component or step.

period

- Indicates when the plan did (or is intended to) come into effect and end.

replaces

- Completed or terminated care plan whose function is taken by this new care plan.

status

- Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

subject

- Identifies the patient or group whose intended care is described by the plan.

supportingInfo

- Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.

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.

title

- Human-friendly name for the care plan.

Constructor:

Inherits all params from parent.

Companion:
object
class CarePlan
class DomainResource
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]): FHIRObject.this.type

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[FHIRObject]
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

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters:
that

the object to compare against this object for equality.

Returns:

true if the receiver object is equivalent to the argument; false otherwise.

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

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Returns:

the hash code value for this object.

Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def modifyField[T : LTag, Up >: UKCore_CarePlan <: 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 >: UKCore_CarePlan <: 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): FHIRObject.this.type

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 >: UKCore_CarePlan <: 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

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Returns:

a string representation of the object.

Definition Classes
FHIRObject -> Any
Inherited from:
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from:
FHIRObject
def updateFromField[T, UpType >: UKCore_CarePlan <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): FHIRObject.this.type
Inherited from:
FHIRObject
def withField[T : LTag, Up >: UKCore_CarePlan <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: UKCore_CarePlan <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: UKCore_CarePlan <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): FHIRObject.this.type
Inherited from:
FHIRObject

Concrete fields

override val activity: LitSeq[Activity]
override val addresses: LitSeq[Reference]
override val author: Option[Reference]
override val basedOn: LitSeq[Reference]
override val careTeam: LitSeq[Reference]
override val category: LitSeq[CodeableConcept]
override val contained: LitSeq[Resource]
override val contributor: LitSeq[Reference]
override val created: Option[FHIRDateTime]
override val description: Option[String]
override val encounter: Option[Reference]
override val extension: LitSeq[Extension]
override val goal: LitSeq[Reference]
override val id: Option[String]
override val identifier: LitSeq[Identifier]
override val implicitRules: Option[UriStr]
override val instantiatesCanonical: LitSeq[Canonical]
override val instantiatesUri: LitSeq[UriStr]
override val intent: CARE_PLAN_INTENT
override val language: Option[LANGUAGES]
override val meta: Option[Meta]
override val modifierExtension: LitSeq[Extension]
override val note: LitSeq[Annotation]
override val partOf: LitSeq[Reference]
override val period: Option[Period]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
override val replaces: LitSeq[Reference]
override val status: REQUEST_STATUS
override val subject: Reference
override val supportingInfo: LitSeq[Reference]
override val text: Option[Narrative]
override val thisTypeName: String
override val title: Option[String]

Inherited fields

val companion: CompanionFor[UKCore_CarePlan]
Inherited from:
FHIRObject