Skip to main content

HS.FHIRModel.R4.CarePlan

class HS.FHIRModel.R4.CarePlan extends HS.FHIRModel.FHIRClassSuper

*****************************************
** CarePlan generated class schema
*****************************************
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.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_CAREPLAN;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _created as HS.FHIRModel.R4.Element;
Extensions for created
Property methods: _createdGet(), _createdGetSwizzled(), _createdIsValid(), _createdNewObject(), _createdSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _instantiatesUri as HS.FHIRModel.R4.SeqOfElement;
Extensions for instantiatesUri
Property methods: _instantiatesUriGet(), _instantiatesUriGetSwizzled(), _instantiatesUriIsValid(), _instantiatesUriNewObject(), _instantiatesUriSet()
property _intent as HS.FHIRModel.R4.Element;
Extensions for intent
Property methods: _intentGet(), _intentGetSwizzled(), _intentIsValid(), _intentNewObject(), _intentSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _title as HS.FHIRModel.R4.Element;
Extensions for title
Property methods: _titleGet(), _titleGetSwizzled(), _titleIsValid(), _titleNewObject(), _titleSet()
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.
Property methods: activityGet(), activityGetSwizzled(), activityIsValid(), activityNewObject(), activitySet()
property addresses as HS.FHIRModel.R4.SeqOfReference;
Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
Property methods: addressesGet(), addressesGetSwizzled(), addressesIsValid(), addressesNewObject(), addressesSet()
property author as HS.FHIRModel.R4.Reference;
When populated, the author is responsible for the care plan. The care plan is attributed to the author.
Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
A care plan that is fulfilled in whole or in part by this care plan.
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property careTeam as HS.FHIRModel.R4.SeqOfReference;
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.
Property methods: careTeamGet(), careTeamGetSwizzled(), careTeamIsValid(), careTeamNewObject(), careTeamSet()
property category as HS.FHIRModel.R4.SeqOfCodeableConcept;
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.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property contributor as HS.FHIRModel.R4.SeqOfReference;
Identifies the individual(s) or organization who provided the contents of the care plan.
Property methods: contributorGet(), contributorGetSwizzled(), contributorIsValid(), contributorNewObject(), contributorSet()
property created as %String;
Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
Property methods: createdDisplayToLogical(), createdGet(), createdIsValid(), createdLogicalToDisplay(), createdLogicalToOdbc(), createdNormalize(), createdSet()
property description as %String;
A description of the scope and nature of the plan.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property encounter as HS.FHIRModel.R4.Reference;
The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property goal as HS.FHIRModel.R4.SeqOfReference;
Describes the intended objective(s) of carrying out the care plan.
Property methods: goalGet(), goalGetSwizzled(), goalIsValid(), goalNewObject(), goalSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
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.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property instantiatesCanonical as HS.FHIRModel.R4.SeqOfString;
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.
Property methods: instantiatesCanonicalGet(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalNewObject(), instantiatesCanonicalSet()
property instantiatesUri as HS.FHIRModel.R4.SeqOfString;
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.
Property methods: instantiatesUriGet(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriNewObject(), instantiatesUriSet()
property intent as %String;
Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
General notes about the care plan not covered elsewhere.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property partOf as HS.FHIRModel.R4.SeqOfReference;
A larger care plan of which this particular care plan is a component or step.
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
property period as HS.FHIRModel.R4.Period;
Indicates when the plan did (or is intended to) come into effect and end.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property replaces as HS.FHIRModel.R4.SeqOfReference;
Completed or terminated care plan whose function is taken by this new care plan.
Property methods: replacesGet(), replacesGetSwizzled(), replacesIsValid(), replacesNewObject(), replacesSet()
property resourceType as %String [ InitialExpression = "CarePlan" , Required ];
This is a CarePlan resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String;
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIRModel.R4.Reference [ Required ];
Identifies the patient or group whose intended care is described by the plan.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property supportingInfo as HS.FHIRModel.R4.SeqOfReference;
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.
Property methods: supportingInfoGet(), supportingInfoGetSwizzled(), supportingInfoIsValid(), supportingInfoNewObject(), supportingInfoSet()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property title as %String;
Human-friendly name for the care plan.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()

Methods

method IncludeActivity()
method IncludeAddresses()
method IncludeAuthor()
method IncludeBasedOn()
method IncludeCareTeam()
method IncludeCategory()
method IncludeContained()
method IncludeContributor()
method IncludeEncounter()
method IncludeExtension()
method IncludeGoal()
method IncludeIdentifier()
method IncludeInstantiatesCanonical()
method IncludeInstantiatesUri()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludePartOf()
method IncludePeriod()
method IncludeReplaces()
method IncludeSubject()
method IncludeSupportingInfo()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab