hl7/com.babylonhealth.lit.hl7.model/PlanDefinition

PlanDefinition

@POJOBoilerplate
class PlanDefinition(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], `type`: Option[CodeableConcept], val date: Option[FHIRDateTime], val title: Option[String], val usage: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val library: LitSeq[Canonical], val language: Option[LANGUAGES], val subtitle: Option[String], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val identifier: LitSeq[Identifier], val subject: Option[SubjectChoice], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val modifierExtension: LitSeq[Extension], val goal: LitSeq[Goal], val action: LitSeq[Action], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends DomainResource

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.

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

Value parameters:
`type`
  • A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
action
  • An action or group of actions to be taken as part of the plan.
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
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.
copyright
  • A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
date
  • The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.
description
  • A free text natural language description of the plan definition from a consumer's perspective.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the plan definition content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
experimental
  • A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
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
  • Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
  • A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
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.
jurisdiction
  • A legal or geographic region in which the plan definition is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
library
  • A reference to a Library resource containing any formal logic used by the plan definition.
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).
name
  • A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
publisher
  • The name of the organization or individual that published the plan definition.
purpose
  • Explanation of why this plan definition is needed and why it has been designed as it has.
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
status
  • The status of this plan definition. Enables tracking the life-cycle of the content.
subject
  • A code or group definition that describes the intended subject of the plan definition.
subtitle
  • An explanatory or alternate title for the plan definition giving additional information about its content.
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
  • A short, descriptive, user-friendly title for the plan definition.
topic
  • Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.
url
  • An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.
usage
  • A detailed description of how the plan definition is used from a clinical perspective.
useContext
  • The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances.
version
  • The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
Constructor:

Introduces the fields url, name, type, date, title, usage, topic, status, author, editor, version, contact, purpose, library, subtitle, reviewer, endorser, publisher, copyright, identifier, subject, useContext, description, experimental, jurisdiction, approvalDate, lastReviewDate, effectivePeriod, relatedArtifact, goal, action.

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]): PlanDefinition

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[PlanDefinition]
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 >: PlanDefinition <: 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 >: PlanDefinition <: 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): PlanDefinition

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 >: PlanDefinition <: 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 >: PlanDefinition <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from:
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): PlanDefinition
Inherited from:
FHIRObject
def withField[T : LTag, Up >: PlanDefinition <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFieldUnsafe[T, Up >: PlanDefinition <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withFields[Up >: PlanDefinition <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from:
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): PlanDefinition
Inherited from:
FHIRObject

Concrete fields

val `type`: Option[CodeableConcept]
val action: LitSeq[Action]
val approvalDate: Option[FHIRDate]
val author: LitSeq[ContactDetail]
val contact: LitSeq[ContactDetail]
override val contained: LitSeq[Resource]
val date: Option[FHIRDateTime]
val description: Option[Markdown]
val editor: LitSeq[ContactDetail]
val effectivePeriod: Option[Period]
val endorser: LitSeq[ContactDetail]
val experimental: Option[Boolean]
override val extension: LitSeq[Extension]
val goal: LitSeq[Goal]
override val id: Option[String]
val identifier: LitSeq[Identifier]
override val implicitRules: Option[UriStr]
val jurisdiction: LitSeq[CodeableConcept]
override val language: Option[LANGUAGES]
val lastReviewDate: Option[FHIRDate]
val library: LitSeq[Canonical]
override val meta: Option[Meta]
override val modifierExtension: LitSeq[Extension]
val name: Option[String]
override val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
val publisher: Option[String]
val purpose: Option[Markdown]
val relatedArtifact: LitSeq[RelatedArtifact]
val reviewer: LitSeq[ContactDetail]
val subject: Option[SubjectChoice]
val subtitle: Option[String]
override val text: Option[Narrative]
override val thisTypeName: String
val title: Option[String]
val topic: LitSeq[CodeableConcept]
val url: Option[UriStr]
val usage: Option[String]
val useContext: LitSeq[UsageContext]
val version: Option[String]

Inherited fields

val companion: CompanionFor[PlanDefinition]
Inherited from:
FHIRObject