Skip to main content

HS.FHIRModel.R4.PlanDefinition

class HS.FHIRModel.R4.PlanDefinition extends HS.FHIRModel.FHIRClassSuper

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

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_PLANDEFINITION;
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 _approvalDate as HS.FHIRModel.R4.Element;
Extensions for approvalDate
Property methods: _approvalDateGet(), _approvalDateGetSwizzled(), _approvalDateIsValid(), _approvalDateNewObject(), _approvalDateSet()
property _copyright as HS.FHIRModel.R4.Element;
Extensions for copyright
Property methods: _copyrightGet(), _copyrightGetSwizzled(), _copyrightIsValid(), _copyrightNewObject(), _copyrightSet()
property _date as HS.FHIRModel.R4.Element;
Extensions for date
Property methods: _dateGet(), _dateGetSwizzled(), _dateIsValid(), _dateNewObject(), _dateSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _experimental as HS.FHIRModel.R4.Element;
Extensions for experimental
Property methods: _experimentalGet(), _experimentalGetSwizzled(), _experimentalIsValid(), _experimentalNewObject(), _experimentalSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _lastReviewDate as HS.FHIRModel.R4.Element;
Extensions for lastReviewDate
Property methods: _lastReviewDateGet(), _lastReviewDateGetSwizzled(), _lastReviewDateIsValid(), _lastReviewDateNewObject(), _lastReviewDateSet()
property _name as HS.FHIRModel.R4.Element;
Extensions for name
Property methods: _nameGet(), _nameGetSwizzled(), _nameIsValid(), _nameNewObject(), _nameSet()
property _publisher as HS.FHIRModel.R4.Element;
Extensions for publisher
Property methods: _publisherGet(), _publisherGetSwizzled(), _publisherIsValid(), _publisherNewObject(), _publisherSet()
property _purpose as HS.FHIRModel.R4.Element;
Extensions for purpose
Property methods: _purposeGet(), _purposeGetSwizzled(), _purposeIsValid(), _purposeNewObject(), _purposeSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property _subtitle as HS.FHIRModel.R4.Element;
Extensions for subtitle
Property methods: _subtitleGet(), _subtitleGetSwizzled(), _subtitleIsValid(), _subtitleNewObject(), _subtitleSet()
property _title as HS.FHIRModel.R4.Element;
Extensions for title
Property methods: _titleGet(), _titleGetSwizzled(), _titleIsValid(), _titleNewObject(), _titleSet()
property _url as HS.FHIRModel.R4.Element;
Extensions for url
Property methods: _urlGet(), _urlGetSwizzled(), _urlIsValid(), _urlNewObject(), _urlSet()
property _usage as HS.FHIRModel.R4.Element;
Extensions for usage
Property methods: _usageGet(), _usageGetSwizzled(), _usageIsValid(), _usageNewObject(), _usageSet()
property _version as HS.FHIRModel.R4.Element;
Extensions for version
Property methods: _versionGet(), _versionGetSwizzled(), _versionIsValid(), _versionNewObject(), _versionSet()
An action or group of actions to be taken as part of the plan.
Property methods: actionGet(), actionGetSwizzled(), actionIsValid(), actionNewObject(), actionSet()
property approvalDate as %String;
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Property methods: approvalDateDisplayToLogical(), approvalDateGet(), approvalDateIsValid(), approvalDateLogicalToDisplay(), approvalDateLogicalToOdbc(), approvalDateNormalize(), approvalDateSet()
An individiual or organization primarily involved in the creation and maintenance of the content.
Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet()
property contact as HS.FHIRModel.R4.SeqOfContactDetail;
Contact details to assist a user in finding and communicating with the publisher.
Property methods: contactGet(), contactGetSwizzled(), contactIsValid(), contactNewObject(), contactSet()
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()
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.
Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
property date as %String;
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.
Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
property description as %String;
A free text natural language description of the plan definition from a consumer's perspective.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
An individual or organization primarily responsible for internal coherence of the content.
Property methods: editorGet(), editorGetSwizzled(), editorIsValid(), editorNewObject(), editorSet()
property effectivePeriod as HS.FHIRModel.R4.Period;
The period during which the plan definition content was or is planned to be in active use.
Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property endorser as HS.FHIRModel.R4.SeqOfContactDetail;
An individual or organization responsible for officially endorsing the content for use in some setting.
Property methods: endorserGet(), endorserGetSwizzled(), endorserIsValid(), endorserNewObject(), endorserSet()
property experimental as %Boolean;
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.
Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
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()
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.
Property methods: goalGet(), goalGetSwizzled(), goalIsValid(), goalNewObject(), goalSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
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.
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 jurisdiction as HS.FHIRModel.R4.SeqOfCodeableConcept;
A legal or geographic region in which the plan definition is intended to be used.
Property methods: jurisdictionGet(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionNewObject(), jurisdictionSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property lastReviewDate as %String;
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
Property methods: lastReviewDateDisplayToLogical(), lastReviewDateGet(), lastReviewDateIsValid(), lastReviewDateLogicalToDisplay(), lastReviewDateLogicalToOdbc(), lastReviewDateNormalize(), lastReviewDateSet()
property library as HS.FHIRModel.R4.SeqOfString;
A reference to a Library resource containing any formal logic used by the plan definition.
Property methods: libraryGet(), libraryGetSwizzled(), libraryIsValid(), libraryNewObject(), librarySet()
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()
property name as %String;
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.
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
property publisher as %String;
The name of the organization or individual that published the plan definition.
Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
property purpose as %String;
Explanation of why this plan definition is needed and why it has been designed as it has.
Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
property relatedArtifact as HS.FHIRModel.R4.SeqOfRelatedArtifact;
Related artifacts such as additional documentation, justification, or bibliographic references.
Property methods: relatedArtifactGet(), relatedArtifactGetSwizzled(), relatedArtifactIsValid(), relatedArtifactNewObject(), relatedArtifactSet()
property resourceType as %String [ InitialExpression = "PlanDefinition" , Required ];
This is a PlanDefinition resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property reviewer as HS.FHIRModel.R4.SeqOfContactDetail;
An individual or organization primarily responsible for review of some aspect of the content.
Property methods: reviewerGet(), reviewerGetSwizzled(), reviewerIsValid(), reviewerNewObject(), reviewerSet()
property status as %String (VALUELIST = ",draft,active,retired,unknown");
The status of this plan definition. Enables tracking the life-cycle of the content.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subjectCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
A code or group definition that describes the intended subject of the plan definition.
Property methods: subjectCodeableConceptGet(), subjectCodeableConceptGetSwizzled(), subjectCodeableConceptIsValid(), subjectCodeableConceptNewObject(), subjectCodeableConceptSet()
property subjectReference as HS.FHIRModel.R4.Reference;
A code or group definition that describes the intended subject of the plan definition.
Property methods: subjectReferenceGet(), subjectReferenceGetSwizzled(), subjectReferenceIsValid(), subjectReferenceNewObject(), subjectReferenceSet()
property subtitle as %String;
An explanatory or alternate title for the plan definition giving additional information about its content.
Property methods: subtitleDisplayToLogical(), subtitleGet(), subtitleIsValid(), subtitleLogicalToDisplay(), subtitleLogicalToOdbc(), subtitleNormalize(), subtitleSet()
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;
A short, descriptive, user-friendly title for the plan definition.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
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.
Property methods: topicGet(), topicGetSwizzled(), topicIsValid(), topicNewObject(), topicSet()
A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property url as %String;
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.
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
property usage as %String;
A detailed description of how the plan definition is used from a clinical perspective.
Property methods: usageDisplayToLogical(), usageGet(), usageIsValid(), usageLogicalToDisplay(), usageLogicalToOdbc(), usageNormalize(), usageSet()
property useContext as HS.FHIRModel.R4.SeqOfUsageContext;
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.
Property methods: useContextGet(), useContextGetSwizzled(), useContextIsValid(), useContextNewObject(), useContextSet()
property version as %String;
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.
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Methods

method IncludeAction()
method IncludeAuthor()
method IncludeContact()
method IncludeContained()
method IncludeEditor()
method IncludeEffectivePeriod()
method IncludeEndorser()
method IncludeExtension()
method IncludeGoal()
method IncludeIdentifier()
method IncludeJurisdiction()
method IncludeLibrary()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeRelatedArtifact()
method IncludeReviewer()
method IncludeSubjectCodeableConcept()
method IncludeSubjectReference()
method IncludeText()
method IncludeTopic()
method IncludeType()
method IncludeUseContext()
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