Private OptionalprefixPlanDefinition.action.prefix Element
Private OptionaltitlePlanDefinition.action.title Element
FHIR Specification
stringPrivate OptionaldescriptionPlanDefinition.action.description Element
Private OptionaltextPlanDefinition.action.textEquivalent Element
FHIR Specification
stringPrivate ReadonlyrequestFHIR CodeSystem: RequestPriority
Private OptionalpriorityPlanDefinition.action.priority Element
FHIR Specification
codeCodeSystem Enumeration: RequestPriorityEnum
Private OptionalcodePlanDefinition.action.code Element
FHIR Specification
CodeableConceptPrivate OptionalreasonPlanDefinition.action.reason Element
FHIR Specification
CodeableConceptPrivate OptionaldocumentationPlanDefinition.action.documentation Element
FHIR Specification
RelatedArtifactPrivate OptionalgoalPlanDefinition.action.goalId Element
FHIR Specification
idPrivate OptionalsubjectPlanDefinition.action.subject[x] Element
@ChoiceDataTypesMeta('PlanDefinition.action.subject[x]', ['CodeableConcept','Reference','canonical',]
FHIR Specification
Private OptionaltriggerPlanDefinition.action.trigger Element
Private OptionalconditionPlanDefinition.action.condition Element
FHIR Specification
BackboneElementPrivate OptionalinputPlanDefinition.action.input Element
Private OptionaloutputPlanDefinition.action.output Element
Private OptionalrelatedPlanDefinition.action.relatedAction Element
FHIR Specification
BackboneElementPrivate OptionaltimingPlanDefinition.action.timing[x] Element
Private OptionalparticipantPlanDefinition.action.participant Element
Private Optionaltype_PlanDefinition.action.type Element
Private ReadonlyactionFHIR CodeSystem: ActionGroupingBehavior
Private OptionalgroupingPlanDefinition.action.groupingBehavior Element
FHIR Specification
codeCodeSystem Enumeration: ActionGroupingBehaviorEnum
Private ReadonlyactionFHIR CodeSystem: ActionSelectionBehavior
Private OptionalselectionPlanDefinition.action.selectionBehavior Element
FHIR Specification
codeCodeSystem Enumeration: ActionSelectionBehaviorEnum
Private ReadonlyactionFHIR CodeSystem: ActionRequiredBehavior
Private OptionalrequiredPlanDefinition.action.requiredBehavior Element
FHIR Specification
codeCodeSystem Enumeration: ActionRequiredBehaviorEnum
Private ReadonlyactionFHIR CodeSystem: ActionPrecheckBehavior
Private OptionalprecheckPlanDefinition.action.precheckBehavior Element
FHIR Specification
codeCodeSystem Enumeration: ActionPrecheckBehaviorEnum
Private ReadonlyactionFHIR CodeSystem: ActionCardinalityBehavior
Private OptionalcardinalityPlanDefinition.action.cardinalityBehavior Element
FHIR Specification
codeCodeSystem Enumeration: ActionCardinalityBehaviorEnum
Private OptionaldefinitionPlanDefinition.action.definition[x] Element
FHIR Specification
Private OptionaltransformPlanDefinition.action.transform Element
FHIR Specification
canonical
Private OptionaldynamicPlanDefinition.action.dynamicValue Element
FHIR Specification
BackboneElementPrivate OptionalactionPlanDefinition.action.action Element
FHIR Specification
BackboneElementStaticparseParse the provided PlanDefinitionActionComponent JSON to instantiate the PlanDefinitionActionComponent data model.
JSON representing FHIR PlanDefinitionActionComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to PlanDefinitionActionComponent
PlanDefinitionActionComponent data model or undefined for PlanDefinitionActionComponent
JsonError if the provided JSON is not a valid JSON object
the prefix property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the prefix property.
the prefix value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the prefix property exists and has a value; false otherwise
the prefix property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the prefix property.
the prefix value
this
PrimitiveTypeError for invalid primitive types
true if the prefix 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 description property value as a StringType object if defined; else an empty StringType 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 fhirString 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 textEquivalent property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the textEquivalent property.
the textEquivalent value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the textEquivalent property exists and has a value; false otherwise
the textEquivalent property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the textEquivalent property.
the textEquivalent value
this
PrimitiveTypeError for invalid primitive types
true if the textEquivalent property exists and has a value; false otherwise
the priority property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: RequestPriorityEnum
Assigns the provided EnumCodeType value to the priority property.
the priority value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: RequestPriorityEnum
true if the priority property exists and has a value; false otherwise
the priority property value as a CodeType if defined; else undefined
CodeSystem Enumeration: RequestPriorityEnum
Assigns the provided PrimitiveType value to the priority property.
the priority value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: RequestPriorityEnum
true if the priority property exists and has a value; false otherwise
the priority property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: RequestPriorityEnum
Assigns the provided primitive value to the priority property.
the priority value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: RequestPriorityEnum
true if the priority property exists and has a value; false otherwise
the code property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the code property.
the code array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the code array property.
the code value
this
InvalidTypeError for invalid data types
true if the code property exists and has a value; false otherwise
the reason property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the reason property.
the reason array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the reason array property.
the reason value
this
InvalidTypeError for invalid data types
true if the reason property exists and has a value; false otherwise
the documentation property value as a RelatedArtifact array
Assigns the provided RelatedArtifact array value to the documentation property.
the documentation array value
this
InvalidTypeError for invalid data types
Add the provided RelatedArtifact value to the documentation array property.
the documentation value
this
InvalidTypeError for invalid data types
true if the documentation property exists and has a value; false otherwise
the goalId property value as a IdType array
Assigns the provided IdType array value to the goalId property.
the goalId array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided IdType value to the goalId array property.
the goalId value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the goalId property exists and has a value; false otherwise
the goalId property value as a fhirId array
Assigns the provided primitive value array to the goalId property.
the goalId value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the goalId array property.
the goalId value
this
PrimitiveTypeError for invalid primitive types
true if the goalId 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 trigger property value as a TriggerDefinition array
Assigns the provided TriggerDefinition array value to the trigger property.
the trigger array value
this
InvalidTypeError for invalid data types
Add the provided TriggerDefinition value to the trigger array property.
the trigger value
this
InvalidTypeError for invalid data types
true if the trigger property exists and has a value; false otherwise
the condition property value as a PlanDefinitionActionConditionComponent array
Assigns the provided PlanDefinitionActionConditionComponent array value to the condition property.
the condition array value
this
InvalidTypeError for invalid data types
Add the provided PlanDefinitionActionConditionComponent value to the condition array property.
the condition value
this
InvalidTypeError for invalid data types
true if the condition property exists and has a value; false otherwise
the input property value as a DataRequirement array
Assigns the provided DataRequirement array value to the input property.
the input array value
this
InvalidTypeError for invalid data types
Add the provided DataRequirement value to the input array property.
the input value
this
InvalidTypeError for invalid data types
true if the input property exists and has a value; false otherwise
the output property value as a DataRequirement array
Assigns the provided DataRequirement array value to the output property.
the output array value
this
InvalidTypeError for invalid data types
Add the provided DataRequirement value to the output array property.
the output value
this
InvalidTypeError for invalid data types
true if the output property exists and has a value; false otherwise
the relatedAction property value as a PlanDefinitionActionRelatedActionComponent array
Assigns the provided PlanDefinitionActionRelatedActionComponent array value to the relatedAction property.
the relatedAction array value
this
InvalidTypeError for invalid data types
Add the provided PlanDefinitionActionRelatedActionComponent value to the relatedAction array property.
the relatedAction value
this
InvalidTypeError for invalid data types
true if the relatedAction property exists and has a value; false otherwise
the timing property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the timing property.
the timing object value
this
InvalidTypeError for invalid data types
true if the timing property exists and has a value; false otherwise
the timing property value as a DateTimeType object if defined; else undefined
true if the timing property exists as a DateTimeType and has a value; false otherwise
the timing property value as a Age object if defined; else undefined
true if the timing property exists as a Age and has a value; false otherwise
the timing property value as a Period object if defined; else undefined
true if the timing property exists as a Period and has a value; false otherwise
the timing property value as a Duration object if defined; else undefined
true if the timing property exists as a Duration and has a value; false otherwise
the timing property value as a Range object if defined; else undefined
true if the timing property exists as a Range and has a value; false otherwise
the timing property value as a Timing object if defined; else undefined
true if the timing property exists as a Timing and has a value; false otherwise
the participant property value as a PlanDefinitionActionParticipantComponent array
Assigns the provided PlanDefinitionActionParticipantComponent array value to the participant property.
the participant array value
this
InvalidTypeError for invalid data types
Add the provided PlanDefinitionActionParticipantComponent value to the participant array property.
the participant value
this
InvalidTypeError for invalid data types
true if the participant 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 groupingBehavior property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: ActionGroupingBehaviorEnum
Assigns the provided EnumCodeType value to the groupingBehavior property.
the groupingBehavior value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: ActionGroupingBehaviorEnum
true if the groupingBehavior property exists and has a value; false otherwise
the groupingBehavior property value as a CodeType if defined; else undefined
CodeSystem Enumeration: ActionGroupingBehaviorEnum
Assigns the provided PrimitiveType value to the groupingBehavior property.
the groupingBehavior value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ActionGroupingBehaviorEnum
true if the groupingBehavior property exists and has a value; false otherwise
the groupingBehavior property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: ActionGroupingBehaviorEnum
Assigns the provided primitive value to the groupingBehavior property.
the groupingBehavior value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ActionGroupingBehaviorEnum
true if the groupingBehavior property exists and has a value; false otherwise
the selectionBehavior property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: ActionSelectionBehaviorEnum
Assigns the provided EnumCodeType value to the selectionBehavior property.
the selectionBehavior value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: ActionSelectionBehaviorEnum
true if the selectionBehavior property exists and has a value; false otherwise
the selectionBehavior property value as a CodeType if defined; else undefined
CodeSystem Enumeration: ActionSelectionBehaviorEnum
Assigns the provided PrimitiveType value to the selectionBehavior property.
the selectionBehavior value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ActionSelectionBehaviorEnum
true if the selectionBehavior property exists and has a value; false otherwise
the selectionBehavior property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: ActionSelectionBehaviorEnum
Assigns the provided primitive value to the selectionBehavior property.
the selectionBehavior value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ActionSelectionBehaviorEnum
true if the selectionBehavior property exists and has a value; false otherwise
the requiredBehavior property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: ActionRequiredBehaviorEnum
Assigns the provided EnumCodeType value to the requiredBehavior property.
the requiredBehavior value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: ActionRequiredBehaviorEnum
true if the requiredBehavior property exists and has a value; false otherwise
the requiredBehavior property value as a CodeType if defined; else undefined
CodeSystem Enumeration: ActionRequiredBehaviorEnum
Assigns the provided PrimitiveType value to the requiredBehavior property.
the requiredBehavior value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ActionRequiredBehaviorEnum
true if the requiredBehavior property exists and has a value; false otherwise
the requiredBehavior property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: ActionRequiredBehaviorEnum
Assigns the provided primitive value to the requiredBehavior property.
the requiredBehavior value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ActionRequiredBehaviorEnum
true if the requiredBehavior property exists and has a value; false otherwise
the precheckBehavior property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: ActionPrecheckBehaviorEnum
Assigns the provided EnumCodeType value to the precheckBehavior property.
the precheckBehavior value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: ActionPrecheckBehaviorEnum
true if the precheckBehavior property exists and has a value; false otherwise
the precheckBehavior property value as a CodeType if defined; else undefined
CodeSystem Enumeration: ActionPrecheckBehaviorEnum
Assigns the provided PrimitiveType value to the precheckBehavior property.
the precheckBehavior value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ActionPrecheckBehaviorEnum
true if the precheckBehavior property exists and has a value; false otherwise
the precheckBehavior property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: ActionPrecheckBehaviorEnum
Assigns the provided primitive value to the precheckBehavior property.
the precheckBehavior value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ActionPrecheckBehaviorEnum
true if the precheckBehavior property exists and has a value; false otherwise
the cardinalityBehavior property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: ActionCardinalityBehaviorEnum
Assigns the provided EnumCodeType value to the cardinalityBehavior property.
the cardinalityBehavior value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: ActionCardinalityBehaviorEnum
true if the cardinalityBehavior property exists and has a value; false otherwise
the cardinalityBehavior property value as a CodeType if defined; else undefined
CodeSystem Enumeration: ActionCardinalityBehaviorEnum
Assigns the provided PrimitiveType value to the cardinalityBehavior property.
the cardinalityBehavior value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ActionCardinalityBehaviorEnum
true if the cardinalityBehavior property exists and has a value; false otherwise
the cardinalityBehavior property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: ActionCardinalityBehaviorEnum
Assigns the provided primitive value to the cardinalityBehavior property.
the cardinalityBehavior value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ActionCardinalityBehaviorEnum
true if the cardinalityBehavior property exists and has a value; false otherwise
the definition property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the definition property.
the definition object value
this
InvalidTypeError for invalid data types
true if the definition property exists and has a value; false otherwise
the definition property value as a CanonicalType object if defined; else undefined
true if the definition property exists as a CanonicalType and has a value; false otherwise
the definition property value as a UriType object if defined; else undefined
true if the definition property exists as a UriType and has a value; false otherwise
the transform property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the transform property.
the transform value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the transform property exists and has a value; false otherwise
the transform property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the transform property.
the transform value
this
PrimitiveTypeError for invalid primitive types
true if the transform property exists and has a value; false otherwise
the dynamicValue property value as a PlanDefinitionActionDynamicValueComponent array
Assigns the provided PlanDefinitionActionDynamicValueComponent array value to the dynamicValue property.
the dynamicValue array value
this
InvalidTypeError for invalid data types
Add the provided PlanDefinitionActionDynamicValueComponent value to the dynamicValue array property.
the dynamicValue value
this
InvalidTypeError for invalid data types
true if the dynamicValue 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
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 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; 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 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 id property value
Assigns the provided value to the id property.
the id value
this
PrimitiveTypeError for invalid value
true if id 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
Determines if the extension property exists.
the url that identifies a specific Extension
an Extension having 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 extension property exists and has any values.
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
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
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 code property
PrivateinitInitialize the reason property
PrivateinitInitialize the documentation property
PrivateinitInitialize the goalId property
PrivateinitInitialize the trigger property
PrivateinitInitialize the condition property
PrivateinitInitialize the input property
PrivateinitInitialize the output property
PrivateinitInitialize the relatedAction property
PrivateinitInitialize the participant property
PrivateinitInitialize the dynamicValue property
PrivateinitInitialize the action property
PlanDefinitionActionComponent Class
Remarks
FHIR Specification
See
FHIR PlanDefinition