Private OptionalsubstanceSubstanceDefinition.relationship.substanceDefinition[x] Element
Privatetype_SubstanceDefinition.relationship.type Element
Private OptionalisSubstanceDefinition.relationship.isDefining Element
FHIR Specification
booleanPrivate OptionalamountSubstanceDefinition.relationship.amount[x] Element
@ChoiceDataTypesMeta('SubstanceDefinition.relationship.amount[x]', ['Quantity','Ratio','string',]
FHIR Specification
Private OptionalratioSubstanceDefinition.relationship.ratioHighLimitAmount Element
Private OptionalcomparatorSubstanceDefinition.relationship.comparator Element
Private OptionalsourceSubstanceDefinition.relationship.source Element
FHIR Specification
Reference
StaticparseParse the provided SubstanceDefinitionRelationshipComponent JSON to instantiate the SubstanceDefinitionRelationshipComponent data model.
JSON representing FHIR SubstanceDefinitionRelationshipComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to SubstanceDefinitionRelationshipComponent
SubstanceDefinitionRelationshipComponent data model or undefined for SubstanceDefinitionRelationshipComponent
JsonError if the provided JSON is not a valid JSON object
the substanceDefinition property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the substanceDefinition property.
the substanceDefinition object value
this
InvalidTypeError for invalid data types
true if the substanceDefinition property exists and has a value; false otherwise
the substanceDefinition property value as a Reference object if defined; else undefined
true if the substanceDefinition property exists as a Reference and has a value; false otherwise
the substanceDefinition property value as a CodeableConcept object if defined; else undefined
true if the substanceDefinition property exists as a CodeableConcept and has a value; false otherwise
the type_ property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided CodeableConcept 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 isDefining property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the isDefining property.
the isDefining value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the isDefining property exists and has a value; false otherwise
the isDefining property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the isDefining property.
the isDefining value
this
PrimitiveTypeError for invalid primitive types
true if the isDefining property exists and has a value; false otherwise
the amount property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the amount property.
the amount object value
this
InvalidTypeError for invalid data types
true if the amount property exists and has a value; false otherwise
the amount property value as a Quantity object if defined; else undefined
true if the amount property exists as a Quantity and has a value; false otherwise
the amount property value as a Ratio object if defined; else undefined
true if the amount property exists as a Ratio and has a value; false otherwise
the amount property value as a StringType object if defined; else undefined
true if the amount property exists as a StringType and has a value; false otherwise
the ratioHighLimitAmount property value as a Ratio object if defined; else an empty Ratio object
Assigns the provided RatioHighLimitAmount object value to the ratioHighLimitAmount property.
the ratioHighLimitAmount object value
this
InvalidTypeError for invalid data types
true if the ratioHighLimitAmount property exists and has a value; false otherwise
the comparator property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Comparator object value to the comparator property.
the comparator object value
this
InvalidTypeError for invalid data types
true if the comparator 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 source property
SubstanceDefinitionRelationshipComponent Class
Remarks
FHIR Specification
See
FHIR SubstanceDefinition