The definition of a plan for a series of actions,
independent of any specific patient or context.
Copy link to this section Properties
BackboneElement
Action defined by the plan.
Property methods: actionBuildValueArray(), actionCollectionToDisplay(), actionCollectionToOdbc(), actionDisplayToCollection(), actionGet(), actionGetObject(), actionGetObjectId(), actionGetSwizzled(), actionIsValid(), actionOdbcToCollection(), actionSet(), actionSetObject(), actionSetObjectId()
Copy link to this section
property approvalDate as %String (MAXLEN = 1000000, XMLNAME = "approvalDate", XMLPROJECTION = "ATTRIBUTE");
date
When the plan definition was approved by publisher.
Property methods: approvalDateDisplayToLogical(), approvalDateGet(), approvalDateIsValid(), approvalDateLogicalToDisplay(), approvalDateLogicalToOdbc(), approvalDateNormalize(), approvalDateSet()
ContactDetail
Who authored the content.
Property methods: authorBuildValueArray(), authorCollectionToDisplay(), authorCollectionToOdbc(), authorDisplayToCollection(), authorGet(), authorGetObject(), authorGetObjectId(), authorGetSwizzled(), authorIsValid(), authorOdbcToCollection(), authorSet(), authorSetObject(), authorSetObjectId()
ContactDetail
Contact details for the publisher.
Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()
Copy link to this section
property copyright as %String (MAXLEN = 1000000, XMLNAME = "copyright", XMLPROJECTION = "ATTRIBUTE");
markdown
Use and/or publishing restrictions.
Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()
Copy link to this section
property date as %String (MAXLEN = 1000000, XMLNAME = "date", XMLPROJECTION = "ATTRIBUTE");
dateTime
Date last changed.
Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()
Copy link to this section
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
markdown
Natural language description of the plan definition.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
ContactDetail
Who edited the content.
Property methods: editorBuildValueArray(), editorCollectionToDisplay(), editorCollectionToOdbc(), editorDisplayToCollection(), editorGet(), editorGetObject(), editorGetObjectId(), editorGetSwizzled(), editorIsValid(), editorOdbcToCollection(), editorSet(), editorSetObject(), editorSetObjectId()
Period
When the plan definition is expected to be used.
Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
ContactDetail
Who endorsed the content.
Property methods: endorserBuildValueArray(), endorserCollectionToDisplay(), endorserCollectionToOdbc(), endorserDisplayToCollection(), endorserGet(), endorserGetObject(), endorserGetObjectId(), endorserGetSwizzled(), endorserIsValid(), endorserOdbcToCollection(), endorserSet(), endorserSetObject(), endorserSetObjectId()
Copy link to this section
property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");
boolean
For testing purposes,
not real usage.
Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()
BackboneElement
What the plan is trying to accomplish.
Property methods: goalBuildValueArray(), goalCollectionToDisplay(), goalCollectionToOdbc(), goalDisplayToCollection(), goalGet(), goalGetObject(), goalGetObjectId(), goalGetSwizzled(), goalIsValid(), goalOdbcToCollection(), goalSet(), goalSetObject(), goalSetObjectId()
Identifier
Additional identifier for the plan definition.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
CodeableConcept
Intended jurisdiction for plan definition (if applicable)
jurisdiction is the REQUIRED FHIR4 ValueSet for codes,
but if you need to express meanings not found in jurisdiction,
you may formally EXTEND jurisdiction to add codes to it.
Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()
Copy link to this section
property lastReviewDate as %String (MAXLEN = 1000000, XMLNAME = "lastReviewDate", XMLPROJECTION = "ATTRIBUTE");
date
When the plan definition was last reviewed.
Property methods: lastReviewDateDisplayToLogical(), lastReviewDateGet(), lastReviewDateIsValid(), lastReviewDateLogicalToDisplay(), lastReviewDateLogicalToOdbc(), lastReviewDateNormalize(), lastReviewDateSet()
Copy link to this section
property library as list of %String (MAXLEN = 1000000, XMLNAME = "library", XMLPROJECTION = "ELEMENT");
canonical
Logic used by the plan definition.
TO DO: Unrecognized value type for the FHIR4 model
Property methods: libraryBuildValueArray(), libraryCollectionToDisplay(), libraryCollectionToOdbc(), libraryDisplayToCollection(), libraryDisplayToLogical(), libraryGet(), libraryGetObject(), libraryGetObjectId(), libraryGetSwizzled(), libraryIsValid(), libraryLogicalToDisplay(), libraryLogicalToOdbc(), libraryNormalize(), libraryOdbcToCollection(), librarySet(), librarySetObject(), librarySetObjectId()
Copy link to this section
property name as %String (MAXLEN = 1000000, XMLNAME = "name", XMLPROJECTION = "ATTRIBUTE");
string
Name for this plan definition (computer friendly)
Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()
Copy link to this section
property publisher as %String (MAXLEN = 1000000, XMLNAME = "publisher", XMLPROJECTION = "ATTRIBUTE");
string
Name of the publisher (organization or individual)
Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()
Copy link to this section
property purpose as %String (MAXLEN = 1000000, XMLNAME = "purpose", XMLPROJECTION = "ATTRIBUTE");
markdown
Why this plan definition is defined.
Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()
RelatedArtifact
Additional documentation,
citations.
Property methods: relatedArtifactBuildValueArray(), relatedArtifactCollectionToDisplay(), relatedArtifactCollectionToOdbc(), relatedArtifactDisplayToCollection(), relatedArtifactGet(), relatedArtifactGetObject(), relatedArtifactGetObjectId(), relatedArtifactGetSwizzled(), relatedArtifactIsValid(), relatedArtifactOdbcToCollection(), relatedArtifactSet(), relatedArtifactSetObject(), relatedArtifactSetObjectId()
ContactDetail
Who reviewed the content.
Property methods: reviewerBuildValueArray(), reviewerCollectionToDisplay(), reviewerCollectionToOdbc(), reviewerDisplayToCollection(), reviewerGet(), reviewerGetObject(), reviewerGetObjectId(), reviewerGetSwizzled(), reviewerIsValid(), reviewerOdbcToCollection(), reviewerSet(), reviewerSetObject(), reviewerSetObjectId()
Copy link to this section
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code
draft | active | retired | unknown
publication-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes;
you may NOT extend publication-status|4.0.1 and you may NOT use codes from other ValueSets.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
CodeableConcept
Type of individual the plan definition is focused on.
subject-type is the REQUIRED FHIR4 ValueSet for codes,
but if you need to express meanings not found in subject-type,
you may formally EXTEND subject-type to add codes to it.
Property methods: subjectCodeableConceptGet(), subjectCodeableConceptGetSwizzled(), subjectCodeableConceptIsValid(), subjectCodeableConceptNewObject(), subjectCodeableConceptSet()
Reference
Type of individual the plan definition is focused on.
Group.
Property methods: subjectReferenceGet(), subjectReferenceGetSwizzled(), subjectReferenceIsValid(), subjectReferenceNewObject(), subjectReferenceSet()
Copy link to this section
property subtitle as %String (MAXLEN = 1000000, XMLNAME = "subtitle", XMLPROJECTION = "ATTRIBUTE");
string
Subordinate title of the plan definition.
Property methods: subtitleDisplayToLogical(), subtitleGet(), subtitleIsValid(), subtitleLogicalToDisplay(), subtitleLogicalToOdbc(), subtitleNormalize(), subtitleSet()
Copy link to this section
property title as %String (MAXLEN = 1000000, XMLNAME = "title", XMLPROJECTION = "ATTRIBUTE");
string
Name for this plan definition (human friendly)
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
CodeableConcept
E.g.
Education,
Treatment,
Assessment.
any FHIR4 code may be used;
definition-topic shows EXAMPLE codes,
but you may use codes from any ValueSet.
Property methods: topicBuildValueArray(), topicCollectionToDisplay(), topicCollectionToOdbc(), topicDisplayToCollection(), topicGet(), topicGetObject(), topicGetObjectId(), topicGetSwizzled(), topicIsValid(), topicOdbcToCollection(), topicSet(), topicSetObject(), topicSetObjectId()
CodeableConcept
order-set | clinical-protocol | eca-rule | workflow-definition
plan-definition-type is the REQUIRED FHIR4 ValueSet for codes,
but if you need to express meanings not found in plan-definition-type,
you may formally EXTEND plan-definition-type to add codes to it.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
Copy link to this section
property url as %String (MAXLEN = 1000000, XMLNAME = "url", XMLPROJECTION = "ATTRIBUTE");
uri
Canonical identifier for this plan definition,
represented as a URI (globally unique)
Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()
Copy link to this section
property usage as %String (MAXLEN = 1000000, XMLNAME = "usage", XMLPROJECTION = "ATTRIBUTE");
string
Describes the clinical usage of the plan.
Property methods: usageDisplayToLogical(), usageGet(), usageIsValid(), usageLogicalToDisplay(), usageLogicalToOdbc(), usageNormalize(), usageSet()
Copy link to this section
property useContext as list of HS.FHIR.DTL.vR4.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");
UsageContext
The context that the content is intended to support.
Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()
Copy link to this section
property version as %String (MAXLEN = 1000000, XMLNAME = "version", XMLPROJECTION = "ATTRIBUTE");
string
Business version of the plan definition.
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()