AdministrableProductDefinition class
AdministrableProductDefinition A medicinal product in the final form which is suitable for administering to a patient (after any mixing of multiple components, dissolution etc. has been performed).
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
AdministrableProductDefinition({@Default(R5ResourceType.AdministrableProductDefinition) @JsonKey(unknownEnumValue: R5ResourceType.AdministrableProductDefinition) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, List<Reference> ? formOf, CodeableConcept? administrableDoseForm, CodeableConcept? unitOfPresentation, List<Reference> ? producedFrom, List<CodeableConcept> ? ingredient, Reference? device, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<AdministrableProductDefinitionProperty> ? property, required List<AdministrableProductDefinitionRouteOfAdministration> routeOfAdministration}) -
AdministrableProductDefinition A medicinal product in the final form
which is suitable for administering to a patient (after any mixing of
multiple components, dissolution etc. has been performed).
constfactory
-
AdministrableProductDefinition.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- AdministrableProductDefinition.fromJsonString(String source)
-
Acts like a constructor, returns a AdministrableProductDefinition,
accepts a
String as an argument, mostly because I got tired of typing it out
factory
- AdministrableProductDefinition.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- administrableDoseForm → CodeableConcept?
-
administrableDoseForm The dose form of the final product after
necessary reconstitution or processing. Contrasts to the manufactured
dose form (see ManufacturedItemDefinition). If the manufactured form
was 'powder for solution for injection', the administrable dose form
could be 'solution for injection' (once mixed with another item having
manufactured form 'solvent for solution for injection').
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
copyWith
→ $AdministrableProductDefinitionCopyWith<
AdministrableProductDefinition> -
no setterinherited
- dbId → int?
-
no setterinherited
- description → FhirMarkdown?
-
description A general description of the product, when in its final
form, suitable for administration e.g. effervescent blue liquid, to be
swallowed. Intended to be used when the other structured properties of
this resource are insufficient or cannot be supported. It is not
intended to duplicate information already carried elswehere.
no setterinherited
- descriptionElement → Element?
-
descriptionElement ("_description") Extensions for description
no setterinherited
- device → Reference?
-
device A device that is integral to the medicinal product, in effect
being considered as an "ingredient" of the medicinal product. This is
not intended for devices that are just co-packaged.
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("extension") May be used to represent additional
information that is not part of the basic definition of the resource.
To make the use of extensions safe and managable, there is a strict
set of governance applied to the definition and use of extensions.
Though any implementer can define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
-
formOf
→ List<
Reference> ? -
formOf References a product from which one or more of the constituent
parts of that product can be prepared and used as described by this
administrable product. If this administrable product describes the
administration of a crushed tablet, the 'formOf' would be the product
representing a distribution containing tablets and possibly also a
cream. This is distinct from the 'producedFrom' which refers to the
specific components of the product that are used in this preparation,
rather than the product as a whole.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier An identifier for the administrable product.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules A reference to a set of rules that were followed when
the resource was constructed, and which must be understood when
processing the content. Often, this is a reference to an
implementation guide that defines the special rules along with other
profiles etc.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
-
ingredient
→ List<
CodeableConcept> ? -
ingredient The ingredients of this administrable medicinal product.
This is only needed if the ingredients are not specified either using
ManufacturedItemDefiniton (via
AdministrableProductDefinition.producedFrom) to state which component
items are used to make this, or using by incoming references from the
Ingredient resource, to state in detail which substances exist within
this. This element allows a basic coded ingredient to be used.
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
- meta → FhirMeta?
-
meta The metadata about the resource. This is content that is
maintained by the infrastructure. Changes to the content might not
always be associated with version changes to the resource.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension May be used to represent additional information
that is not part of the basic definition of the resource and that
modifies the understanding of the element that contains it and/or the
understanding of the containing element's descendants. Usually
modifier elements provide negation or qualification. To make the use
of extensions safe and managable, there is a strict set of governance
applied to the definition and use of extensions. Though any
implementer is allowed to define an extension, there is a set of
requirements that SHALL be met as part of the definition of the
extension. Applications processing a resource are required to check
for modifier extensions.Modifier extensions SHALL NOT change the
meaning of any elements on Resource or DomainResource (including
cannot change the meaning of modifierExtension itself).
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
-
producedFrom
→ List<
Reference> ? -
producedFrom Indicates the specific manufactured items that are part
of the 'formOf' product that are used in the preparation of this
specific administrable form. In some cases, an administrable form
might use all of the items from the overall product (or there might
only be one item), while in other cases, an administrable form might
use only a subset of the items available in the overall product. For
example, an administrable form might involve combining a liquid and a
powder available as part of an overall product, but not involve
applying the also supplied cream.
no setterinherited
-
property
→ List<
AdministrableProductDefinitionProperty> ? -
property Characteristics e.g. a product's onset of action.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a AdministrableProductDefinition resource
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
-
routeOfAdministration
→ List<
AdministrableProductDefinitionRouteOfAdministration> -
routeOfAdministration The path by which the product is taken into or
makes contact with the body. In some regions this is referred to as
the licenced or approved route. RouteOfAdministration cannot be used
when the 'formOf' product already uses
MedicinalProductDefinition.route (and vice versa).
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → FhirCode?
-
status The status of this administrable product. Enables tracking the
life-cycle of the content.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
- text → Narrative?
-
text A human-readable narrative that contains a summary of the
resource and can be used to represent the content of the resource to a
human. The narrative need not encode all the structured data, but is
required to contain sufficient detail to make it "clinically safe" for
a human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- unitOfPresentation → CodeableConcept?
-
unitOfPresentation The presentation type in which this item is given
to a patient. e.g. for a spray - 'puff' (as in 'contains 100 mcg per
puff'), or for a liquid - 'vial' (as in 'contains 5 ml per vial').
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited