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 Detail

      • 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.
    • Method Detail

      • 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
      • 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
      • 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
      • 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
      • 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
      • 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
      • isEmpty

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