Skip to main content

AdministrableProductDefinition

PropertyValue
Publisher
NameAdministrableProductDefinition
URLhttp://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
AdministrableProductDefinition0..*AdministrableProductDefinitionA 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).
AdministrableProductDefinition.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
AdministrableProductDefinition.meta0..1MetaThe 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.
AdministrableProductDefinition.implicitRules0..1uriA 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.
AdministrableProductDefinition.language0..1codeThe base language in which the resource is written.
AdministrableProductDefinition.text0..1NarrativeA 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.
AdministrableProductDefinition.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
AdministrableProductDefinition.extension0..*ExtensionMay 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 manageable, 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.
AdministrableProductDefinition.modifierExtension0..*ExtensionMay 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 manageable, 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).
AdministrableProductDefinition.identifier0..*IdentifierAn identifier for the administrable product.
AdministrableProductDefinition.status1..1codeThe status of this administrable product. Enables tracking the life-cycle of the content.
AdministrableProductDefinition.formOf0..*ReferenceReferences 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.
AdministrableProductDefinition.administrableDoseForm0..1CodeableConceptThe 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').
AdministrableProductDefinition.unitOfPresentation0..1CodeableConceptThe 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').
AdministrableProductDefinition.producedFrom0..*ReferenceIndicates 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.
AdministrableProductDefinition.ingredient0..*CodeableConceptThe 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.
AdministrableProductDefinition.device0..1ReferenceA 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.property0..*BackboneElementCharacteristics e.g. a product's onset of action.
AdministrableProductDefinition.property.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
AdministrableProductDefinition.property.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
AdministrableProductDefinition.property.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. 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).
AdministrableProductDefinition.property.type1..1CodeableConceptA code expressing the type of characteristic.
AdministrableProductDefinition.property.value[x]0..1CodeableConceptA value for the characteristic.
AdministrableProductDefinition.property.status0..1CodeableConceptThe status of characteristic e.g. assigned or pending.
AdministrableProductDefinition.routeOfAdministration1..*BackboneElementThe 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).
AdministrableProductDefinition.routeOfAdministration.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
AdministrableProductDefinition.routeOfAdministration.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
AdministrableProductDefinition.routeOfAdministration.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. 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).
AdministrableProductDefinition.routeOfAdministration.code1..1CodeableConceptCoded expression for the route.
AdministrableProductDefinition.routeOfAdministration.firstDose0..1QuantityThe first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.
AdministrableProductDefinition.routeOfAdministration.maxSingleDose0..1QuantityThe maximum single dose that can be administered, specified using a numerical value and its unit of measurement.
AdministrableProductDefinition.routeOfAdministration.maxDosePerDay0..1QuantityThe maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.
AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod0..1RatioThe maximum dose per treatment period that can be administered.
AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod0..1DurationThe maximum treatment period during which the product can be administered.
AdministrableProductDefinition.routeOfAdministration.targetSpecies0..*BackboneElementA species for which this route applies.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. 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).
AdministrableProductDefinition.routeOfAdministration.targetSpecies.code1..1CodeableConceptCoded expression for the species.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod0..*BackboneElementA species specific time during which consumption of animal product is not appropriate.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, 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.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 manageable, 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. 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).
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue1..1CodeableConceptCoded expression for the type of tissue for which the withdrawal period applies, e.g. meat, milk.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value1..1QuantityA value for the time.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation0..1stringExtra information about the withdrawal period.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
devicereferenceA 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-packagedAdministrableProductDefinition.device
dose-formtokenThe administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processingAdministrableProductDefinition.administrableDoseForm
form-ofreferenceThe 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 productAdministrableProductDefinition.formOf
identifiertokenAn identifier for the administrable productAdministrableProductDefinition.identifier
ingredienttokenThe ingredients of this administrable medicinal productAdministrableProductDefinition.ingredient
manufactured-itemreferenceThe 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 ingredientsAdministrableProductDefinition.producedFrom
routetokenCoded expression for the routeAdministrableProductDefinition.routeOfAdministration.code
target-speciestokenCoded expression for the speciesAdministrableProductDefinition.routeOfAdministration.targetSpecies.code