Class OperationOutcome.Issue

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
    Enclosing class:
    OperationOutcome

    public static class OperationOutcome.Issue
    extends ca.uhn.fhir.model.base.resource.BaseOperationOutcome.BaseIssue
    implements ca.uhn.fhir.model.api.IResourceBlock
    Block class for child element: OperationOutcome.issue ()

    Definition: An error, warning or information message that results from a system action

    See Also:
    Serialized Form
    • Constructor Detail

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getSeverityElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<IssueSeverityEnumgetSeverityElement()
        Gets the value(s) for severity (). creating it if it does not exist. Will not return null.

        Definition: Indicates whether the issue indicates a variation from successful processing

        Specified by:
        getSeverityElement in class ca.uhn.fhir.model.base.resource.BaseOperationOutcome.BaseIssue
      • getSeverity

        public String getSeverity()
        Gets the value(s) for severity (). creating it if it does not exist. This method may return null.

        Definition: Indicates whether the issue indicates a variation from successful processing

      • setSeverity

        public OperationOutcome.Issue setSeverity​(ca.uhn.fhir.model.primitive.BoundCodeDt<IssueSeverityEnum> theValue)
        Sets the value(s) for severity ()

        Definition: Indicates whether the issue indicates a variation from successful processing

      • getCodeElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<IssueTypeEnumgetCodeElement()
        Gets the value(s) for code (). creating it if it does not exist. Will not return null.

        Definition: Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element

      • getCode

        public String getCode()
        Gets the value(s) for code (). creating it if it does not exist. This method may return null.

        Definition: Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element

      • setCode

        public OperationOutcome.Issue setCode​(ca.uhn.fhir.model.primitive.BoundCodeDt<IssueTypeEnum> theValue)
        Sets the value(s) for code ()

        Definition: Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element

      • setCode

        public OperationOutcome.Issue setCode​(IssueTypeEnum theValue)
        Sets the value(s) for code ()

        Definition: Describes the type of the issue. The system that creates an OperationOutcome SHALL choose the most applicable code from the IssueType value set, and may additional provide its own code for the error in the details element

      • getDetails

        public CodeableConceptDt getDetails()
        Gets the value(s) for details (). creating it if it does not exist. Will not return null.

        Definition: Additional details about the error. This may be a text description of the error, or a system code that identifies the error

      • setDetails

        public OperationOutcome.Issue setDetails​(CodeableConceptDt theValue)
        Sets the value(s) for details ()

        Definition: Additional details about the error. This may be a text description of the error, or a system code that identifies the error

      • getDiagnosticsElement

        public ca.uhn.fhir.model.primitive.StringDt getDiagnosticsElement()
        Gets the value(s) for diagnostics (). creating it if it does not exist. Will not return null.

        Definition: Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue.

      • getDiagnostics

        public String getDiagnostics()
        Gets the value(s) for diagnostics (). creating it if it does not exist. This method may return null.

        Definition: Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue.

      • setDiagnostics

        public OperationOutcome.Issue setDiagnostics​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for diagnostics ()

        Definition: Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue.

      • setDiagnostics

        public OperationOutcome.Issue setDiagnostics​(String theString)
        Sets the value for diagnostics ()

        Definition: Additional diagnostic information about the issue. Typically, this may be a description of how a value is erroneous, or a stack dump to help trace the issue.

        Specified by:
        setDiagnostics in class ca.uhn.fhir.model.base.resource.BaseOperationOutcome.BaseIssue
      • getLocation

        public List<ca.uhn.fhir.model.primitive.StringDt> getLocation()
        Gets the value(s) for location (). creating it if it does not exist. Will not return null.

        Definition: A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.

      • setLocation

        public OperationOutcome.Issue setLocation​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
        Sets the value(s) for location ()

        Definition: A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.

      • addLocation

        public ca.uhn.fhir.model.primitive.StringDt addLocation()
        Adds and returns a new value for location ()

        Definition: A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.

      • addLocation

        public OperationOutcome.Issue addLocation​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Adds a given new value for location ()

        Definition: A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.

        Parameters:
        theValue - The location to add (must not be null)
      • getLocationFirstRep

        public ca.uhn.fhir.model.primitive.StringDt getLocationFirstRep()
        Gets the first repetition for location (), creating it if it does not already exist.

        Definition: A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.

        Specified by:
        getLocationFirstRep in class ca.uhn.fhir.model.base.resource.BaseOperationOutcome.BaseIssue
      • addLocation

        public OperationOutcome.Issue addLocation​(String theString)
        Adds a new value for location ()

        Definition: A simple XPath limited to element names, repetition indicators and the default child access that identifies one of the elements in the resource that caused this issue to be raised.

        Specified by:
        addLocation in class ca.uhn.fhir.model.base.resource.BaseOperationOutcome.BaseIssue
        Returns:
        Returns a reference to this object, to allow for simple chaining.
      • getDetailsElement

        @Deprecated
        public ca.uhn.fhir.model.primitive.StringDt getDetailsElement()
        Deprecated.
        Use getDiagnosticsElement() instead - OperationOutcome.details was renamed to OperationOutcome.diagnostics in DSTU2 and a new OperationOutcome.details codeableconcept element was introduced
        Specified by:
        getDetailsElement in class ca.uhn.fhir.model.base.resource.BaseOperationOutcome.BaseIssue
      • setDetails

        @Deprecated
        public ca.uhn.fhir.model.base.resource.BaseOperationOutcome.BaseIssue setDetails​(String theString)
        Deprecated.
        Use setDetails(String) instead - OperationOutcome.details was renamed to OperationOutcome.diagnostics in DSTU2 and a new OperationOutcome.details codeableconcept element was introduced
        Specified by:
        setDetails in class ca.uhn.fhir.model.base.resource.BaseOperationOutcome.BaseIssue