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

15.5 Resource AdministrableProductDefinition - Content

Biomedical Research and Regulation icon

Work Group

Maturity Level: 2

Trial Use

Security Category: Anonymous

Compartments: No 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).

15.5.1 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.

15.5.2 References to this Resource

Resource References: ActivityDefinition, Ingredient and PlanDefinition

Structure

Name	Flags	Card.	Type	Description & Constraints
AdministrableProductDefinition	TU		DomainResource	A medicinal product in the final form, suitable for administration - after any mixing of multiple components + Rule: RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa) Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..*	Identifier	An identifier for the administrable product
status	?!Σ	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (Required)
formOf	Σ C	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
administrableDoseForm	Σ	0..1	CodeableConcept	The dose form of the final product after necessary reconstitution or processing Binding: Administrable Dose Form (Example)
unitOfPresentation	Σ	0..1	CodeableConcept	The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: Unit Of Presentation (Example)
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
ingredient	Σ	0..*	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: SNOMED CT Substance Codes (Example)
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
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
property	Σ	0..*	BackboneElement	Characteristics e.g. a product's onset of action
type	Σ	1..1	CodeableConcept	A code expressing the type of characteristic Binding: Product Characteristic (Example)
value[x]	Σ	0..1		A value for the characteristic
valueCodeableConcept			CodeableConcept
valueQuantity			Quantity
valueDate			date
valueBoolean			boolean
valueMarkdown			markdown
valueAttachment			Attachment
valueReference			Reference(Binary)
status	Σ	0..1	CodeableConcept	The status of characteristic e.g. assigned or pending Binding: PublicationStatus (Required)
routeOfAdministration	Σ	1..*	BackboneElement	The path by which the product is taken into or makes contact with the body
code	Σ	1..1	CodeableConcept	Coded expression for the route Binding: SNOMED CT Route Codes (Example)
firstDose	Σ	0..1	Quantity	The first dose (dose quantity) administered can be specified for the product
maxSingleDose	Σ	0..1	Quantity	The maximum single dose that can be administered
maxDosePerDay	Σ	0..1	Quantity	The maximum dose quantity to be administered in any one 24-h period
maxDosePerTreatmentPeriod	Σ	0..1	Ratio	The maximum dose per treatment period that can be administered
maxTreatmentPeriod	Σ	0..1	Duration	The maximum treatment period during which the product can be administered
targetSpecies	Σ	0..*	BackboneElement	A species for which this route applies
code	Σ	1..1	CodeableConcept	Coded expression for the species Binding: Target Species (Example)
withdrawalPeriod	Σ	0..*	BackboneElement	A species specific time during which consumption of animal product is not appropriate
tissue	Σ	1..1	CodeableConcept	The type of tissue for which the withdrawal period applies, e.g. meat, milk Binding: Animal Tissue Type (Example)
value	Σ	1..1	Quantity	A value for the time
supportingInformation	Σ	0..1	string	Extra information about the withdrawal period
Documentation for this format

