Class Ingredient

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

public class Ingredient extends DomainResource
An ingredient of a manufactured item or pharmaceutical product.
See Also:
  • Field Details

    • identifier

      The identifier(s) of this Ingredient that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.
    • status

      The status of this ingredient. Enables tracking the life-cycle of the content.
    • for_

      protected List<Reference> for_
      The product which this ingredient is a constituent part of.
    • role

      protected CodeableConcept role
      A classification of the ingredient identifying its purpose within the product, e.g. active, inactive.
    • function

      A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: antioxidant, alkalizing agent.
    • group

      A classification of the ingredient according to where in the physical item it tends to be used, such the outer shell of a tablet, inner body or ink.
    • allergenicIndicator

      If the ingredient is a known or suspected allergen. Note that this is a property of the substance, so if a reference to a SubstanceDefinition is used to decribe that (rather than just a code), the allergen information should go there, not here.
    • comment

      protected MarkdownType comment
      A place for providing any notes that are relevant to the component, e.g. removed during process, adjusted for loss on drying.
    • manufacturer

      The organization(s) that manufacture this ingredient. Can be used to indicate: 1) Organizations we are aware of that manufacture this ingredient 2) Specific Manufacturer(s) currently being used 3) Set of organisations allowed to manufacture this ingredient for this product Users must be clear on the application of context relevant to their use case.
    • substance

      The substance that comprises this ingredient.
    • SP_FOR

      public static final String SP_FOR
      Search parameter: for

      Description: The product which this ingredient is a constituent part of
      Type: reference
      Path: Ingredient.for

      See Also:
    • FOR

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

      Description: The product which this ingredient is a constituent part of
      Type: reference
      Path: Ingredient.for

    • INCLUDE_FOR

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

      public static final String SP_FUNCTION
      Search parameter: function

      Description: A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent
      Type: token
      Path: Ingredient.function

      See Also:
    • FUNCTION

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

      Description: A classification of the ingredient identifying its precise purpose(s) in the drug product. This extends the Ingredient.role to add more detail. Example: Antioxidant, Alkalizing Agent
      Type: token
      Path: Ingredient.function

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: An identifier or code by which the ingredient can be referenced
      Type: token
      Path: Ingredient.identifier

      See Also:
    • IDENTIFIER

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

      Description: An identifier or code by which the ingredient can be referenced
      Type: token
      Path: Ingredient.identifier

    • SP_MANUFACTURER

      public static final String SP_MANUFACTURER
      Search parameter: manufacturer

      Description: The organization that manufactures this ingredient
      Type: reference
      Path: Ingredient.manufacturer.manufacturer

      See Also:
    • MANUFACTURER

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

      Description: The organization that manufactures this ingredient
      Type: reference
      Path: Ingredient.manufacturer.manufacturer

    • INCLUDE_MANUFACTURER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_MANUFACTURER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Ingredient:manufacturer".
    • SP_ROLE

      public static final String SP_ROLE
      Search parameter: role

      Description: A classification of the ingredient identifying its purpose within the product, e.g. active, inactive
      Type: token
      Path: Ingredient.role

      See Also:
    • ROLE

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

      Description: A classification of the ingredient identifying its purpose within the product, e.g. active, inactive
      Type: token
      Path: Ingredient.role

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The status of this ingredient. Enables tracking the life-cycle of the content
      Type: token
      Path: Ingredient.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 ingredient. Enables tracking the life-cycle of the content
      Type: token
      Path: Ingredient.status

    • SP_STRENGTH_CONCENTRATION_QUANTITY

      Search parameter: strength-concentration-quantity

      Description: Ingredient concentration strength as quantity
      Type: quantity
      Path: Ingredient.substance.strength.concentration.ofType(Quantity)

      See Also:
    • STRENGTH_CONCENTRATION_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam STRENGTH_CONCENTRATION_QUANTITY
      Fluent Client search parameter constant for strength-concentration-quantity

      Description: Ingredient concentration strength as quantity
      Type: quantity
      Path: Ingredient.substance.strength.concentration.ofType(Quantity)

    • SP_STRENGTH_PRESENTATION_QUANTITY

      Search parameter: strength-presentation-quantity

      Description: Ingredient presentation strength as quantity
      Type: quantity
      Path: Ingredient.substance.strength.presentation.ofType(Quantity)

      See Also:
    • STRENGTH_PRESENTATION_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam STRENGTH_PRESENTATION_QUANTITY
      Fluent Client search parameter constant for strength-presentation-quantity

      Description: Ingredient presentation strength as quantity
      Type: quantity
      Path: Ingredient.substance.strength.presentation.ofType(Quantity)

    • SP_SUBSTANCE_CODE

      public static final String SP_SUBSTANCE_CODE
      Search parameter: substance-code

      Description: Reference to a concept (by class)
      Type: token
      Path: Ingredient.substance.code.concept

      See Also:
    • SUBSTANCE_CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam SUBSTANCE_CODE
      Fluent Client search parameter constant for substance-code

      Description: Reference to a concept (by class)
      Type: token
      Path: Ingredient.substance.code.concept

    • SP_SUBSTANCE_DEFINITION

      public static final String SP_SUBSTANCE_DEFINITION
      Search parameter: substance-definition

      Description: Reference to a resource (by instance)
      Type: reference
      Path: Ingredient.substance.code.reference

      See Also:
    • SUBSTANCE_DEFINITION

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBSTANCE_DEFINITION
      Fluent Client search parameter constant for substance-definition

      Description: Reference to a resource (by instance)
      Type: reference
      Path: Ingredient.substance.code.reference

    • INCLUDE_SUBSTANCE_DEFINITION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBSTANCE_DEFINITION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Ingredient:substance-definition".
    • SP_SUBSTANCE

      public static final String SP_SUBSTANCE
      Search parameter: substance

      Description: Reference to a resource (by instance)
      Type: reference
      Path: Ingredient.substance.code.reference

      See Also:
    • SUBSTANCE

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

      Description: Reference to a resource (by instance)
      Type: reference
      Path: Ingredient.substance.code.reference

    • INCLUDE_SUBSTANCE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBSTANCE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Ingredient:substance".
  • Constructor Details

  • Method Details