Class Substance

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 Substance extends DomainResource
A homogeneous material with a definite composition.
See Also:
Serialized Form
  • Field Details

    • identifier

      Unique identifier for the substance. For an instance, an identifier associated with the package/container (usually a label affixed directly).
    • instance

      protected BooleanType instance
      A boolean to indicate if this an instance of a substance or a kind of one (a definition).
    • status

      A code to indicate if the substance is actively used.
    • category

      A code that classifies the general type of substance. This is used for searching, sorting and display purposes.
    • code

      A code (or set of codes) that identify this substance.
    • description

      A description of the substance - its appearance, handling requirements, and other usage notes.
    • expiry

      protected DateTimeType expiry
      When the substance is no longer valid to use. For some substances, a single arbitrary date is used for expiry.
    • quantity

      protected Quantity quantity
      The amount of the substance.
    • ingredient

      A substance can be composed of other substances.
    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter: category

      Description: The category of the substance
      Type: token
      Path: Substance.category

      See Also:
      Constant Field Values
    • CATEGORY

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

      Description: The category of the substance
      Type: token
      Path: Substance.category

    • SP_CODE_REFERENCE

      public static final String SP_CODE_REFERENCE
      Search parameter: code-reference

      Description: A reference to the defining substance
      Type: reference
      Path: Substance.code.reference

      See Also:
      Constant Field Values
    • CODE_REFERENCE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CODE_REFERENCE
      Fluent Client search parameter constant for code-reference

      Description: A reference to the defining substance
      Type: reference
      Path: Substance.code.reference

    • INCLUDE_CODE_REFERENCE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_CODE_REFERENCE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Substance:code-reference".
    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: The code of the substance or ingredient
      Type: token
      Path: Substance.code.concept | (Substance.ingredient.substance as CodeableConcept)

      See Also:
      Constant Field Values
    • CODE

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

      Description: The code of the substance or ingredient
      Type: token
      Path: Substance.code.concept | (Substance.ingredient.substance as CodeableConcept)

    • SP_EXPIRY

      public static final String SP_EXPIRY
      Search parameter: expiry

      Description: Expiry date of package or container of substance
      Type: date
      Path: Substance.expiry

      See Also:
      Constant Field Values
    • EXPIRY

      public static final ca.uhn.fhir.rest.gclient.DateClientParam EXPIRY
      Fluent Client search parameter constant for expiry

      Description: Expiry date of package or container of substance
      Type: date
      Path: Substance.expiry

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: Unique identifier for the substance
      Type: token
      Path: Substance.identifier

      See Also:
      Constant Field Values
    • IDENTIFIER

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

      Description: Unique identifier for the substance
      Type: token
      Path: Substance.identifier

    • SP_QUANTITY

      public static final String SP_QUANTITY
      Search parameter: quantity

      Description: Amount of substance in the package
      Type: quantity
      Path: Substance.quantity

      See Also:
      Constant Field Values
    • QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam QUANTITY
      Fluent Client search parameter constant for quantity

      Description: Amount of substance in the package
      Type: quantity
      Path: Substance.quantity

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: active | inactive | entered-in-error
      Type: token
      Path: Substance.status

      See Also:
      Constant Field Values
    • STATUS

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

      Description: active | inactive | entered-in-error
      Type: token
      Path: Substance.status

    • SP_SUBSTANCE_REFERENCE

      public static final String SP_SUBSTANCE_REFERENCE
      Search parameter: substance-reference

      Description: A component of the substance
      Type: reference
      Path: (Substance.ingredient.substance as Reference)

      See Also:
      Constant Field Values
    • SUBSTANCE_REFERENCE

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

      Description: A component of the substance
      Type: reference
      Path: (Substance.ingredient.substance as Reference)

    • INCLUDE_SUBSTANCE_REFERENCE

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

  • Method Details