Generated Narrative: StructureDefinition ext-R4B-AdministrableProductDefinition Name Flags Card. Type Description & Constraints Extension 0..* Extension(4.0.1) A medicinal product in the final form, suitable for administration - after any mixing of multiple components #xD; Slices for extension 2..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:status 1..1 Extension draft | active | retired | unknown #xD; url 1..1 uri "status" #xD; value[x] 0..1 code draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:formOf" title="Slice 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.">extension:formOf 0..* Extension 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 #xD; url 1..1 uri "formOf" #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:formOf.value[x]" title="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.">value[x] 0..1 Reference() 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 #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:administrableDoseForm" title="Slice 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').">extension:administrableDoseForm 0..1 Extension The dose form of the final product after necessary reconstitution or processing #xD; url 1..1 uri "administrableDoseForm" #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:administrableDoseForm.value[x]" title="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').">value[x] 0..1 CodeableConcept The dose form of the final product after necessary reconstitution or processing Binding: R4B_administrable_dose_form_for_R4 (0.0.1-snapshot-2) (example): Dose form for a medication, in the form suitable for administering to the patient, after mixing, where necessary. #xD; extension:unitOfPresentation 0..1 Extension The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' #xD; url 1..1 uri "unitOfPresentation" #xD; value[x] 0..1 CodeableConcept The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: R4B_unit_of_presentation_for_R4 (0.0.1-snapshot-2) (example): The presentation type in which an administrable medicinal product is given to a patient. #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:producedFrom" title="Slice 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.">extension:producedFrom 0..* Extension Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form #xD; url 1..1 uri "producedFrom" #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:producedFrom.value[x]" title="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.">value[x] 0..1 Reference() Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:ingredient" title="Slice 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.">extension:ingredient 0..* Extension 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 #xD; url 1..1 uri "ingredient" #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:ingredient.value[x]" title="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.">value[x] 0..1 CodeableConcept 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 Binding: AccountStatus (example): This value set includes all substance codes from SNOMED CT - provided as an exemplar value set. #xD; extension:device 0..1 Extension A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product #xD; url 1..1 uri "device" #xD; value[x] 0..1 Reference() A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product #xD; extension:property 0..* Extension Characteristics e.g. a product's onset of action #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:type 1..1 Extension A code expressing the type of characteristic #xD; url 1..1 uri "type" #xD; value[x] 0..1 CodeableConcept A code expressing the type of characteristic Binding: AccountStatus (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. #xD; extension:value[x] 0..1 Extension A value for the characteristic #xD; url 1..1 uri "value[x]" #xD; value[x] 0..1 A value for the characteristic #xD; valueCodeableConcept CodeableConcept #xD; valueQuantity Quantity #xD; valueDate date #xD; valueBoolean boolean #xD; valueAttachment Attachment #xD; extension:status 0..1 Extension The status of characteristic e.g. assigned or pending #xD; url 1..1 uri "status" #xD; value[x] 0..1 CodeableConcept The status of characteristic e.g. assigned or pending Binding: PublicationStatus (required): The lifecycle status of an artifact. #xD; url 1..1 uri "property" #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:routeOfAdministration" title="Slice 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).">extension:routeOfAdministration 1..* Extension The path by which the product is taken into or makes contact with the body #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:code 1..1 Extension Coded expression for the route #xD; url 1..1 uri "code" #xD; value[x] 0..1 CodeableConcept Coded expression for the route Binding: R4B_route_codes_for_R4 (0.0.1-snapshot-2) (example): A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. #xD; extension:firstDose 0..1 Extension The first dose (dose quantity) administered can be specified for the product #xD; url 1..1 uri "firstDose" #xD; value[x] 0..1 Quantity The first dose (dose quantity) administered can be specified for the product #xD; extension:maxSingleDose 0..1 Extension The maximum single dose that can be administered #xD; url 1..1 uri "maxSingleDose" #xD; value[x] 0..1 Quantity The maximum single dose that can be administered #xD; extension:maxDosePerDay 0..1 Extension The maximum dose quantity to be administered in any one 24-h period #xD; url 1..1 uri "maxDosePerDay" #xD; value[x] 0..1 Quantity The maximum dose quantity to be administered in any one 24-h period #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:routeOfAdministration.extension:maxDosePerTreatmentPeriod" title="Slice maxDosePerTreatmentPeriod: This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.">extension:maxDosePerTreatmentPeriod 0..1 Extension The maximum dose per treatment period that can be administered #xD; url 1..1 uri "maxDosePerTreatmentPeriod" #xD; value[x] 0..1 Ratio The maximum dose per treatment period that can be administered #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:routeOfAdministration.extension:maxTreatmentPeriod" title="Slice maxTreatmentPeriod: This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.">extension:maxTreatmentPeriod 0..1 Extension The maximum treatment period during which the product can be administered #xD; url 1..1 uri "maxTreatmentPeriod" #xD; value[x] 0..1 Duration The maximum treatment period during which the product can be administered #xD; extension:targetSpecies 0..* Extension A species for which this route applies #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:code 1..1 Extension Coded expression for the species #xD; url 1..1 uri "code" #xD; value[x] 0..1 CodeableConcept Coded expression for the species Binding: R4B_target_species_for_R4 (0.0.1-snapshot-2) (example): A tissue type of an animal. #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:routeOfAdministration.extension:targetSpecies.extension:withdrawalPeriod" title="Slice withdrawalPeriod: This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.">extension:withdrawalPeriod 0..* Extension A species specific time during which consumption of animal product is not appropriate #xD; Slices for extension 2..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:tissue 1..1 Extension The type of tissue for which the withdrawal period applies, e.g. meat, milk #xD; url 1..1 uri "tissue" #xD; value[x] 0..1 CodeableConcept The type of tissue for which the withdrawal period applies, e.g. meat, milk Binding: R4B_animal_tissue_type_for_R4 (0.0.1-snapshot-2) (example): A tissue type of an animal. #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:routeOfAdministration.extension:targetSpecies.extension:withdrawalPeriod.extension:value" title="Slice value: This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.">extension:value 1..1 Extension A value for the time #xD; url 1..1 uri "value" #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:routeOfAdministration.extension:targetSpecies.extension:withdrawalPeriod.extension:value.value[x]" title="This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.">value[x] 0..1 Quantity A value for the time #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:routeOfAdministration.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation" title="Slice supportingInformation: This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.">extension:supportingInformation 0..1 Extension Extra information about the withdrawal period #xD; url 1..1 uri "supportingInformation" #xD; <a href="StructureDefinition-ext-R4B-AdministrableProductDefinition-definitions.html#Extension.extension:routeOfAdministration.extension:targetSpecies.extension:withdrawalPeriod.extension:supportingInformation.value[x]" title="This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.">value[x] 0..1 string Extra information about the withdrawal period #xD; url 1..1 uri "withdrawalPeriod" #xD; url 1..1 uri "targetSpecies" #xD; url 1..1 uri "routeOfAdministration" #xD; url 1..1 uri "http://hl7.org/fhir/4.3/StructureDefinition/extension-AdministrableProductDefinition" #xD; Documentation for this format
Cross-version Extension for R4B.AdministrableProductDefinition for use in FHIR R4
This cross-version extension represents AdministrableProductDefinition from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
A medicinal product in the final form, suitable for administration - after any mixing of multiple components
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).
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
The status of this administrable product. Enables tracking the life-cycle of the content.
Additional content defined by implementations
May 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.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
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
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.
The dose form of the final product after necessary reconstitution or processing
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').
Dose form for a medication, in the form suitable for administering to the patient, after mixing, where necessary.
The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
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').
The presentation type in which an administrable medicinal product is given to a patient.
Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
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.
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
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.
This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.
A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
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.
Characteristics e.g. a product's onset of action
This cross-version extension represents AdministrableProductDefinition.property from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
A code expressing the type of characteristic
This cross-version extension represents AdministrableProductDefinition.property.type from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.
This cross-version extension represents AdministrableProductDefinition.property.value[x] from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
The status of characteristic e.g. assigned or pending
This cross-version extension represents AdministrableProductDefinition.property.status from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
The path by which the product is taken into or makes contact with the body
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).
This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.code from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body.
The first dose (dose quantity) administered can be specified for the product
The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement.
The maximum single dose that can be administered
The maximum single dose that can be administered, specified using a numerical value and its unit of measurement.
The maximum dose quantity to be administered in any one 24-h period
The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered.
The maximum dose per treatment period that can be administered
This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
The maximum treatment period during which the product can be administered
This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.targetSpecies from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.targetSpecies.code from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
A species specific time during which consumption of animal product is not appropriate
This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
The type of tissue for which the withdrawal period applies, e.g. meat, milk
Coded expression for the type of tissue for which the withdrawal period applies, e.g. meat, milk.
This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.
Extra information about the withdrawal period
This cross-version extension represents AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation from http://hl7.org/fhir/StructureDefinition/AdministrableProductDefinition|4.3.0 for use in FHIR R4.