• Domains
• Routes
  • Health
  • CCD
    • CCD Authorization
    • Ccd Routes
      • GET
      • POST
      • OPTIONS
      • Sections and Template-Names
        • CCD Sections
        • CCD Template Name

• /health - Returns 200 when the container is healthy.

• Query Parameters:

  • :site-id - requied; String; The database to retrieve data from (Ex: BS001).
  • :patient-id - required; Integer; A patient's ID (PID).
  • :visit-id - required; Integer; A patient's visit ID (VID).
  • mock - optional; String ("true" is the only valid input); If true, returns a mocked payload. Useful for debugging purposes.

• All routes use a Bearer token for authorization (auth).

• Resource (DEPRECATED -- use POST resource): GET /api/:version/sites/:site-id/patients/:patient-id/ccd?visit=:visit-id&user=:username[&sections=<see_below>][&template-name=<see_below>][&mock=true]

• URL Parameters (Required):

  • :version - String; {v1 or v2} Signifies which service to generate a CCD.
  • :site-id - String; The database to retrieve data from (Ex: BS001).
  • :patient-id - String; A patient's ID (PID).

• Query Parameters:

  • visit - required; Integer; A patient's visit ID (VID).
  • user - required; String; A username for logging purposes.
  • sections - optional; String (comma delimited); See this for notes on valid sections values.
  • template-name - optional; See this for notes on valid template-name values.
  • mock - optional; String ("true" is the only valid input); If true, returns a mocked payload. Useful for debugging purposes.

• Response:

  • Status code: 200
  • Data: XML

• Notes:

1. The version parameter v2 will work better than v1.
2. All parameter key/values should be separated by dashes, if necessary. Ex: &user=api-user.
3. An example of a sections string: sections=goals,vitals,social-history
4. Example Route https://records.docutaptest.com/api/v2/sites/DT061/patients/121378/ccd?visit=82593&user=api-user

• Resource: POST /api/:version/sites/:site-id/patients/:patient-id/ccd

• POST CCD URL Parameters (Required)

  • :version - String; {v1 or v2} Signifies which service to generate a CCD.
  • :site-id - String; The database to retrieve data from (Ex: BS001).
  • :patient-id - String; A patient's ID (PID).

• POST CCD Body Parameters (in JSON)

  • visit - required; Integer; A patient's visit ID (VID).
  • user - required; String; A username for logging purposes.
  • sections - optional; Array[Strings]; See this for notes on valid sections values.
  • template-name - optional; See this for notes on valid template-name values.
  • security¹ - optional; Object.
    • code - optional; String (single character); N, R, or V (for Normal, Restricted, and Very Restricted). Defaults to an N if no code field is supplied.
    • text - optional; String. Defaults to "" if none supplied.
  • mock - optional; String ("true" is only valid input); If true, returns a mocked payload. Useful for debugging purposes.

• JSON body example:

  {
    "visit": 147777,
    "user": "api-user",
    "sections": ["goals", "med-list", "social-history", "vitals"],
    "template-name": "clinical-summary",
    "security": {
      "code": "N",
      "text": "Some example text placeholder"
    },
    "mock": "true"
  }

• Response:

  • Status code: 200
  • Data: XML

• Notes:

1. The security section will always be attempted to be generated at the very end of the CCD document. This section is special since it isn't explicitly listed in the sections string array. Instead, if a security object is provided (and the text field has data), then the security section will be generated.
2. The version parameter v2 will work better than v1.
3. All parameter key/values should be separated by dashes, if necessary.
   • Ex: user=api-user

• Example Route: https://records.docutaptest.com/api/v2/sites/DT061/patients/121378/ccd

• Resource: OPTIONS /v2/sites/:site/patients/:patient/ccd

• Alias: OPTIONS /v2/ccd

• URL Parameters (Required):

  • :site-id - String; The database to retrieve data from (Ex: BS001).
  • :patient-id - String; A patient's ID (PID).

• Response:

  • Status Code: 200

  • Data: JSON

  • Example (Use the OPTIONS route for the most up-to-date example):

    {
      "sections": [
        "cognitive-status",
        "encounter-diagnosis",
        ...
      ],
      "template-name": ["care-plan", "clinical-summary", "transition-of-care/referral"]
    }

• Notes:

1. The alias will mimic the behavior of the resource, except that you no longer have to specify a site-id and a pid.

To get the most up-to-date sections listing, use the OPTIONS CCD Route.

• Notes:

1. The parameter values are case insensitive.

2. If no sections parameter is passed to the route, ALL sections will be generated, if possible.

3. If you specify certain sections, be warned that you may generate valid XML code but it might not be a valid CCD document!

4. Regarding the interventions section, if no medications or procedures arrays are included in the JSON payload, the text field will be placed into the instruction subsection.

5. The Plan of Treatment section in the CCD doesn't have the name plan-of-treatment mapped to it when passing a list of sections via the body parameter. Instead, if any combination of the following section names are sent in the sections body parameter, the Plan of Treatment section will be generated exactly once. Otherwise, the Plan of Treatment section won't be generated.

   1. future-appointments
   2. future-scheduled-tests
   3. pending-diagnostic-tests
   4. patient-education

6. The lab-tests-and-results (lab-results) section will only generate if atleast one of the following JSON fields are provided to the API:

   1. pending_tests
   2. future_lab
   3. future_xray
   4. misc_procedures

7. See MR-2015 for notes/discussions.

To get the most up-to-date template-name listing, use the OPTIONS CCD Route.

• Notes:

1. The parameter values are case insensitive.
2. If no template-name is provided, the default will be clinical-summary.
3. The route only accepts one template name. If multiple are given, the default template will be returned.
4. See MR-2015 for notes/discussions.

• Resource: POST /api/:version/sites/:site-id/patients/:patient-id/ccd/search

Inputs are the same as the CCD Post route except for two new body params:

• Additional Body Parameters:

  • start-date - optional; string; MM/DD/YYYY format (Ex: 01/23/2019).
  • end-date - optional; string; MM/DD/YYYY format (Ex: 01/23/2019).

• Response:

  • Status code: 200

  • Data: JSON

  • Example:

    {
      "results": [
        {
          "date": "05/31/2019",
          "visitId": "1234",
          "status": "Completed",
          "ccd": "<?xml version=\"1.0\" ?>\n<ClinicalDocument…" // raw CCD data as a string
        }
      ]
    }

• Notes:

1. If start-date or end-date are used, you must provide both start-date and end-date