Forms API Overview

Forms API Overview


  • You can run GET ccdBatchExchange on a regular basis — once per day or as often as needed based on the practice — to pull all new forms data into your system. You should run GET patient first so that you have any newly-registered patients in your system before adding any forms data to their records.
  • Demographic data (patient name, address, phone, etc.) returned by the Patient API may be more current than the data returned by the Forms API. You may want to ignore demographic data returned by the Forms API for any fields that already have values in your database.
  • Medfusion APIs will follow the standard ISO8601 formats for all time elements, unless otherwise noted ( The standard format will include the timezone. For UTC (the preferred time zone to be used for timestamps), the time zone is specified as ‘Z’. The API documentation will clearly specify any deviation from the ISO8601 recommendation.
    For example, an alternative format is to specify timestamps as epochs since January 1, 1970, 00:00:00 UTC, either in seconds (POSIX time) or milliseconds (Java).


  1. Make a GET patient request on a scheduled basis.
  2. Process the returned data.
  3. Repeat the first two steps as needed to get all updated patient information.
  4. Run a GET ccdExchangeBatch request.
  5. Process the returned data. (Do not overwrite any values that were returned by GET patient, as information from the Patient API may be more current than information from the Forms API.)
  6. Repeat steps 4 and 5 as needed to get all new forms information.



Forms API

Forms API GET ccdExchangeBatch