Private OptionalurlPlanDefinition.url Element
FHIR Specification
uriPrivate OptionalidentifierPlanDefinition.identifier Element
FHIR Specification
IdentifierPrivate OptionalversionPlanDefinition.version Element
FHIR Specification
stringPrivate OptionalnamePlanDefinition.name Element
FHIR Specification
stringPrivate OptionaltitlePlanDefinition.title Element
FHIR Specification
stringPrivate OptionalsubtitlePlanDefinition.subtitle Element
Private Optionaltype_PlanDefinition.type Element
FHIR Specification
CodeableConceptPrivate ReadonlypublicationFHIR CodeSystem: PublicationStatus
PrivatestatusPlanDefinition.status Element
FHIR Specification
codeCodeSystem Enumeration: PublicationStatusEnum
Private OptionalexperimentalPlanDefinition.experimental Element
FHIR Specification
booleanPrivate OptionalsubjectPlanDefinition.subject[x] Element
@ChoiceDataTypesMeta('PlanDefinition.subject[x]', ['CodeableConcept','Reference','canonical',]
FHIR Specification
Private OptionaldatePlanDefinition.date Element
FHIR Specification
dateTimePrivate OptionalpublisherPlanDefinition.publisher Element
FHIR Specification
stringPrivate OptionalcontactPlanDefinition.contact Element
FHIR Specification
ContactDetailPrivate OptionaldescriptionPlanDefinition.description Element
FHIR Specification
markdownPrivate OptionalusePlanDefinition.useContext Element
FHIR Specification
UsageContextPrivate OptionaljurisdictionPlanDefinition.jurisdiction Element
FHIR Specification
CodeableConceptPrivate OptionalpurposePlanDefinition.purpose Element
FHIR Specification
markdownPrivate OptionalusagePlanDefinition.usage Element
Private OptionalcopyrightPlanDefinition.copyright Element
FHIR Specification
markdownPrivate OptionalapprovalPlanDefinition.approvalDate Element
FHIR Specification
datePrivate OptionallastPlanDefinition.lastReviewDate Element
FHIR Specification
datePrivate OptionaleffectivePlanDefinition.effectivePeriod Element
FHIR Specification
PeriodPrivate OptionaltopicPlanDefinition.topic Element
FHIR Specification
CodeableConceptPrivate OptionalauthorPlanDefinition.author Element
Private OptionaleditorPlanDefinition.editor Element
Private OptionalreviewerPlanDefinition.reviewer Element
Private OptionalendorserPlanDefinition.endorser Element
Private OptionalrelatedPlanDefinition.relatedArtifact Element
FHIR Specification
RelatedArtifactPrivate OptionallibraryPlanDefinition.library Element
FHIR Specification
canonical
Private OptionalgoalPlanDefinition.goal Element
FHIR Specification
BackboneElementPrivate OptionalactionPlanDefinition.action Element
FHIR Specification
BackboneElementStaticparseParse the provided PlanDefinition JSON to instantiate the PlanDefinition data model.
JSON representing FHIR PlanDefinition
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to PlanDefinition
PlanDefinition data model or undefined for PlanDefinition
JsonError if the provided JSON is not a valid JSON object
the url property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the url property.
the url value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the url property value as a fhirUri if defined; else undefined
Assigns the provided primitive value to the url property.
the url value
this
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the version property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the version property.
the version value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the version property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the version property.
the version value
this
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the name property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the name property.
the name value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the name property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the name property.
the name value
this
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the title property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the title property.
the title value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the title property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the title property.
the title value
this
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the subtitle property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the subtitle property.
the subtitle value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the subtitle property exists and has a value; false otherwise
the subtitle property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the subtitle property.
the subtitle value
this
PrimitiveTypeError for invalid primitive types
true if the subtitle property exists and has a value; false otherwise
the type_ property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Type object value to the type_ property.
the type_ object value
this
InvalidTypeError for invalid data types
true if the type_ property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the experimental property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the experimental property.
the experimental value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the experimental property exists and has a value; false otherwise
the experimental property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the experimental property.
the experimental value
this
PrimitiveTypeError for invalid primitive types
true if the experimental property exists and has a value; false otherwise
the subject property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the subject property.
the subject object value
this
InvalidTypeError for invalid data types
true if the subject property exists and has a value; false otherwise
the subject property value as a CodeableConcept object if defined; else undefined
true if the subject property exists as a CodeableConcept and has a value; false otherwise
the subject property value as a Reference object if defined; else undefined
true if the subject property exists as a Reference and has a value; false otherwise
the subject property value as a CanonicalType object if defined; else undefined
true if the subject property exists as a CanonicalType and has a value; false otherwise
the date property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the date property.
the date value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the date property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the date property.
the date value
this
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the publisher property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the publisher property.
the publisher value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the publisher property exists and has a value; false otherwise
the publisher property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the publisher property.
the publisher value
this
PrimitiveTypeError for invalid primitive types
true if the publisher property exists and has a value; false otherwise
the contact property value as a ContactDetail array
Assigns the provided ContactDetail array value to the contact property.
the contact array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the contact array property.
the contact value
this
InvalidTypeError for invalid data types
true if the contact property exists and has a value; false otherwise
the description property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the description property.
the description value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the description property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the description property.
the description value
this
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the useContext property value as a UsageContext array
Assigns the provided UsageContext array value to the useContext property.
the useContext array value
this
InvalidTypeError for invalid data types
Add the provided UsageContext value to the useContext array property.
the useContext value
this
InvalidTypeError for invalid data types
true if the useContext property exists and has a value; false otherwise
the jurisdiction property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the jurisdiction property.
the jurisdiction array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the jurisdiction array property.
the jurisdiction value
this
InvalidTypeError for invalid data types
true if the jurisdiction property exists and has a value; false otherwise
the purpose property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the purpose property.
the purpose value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the purpose property exists and has a value; false otherwise
the purpose property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the purpose property.
the purpose value
this
PrimitiveTypeError for invalid primitive types
true if the purpose property exists and has a value; false otherwise
the usage property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the usage property.
the usage value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the usage property exists and has a value; false otherwise
the usage property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the usage property.
the usage value
this
PrimitiveTypeError for invalid primitive types
true if the usage property exists and has a value; false otherwise
the copyright property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the copyright property.
the copyright value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the copyright property exists and has a value; false otherwise
the copyright property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the copyright property.
the copyright value
this
PrimitiveTypeError for invalid primitive types
true if the copyright property exists and has a value; false otherwise
the approvalDate property value as a DateType object if defined; else an empty DateType object
Assigns the provided PrimitiveType value to the approvalDate property.
the approvalDate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the approvalDate property exists and has a value; false otherwise
the approvalDate property value as a fhirDate if defined; else undefined
Assigns the provided primitive value to the approvalDate property.
the approvalDate value
this
PrimitiveTypeError for invalid primitive types
true if the approvalDate property exists and has a value; false otherwise
the lastReviewDate property value as a DateType object if defined; else an empty DateType object
Assigns the provided PrimitiveType value to the lastReviewDate property.
the lastReviewDate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the lastReviewDate property exists and has a value; false otherwise
the lastReviewDate property value as a fhirDate if defined; else undefined
Assigns the provided primitive value to the lastReviewDate property.
the lastReviewDate value
this
PrimitiveTypeError for invalid primitive types
true if the lastReviewDate property exists and has a value; false otherwise
the effectivePeriod property value as a Period object if defined; else an empty Period object
Assigns the provided EffectivePeriod object value to the effectivePeriod property.
the effectivePeriod object value
this
InvalidTypeError for invalid data types
true if the effectivePeriod property exists and has a value; false otherwise
the topic property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the topic property.
the topic array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the topic array property.
the topic value
this
InvalidTypeError for invalid data types
true if the topic property exists and has a value; false otherwise
the author property value as a ContactDetail array
Assigns the provided ContactDetail array value to the author property.
the author array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the author array property.
the author value
this
InvalidTypeError for invalid data types
true if the author property exists and has a value; false otherwise
the editor property value as a ContactDetail array
Assigns the provided ContactDetail array value to the editor property.
the editor array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the editor array property.
the editor value
this
InvalidTypeError for invalid data types
true if the editor property exists and has a value; false otherwise
the reviewer property value as a ContactDetail array
Assigns the provided ContactDetail array value to the reviewer property.
the reviewer array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the reviewer array property.
the reviewer value
this
InvalidTypeError for invalid data types
true if the reviewer property exists and has a value; false otherwise
the endorser property value as a ContactDetail array
Assigns the provided ContactDetail array value to the endorser property.
the endorser array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the endorser array property.
the endorser value
this
InvalidTypeError for invalid data types
true if the endorser property exists and has a value; false otherwise
the relatedArtifact property value as a RelatedArtifact array
Assigns the provided RelatedArtifact array value to the relatedArtifact property.
the relatedArtifact array value
this
InvalidTypeError for invalid data types
Add the provided RelatedArtifact value to the relatedArtifact array property.
the relatedArtifact value
this
InvalidTypeError for invalid data types
true if the relatedArtifact property exists and has a value; false otherwise
the library property value as a CanonicalType array
Assigns the provided CanonicalType array value to the library property.
the library array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the library array property.
the library value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the library property exists and has a value; false otherwise
the library property value as a fhirCanonical array
Assigns the provided primitive value array to the library property.
the library value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the library array property.
the library value
this
PrimitiveTypeError for invalid primitive types
true if the library property exists and has a value; false otherwise
the goal property value as a PlanDefinitionGoalComponent array
Assigns the provided PlanDefinitionGoalComponent array value to the goal property.
the goal array value
this
InvalidTypeError for invalid data types
Add the provided PlanDefinitionGoalComponent value to the goal array property.
the goal value
this
InvalidTypeError for invalid data types
true if the goal property exists and has a value; false otherwise
the action property value as a PlanDefinitionActionComponent array
Assigns the provided PlanDefinitionActionComponent array value to the action property.
the action array value
this
InvalidTypeError for invalid data types
Add the provided PlanDefinitionActionComponent value to the action array property.
the action value
this
InvalidTypeError for invalid data types
true if the action property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the contact property
PrivateinitInitialize the useContext property
PrivateinitInitialize the jurisdiction property
PrivateinitInitialize the topic property
PrivateinitInitialize the author property
PrivateinitInitialize the editor property
PrivateinitInitialize the reviewer property
PrivateinitInitialize the endorser property
PrivateinitInitialize the relatedArtifact property
PrivateinitInitialize the library property
PrivateinitInitialize the goal property
PrivateinitInitialize the action property
PlanDefinition Class
Remarks
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 and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.
FHIR Specification
See
FHIR PlanDefinition