This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B
Biomedical Research and Regulation Work Group | Maturity Level: 1 | Trial Use | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
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).
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 often the administrable product is the same as 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 is referenced by MedicinalProductDefinition and PlanDefinition.
This resource does not implement any patterns.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AdministrableProductDefinition | TU | DomainResource | 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) Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..* | Identifier | An identifier for the administrable product |
subject | Σ | 0..* | Reference(MedicinalProductDefinition) | 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 |
administrableDoseForm | Σ | 0..1 | CodeableConcept | The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing |
unitOfPresentation | Σ | 0..1 | CodeableConcept | The units of presentation for the administrable product, for example 'tablet' |
producedFrom | Σ | 0..* | Reference(ManufacturedItemDefinition) | 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 |
ingredient | Σ | 0..* | Reference(Ingredient) | The ingredients of this administrable medicinal product. Sometimes it may be appropriate to specify these via the associated manufactured item(s) |
device | Σ | 0..* | Reference(DeviceDefinition) | 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 |
property | Σ | 0..* | BackboneElement | Characteristics e.g. a products onset of action |
type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic |
value[x] | Σ | 0..1 | A value for the characteristic | |
valueCodeableConcept | CodeableConcept | |||
valueQuantity | Quantity | |||
valueDate | date | |||
valueBoolean | boolean | |||
valueAttachment | Attachment | |||
status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending |
routeOfAdministration | Σ | 1..* | BackboneElement | 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 |
code | Σ | 1..1 | CodeableConcept | Coded expression for the route |
firstDose | Σ | 0..1 | Quantity | The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement |
maxSingleDose | Σ | 0..1 | Quantity | The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement |
maxDosePerDay | Σ | 0..1 | Quantity | The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered |
maxDosePerTreatmentPeriod | Σ | 0..1 | Ratio | The maximum dose per treatment period that can be administered |
maxTreatmentPeriod | Σ | 0..1 | Duration | The maximum treatment period during which an Investigational Medicinal Product can be administered |
targetSpecies | Σ | 0..* | BackboneElement | A species for which this route applies |
code | Σ | 1..1 | CodeableConcept | Coded expression for the species |
withdrawalPeriod | Σ | 0..* | BackboneElement | A species specific time during which consumption of animal product is not appropriate |
tissue | Σ | 1..1 | CodeableConcept | Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk |
value | Σ | 1..1 | Quantity | A value for the time |
supportingInformation | Σ | 0..1 | string | Extra information about the withdrawal period |
Documentation for this format |
UML Diagram (Legend)
XML Template
<AdministrableProductDefinition xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier An identifier for the administrable product --></identifier> <subject><!-- 0..* Reference(MedicinalProductDefinition) 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 --></subject> <administrableDoseForm><!-- 0..1 CodeableConcept The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing --></administrableDoseForm> <unitOfPresentation><!-- 0..1 CodeableConcept The units of presentation for the administrable product, for example 'tablet' --></unitOfPresentation> <producedFrom><!-- 0..* Reference(ManufacturedItemDefinition) 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 --></producedFrom> <ingredient><!-- 0..* Reference(Ingredient) The ingredients of this administrable medicinal product. Sometimes it may be appropriate to specify these via the associated manufactured item(s) --></ingredient> <device><!-- 0..* Reference(DeviceDefinition) 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 --></device> <property> <!-- 0..* Characteristics e.g. a products onset of action --> <type><!-- 1..1 CodeableConcept A code expressing the type of characteristic --></type> <value[x]><!-- 0..1 CodeableConcept|Quantity|date|boolean|Attachment A value for the characteristic --></value[x]> <status><!-- 0..1 CodeableConcept The status of characteristic e.g. assigned or pending --></status> </property> <routeOfAdministration> <!-- 1..* 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 --> <code><!-- 1..1 CodeableConcept Coded expression for the route --></code> <firstDose><!-- 0..1 Quantity The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement --></firstDose> <maxSingleDose><!-- 0..1 Quantity The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement --></maxSingleDose> <maxDosePerDay><!-- 0..1 Quantity The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered --></maxDosePerDay> <maxDosePerTreatmentPeriod><!-- 0..1 Ratio The maximum dose per treatment period that can be administered --></maxDosePerTreatmentPeriod> <maxTreatmentPeriod><!-- 0..1 Duration The maximum treatment period during which an Investigational Medicinal Product can be administered --></maxTreatmentPeriod> <targetSpecies> <!-- 0..* A species for which this route applies --> <code><!-- 1..1 CodeableConcept Coded expression for the species --></code> <withdrawalPeriod> <!-- 0..* A species specific time during which consumption of animal product is not appropriate --> <tissue><!-- 1..1 CodeableConcept Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk --></tissue> <value><!-- 1..1 Quantity A value for the time --></value> <supportingInformation value="[string]"/><!-- 0..1 Extra information about the withdrawal period --> </withdrawalPeriod> </targetSpecies> </routeOfAdministration> </AdministrableProductDefinition>
JSON Template
{ "resourceType" : "AdministrableProductDefinition", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // An identifier for the administrable product "subject" : [{ Reference(MedicinalProductDefinition) }], // 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 "administrableDoseForm" : { CodeableConcept }, // The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing "unitOfPresentation" : { CodeableConcept }, // The units of presentation for the administrable product, for example 'tablet' "producedFrom" : [{ Reference(ManufacturedItemDefinition) }], // 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 "ingredient" : [{ Reference(Ingredient) }], // The ingredients of this administrable medicinal product. Sometimes it may be appropriate to specify these via the associated manufactured item(s) "device" : [{ Reference(DeviceDefinition) }], // 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 "property" : [{ // Characteristics e.g. a products onset of action "type" : { CodeableConcept }, // R! A code expressing the type of characteristic // value[x]: A value for the characteristic. One of these 5: "valueCodeableConcept" : { CodeableConcept }, "valueQuantity" : { Quantity }, "valueDate" : "<date>", "valueBoolean" : <boolean>, "valueAttachment" : { Attachment }, "status" : { CodeableConcept } // The status of characteristic e.g. assigned or pending }], "routeOfAdministration" : [{ // R! 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 "code" : { CodeableConcept }, // R! Coded expression for the route "firstDose" : { Quantity }, // The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement "maxSingleDose" : { Quantity }, // The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement "maxDosePerDay" : { Quantity }, // The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered "maxDosePerTreatmentPeriod" : { Ratio }, // The maximum dose per treatment period that can be administered "maxTreatmentPeriod" : { Duration }, // The maximum treatment period during which an Investigational Medicinal Product can be administered "targetSpecies" : [{ // A species for which this route applies "code" : { CodeableConcept }, // R! Coded expression for the species "withdrawalPeriod" : [{ // A species specific time during which consumption of animal product is not appropriate "tissue" : { CodeableConcept }, // R! Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk "value" : { Quantity }, // R! A value for the time "supportingInformation" : "<string>" // Extra information about the withdrawal period }] }] }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:AdministrableProductDefinition; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:AdministrableProductDefinition.identifier [ Identifier ], ... ; # 0..* An identifier for the administrable product fhir:AdministrableProductDefinition.subject [ Reference(MedicinalProductDefinition) ], ... ; # 0..* 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 fhir:AdministrableProductDefinition.administrableDoseForm [ CodeableConcept ]; # 0..1 The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing fhir:AdministrableProductDefinition.unitOfPresentation [ CodeableConcept ]; # 0..1 The units of presentation for the administrable product, for example 'tablet' fhir:AdministrableProductDefinition.producedFrom [ Reference(ManufacturedItemDefinition) ], ... ; # 0..* 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 fhir:AdministrableProductDefinition.ingredient [ Reference(Ingredient) ], ... ; # 0..* The ingredients of this administrable medicinal product. Sometimes it may be appropriate to specify these via the associated manufactured item(s) fhir:AdministrableProductDefinition.device [ Reference(DeviceDefinition) ], ... ; # 0..* 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:AdministrableProductDefinition.property [ # 0..* Characteristics e.g. a products onset of action fhir:AdministrableProductDefinition.property.type [ CodeableConcept ]; # 1..1 A code expressing the type of characteristic # AdministrableProductDefinition.property.value[x] : 0..1 A value for the characteristic. One of these 5 fhir:AdministrableProductDefinition.property.valueCodeableConcept [ CodeableConcept ] fhir:AdministrableProductDefinition.property.valueQuantity [ Quantity ] fhir:AdministrableProductDefinition.property.valueDate [ date ] fhir:AdministrableProductDefinition.property.valueBoolean [ boolean ] fhir:AdministrableProductDefinition.property.valueAttachment [ Attachment ] fhir:AdministrableProductDefinition.property.status [ CodeableConcept ]; # 0..1 The status of characteristic e.g. assigned or pending ], ...; fhir:AdministrableProductDefinition.routeOfAdministration [ # 1..* 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 fhir:AdministrableProductDefinition.routeOfAdministration.code [ CodeableConcept ]; # 1..1 Coded expression for the route fhir:AdministrableProductDefinition.routeOfAdministration.firstDose [ Quantity ]; # 0..1 The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement fhir:AdministrableProductDefinition.routeOfAdministration.maxSingleDose [ Quantity ]; # 0..1 The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement fhir:AdministrableProductDefinition.routeOfAdministration.maxDosePerDay [ Quantity ]; # 0..1 The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered fhir:AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod [ Ratio ]; # 0..1 The maximum dose per treatment period that can be administered fhir:AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod [ Duration ]; # 0..1 The maximum treatment period during which an Investigational Medicinal Product can be administered fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies [ # 0..* A species for which this route applies fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies.code [ CodeableConcept ]; # 1..1 Coded expression for the species fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod [ # 0..* A species specific time during which consumption of animal product is not appropriate fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue [ CodeableConcept ]; # 1..1 Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value [ Quantity ]; # 1..1 A value for the time fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation [ string ]; # 0..1 Extra information about the withdrawal period ], ...; ], ...; ], ...; ]
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AdministrableProductDefinition | TU | DomainResource | 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) Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
identifier | Σ | 0..* | Identifier | An identifier for the administrable product |
subject | Σ | 0..* | Reference(MedicinalProductDefinition) | 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 |
administrableDoseForm | Σ | 0..1 | CodeableConcept | The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing |
unitOfPresentation | Σ | 0..1 | CodeableConcept | The units of presentation for the administrable product, for example 'tablet' |
producedFrom | Σ | 0..* | Reference(ManufacturedItemDefinition) | 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 |
ingredient | Σ | 0..* | Reference(Ingredient) | The ingredients of this administrable medicinal product. Sometimes it may be appropriate to specify these via the associated manufactured item(s) |
device | Σ | 0..* | Reference(DeviceDefinition) | 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 |
property | Σ | 0..* | BackboneElement | Characteristics e.g. a products onset of action |
type | Σ | 1..1 | CodeableConcept | A code expressing the type of characteristic |
value[x] | Σ | 0..1 | A value for the characteristic | |
valueCodeableConcept | CodeableConcept | |||
valueQuantity | Quantity | |||
valueDate | date | |||
valueBoolean | boolean | |||
valueAttachment | Attachment | |||
status | Σ | 0..1 | CodeableConcept | The status of characteristic e.g. assigned or pending |
routeOfAdministration | Σ | 1..* | BackboneElement | 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 |
code | Σ | 1..1 | CodeableConcept | Coded expression for the route |
firstDose | Σ | 0..1 | Quantity | The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement |
maxSingleDose | Σ | 0..1 | Quantity | The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement |
maxDosePerDay | Σ | 0..1 | Quantity | The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered |
maxDosePerTreatmentPeriod | Σ | 0..1 | Ratio | The maximum dose per treatment period that can be administered |
maxTreatmentPeriod | Σ | 0..1 | Duration | The maximum treatment period during which an Investigational Medicinal Product can be administered |
targetSpecies | Σ | 0..* | BackboneElement | A species for which this route applies |
code | Σ | 1..1 | CodeableConcept | Coded expression for the species |
withdrawalPeriod | Σ | 0..* | BackboneElement | A species specific time during which consumption of animal product is not appropriate |
tissue | Σ | 1..1 | CodeableConcept | Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk |
value | Σ | 1..1 | Quantity | A value for the time |
supportingInformation | Σ | 0..1 | string | Extra information about the withdrawal period |
Documentation for this format |
XML Template
<AdministrableProductDefinition xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier An identifier for the administrable product --></identifier> <subject><!-- 0..* Reference(MedicinalProductDefinition) 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 --></subject> <administrableDoseForm><!-- 0..1 CodeableConcept The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing --></administrableDoseForm> <unitOfPresentation><!-- 0..1 CodeableConcept The units of presentation for the administrable product, for example 'tablet' --></unitOfPresentation> <producedFrom><!-- 0..* Reference(ManufacturedItemDefinition) 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 --></producedFrom> <ingredient><!-- 0..* Reference(Ingredient) The ingredients of this administrable medicinal product. Sometimes it may be appropriate to specify these via the associated manufactured item(s) --></ingredient> <device><!-- 0..* Reference(DeviceDefinition) 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 --></device> <property> <!-- 0..* Characteristics e.g. a products onset of action --> <type><!-- 1..1 CodeableConcept A code expressing the type of characteristic --></type> <value[x]><!-- 0..1 CodeableConcept|Quantity|date|boolean|Attachment A value for the characteristic --></value[x]> <status><!-- 0..1 CodeableConcept The status of characteristic e.g. assigned or pending --></status> </property> <routeOfAdministration> <!-- 1..* 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 --> <code><!-- 1..1 CodeableConcept Coded expression for the route --></code> <firstDose><!-- 0..1 Quantity The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement --></firstDose> <maxSingleDose><!-- 0..1 Quantity The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement --></maxSingleDose> <maxDosePerDay><!-- 0..1 Quantity The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered --></maxDosePerDay> <maxDosePerTreatmentPeriod><!-- 0..1 Ratio The maximum dose per treatment period that can be administered --></maxDosePerTreatmentPeriod> <maxTreatmentPeriod><!-- 0..1 Duration The maximum treatment period during which an Investigational Medicinal Product can be administered --></maxTreatmentPeriod> <targetSpecies> <!-- 0..* A species for which this route applies --> <code><!-- 1..1 CodeableConcept Coded expression for the species --></code> <withdrawalPeriod> <!-- 0..* A species specific time during which consumption of animal product is not appropriate --> <tissue><!-- 1..1 CodeableConcept Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk --></tissue> <value><!-- 1..1 Quantity A value for the time --></value> <supportingInformation value="[string]"/><!-- 0..1 Extra information about the withdrawal period --> </withdrawalPeriod> </targetSpecies> </routeOfAdministration> </AdministrableProductDefinition>
JSON Template
{ "resourceType" : "AdministrableProductDefinition", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // An identifier for the administrable product "subject" : [{ Reference(MedicinalProductDefinition) }], // 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 "administrableDoseForm" : { CodeableConcept }, // The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing "unitOfPresentation" : { CodeableConcept }, // The units of presentation for the administrable product, for example 'tablet' "producedFrom" : [{ Reference(ManufacturedItemDefinition) }], // 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 "ingredient" : [{ Reference(Ingredient) }], // The ingredients of this administrable medicinal product. Sometimes it may be appropriate to specify these via the associated manufactured item(s) "device" : [{ Reference(DeviceDefinition) }], // 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 "property" : [{ // Characteristics e.g. a products onset of action "type" : { CodeableConcept }, // R! A code expressing the type of characteristic // value[x]: A value for the characteristic. One of these 5: "valueCodeableConcept" : { CodeableConcept }, "valueQuantity" : { Quantity }, "valueDate" : "<date>", "valueBoolean" : <boolean>, "valueAttachment" : { Attachment }, "status" : { CodeableConcept } // The status of characteristic e.g. assigned or pending }], "routeOfAdministration" : [{ // R! 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 "code" : { CodeableConcept }, // R! Coded expression for the route "firstDose" : { Quantity }, // The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement "maxSingleDose" : { Quantity }, // The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement "maxDosePerDay" : { Quantity }, // The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered "maxDosePerTreatmentPeriod" : { Ratio }, // The maximum dose per treatment period that can be administered "maxTreatmentPeriod" : { Duration }, // The maximum treatment period during which an Investigational Medicinal Product can be administered "targetSpecies" : [{ // A species for which this route applies "code" : { CodeableConcept }, // R! Coded expression for the species "withdrawalPeriod" : [{ // A species specific time during which consumption of animal product is not appropriate "tissue" : { CodeableConcept }, // R! Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk "value" : { Quantity }, // R! A value for the time "supportingInformation" : "<string>" // Extra information about the withdrawal period }] }] }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:AdministrableProductDefinition; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:AdministrableProductDefinition.identifier [ Identifier ], ... ; # 0..* An identifier for the administrable product fhir:AdministrableProductDefinition.subject [ Reference(MedicinalProductDefinition) ], ... ; # 0..* 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 fhir:AdministrableProductDefinition.administrableDoseForm [ CodeableConcept ]; # 0..1 The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing fhir:AdministrableProductDefinition.unitOfPresentation [ CodeableConcept ]; # 0..1 The units of presentation for the administrable product, for example 'tablet' fhir:AdministrableProductDefinition.producedFrom [ Reference(ManufacturedItemDefinition) ], ... ; # 0..* 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 fhir:AdministrableProductDefinition.ingredient [ Reference(Ingredient) ], ... ; # 0..* The ingredients of this administrable medicinal product. Sometimes it may be appropriate to specify these via the associated manufactured item(s) fhir:AdministrableProductDefinition.device [ Reference(DeviceDefinition) ], ... ; # 0..* 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:AdministrableProductDefinition.property [ # 0..* Characteristics e.g. a products onset of action fhir:AdministrableProductDefinition.property.type [ CodeableConcept ]; # 1..1 A code expressing the type of characteristic # AdministrableProductDefinition.property.value[x] : 0..1 A value for the characteristic. One of these 5 fhir:AdministrableProductDefinition.property.valueCodeableConcept [ CodeableConcept ] fhir:AdministrableProductDefinition.property.valueQuantity [ Quantity ] fhir:AdministrableProductDefinition.property.valueDate [ date ] fhir:AdministrableProductDefinition.property.valueBoolean [ boolean ] fhir:AdministrableProductDefinition.property.valueAttachment [ Attachment ] fhir:AdministrableProductDefinition.property.status [ CodeableConcept ]; # 0..1 The status of characteristic e.g. assigned or pending ], ...; fhir:AdministrableProductDefinition.routeOfAdministration [ # 1..* 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 fhir:AdministrableProductDefinition.routeOfAdministration.code [ CodeableConcept ]; # 1..1 Coded expression for the route fhir:AdministrableProductDefinition.routeOfAdministration.firstDose [ Quantity ]; # 0..1 The first dose (dose quantity) administered can be specified for the product, using a numerical value and its unit of measurement fhir:AdministrableProductDefinition.routeOfAdministration.maxSingleDose [ Quantity ]; # 0..1 The maximum single dose that can be administered, can be specified using a numerical value and its unit of measurement fhir:AdministrableProductDefinition.routeOfAdministration.maxDosePerDay [ Quantity ]; # 0..1 The maximum dose per day (maximum dose quantity to be administered in any one 24-h period) that can be administered fhir:AdministrableProductDefinition.routeOfAdministration.maxDosePerTreatmentPeriod [ Ratio ]; # 0..1 The maximum dose per treatment period that can be administered fhir:AdministrableProductDefinition.routeOfAdministration.maxTreatmentPeriod [ Duration ]; # 0..1 The maximum treatment period during which an Investigational Medicinal Product can be administered fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies [ # 0..* A species for which this route applies fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies.code [ CodeableConcept ]; # 1..1 Coded expression for the species fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod [ # 0..* A species specific time during which consumption of animal product is not appropriate fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue [ CodeableConcept ]; # 1..1 Coded expression for the type of tissue for which the withdrawal period applues, e.g. meat, milk fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.value [ Quantity ]; # 1..1 A value for the time fhir:AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.supportingInformation [ string ]; # 0..1 Extra information about the withdrawal period ], ...; ], ...; ], ...; ]
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis a
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
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 (DeviceDefinition) | |
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 | reference | The ingredients of this administrable medicinal product. Sometimes it may be appropriate to specify these via the associated manufactured item(s) | AdministrableProductDefinition.ingredient (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 (ManufacturedItemDefinition) | |
route | token | Coded expression for the route | AdministrableProductDefinition.routeOfAdministration.code | |
subject | 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.subject (MedicinalProductDefinition) | |
target-species | token | Coded expression for the species | AdministrableProductDefinition.routeOfAdministration.targetSpecies.code |