Class AdministrableProductDefinition

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

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).
See Also:
  • Field Details

    • identifier

      An identifier for the administrable product.
    • status

      The status of this administrable product. Enables tracking the life-cycle of the content.
    • formOf

      protected List<Reference> 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.
    • 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').
    • unitOfPresentation

      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').
    • 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.
    • 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.
    • device

      protected Reference device
      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.
    • description

      A general description of the product, when in its final form, suitable for administration e.g. effervescent blue liquid, to be swallowed. Intended to be used when the other structured properties of this resource are insufficient or cannot be supported. It is not intended to duplicate information already carried elswehere.
    • property

      Characteristics e.g. a product's onset of action.
    • 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).
    • SP_DEVICE

      public static final String SP_DEVICE
      Search parameter: device

      Description: 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
      Type: reference
      Path: AdministrableProductDefinition.device

      See Also:
    • DEVICE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE
      Fluent Client search parameter constant for device

      Description: 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
      Type: reference
      Path: AdministrableProductDefinition.device

    • INCLUDE_DEVICE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DEVICE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "AdministrableProductDefinition:device".
    • SP_DOSE_FORM

      public static final String SP_DOSE_FORM
      Search parameter: dose-form

      Description: The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing
      Type: token
      Path: AdministrableProductDefinition.administrableDoseForm

      See Also:
    • DOSE_FORM

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam DOSE_FORM
      Fluent Client search parameter constant for dose-form

      Description: The administrable dose form, i.e. the dose form of the final product after necessary reconstitution or processing
      Type: token
      Path: AdministrableProductDefinition.administrableDoseForm

    • SP_FORM_OF

      public static final String SP_FORM_OF
      Search parameter: form-of

      Description: 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
      Type: reference
      Path: AdministrableProductDefinition.formOf

      See Also:
    • FORM_OF

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam FORM_OF
      Fluent Client search parameter constant for form-of

      Description: 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
      Type: reference
      Path: AdministrableProductDefinition.formOf

    • INCLUDE_FORM_OF

      public static final ca.uhn.fhir.model.api.Include INCLUDE_FORM_OF
      Constant for fluent queries to be used to add include statements. Specifies the path value of "AdministrableProductDefinition:form-of".
    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: An identifier for the administrable product
      Type: token
      Path: AdministrableProductDefinition.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: An identifier for the administrable product
      Type: token
      Path: AdministrableProductDefinition.identifier

    • SP_INGREDIENT

      public static final String SP_INGREDIENT
      Search parameter: ingredient

      Description: The ingredients of this administrable medicinal product
      Type: token
      Path: AdministrableProductDefinition.ingredient

      See Also:
    • INGREDIENT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam INGREDIENT
      Fluent Client search parameter constant for ingredient

      Description: The ingredients of this administrable medicinal product
      Type: token
      Path: AdministrableProductDefinition.ingredient

    • SP_MANUFACTURED_ITEM

      public static final String SP_MANUFACTURED_ITEM
      Search parameter: manufactured-item

      Description: 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
      Type: reference
      Path: AdministrableProductDefinition.producedFrom

      See Also:
    • MANUFACTURED_ITEM

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MANUFACTURED_ITEM
      Fluent Client search parameter constant for manufactured-item

      Description: 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
      Type: reference
      Path: AdministrableProductDefinition.producedFrom

    • INCLUDE_MANUFACTURED_ITEM

      public static final ca.uhn.fhir.model.api.Include INCLUDE_MANUFACTURED_ITEM
      Constant for fluent queries to be used to add include statements. Specifies the path value of "AdministrableProductDefinition:manufactured-item".
    • SP_ROUTE

      public static final String SP_ROUTE
      Search parameter: route

      Description: Coded expression for the route
      Type: token
      Path: AdministrableProductDefinition.routeOfAdministration.code

      See Also:
    • ROUTE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam ROUTE
      Fluent Client search parameter constant for route

      Description: Coded expression for the route
      Type: token
      Path: AdministrableProductDefinition.routeOfAdministration.code

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The status of this administrable product. Enables tracking the life-cycle of the content.
      Type: token
      Path: AdministrableProductDefinition.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The status of this administrable product. Enables tracking the life-cycle of the content.
      Type: token
      Path: AdministrableProductDefinition.status

    • SP_TARGET_SPECIES

      public static final String SP_TARGET_SPECIES
      Search parameter: target-species

      Description: Coded expression for the species
      Type: token
      Path: AdministrableProductDefinition.routeOfAdministration.targetSpecies.code

      See Also:
    • TARGET_SPECIES

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TARGET_SPECIES
      Fluent Client search parameter constant for target-species

      Description: Coded expression for the species
      Type: token
      Path: AdministrableProductDefinition.routeOfAdministration.targetSpecies.code

  • Constructor Details

  • Method Details