Class FhirHistory


  • public class FhirHistory
    extends Object
    API for the "history" method
    • Constructor Summary

      Constructors 
      Constructor Description
      FhirHistory​(ca.uhn.fhir.rest.client.api.IGenericClient client)  
    • Constructor Detail

      • FhirHistory

        public FhirHistory​(ca.uhn.fhir.rest.client.api.IGenericClient client)
    • Method Detail

      • onServer

        public <T extends org.hl7.fhir.instance.model.api.IBaseBundle> T onServer​(Class<T> returnType,
                                                                                  Integer count,
                                                                                  Date cutoff,
                                                                                  org.hl7.fhir.instance.model.api.IPrimitiveType<Date> iCutoff,
                                                                                  Map<ExtraParameters,​Object> extraParameters)
        Perform the operation across all versions of all resources of all types on the server
        Type Parameters:
        T - extends IBaseBundle
        Parameters:
        returnType - Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2+ server.
        count - Request that the server return only up to theCount number of resources, may be NULL
        cutoff - Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL
        iCutoff - Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL
        extraParameters - see ExtraParameters for a full list of parameters that can be passed, may be NULL
        Returns:
        the IBaseBundle
      • onType

        public <T extends org.hl7.fhir.instance.model.api.IBaseBundle> T onType​(Class<org.hl7.fhir.instance.model.api.IBaseResource> resourceType,
                                                                                Class<T> returnType,
                                                                                Integer count,
                                                                                Date cutoff,
                                                                                org.hl7.fhir.instance.model.api.IPrimitiveType<Date> iCutoff,
                                                                                Map<ExtraParameters,​Object> extraParameters)
        Perform the operation across all versions of all resources of the given type on the server
        Type Parameters:
        T - extends IBaseBundle
        Parameters:
        resourceType - The resource type to search for
        returnType - Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2+ server.
        count - Request that the server return only up to theCount number of resources, may be NULL
        cutoff - Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL
        iCutoff - Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL
        extraParameters - see ExtraParameters for a full list of parameters that can be passed, may be NULL
        Returns:
        the IBaseBundle
      • onInstance

        public <T extends org.hl7.fhir.instance.model.api.IBaseBundle> T onInstance​(org.hl7.fhir.instance.model.api.IIdType id,
                                                                                    Class<T> returnType,
                                                                                    Integer count,
                                                                                    Date cutoff,
                                                                                    org.hl7.fhir.instance.model.api.IPrimitiveType<Date> iCutoff,
                                                                                    Map<ExtraParameters,​Object> extraParameters)
        Perform the operation across all versions of a specific resource (by ID and type) on the server. Note that theId must be populated with both a resource type and a resource ID at a minimum.
        Type Parameters:
        T - extends IBaseBundle
        Parameters:
        id - the IIdType which must be populated with both a resource type and a resource ID at
        returnType - Request that the method return a Bundle resource (such as ca.uhn.fhir.model.dstu2.resource.Bundle). Use this method if you are accessing a DSTU2+ server.
        count - Request that the server return only up to theCount number of resources, may be NULL
        cutoff - Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL
        iCutoff - Request that the server return only resource versions that were created at or after the given time (inclusive), may be NULL
        extraParameters - see ExtraParameters for a full list of parameters that can be passed, may be NULL
        Returns:
        the IBaseBundle
        Throws:
        IllegalArgumentException - If id does not contain at least a resource type and ID