Class UsageContext

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class UsageContext extends Type implements org.hl7.fhir.instance.model.api.ICompositeType
Specifies clinical/business/etc metadata that can be used to retrieve, index and/or categorize an artifact. This metadata can either be specific to the applicable population (e.g., age category, DRG) or the specific context of care (e.g., venue, care setting, provider of care).
See Also:
Serialized Form
  • Field Details

    • code

      protected Coding code
      A code that identifies the type of context being specified by this usage context.
    • value

      protected Type value
      A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.
  • Constructor Details

  • Method Details

    • getCode

      public Coding getCode()
      Returns:
      code (A code that identifies the type of context being specified by this usage context.)
    • hasCode

      public boolean hasCode()
    • setCode

      public UsageContext setCode(Coding value)
      Parameters:
      value - code (A code that identifies the type of context being specified by this usage context.)
    • getValue

      public Type getValue()
      Returns:
      value (A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.)
    • getValueCodeableConcept

      public CodeableConcept getValueCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      value (A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • hasValueCodeableConcept

      public boolean hasValueCodeableConcept()
    • getValueQuantity

      public Quantity getValueQuantity() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      value (A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • hasValueQuantity

      public boolean hasValueQuantity()
    • getValueRange

      public Range getValueRange() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      value (A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • hasValueRange

      public boolean hasValueRange()
    • hasValue

      public boolean hasValue()
    • setValue

      public UsageContext setValue(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
      Parameters:
      value - value (A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.)
      Throws:
      org.hl7.fhir.exceptions.FHIRFormatError
    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Element
    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • getProperty

      public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class Element
    • copy

      public UsageContext copy()
      Overrides:
      copy in class Type
    • typedCopy

      protected UsageContext typedCopy()
      Specified by:
      typedCopy in class Type
    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Element
    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Element
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class Element