Private OptionalcategoryPlanDefinition.goal.category Element
PrivatedescriptionPlanDefinition.goal.description Element
FHIR Specification
CodeableConceptPrivate OptionalpriorityPlanDefinition.goal.priority Element
Private OptionalstartPlanDefinition.goal.start Element
Private OptionaladdressesPlanDefinition.goal.addresses Element
Private OptionaldocumentationPlanDefinition.goal.documentation Element
FHIR Specification
RelatedArtifactPrivate OptionaltargetPlanDefinition.goal.target Element
StaticparseParse the provided PlanDefinitionGoalComponent JSON to instantiate the PlanDefinitionGoalComponent data model.
JSON representing FHIR PlanDefinitionGoalComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to PlanDefinitionGoalComponent
PlanDefinitionGoalComponent data model or undefined for PlanDefinitionGoalComponent
JsonError if the provided JSON is not a valid JSON object
the category property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Category object value to the category property.
the category object value
this
InvalidTypeError for invalid data types
true if the category property exists and has a value; false otherwise
the description property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided CodeableConcept object value to the description property.
the description object value
this
InvalidTypeError for invalid data types
true if the description property exists and has a value; false otherwise
the priority property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Priority object value to the priority property.
the priority object value
this
InvalidTypeError for invalid data types
true if the priority property exists and has a value; false otherwise
the start property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Start object value to the start property.
the start object value
this
InvalidTypeError for invalid data types
true if the start property exists and has a value; false otherwise
the addresses property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the addresses property.
the addresses array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the addresses array property.
the addresses value
this
InvalidTypeError for invalid data types
true if the addresses 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 target property value as a PlanDefinitionGoalTargetComponent array
Assigns the provided PlanDefinitionGoalTargetComponent array value to the target property.
the target array value
this
InvalidTypeError for invalid data types
Add the provided PlanDefinitionGoalTargetComponent value to the target array property.
the target value
this
InvalidTypeError for invalid data types
true if the target 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 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 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 addresses property
PrivateinitInitialize the documentation property
PrivateinitInitialize the target property
PlanDefinitionGoalComponent Class
Remarks
FHIR Specification
See
FHIR PlanDefinition