See the Extensions for this resource

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>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <formOf><!-- I 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 --></formOf>
 <administrableDoseForm><!-- 0..1 CodeableConcept The dose form of the final product after necessary reconstitution or processing --></administrableDoseForm>
 <unitOfPresentation><!-- 0..1 CodeableConcept The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' --></unitOfPresentation>
 <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 --></producedFrom>
 <ingredient><!-- 0..* 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 --></ingredient>
 <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 --></device>
 <description value="[markdown]"/><!-- 0..1 A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed -->
 <property>  <!-- 0..* Characteristics e.g. a product's onset of action -->
  <type><!-- 1..1 CodeableConcept A code expressing the type of characteristic --></type>
  <value[x]><!-- 0..1 CodeableConcept|Quantity|date|boolean|markdown|Attachment|
    Reference(Binary) 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 -->
  <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 --></firstDose>
  <maxSingleDose><!-- 0..1 Quantity The maximum single dose that can be administered --></maxSingleDose>
  <maxDosePerDay><!-- 0..1 Quantity The maximum dose quantity to be administered in any one 24-h period --></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 the 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 The type of tissue for which the withdrawal period applies, 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
  "status" : "<code>", // R!  draft | active | retired | unknown
  "formOf" : [{ Reference(MedicinalProductDefinition) }], // I 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
  "administrableDoseForm" : { CodeableConcept }, // The dose form of the final product after necessary reconstitution or processing
  "unitOfPresentation" : { CodeableConcept }, // The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
  "producedFrom" : [{ 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
  "ingredient" : [{ 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
  "device" : { Reference(DeviceDefinition) }, // A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
  "description" : "<markdown>", // A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed
  "property" : [{ // Characteristics e.g. a product's onset of action
    "type" : { CodeableConcept }, // R!  A code expressing the type of characteristic
    // value[x]: A value for the characteristic. One of these 7:
    "valueCodeableConcept" : { CodeableConcept },
    "valueQuantity" : { Quantity },
    "valueDate" : "<date>",
    "valueBoolean" : <boolean>,
    "valueMarkdown" : "<markdown>",
    "valueAttachment" : { Attachment },
    "valueReference" : { Reference(Binary) },
    "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
    "code" : { CodeableConcept }, // R!  Coded expression for the route
    "firstDose" : { Quantity }, // The first dose (dose quantity) administered can be specified for the product
    "maxSingleDose" : { Quantity }, // The maximum single dose that can be administered
    "maxDosePerDay" : { Quantity }, // The maximum dose quantity to be administered in any one 24-h period
    "maxDosePerTreatmentPeriod" : { Ratio }, // The maximum dose per treatment period that can be administered
    "maxTreatmentPeriod" : { Duration }, // The maximum treatment period during which the 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!  The type of tissue for which the withdrawal period applies, 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:identifier  ( [ Identifier ] ... ) ; # 0..* An identifier for the administrable product
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:formOf  ( [ Reference(MedicinalProductDefinition) ] ... ) ; # 0..* I 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
  fhir:administrableDoseForm [ CodeableConcept ] ; # 0..1 The dose form of the final product after necessary reconstitution or processing
  fhir:unitOfPresentation [ CodeableConcept ] ; # 0..1 The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
  fhir:producedFrom  ( [ Reference(ManufacturedItemDefinition) ] ... ) ; # 0..* Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
  fhir:ingredient  ( [ CodeableConcept ] ... ) ; # 0..* 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
  fhir:device [ Reference(DeviceDefinition) ] ; # 0..1 A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
  fhir:description [ markdown ] ; # 0..1 A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed
  fhir:property ( [ # 0..* Characteristics e.g. a product's onset of action
    fhir:type [ CodeableConcept ] ; # 1..1 A code expressing the type of characteristic
    # value[x] : 0..1 A value for the characteristic. One of these 7
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:date ; date ]
      fhir:value [  a fhir:boolean ; boolean ]
      fhir:value [  a fhir:markdown ; markdown ]
      fhir:value [  a fhir:Attachment ; Attachment ]
      fhir:value [  a fhir:Reference ; Reference(Binary) ]
    fhir:status [ CodeableConcept ] ; # 0..1 The status of characteristic e.g. assigned or pending
  ] ... ) ;
  fhir:routeOfAdministration ( [ # 1..* The path by which the product is taken into or makes contact with the body
    fhir:code [ CodeableConcept ] ; # 1..1 Coded expression for the route
    fhir:firstDose [ Quantity ] ; # 0..1 The first dose (dose quantity) administered can be specified for the product
    fhir:maxSingleDose [ Quantity ] ; # 0..1 The maximum single dose that can be administered
    fhir:maxDosePerDay [ Quantity ] ; # 0..1 The maximum dose quantity to be administered in any one 24-h period
    fhir:maxDosePerTreatmentPeriod [ Ratio ] ; # 0..1 The maximum dose per treatment period that can be administered
    fhir:maxTreatmentPeriod [ Duration ] ; # 0..1 The maximum treatment period during which the product can be administered
    fhir:targetSpecies ( [ # 0..* A species for which this route applies
      fhir:code [ CodeableConcept ] ; # 1..1 Coded expression for the species
      fhir:withdrawalPeriod ( [ # 0..* A species specific time during which consumption of animal product is not appropriate
        fhir:tissue [ CodeableConcept ] ; # 1..1 The type of tissue for which the withdrawal period applies, e.g. meat, milk
        fhir:value [ Quantity ] ; # 1..1 A value for the time
        fhir:supportingInformation [ string ] ; # 0..1 Extra information about the withdrawal period
      ] ... ) ;
    ] ... ) ;
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints
AdministrableProductDefinition	TU		DomainResource	A medicinal product in the final form, suitable for administration - after any mixing of multiple components + Rule: RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa) Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
identifier	Σ	0..*	Identifier	An identifier for the administrable product
status	?!Σ	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (Required)
formOf	Σ C	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
administrableDoseForm	Σ	0..1	CodeableConcept	The dose form of the final product after necessary reconstitution or processing Binding: Administrable Dose Form (Example)
unitOfPresentation	Σ	0..1	CodeableConcept	The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' Binding: Unit Of Presentation (Example)
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
ingredient	Σ	0..*	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: SNOMED CT Substance Codes (Example)
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
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
property	Σ	0..*	BackboneElement	Characteristics e.g. a product's onset of action
type	Σ	1..1	CodeableConcept	A code expressing the type of characteristic Binding: Product Characteristic (Example)
value[x]	Σ	0..1		A value for the characteristic
valueCodeableConcept			CodeableConcept
valueQuantity			Quantity
valueDate			date
valueBoolean			boolean
valueMarkdown			markdown
valueAttachment			Attachment
valueReference			Reference(Binary)
status	Σ	0..1	CodeableConcept	The status of characteristic e.g. assigned or pending Binding: PublicationStatus (Required)
routeOfAdministration	Σ	1..*	BackboneElement	The path by which the product is taken into or makes contact with the body
code	Σ	1..1	CodeableConcept	Coded expression for the route Binding: SNOMED CT Route Codes (Example)
firstDose	Σ	0..1	Quantity	The first dose (dose quantity) administered can be specified for the product
maxSingleDose	Σ	0..1	Quantity	The maximum single dose that can be administered
maxDosePerDay	Σ	0..1	Quantity	The maximum dose quantity to be administered in any one 24-h period
maxDosePerTreatmentPeriod	Σ	0..1	Ratio	The maximum dose per treatment period that can be administered
maxTreatmentPeriod	Σ	0..1	Duration	The maximum treatment period during which the product can be administered
targetSpecies	Σ	0..*	BackboneElement	A species for which this route applies
code	Σ	1..1	CodeableConcept	Coded expression for the species Binding: Target Species (Example)
withdrawalPeriod	Σ	0..*	BackboneElement	A species specific time during which consumption of animal product is not appropriate
tissue	Σ	1..1	CodeableConcept	The type of tissue for which the withdrawal period applies, e.g. meat, milk Binding: Animal Tissue Type (Example)
value	Σ	1..1	Quantity	A value for the time
supportingInformation	Σ	0..1	string	Extra information about the withdrawal period
Documentation for this format

See the Extensions for this resource

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>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <formOf><!-- I 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 --></formOf>
 <administrableDoseForm><!-- 0..1 CodeableConcept The dose form of the final product after necessary reconstitution or processing --></administrableDoseForm>
 <unitOfPresentation><!-- 0..1 CodeableConcept The presentation type in which this item is given to a patient. e.g. for a spray - 'puff' --></unitOfPresentation>
 <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 --></producedFrom>
 <ingredient><!-- 0..* 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 --></ingredient>
 <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 --></device>
 <description value="[markdown]"/><!-- 0..1 A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed -->
 <property>  <!-- 0..* Characteristics e.g. a product's onset of action -->
  <type><!-- 1..1 CodeableConcept A code expressing the type of characteristic --></type>
  <value[x]><!-- 0..1 CodeableConcept|Quantity|date|boolean|markdown|Attachment|
    Reference(Binary) 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 -->
  <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 --></firstDose>
  <maxSingleDose><!-- 0..1 Quantity The maximum single dose that can be administered --></maxSingleDose>
  <maxDosePerDay><!-- 0..1 Quantity The maximum dose quantity to be administered in any one 24-h period --></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 the 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 The type of tissue for which the withdrawal period applies, 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
  "status" : "<code>", // R!  draft | active | retired | unknown
  "formOf" : [{ Reference(MedicinalProductDefinition) }], // I 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
  "administrableDoseForm" : { CodeableConcept }, // The dose form of the final product after necessary reconstitution or processing
  "unitOfPresentation" : { CodeableConcept }, // The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
  "producedFrom" : [{ 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
  "ingredient" : [{ 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
  "device" : { Reference(DeviceDefinition) }, // A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
  "description" : "<markdown>", // A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed
  "property" : [{ // Characteristics e.g. a product's onset of action
    "type" : { CodeableConcept }, // R!  A code expressing the type of characteristic
    // value[x]: A value for the characteristic. One of these 7:
    "valueCodeableConcept" : { CodeableConcept },
    "valueQuantity" : { Quantity },
    "valueDate" : "<date>",
    "valueBoolean" : <boolean>,
    "valueMarkdown" : "<markdown>",
    "valueAttachment" : { Attachment },
    "valueReference" : { Reference(Binary) },
    "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
    "code" : { CodeableConcept }, // R!  Coded expression for the route
    "firstDose" : { Quantity }, // The first dose (dose quantity) administered can be specified for the product
    "maxSingleDose" : { Quantity }, // The maximum single dose that can be administered
    "maxDosePerDay" : { Quantity }, // The maximum dose quantity to be administered in any one 24-h period
    "maxDosePerTreatmentPeriod" : { Ratio }, // The maximum dose per treatment period that can be administered
    "maxTreatmentPeriod" : { Duration }, // The maximum treatment period during which the 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!  The type of tissue for which the withdrawal period applies, 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:identifier  ( [ Identifier ] ... ) ; # 0..* An identifier for the administrable product
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:formOf  ( [ Reference(MedicinalProductDefinition) ] ... ) ; # 0..* I 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
  fhir:administrableDoseForm [ CodeableConcept ] ; # 0..1 The dose form of the final product after necessary reconstitution or processing
  fhir:unitOfPresentation [ CodeableConcept ] ; # 0..1 The presentation type in which this item is given to a patient. e.g. for a spray - 'puff'
  fhir:producedFrom  ( [ Reference(ManufacturedItemDefinition) ] ... ) ; # 0..* Indicates the specific manufactured items that are part of the 'formOf' product that are used in the preparation of this specific administrable form
  fhir:ingredient  ( [ CodeableConcept ] ... ) ; # 0..* 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
  fhir:device [ Reference(DeviceDefinition) ] ; # 0..1 A device that is integral to the medicinal product, in effect being considered as an "ingredient" of the medicinal product
  fhir:description [ markdown ] ; # 0..1 A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed
  fhir:property ( [ # 0..* Characteristics e.g. a product's onset of action
    fhir:type [ CodeableConcept ] ; # 1..1 A code expressing the type of characteristic
    # value[x] : 0..1 A value for the characteristic. One of these 7
      fhir:value [  a fhir:CodeableConcept ; CodeableConcept ]
      fhir:value [  a fhir:Quantity ; Quantity ]
      fhir:value [  a fhir:date ; date ]
      fhir:value [  a fhir:boolean ; boolean ]
      fhir:value [  a fhir:markdown ; markdown ]
      fhir:value [  a fhir:Attachment ; Attachment ]
      fhir:value [  a fhir:Reference ; Reference(Binary) ]
    fhir:status [ CodeableConcept ] ; # 0..1 The status of characteristic e.g. assigned or pending
  ] ... ) ;
  fhir:routeOfAdministration ( [ # 1..* The path by which the product is taken into or makes contact with the body
    fhir:code [ CodeableConcept ] ; # 1..1 Coded expression for the route
    fhir:firstDose [ Quantity ] ; # 0..1 The first dose (dose quantity) administered can be specified for the product
    fhir:maxSingleDose [ Quantity ] ; # 0..1 The maximum single dose that can be administered
    fhir:maxDosePerDay [ Quantity ] ; # 0..1 The maximum dose quantity to be administered in any one 24-h period
    fhir:maxDosePerTreatmentPeriod [ Ratio ] ; # 0..1 The maximum dose per treatment period that can be administered
    fhir:maxTreatmentPeriod [ Duration ] ; # 0..1 The maximum treatment period during which the product can be administered
    fhir:targetSpecies ( [ # 0..* A species for which this route applies
      fhir:code [ CodeableConcept ] ; # 1..1 Coded expression for the species
      fhir:withdrawalPeriod ( [ # 0..* A species specific time during which consumption of animal product is not appropriate
        fhir:tissue [ CodeableConcept ] ; # 1..1 The type of tissue for which the withdrawal period applies, e.g. meat, milk
        fhir:value [ Quantity ] ; # 1..1 A value for the time
        fhir:supportingInformation [ string ] ; # 0..1 Extra information about the withdrawal period
      ] ... ) ;
    ] ... ) ;
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

15.5.3.1 Terminology Bindings

Path	ValueSet	Type	Documentation
AdministrableProductDefinition.status	PublicationStatus	Required	The lifecycle status of an artifact.
AdministrableProductDefinition.administrableDoseForm	AdministrableDoseForm	Example	Dose form for a medication, in the form suitable for administering to the patient, after mixing, where necessary.
AdministrableProductDefinition.unitOfPresentation	UnitOfPresentation	Example	The presentation type in which an administrable medicinal product is given to a patient.
AdministrableProductDefinition.ingredient	SNOMEDCTSubstanceCodes	Example	This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.
AdministrableProductDefinition.property.type	ProductCharacteristic	Example	This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.
AdministrableProductDefinition.property.status	PublicationStatus	Required	The lifecycle status of an artifact.
AdministrableProductDefinition.routeOfAdministration.code	SNOMEDCTRouteCodes	Example	This value set includes all Route codes from SNOMED CT - provided as an exemplar.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.code	TargetSpecies	Example	A species for which a medicinal product is intended.
AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue	AnimalTissueType	Example	A tissue type of an animal.

Path

ValueSet

Type

Documentation

AdministrableProductDefinition.status

PublicationStatus

Required

The lifecycle status of an artifact.

AdministrableProductDefinition.administrableDoseForm

AdministrableDoseForm

Example

Dose form for a medication, in the form suitable for administering to the patient, after mixing, where necessary.

AdministrableProductDefinition.unitOfPresentation

UnitOfPresentation

Example

The presentation type in which an administrable medicinal product is given to a patient.

AdministrableProductDefinition.ingredient

SNOMEDCTSubstanceCodes

Example

This value set includes all substance codes from SNOMED CT - provided as an exemplar value set.

AdministrableProductDefinition.property.type

ProductCharacteristic

Example

This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.

AdministrableProductDefinition.property.status

PublicationStatus

Required

The lifecycle status of an artifact.

AdministrableProductDefinition.routeOfAdministration.code

SNOMEDCTRouteCodes

Example

This value set includes all Route codes from SNOMED CT - provided as an exemplar.

AdministrableProductDefinition.routeOfAdministration.targetSpecies.code

TargetSpecies

Example

A species for which a medicinal product is intended.

AdministrableProductDefinition.routeOfAdministration.targetSpecies.withdrawalPeriod.tissue

AnimalTissueType

Example

A tissue type of an animal.

15.5.3.2 Constraints

UniqueKey

Level

Location

Description

Expression

apd-1

Rule

(base)

RouteOfAdministration cannot be used when the 'formOf' product already uses MedicinalProductDefinition.route (and vice versa)

AdministrableProductDefinition.formOf.resolve().route.empty()

15.5.4 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to 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
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 (MedicinalProductDefinition)
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 (ManufacturedItemDefinition)
route	token	Coded expression for the route	AdministrableProductDefinition.routeOfAdministration.code
status	token	The status of this administrable product. Enables tracking the life-cycle of the content.	AdministrableProductDefinition.status
target-species	token	Coded expression for the species	AdministrableProductDefinition.routeOfAdministration.targetSpecies.code