PrivatenameSubstanceDefinition.name.name Element
Private Optionaltype_SubstanceDefinition.name.type Element
Private OptionalstatusSubstanceDefinition.name.status Element
Private OptionalpreferredSubstanceDefinition.name.preferred Element
Private OptionallanguageSubstanceDefinition.name.language Element
Private OptionaldomainSubstanceDefinition.name.domain Element
FHIR Specification
CodeableConceptPrivate OptionaljurisdictionSubstanceDefinition.name.jurisdiction Element
Private OptionalsynonymSubstanceDefinition.name.synonym Element
Private OptionaltranslationSubstanceDefinition.name.translation Element
Private OptionalofficialSubstanceDefinition.name.official Element
Private OptionalsourceSubstanceDefinition.name.source Element
FHIR Specification
Reference
StaticparseParse the provided SubstanceDefinitionNameComponent JSON to instantiate the SubstanceDefinitionNameComponent data model.
JSON representing FHIR SubstanceDefinitionNameComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to SubstanceDefinitionNameComponent
SubstanceDefinitionNameComponent data model or undefined for SubstanceDefinitionNameComponent
JsonError if the provided JSON is not a valid JSON object
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 null
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 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 CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Status object value to the status property.
the status object value
this
InvalidTypeError for invalid data types
true if the status property exists and has a value; false otherwise
the preferred property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the preferred property.
the preferred value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the preferred property exists and has a value; false otherwise
the preferred property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the preferred property.
the preferred value
this
PrimitiveTypeError for invalid primitive types
true if the preferred property exists and has a value; false otherwise
the language property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the language property.
the language array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the language array property.
the language value
this
InvalidTypeError for invalid data types
true if the language property exists and has a value; false otherwise
the domain property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the domain property.
the domain array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the domain array property.
the domain value
this
InvalidTypeError for invalid data types
true if the domain 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 synonym property value as a SubstanceDefinitionNameComponent array
Assigns the provided SubstanceDefinitionNameComponent array value to the synonym property.
the synonym array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceDefinitionNameComponent value to the synonym array property.
the synonym value
this
InvalidTypeError for invalid data types
true if the synonym property exists and has a value; false otherwise
the translation property value as a SubstanceDefinitionNameComponent array
Assigns the provided SubstanceDefinitionNameComponent array value to the translation property.
the translation array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceDefinitionNameComponent value to the translation array property.
the translation value
this
InvalidTypeError for invalid data types
true if the translation property exists and has a value; false otherwise
the official property value as a SubstanceDefinitionNameOfficialComponent array
Assigns the provided SubstanceDefinitionNameOfficialComponent array value to the official property.
the official array value
this
InvalidTypeError for invalid data types
Add the provided SubstanceDefinitionNameOfficialComponent value to the official array property.
the official value
this
InvalidTypeError for invalid data types
true if the official property exists and has a value; false otherwise
the source property value as a Reference array
Assigns the provided Reference array value to the source property.
the source array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the source array property.
the source value
this
InvalidTypeError for invalid data type or reference value
true if the source 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 language property
PrivateinitInitialize the domain property
PrivateinitInitialize the jurisdiction property
PrivateinitInitialize the synonym property
PrivateinitInitialize the translation property
PrivateinitInitialize the official property
PrivateinitInitialize the source property
SubstanceDefinitionNameComponent Class
Remarks
FHIR Specification
See
FHIR SubstanceDefinition