Private OptionalidentifierMedicinalProductPharmaceutical.identifier Element
PrivateadministrableMedicinalProductPharmaceutical.administrableDoseForm Element
Private OptionalunitMedicinalProductPharmaceutical.unitOfPresentation Element
Private OptionalingredientMedicinalProductPharmaceutical.ingredient Element
FHIR Specification
Reference
Private OptionaldeviceMedicinalProductPharmaceutical.device Element
FHIR Specification
Reference
Private OptionalcharacteristicsMedicinalProductPharmaceutical.characteristics Element
PrivaterouteMedicinalProductPharmaceutical.routeOfAdministration Element
FHIR Specification
BackboneElementStaticparseParse the provided MedicinalProductPharmaceutical JSON to instantiate the MedicinalProductPharmaceutical data model.
JSON representing FHIR MedicinalProductPharmaceutical
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to MedicinalProductPharmaceutical
MedicinalProductPharmaceutical data model or undefined for MedicinalProductPharmaceutical
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the administrableDoseForm property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided CodeableConcept object value to the administrableDoseForm property.
the administrableDoseForm object value
this
InvalidTypeError for invalid data types
true if the administrableDoseForm property exists and has a value; false otherwise
the unitOfPresentation property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided UnitOfPresentation object value to the unitOfPresentation property.
the unitOfPresentation object value
this
InvalidTypeError for invalid data types
true if the unitOfPresentation property exists and has a value; false otherwise
the ingredient property value as a Reference array
Assigns the provided Reference array value to the ingredient property.
the ingredient array value
this
@ReferenceTargets('MedicinalProductPharmaceutical.ingredient', ['MedicinalProductIngredient',])
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the ingredient array property.
the ingredient value
this
@ReferenceTargets('MedicinalProductPharmaceutical.ingredient', ['MedicinalProductIngredient',])
InvalidTypeError for invalid data type or reference value
true if the ingredient property exists and has a value; false otherwise
the device property value as a Reference array
Assigns the provided Reference array value to the device property.
the device array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the device array property.
the device value
this
InvalidTypeError for invalid data type or reference value
true if the device property exists and has a value; false otherwise
the characteristics property value as a MedicinalProductPharmaceuticalCharacteristicsComponent array
Assigns the provided MedicinalProductPharmaceuticalCharacteristicsComponent array value to the characteristics property.
the characteristics array value
this
InvalidTypeError for invalid data types
Add the provided MedicinalProductPharmaceuticalCharacteristicsComponent value to the characteristics array property.
the characteristics value
this
InvalidTypeError for invalid data types
true if the characteristics property exists and has a value; false otherwise
the routeOfAdministration property value as a MedicinalProductPharmaceuticalRouteOfAdministrationComponent array
Assigns the provided MedicinalProductPharmaceuticalRouteOfAdministrationComponent array value to the routeOfAdministration property.
the routeOfAdministration array value
this
InvalidTypeError for invalid data types
Add the provided MedicinalProductPharmaceuticalRouteOfAdministrationComponent value to the routeOfAdministration array property.
the routeOfAdministration value
this
InvalidTypeError for invalid data types
true if the routeOfAdministration 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 text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property 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
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 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
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
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 FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; 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 identifier property
PrivateinitInitialize the ingredient property
PrivateinitInitialize the device property
PrivateinitInitialize the characteristics property
PrivateinitInitialize the routeOfAdministration property
MedicinalProductPharmaceutical Class
Remarks
A pharmaceutical product described in terms of its composition and dose form.
FHIR Specification
See
FHIR MedicinalProductPharmaceutical