AdministrableProductDefinition
Introduction
Scope and Usage
For an overview of this resource and others in the Medication Definition domain, also see the module page
A medicinal product may consist of several items, which need to be combined or processed before administration to the patient. This resource covers the ready-for-use administrable product - the components of which are ManufacturedItemDefinition resources. Note that in some cases the administrable product needs no processing or transformation from the manufactured item.
This resource represents the final form of the product; hence it details properties such as the route, that only apply to the final product. It is a definitional resource, representing the properties of a product, but not the actual instance given to someone. When necessary to record that, a Medication resource is used.
This resource corresponds to the Pharmaceutical Product as defined by the ISO IDMP set of standards, see ISO 11615 and ISO 11616. To better align with the HL7 guidelines for supporting different product concepts and to avoid possible confusion with the resources defined in the Medications module of HL7 FHIR, the concept "Administrable Product" has been adopted for the name of this resource, whereas the terms and definitions of other core resources in the Medication Definition module do correspond directly to the ISO IDMP terms. See also the mapping table for a detailed mapping of this resource to the IDMP Pharmaceutical Product definition.
StructureDefinition
Elements (Simplified)
- AdministrableProductDefinition [0..*]: - A medicinal product in the final form, suitable for administration - after any mixing of multiple components
- AdministrableProductDefinition.identifier [0..*]: Identifier An identifier for the administrable product instance
- AdministrableProductDefinition.status [1..1]: code required:publication-status draft | active | retired | unknown
- AdministrableProductDefinition.formOf [0..*]: Reference(MedicinalProductDefinition) 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
- AdministrableProductDefinition.administrableDoseForm [0..1]: CodeableConcept example:administrable-dose-form The dose form of the final product after necessary reconstitution or processing
- AdministrableProductDefinition.unitOfPresentation [0..1]: CodeableConcept example:unit-of-presentation The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
- AdministrableProductDefinition.producedFrom [0..*]: Reference(ManufacturedItemDefinition) Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
- AdministrableProductDefinition.ingredient [0..*]: CodeableConcept example:substance-codes The ingredients of this administrable medicinal product. This is only needed if the ingredients are not specified either using ManufacturedItemDefinition, or using incoming references from the Ingredient resource
- AdministrableProductDefinition.device [0..1]: Reference(DeviceDefinition) A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
- AdministrableProductDefinition.description [0..1]: markdown A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed
- AdministrableProductDefinition.code [0..*]: Coding example:medication-codes A code that this product is known by, within some formal terminology. May be a PhPID
- AdministrableProductDefinition.property [0..*]: BackboneElement Characteristics e.g. a product's onset of action
- AdministrableProductDefinition.property.type [1..1]: CodeableConcept example:product-characteristic-codes A code expressing the type of characteristic
- AdministrableProductDefinition.property.value[x] [0..1]: CodeableConcept, Quantity, Range, date, boolean, markdown, Attachment, Reference(Binary) A value for the characteristic
- AdministrableProductDefinition.property.status [0..1]: CodeableConcept required:publication-status The status of characteristic e.g. assigned or pending
- AdministrableProductDefinition.routeOfAdministration [1..*]: BackboneElement The path by which the product is taken into or makes contact with the body
- AdministrableProductDefinition.routeOfAdministration.code [1..1]: CodeableConcept example:route-codes Coded expression for the route
- AdministrableProductDefinition.routeOfAdministration.firstDose [0..1]: Quantity The first dose (dose quantity) administered can be specified for the product
- AdministrableProductDefinition.routeOfAdministration.maxSingleDose [0..1]: Quantity The maximum single dose that can be administered
- AdministrableProductDefinition.routeOfAdministration.maxDosePerDay [0..1]: Quantity The maximum dose quantity to be administered in any one 24-h period
- AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod [0..1]: Ratio The maximum dose per treatment period that can be administered
- AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod [0..1]: Duration The maximum treatment period during which the product can be administered
- AdministrableProductDefinition.routeOfAdministration.targetSpecies [0..*]: BackboneElement A species for which this route applies
- AdministrableProductDefinition.routeOfAdministration.targetSpecies.code [1..1]: CodeableConcept example:target-species Coded expression for the species
- AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod [0..*]: BackboneElement A species specific time during which consumption of animal product is not appropriate
- AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue [1..1]: CodeableConcept example:animal-tissue-type The type of tissue for which the withdrawal period applies, e.g. meat, milk
- AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value [1..1]: Quantity A value for the time
- AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation [0..1]: string Extra information about the withdrawal period
Mappings
- AdministrableProductDefinition Mappings — 31 mapping entries
Resource Packs
list-AdministrableProductDefinition-packs.xml
<?xml version="1.0" encoding="UTF-8"?>
<List xmlns="http://hl7.org/fhir">
<id value="AdministrableProductDefinition-packs"/>
<status value="current"/>
<mode value="working"/>
</List>
Search Parameters
- device — reference — 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 —
AdministrableProductDefinition.device - dose-form — token — The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing —
AdministrableProductDefinition.administrableDoseForm - identifier — token — An identifier for the administrable product —
AdministrableProductDefinition.identifier - ingredient — token — The ingredients of this administrable medicinal product —
AdministrableProductDefinition.ingredient - manufactured-item — reference — The manufactured item(s) that this administrable product is produced from. Either a single item, or several that are mixed before administration (e.g. a power item and a solution item). Note that these are not raw ingredients —
AdministrableProductDefinition.producedFrom - route — token — Coded expression for the route —
AdministrableProductDefinition.routeOfAdministration.code - form-of — reference — The medicinal product that this is an administrable form of. This is not a reference to the item(s) that make up this administrable form - it is the whole product —
AdministrableProductDefinition.formOf - target-species — token — Coded expression for the species —
AdministrableProductDefinition.routeOfAdministration.targetSpecies.code - status — token — The status of this administrable product. Enables tracking the life-cycle of the content. —
AdministrableProductDefinition.status
Examples
- administrableproductdefinition-example — administrableproductdefinition-example
- administrableproductdefinition-examples-header — administrableproductdefinition-examples-header
- example — administrableproductdefinition-example — Example of administrableproductdefinition
Mapping Exceptions
administrableproductdefinition-fivews-mapping-exceptions.xml
Unmapped Elements
- FiveWs.what — Unknown
- FiveWs.recorded — Unknown
- FiveWs.author — Unknown
- FiveWs.actor — Unknown
- FiveWs.cause — Unknown
- FiveWs.version — Unknown
- FiveWs.witness — Unknown
- FiveWs.where — Unknown
- FiveWs.context — Unknown
- FiveWs.init — Unknown
- FiveWs.why — Unknown
- FiveWs.identifier — Unknown
- FiveWs.source — Unknown
- FiveWs.who — Unknown
- FiveWs.grade — Unknown
- FiveWs.status — Unknown
- FiveWs.planned — Unknown
- FiveWs.done — Unknown
- FiveWs.subject — Unknown