Data Model Libraries
    Preparing search index...

    Class AdministrableProductDefinition

    AdministrableProductDefinition Class

    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).

    FHIR Specification

    • Short: A medicinal product in the final form, suitable for administration - after any mixing of multiple components
    • Definition: 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).
    • FHIR Version: 5.0.0

    FHIR AdministrableProductDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? publicationStatusEnum status formOf? administrableDoseForm? unitOfPresentation? producedFrom? ingredient? device? description? property? routeOfAdministration

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getFormOf setFormOf addFormOf hasFormOf getAdministrableDoseForm setAdministrableDoseForm hasAdministrableDoseForm getUnitOfPresentation setUnitOfPresentation hasUnitOfPresentation getProducedFrom setProducedFrom addProducedFrom hasProducedFrom getIngredient setIngredient addIngredient hasIngredient getDevice setDevice hasDevice getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getProperty setProperty addProperty hasProperty getRouteOfAdministration setRouteOfAdministration addRouteOfAdministration hasRouteOfAdministration fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initFormOf initProducedFrom initIngredient initProperty initRouteOfAdministration

    Constructors

    Properties

    identifier?: Identifier[]

    AdministrableProductDefinition.identifier Element

    FHIR Specification

    • Short: An identifier for the administrable product
    • Definition: An identifier for the administrable product.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    AdministrableProductDefinition.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this administrable product. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of administrable products that are appropriate for use versus not.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    formOf?: Reference[]

    AdministrableProductDefinition.formOf Element

    FHIR Specification

    • Short: 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
    • Definition: 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.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    administrableDoseForm?: CodeableConcept

    AdministrableProductDefinition.administrableDoseForm Element

    FHIR Specification

    • Short: The dose form of the final product after necessary reconstitution or processing
    • Definition: 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').
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    unitOfPresentation?: CodeableConcept

    AdministrableProductDefinition.unitOfPresentation Element

    FHIR Specification

    • Short: The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
    • Definition: 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').
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    producedFrom?: Reference[]

    AdministrableProductDefinition.producedFrom Element

    FHIR Specification

    • Short: Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
    • Definition: 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.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    ingredient?: CodeableConcept[]

    AdministrableProductDefinition.ingredient Element

    FHIR Specification

    • Short: The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefiniton, or using by incoming references from the Ingredient resource
    • Definition: 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.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    device?: Reference

    AdministrableProductDefinition.device Element

    FHIR Specification

    • Short: A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
    • Definition: 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.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    AdministrableProductDefinition.description Element

    FHIR Specification

    • Short: A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed
    • Definition: 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.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    property?: AdministrableProductDefinitionPropertyComponent[]

    AdministrableProductDefinition.property Element

    FHIR Specification

    • Short: Characteristics e.g. a product's onset of action
    • Definition: Characteristics e.g. a product's onset of action.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    routeOfAdministration:
        | null
        | AdministrableProductDefinitionRouteOfAdministrationComponent[]

    AdministrableProductDefinition.routeOfAdministration Element

    FHIR Specification

    • Short: The path by which the product is taken into or makes contact with the body
    • Definition: 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).
    • FHIR Type: BackboneElement
    • Cardinality: 1..*
    • isModifier: false
    • isSummary: true

    Methods

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      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

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetFormOfsetFormOfaddFormOfhasFormOfgetAdministrableDoseFormsetAdministrableDoseFormhasAdministrableDoseFormgetUnitOfPresentationsetUnitOfPresentationhasUnitOfPresentationgetProducedFromsetProducedFromaddProducedFromhasProducedFromgetIngredientsetIngredientaddIngredienthasIngredientgetDevicesetDevicehasDevicegetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetPropertysetPropertyaddPropertyhasPropertygetRouteOfAdministrationsetRouteOfAdministrationaddRouteOfAdministrationhasRouteOfAdministrationfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitFormOfinitProducedFrominitIngredientinitPropertyinitRouteOfAdministration