PrivatekeyExampleScenario.instance.key Element
PrivatestructureExampleScenario.instance.structureType Element
Private OptionalstructureExampleScenario.instance.structureVersion Element
Private OptionalstructureExampleScenario.instance.structureProfile[x] Element
PrivatetitleExampleScenario.instance.title Element
Private OptionaldescriptionExampleScenario.instance.description Element
Private OptionalcontentExampleScenario.instance.content Element
FHIR Specification
ReferencePrivate OptionalversionExampleScenario.instance.version Element
FHIR Specification
BackboneElementPrivate OptionalcontainedExampleScenario.instance.containedInstance Element
StaticparseParse the provided ExampleScenarioInstanceComponent JSON to instantiate the ExampleScenarioInstanceComponent data model.
JSON representing FHIR ExampleScenarioInstanceComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ExampleScenarioInstanceComponent
ExampleScenarioInstanceComponent data model or undefined for ExampleScenarioInstanceComponent
JsonError if the provided JSON is not a valid JSON object
the key property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the key property.
the key value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the key property exists and has a value; false otherwise
the key property value as a fhirString if defined; else null
Assigns the provided primitive value to the key property.
the key value
this
PrimitiveTypeError for invalid primitive types
true if the key property exists and has a value; false otherwise
the structureType property value as a Coding object if defined; else an empty Coding object
Assigns the provided Coding object value to the structureType property.
the structureType object value
this
InvalidTypeError for invalid data types
true if the structureType property exists and has a value; false otherwise
the structureVersion property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the structureVersion property.
the structureVersion value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the structureVersion property exists and has a value; false otherwise
the structureVersion property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the structureVersion property.
the structureVersion value
this
PrimitiveTypeError for invalid primitive types
true if the structureVersion property exists and has a value; false otherwise
the structureProfile property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the structureProfile property.
the structureProfile object value
this
InvalidTypeError for invalid data types
true if the structureProfile property exists and has a value; false otherwise
the structureProfile property value as a CanonicalType object if defined; else undefined
true if the structureProfile property exists as a CanonicalType and has a value; false otherwise
the structureProfile property value as a UriType object if defined; else undefined
true if the structureProfile property exists as a UriType 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 null
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 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 content property value as a Reference object; else an empty Reference object
Assigns the provided Content object value to the content property.
the content object value
this
InvalidTypeError for invalid data type or reference value
true if the content property exists and has a value; false otherwise
the version property value as a ExampleScenarioInstanceVersionComponent array
Assigns the provided ExampleScenarioInstanceVersionComponent array value to the version property.
the version array value
this
InvalidTypeError for invalid data types
Add the provided ExampleScenarioInstanceVersionComponent value to the version array property.
the version value
this
InvalidTypeError for invalid data types
true if the version property exists and has a value; false otherwise
the containedInstance property value as a ExampleScenarioInstanceContainedInstanceComponent array
Assigns the provided ExampleScenarioInstanceContainedInstanceComponent array value to the containedInstance property.
the containedInstance array value
this
InvalidTypeError for invalid data types
Add the provided ExampleScenarioInstanceContainedInstanceComponent value to the containedInstance array property.
the containedInstance value
this
InvalidTypeError for invalid data types
true if the containedInstance 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 version property
PrivateinitInitialize the containedInstance property
ExampleScenarioInstanceComponent Class
Remarks
FHIR Specification
See
FHIR ExampleScenario