Class Conformance.RestResource

  • 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:
    Conformance

    public static class Conformance.RestResource
    extends ca.uhn.fhir.model.api.BaseIdentifiableElement
    implements ca.uhn.fhir.model.api.IResourceBlock
    Block class for child element: Conformance.rest.resource ()

    Definition: A specification of the restful capabilities of the solution for a specific resource type

    See Also:
    Serialized Form
    • 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
      • getTypeElement

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

        Definition: A type of resource exposed via the restful interface

      • getType

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

        Definition: A type of resource exposed via the restful interface

      • getProfile

        public ResourceReferenceDt getProfile()
        Gets the value(s) for profile (). creating it if it does not exist. Will not return null.

        Definition: A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles]{profiling.html#profile-uses}

      • setProfile

        public Conformance.RestResource setProfile​(ResourceReferenceDt theValue)
        Sets the value(s) for profile ()

        Definition: A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles]{profiling.html#profile-uses}

      • getVersioningElement

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

        Definition: This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API

      • getVersioning

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

        Definition: This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API

      • setVersioning

        public Conformance.RestResource setVersioning​(ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceVersionPolicyEnum> theValue)
        Sets the value(s) for versioning ()

        Definition: This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API

      • setVersioning

        public Conformance.RestResource setVersioning​(ResourceVersionPolicyEnum theValue)
        Sets the value(s) for versioning ()

        Definition: This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API

      • getReadHistoryElement

        public ca.uhn.fhir.model.primitive.BooleanDt getReadHistoryElement()
        Gets the value(s) for readHistory (). creating it if it does not exist. Will not return null.

        Definition: A flag for whether the server is able to return past versions as part of the vRead operation

      • getReadHistory

        public Boolean getReadHistory()
        Gets the value(s) for readHistory (). creating it if it does not exist. This method may return null.

        Definition: A flag for whether the server is able to return past versions as part of the vRead operation

      • setReadHistory

        public Conformance.RestResource setReadHistory​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for readHistory ()

        Definition: A flag for whether the server is able to return past versions as part of the vRead operation

      • setReadHistory

        public Conformance.RestResource setReadHistory​(boolean theBoolean)
        Sets the value for readHistory ()

        Definition: A flag for whether the server is able to return past versions as part of the vRead operation

      • getUpdateCreateElement

        public ca.uhn.fhir.model.primitive.BooleanDt getUpdateCreateElement()
        Gets the value(s) for updateCreate (). creating it if it does not exist. Will not return null.

        Definition: A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server

      • getUpdateCreate

        public Boolean getUpdateCreate()
        Gets the value(s) for updateCreate (). creating it if it does not exist. This method may return null.

        Definition: A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server

      • setUpdateCreate

        public Conformance.RestResource setUpdateCreate​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for updateCreate ()

        Definition: A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server

      • setUpdateCreate

        public Conformance.RestResource setUpdateCreate​(boolean theBoolean)
        Sets the value for updateCreate ()

        Definition: A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server

      • getConditionalCreateElement

        public ca.uhn.fhir.model.primitive.BooleanDt getConditionalCreateElement()
        Gets the value(s) for conditionalCreate (). creating it if it does not exist. Will not return null.

        Definition: A flag that indicates that the server supports conditional create

      • getConditionalCreate

        public Boolean getConditionalCreate()
        Gets the value(s) for conditionalCreate (). creating it if it does not exist. This method may return null.

        Definition: A flag that indicates that the server supports conditional create

      • setConditionalCreate

        public Conformance.RestResource setConditionalCreate​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for conditionalCreate ()

        Definition: A flag that indicates that the server supports conditional create

      • getConditionalUpdateElement

        public ca.uhn.fhir.model.primitive.BooleanDt getConditionalUpdateElement()
        Gets the value(s) for conditionalUpdate (). creating it if it does not exist. Will not return null.

        Definition: A flag that indicates that the server supports conditional update

      • getConditionalUpdate

        public Boolean getConditionalUpdate()
        Gets the value(s) for conditionalUpdate (). creating it if it does not exist. This method may return null.

        Definition: A flag that indicates that the server supports conditional update

      • setConditionalUpdate

        public Conformance.RestResource setConditionalUpdate​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
        Sets the value(s) for conditionalUpdate ()

        Definition: A flag that indicates that the server supports conditional update

      • getConditionalDeleteElement

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

        Definition: A code that indicates how the server supports conditional delete

      • getConditionalDelete

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

        Definition: A code that indicates how the server supports conditional delete

      • getSearchInclude

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

        Definition: A list of _include values supported by the server

      • setSearchInclude

        public Conformance.RestResource setSearchInclude​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
        Sets the value(s) for searchInclude ()

        Definition: A list of _include values supported by the server

      • addSearchInclude

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

        Definition: A list of _include values supported by the server

      • addSearchInclude

        public Conformance.RestResource addSearchInclude​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Adds a given new value for searchInclude ()

        Definition: A list of _include values supported by the server

        Parameters:
        theValue - The searchInclude to add (must not be null)
      • getSearchIncludeFirstRep

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

        Definition: A list of _include values supported by the server

      • addSearchInclude

        public Conformance.RestResource addSearchInclude​(String theString)
        Adds a new value for searchInclude ()

        Definition: A list of _include values supported by the server

        Returns:
        Returns a reference to this object, to allow for simple chaining.
      • getSearchRevInclude

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

        Definition: A list of _revinclude (reverse include) values supported by the server

      • setSearchRevInclude

        public Conformance.RestResource setSearchRevInclude​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
        Sets the value(s) for searchRevInclude ()

        Definition: A list of _revinclude (reverse include) values supported by the server

      • addSearchRevInclude

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

        Definition: A list of _revinclude (reverse include) values supported by the server

      • addSearchRevInclude

        public Conformance.RestResource addSearchRevInclude​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Adds a given new value for searchRevInclude ()

        Definition: A list of _revinclude (reverse include) values supported by the server

        Parameters:
        theValue - The searchRevInclude to add (must not be null)
      • getSearchRevIncludeFirstRep

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

        Definition: A list of _revinclude (reverse include) values supported by the server

      • addSearchRevInclude

        public Conformance.RestResource addSearchRevInclude​(String theString)
        Adds a new value for searchRevInclude ()

        Definition: A list of _revinclude (reverse include) values supported by the server

        Returns:
        Returns a reference to this object, to allow for simple chaining.
      • getSearchParam

        public List<Conformance.RestResourceSearchParamgetSearchParam()
        Gets the value(s) for searchParam (). creating it if it does not exist. Will not return null.

        Definition: Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation

      • addSearchParam

        public Conformance.RestResourceSearchParam addSearchParam()
        Adds and returns a new value for searchParam ()

        Definition: Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation

      • addSearchParam

        public Conformance.RestResource addSearchParam​(Conformance.RestResourceSearchParam theValue)
        Adds a given new value for searchParam ()

        Definition: Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation

        Parameters:
        theValue - The searchParam to add (must not be null)
      • getSearchParamFirstRep

        public Conformance.RestResourceSearchParam getSearchParamFirstRep()
        Gets the first repetition for searchParam (), creating it if it does not already exist.

        Definition: Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation