FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Biomedical Research and Regulation icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Anonymous Compartments: No defined compartments

Detailed Descriptions for the elements in the AdministrableProductDefinition resource.

AdministrableProductDefinition
Element Id AdministrableProductDefinition
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).

Short Display A medicinal product in the final form, suitable for administration - after any mixing of multiple components
Cardinality 0..*
Type DomainResource
Alternate Names Pharmaceutical Product
Summary false
Invariants
Defined on this element
apd-1Rule RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)AdministrableProductDefinition.formOf.resolve().route.empty()
AdministrableProductDefinition.identifier
Element Id AdministrableProductDefinition.identifier
Definition

An identifier for the administrable product.

Short Display An identifier for the administrable product
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Summary true
AdministrableProductDefinition.status
Element Id AdministrableProductDefinition.status
Definition

The status of this administrable product. Enables tracking the life-cycle of the content.

Short Display draft | active | retired | unknown
Cardinality 1..1
Terminology Binding PublicationStatus (Required)
Type code
Is Modifier true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summary true
Comments

Allows filtering of administrable products that are appropriate for use versus not.

AdministrableProductDefinition.formOf
Element Id AdministrableProductDefinition.formOf
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.

Short Display 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
Cardinality 0..*
Type Reference(MedicinalProductDefinition)
Summary true
Invariants
Affect this element
apd-1Rule RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)AdministrableProductDefinition.formOf.resolve().route.empty()
AdministrableProductDefinition.administrableDoseForm
Element Id AdministrableProductDefinition.administrableDoseForm
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').

Short Display The dose form of the final product after necessary reconstitution or processing
Cardinality 0..1
Terminology Binding Administrable Dose Form (Example)
Type CodeableConcept
Summary true
AdministrableProductDefinition.unitOfPresentation
Element Id AdministrableProductDefinition.unitOfPresentation
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').

Short Display The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
Cardinality 0..1
Terminology Binding Unit Of Presentation (Example)
Type CodeableConcept
Summary true
AdministrableProductDefinition.producedFrom
Element Id AdministrableProductDefinition.producedFrom
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.

Short Display Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
Cardinality 0..*
Type Reference(ManufacturedItemDefinition)
Summary true
AdministrableProductDefinition.ingredient
Element Id AdministrableProductDefinition.ingredient
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.

Short Display 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
Cardinality 0..*
Terminology Binding SNOMED CT Substance Codes (Example)
Type CodeableConcept
Summary true
AdministrableProductDefinition.device
Element Id AdministrableProductDefinition.device
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.

Short Display A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
Cardinality 0..1
Type Reference(DeviceDefinition)
Summary true
AdministrableProductDefinition.description
Element Id AdministrableProductDefinition.description
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.

Short Display A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed
Cardinality 0..1
Type markdown
Summary false
AdministrableProductDefinition.property
Element Id AdministrableProductDefinition.property
Definition

Characteristics e.g. a product's onset of action.

Short Display Characteristics e.g. a product's onset of action
Cardinality 0..*
Summary true
AdministrableProductDefinition.property.type
Element Id AdministrableProductDefinition.property.type
Definition

A code expressing the type of characteristic.

Short Display A code expressing the type of characteristic
Cardinality 1..1
Terminology Binding Product Characteristic (Example)
Type CodeableConcept
Summary true
AdministrableProductDefinition.property.value[x]
Element Id AdministrableProductDefinition.property.value[x]
Definition

A value for the characteristic.

Short Display A value for the characteristic
Cardinality 0..1
Type CodeableConcept|Quantity|date|boolean|markdown|Attachment|Reference(Binary)
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
AdministrableProductDefinition.property.status
Element Id AdministrableProductDefinition.property.status
Definition

The status of characteristic e.g. assigned or pending.

Short Display The status of characteristic e.g. assigned or pending
Cardinality 0..1
Terminology Binding PublicationStatus (Required)
Type CodeableConcept
Summary true
AdministrableProductDefinition.routeOfAdministration
Element Id AdministrableProductDefinition.routeOfAdministration
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).

Short Display The path by which the product is taken into or makes contact with the body
Cardinality 1..*
Summary true
AdministrableProductDefinition.routeOfAdministration.code
Element Id AdministrableProductDefinition.routeOfAdministration.code
Definition

Coded expression for the route.

Short Display Coded expression for the route
Cardinality 1..1
Terminology Binding SNOMED CT Route Codes (Example)
Type CodeableConcept
Summary true
AdministrableProductDefinition.routeOfAdministration.firstDose
Element Id AdministrableProductDefinition.routeOfAdministration.firstDose
Definition

The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.

Short Display The first dose (dose quantity) administered can be specified for the product
Cardinality 0..1
Type Quantity
Summary true
AdministrableProductDefinition.routeOfAdministration.maxSingleDose
Element Id AdministrableProductDefinition.routeOfAdministration.maxSingleDose
Definition

The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.

Short Display The maximum single dose that can be administered
Cardinality 0..1
Type Quantity
Summary true
AdministrableProductDefinition.routeOfAdministration.maxDosePerDay
Element Id AdministrableProductDefinition.routeOfAdministration.maxDosePerDay
Definition

The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.

Short Display The maximum dose quantity to be administered in any one 24-h period
Cardinality 0..1
Type Quantity
Summary true
AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod
Element Id AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod
Definition

The maximum dose per treatment period that can be administered.

Short Display The maximum dose per treatment period that can be administered
Cardinality 0..1
Type Ratio
Summary true
AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod
Element Id AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod
Definition

The maximum treatment period during which the product can be administered.

Short Display The maximum treatment period during which the product can be administered
Cardinality 0..1
Type Duration
Summary true
AdministrableProductDefinition.routeOfAdministration.targetSpecies
Element Id AdministrableProductDefinition.routeOfAdministration.targetSpecies
Definition

A species for which this route applies.

Short Display A species for which this route applies
Cardinality 0..*
Summary true
AdministrableProductDefinition.routeOfAdministration.targetSpecies.code
Element Id AdministrableProductDefinition.routeOfAdministration.targetSpecies.code
Definition

Coded expression for the species.

Short Display Coded expression for the species
Cardinality 1..1
Terminology Binding Target Species (Example)
Type CodeableConcept
Summary true
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod
Element Id AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod
Definition

A species specific time during which consumption of animal product is not appropriate.

Short Display A species specific time during which consumption of animal product is not appropriate
Cardinality 0..*
Summary true
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue
Element Id AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue
Definition

Coded expression for the type of tissue for which the withdrawal period applies, e.g. meat, milk.

Short Display The type of tissue for which the withdrawal period applies, e.g. meat, milk
Cardinality 1..1
Terminology Binding Animal Tissue Type (Example)
Type CodeableConcept
Summary true
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value
Element Id AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value
Definition

A value for the time.

Short Display A value for the time
Cardinality 1..1
Type Quantity
Summary true
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation
Element Id AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation
Definition

Extra information about the withdrawal period.

Short Display Extra information about the withdrawal period
Cardinality 0..1
Type string
Summary true