Vendors

A list of vendors undergoing certification

/vendors get post

get

View a list of vendors

post

Create a new vendor

View a list of vendors

Secured by basic

This API supports Basic Authentication.

Response
Security

HTTP status code 200

Body

Type: application/json

Schema:

{
  "title": "Vendors",
  "id": "http://cypress.healthit.gov/schemas/vendors.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "array",
  "items": { "$ref": "vendor" }
}

Secured by basic

Create a new vendor

Secured by basic

This API supports Basic Authentication.

Body

Type: application/json

Schema:

{
  "title": "Vendor",
  "id": "http://cypress.healthit.gov/schemas/vendor.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "vendor_id": {"type": "string"},
    "name": {"type": "string"},
    "url": {"type": "string"},
    "address": {"type": "string"},
    "zip": {"type": "string"},
    "state": {"type": "string"},
    "points_of_contact": { "type": "array", "items": { "$ref": "point_of_contact" } },
    "created_at": {"type": "string", "format": "date-time"},
    "updated_at": {"type": "string", "format": "date-time"}
  },
  "links": [
    {
      "rel": "self",
      "href": "/vendors/{id}"
    },
    {
      "rel": "products",
      "href": "/vendors/{id}/products"
    }
  ]
}

Type: application/xml

HTTP status code 201

Successfully created a new vendor

Body

Type: application/json

Schema:

{
  "title": "Vendor",
  "id": "http://cypress.healthit.gov/schemas/vendor.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "vendor_id": {"type": "string"},
    "name": {"type": "string"},
    "url": {"type": "string"},
    "address": {"type": "string"},
    "zip": {"type": "string"},
    "state": {"type": "string"},
    "points_of_contact": { "type": "array", "items": { "$ref": "point_of_contact" } },
    "created_at": {"type": "string", "format": "date-time"},
    "updated_at": {"type": "string", "format": "date-time"}
  },
  "links": [
    {
      "rel": "self",
      "href": "/vendors/{id}"
    },
    {
      "rel": "products",
      "href": "/vendors/{id}/products"
    }
  ]
}

HTTP status code 422

Invalid vendor

Body

Type: application/json

Schema:

{
  "title": "Errors",
  "id": "http://cypress.healthit.gov/schemas/errors.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "messages": {
            "type": "array",
            "items": { "type" : "string" }
          }
        }
      }
    }
  }
}

Secured by basic

/vendors/{id} get put delete

A Vendor undergoing certification

get

View information about a vendor

put

Update information about a vendor

delete

Delete a vendor

View information about a vendor

Secured by basic

This API supports Basic Authentication.

URI Parameters

Vendor ID: required (string)

HTTP status code 200

Vendor object in JSON/XML

Body

Type: application/json

Schema:

{
  "title": "Vendor",
  "id": "http://cypress.healthit.gov/schemas/vendor.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "vendor_id": {"type": "string"},
    "name": {"type": "string"},
    "url": {"type": "string"},
    "address": {"type": "string"},
    "zip": {"type": "string"},
    "state": {"type": "string"},
    "points_of_contact": { "type": "array", "items": { "$ref": "point_of_contact" } },
    "created_at": {"type": "string", "format": "date-time"},
    "updated_at": {"type": "string", "format": "date-time"}
  },
  "links": [
    {
      "rel": "self",
      "href": "/vendors/{id}"
    },
    {
      "rel": "products",
      "href": "/vendors/{id}/products"
    }
  ]
}

Secured by basic

Update information about a vendor

Secured by basic

This API supports Basic Authentication.

URI Parameters

Vendor ID: required (string)

Body

Type: application/json

Schema:

{
  "title": "Vendor",
  "id": "http://cypress.healthit.gov/schemas/vendor.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "vendor_id": {"type": "string"},
    "name": {"type": "string"},
    "url": {"type": "string"},
    "address": {"type": "string"},
    "zip": {"type": "string"},
    "state": {"type": "string"},
    "points_of_contact": { "type": "array", "items": { "$ref": "point_of_contact" } },
    "created_at": {"type": "string", "format": "date-time"},
    "updated_at": {"type": "string", "format": "date-time"}
  },
  "links": [
    {
      "rel": "self",
      "href": "/vendors/{id}"
    },
    {
      "rel": "products",
      "href": "/vendors/{id}/products"
    }
  ]
}

Type: application/xml

HTTP status code 200

Vendor record updated

Secured by basic

/vendors/{id}/products get post

A vendor's products

get

View a list of the vendor's products undergoing certification

post

Create a new product for this vendor

View a list of the vendor's products undergoing certification

Secured by basic

This API supports Basic Authentication.

URI Parameters

Vendor ID: required (string)

HTTP status code 200

Body

Type: application/json

Schema:

{
  "title": "Products",
  "id": "http://cypress.healthit.gov/schemas/products.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "array",
  "items": { "$ref": "product" }
}

Secured by basic

Create a new product for this vendor

Secured by basic

This API supports Basic Authentication.

URI Parameters

Vendor ID: required (string)

Body

Type: application/json

Schema:

{
  "title": "Product",
  "id": "http://cypress.healthit.gov/schemas/product.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "name": {"type": "string"},
    "version": {"type": "string"},
    "description": {"type": "string"},
    "bundle_id": {"type": "string"},
    "c1_test": {"type": "boolean"},
    "c2_test": {"type": "boolean"},
    "c3_test": {"type": "boolean"},
    "c4_test": {"type": "boolean"},
    "cures_update": {"type": "boolean"},
    "all_eh": {"type": "boolean"},
    "all_ep": {"type": "boolean"},
    "randomize_patients": {"type": "boolean"},
    "duplicate_patients": {"type": "boolean"},
    "shift_patients": {"type": "boolean"},
    "measure_ids": {"type": "array"},
    "created_at": {"type": "string", "format": "date-time"},
    "updated_at": {"type": "string", "format": "date-time"}
  },
  "links": [
    {
      "rel": "self",
      "href": "/vendors/{vendor_id}/products/{id}"
    },
    {
      "rel": "product_tests",
      "href": "/products/{id}/product_tests"
    },
    {
      "rel": "patients",
      "href": "/vendors/{vendor_id}/products/{id}/patients"
    }
  ]
}

Type: application/xml

HTTP status code 201

Product has been created

Body

Type: application/json

Schema:

{
  "title": "Product",
  "id": "http://cypress.healthit.gov/schemas/product.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "name": {"type": "string"},
    "version": {"type": "string"},
    "description": {"type": "string"},
    "bundle_id": {"type": "string"},
    "c1_test": {"type": "boolean"},
    "c2_test": {"type": "boolean"},
    "c3_test": {"type": "boolean"},
    "c4_test": {"type": "boolean"},
    "cures_update": {"type": "boolean"},
    "all_eh": {"type": "boolean"},
    "all_ep": {"type": "boolean"},
    "randomize_patients": {"type": "boolean"},
    "duplicate_patients": {"type": "boolean"},
    "shift_patients": {"type": "boolean"},
    "measure_ids": {"type": "array"},
    "created_at": {"type": "string", "format": "date-time"},
    "updated_at": {"type": "string", "format": "date-time"}
  },
  "links": [
    {
      "rel": "self",
      "href": "/vendors/{vendor_id}/products/{id}"
    },
    {
      "rel": "product_tests",
      "href": "/products/{id}/product_tests"
    },
    {
      "rel": "patients",
      "href": "/vendors/{vendor_id}/products/{id}/patients"
    }
  ]
}

HTTP status code 422

Invalid Product

Body

Type: application/json

Schema:

{
  "title": "Errors",
  "id": "http://cypress.healthit.gov/schemas/errors.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "messages": {
            "type": "array",
            "items": { "type" : "string" }
          }
        }
      }
    }
  }
}

Secured by basic

/vendors/{id}/products/{product_id} get delete

Product undergoing certification testing

get

View information about a Product

delete

Delete a product

View information about a Product

Secured by basic

This API supports Basic Authentication.

URI Parameters

Vendor ID: required (string)
Product ID: required (string)

HTTP status code 200

Product is available for testing

Body

Type: application/json

Schema:

{
  "title": "Product",
  "id": "http://cypress.healthit.gov/schemas/product.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "name": {"type": "string"},
    "version": {"type": "string"},
    "description": {"type": "string"},
    "bundle_id": {"type": "string"},
    "c1_test": {"type": "boolean"},
    "c2_test": {"type": "boolean"},
    "c3_test": {"type": "boolean"},
    "c4_test": {"type": "boolean"},
    "cures_update": {"type": "boolean"},
    "all_eh": {"type": "boolean"},
    "all_ep": {"type": "boolean"},
    "randomize_patients": {"type": "boolean"},
    "duplicate_patients": {"type": "boolean"},
    "shift_patients": {"type": "boolean"},
    "measure_ids": {"type": "array"},
    "created_at": {"type": "string", "format": "date-time"},
    "updated_at": {"type": "string", "format": "date-time"}
  },
  "links": [
    {
      "rel": "self",
      "href": "/vendors/{vendor_id}/products/{id}"
    },
    {
      "rel": "product_tests",
      "href": "/products/{id}/product_tests"
    },
    {
      "rel": "patients",
      "href": "/vendors/{vendor_id}/products/{id}/patients"
    }
  ]
}

Secured by basic

Product Tests (Single Measure Testing and Filter Tests)

/products/{product_id}/product_tests get

get

View list of a product's tests (One per measure for C1/C2, One for each C4 Filter)

Secured by basic

This API supports Basic Authentication.

URI Parameters

Parent Task ID: required (string)

HTTP status code 200

Product is available for testing

Body

Type: application/json

Schema:

{
  "title": "Product Tests",
  "id": "http://cypress.healthit.gov/schemas/product_tests.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "array",
  "items": { "$ref": "product_test" }
}

Secured by basic

/products/{product_id}/product_tests/{id} get

get

View a product test (such as a Single Measure Test or a C4 Filter)

Secured by basic

This API supports Basic Authentication.

URI Parameters

Parent Task ID: required (string)
Product test ID: required (string)

HTTP status code 200

Product is available for testing

Body

Type: application/json

Schema:

{
  "title": "Product Test",
  "id": "http://cypress.healthit.gov/schemas/product.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "name": {"type": "string"},
    "cms_id": {"type": "string"},
    "measure_id": {"type": "string"},
    "type": {"type": "string"},
    "state": {"type": "string"},
    "provider" : {
      "type" : "object",
      "properties" : {
        "tin" : {"type": "string"},
        "npi" : {"type": "string"},
        "ccn" : {"type": "string"},
        "name" : {"type": "string"}
      }
    },
    "filters" : {
      "type" : "object",
      "properties" : {
        "problem" : {"type": "string"},
        "gender" : {"type": "string"},
        "payer" : {"type": "string"},
        "race" : {"type": "string"},
        "ethnicity" : {"type": "string"},
        "provider" : {
          "type" : "object",
          "properties" : {
            "npi" : {"type": "string"},
            "tin" : {"type": "string"},
            "address" : {
              "type" : "object",
              "properties" : {
                "street" : {"type": "string"},
                "city" : {"type": "string"},
                "state" : {"type": "string"},
                "zip" : {"type": "string"},
                "country" : {"type": "string"}
              }
            }
          }
        }
      }
    },
    "created_at": {"type": "string", "format": "date-time"},
    "updated_at": {"type": "string", "format": "date-time"}
  },
  "links": [
    {
      "rel": "self",
      "href": "/products/{product_id}/product_tests/{id}"
    },
    {
      "rel": "tasks",
      "href": "/product_tests/{id}/tasks"
    },
    {
      "rel": "patients",
      "href": "/product_tests/{id}/patients"
    }
  ]
}

Secured by basic

/product_tests/{product_test_id}/tasks

/product_tests/{product_test_id}/tasks get

get

List of testing tasks for a product ID

Secured by basic

This API supports Basic Authentication.

URI Parameters

Parent resource product test ID: required (string)

HTTP status code 200

List of tasks for a product test

Body

Type: application/json

Schema:

{
  "title": "Tasks",
  "id": "http://cypress.healthit.gov/schemas/tasks.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "array",
  "items": { "$ref": "task" }
}

Secured by basic

/product_tests/{product_test_id}/tasks/{id} get

get

A single task for a product test such as a single C1 measure task or a Filter task

Secured by basic

This API supports Basic Authentication.

URI Parameters

Parent resource product test ID: required (string)
Task ID: required (string)

HTTP status code 200

Body

Type: application/json

Schema:

{
  "title": "Task",
  "id": "http://cypress.healthit.gov/schemas/product.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "type": {"type": "string"}
  },
  "links": [
    {
      "rel": "self",
      "href": "/product_tests/{product_test_id}/tasks/{id}"
    },
    {
      "rel": "executions",
      "href": "/tasks/{task_id}/test_executions"
    }
  ]
}

Secured by basic

Task

/tasks/{task_id}/test_executions get post

get

View a list of test executions

post

Upload a new test artifact

View a list of test executions

Secured by basic

This API supports Basic Authentication.

URI Parameters

Parent Task ID: required (string)

HTTP status code 200

Body

Type: application/json

Schema:

{
  "title": "Test Executions",
  "id": "http://cypress.healthit.gov/schemas/test_executions.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "array",
  "items": { "$ref": "test_executions" }
}

Secured by basic

Upload a new test artifact

Secured by basic

This API supports Basic Authentication.

URI Parameters

Parent Task ID: required (string)

Body

Type: multipart/form-data

Form Parameters

results: required (file)
Artifact to be tested

HTTP status code 201

File Uploaded Successfully. Cypress is checking data for accuracy and correctness

Body

Type: application/json

Schema:

{
  "title": "Test Execution",
  "id": "http://cypress.healthit.gov/schemas/test_execution.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "state": {"type": "string"},
    "execution_errors": {"type": "array", "items": { "$ref": "execution_error" } },
    "created_at": {"type": "string", "format": "date-time"}
  },
    "links": [
    {
      "rel": "self",
      "href": "/tasks{task_id}/test_executions/{id}"
    }
  ]
}

HTTP status code 422

File uploaded is not processable by Cypress

Body

Type: application/json

Schema:

{
  "title": "Errors",
  "id": "http://cypress.healthit.gov/schemas/errors.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "messages": {
            "type": "array",
            "items": { "type" : "string" }
          }
        }
      }
    }
  }
}

Secured by basic

/tasks/{task_id}/test_executions/{id} get delete

get

View information about a test execution

delete

Delete a test execution

View information about a test execution

Secured by basic

This API supports Basic Authentication.

URI Parameters

Parent Task ID: required (string)
Test Execution ID: required (string)

HTTP status code 200

Body

Type: application/json

Schema:

{
  "title": "Test Execution",
  "id": "http://cypress.healthit.gov/schemas/test_execution.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "state": {"type": "string"},
    "execution_errors": {"type": "array", "items": { "$ref": "execution_error" } },
    "created_at": {"type": "string", "format": "date-time"}
  },
    "links": [
    {
      "rel": "self",
      "href": "/tasks{task_id}/test_executions/{id}"
    }
  ]
}

Secured by basic

/bundles

Bundles installed on the system

/bundles get

get

View a list of all installed bundles

Secured by basic

This API supports Basic Authentication.

Response
Security

HTTP status code 200

Body

Type: application/json

Schema:

{
  "title": "Bundles",
  "id": "http://cypress.healthit.gov/schemas/bundles.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "array",
  "items": { "$ref": "bundle" }
}

Secured by basic

/bundles/{id} get

Annual Update Bundle

get

View a list of all installed bundles

Secured by basic

This API supports Basic Authentication.

URI Parameters

Bundle ID: required (string)

HTTP status code 200

Body

Type: application/json

Schema:

{
  "title": "Bundle",
  "id": "http://cypress.healthit.gov/schemas/bundle.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "title": {"type": "string"},
    "version": {"type": "string"}
  },
    "links": [
    {
      "rel": "self",
      "href": "/bundles/{id}"
    }, {
      "rel": "measures",
      "href": "/bundles/{id}/measures"
    }
  ]
}

Secured by basic

/bundles/{id}/measures get

get

List of measure in the bundle

Secured by basic

This API supports Basic Authentication.

URI Parameters

Bundle ID: required (string)

HTTP status code 200

Body

Type: application/json

Schema:

{
  "title": "Measures",
  "id": "http://cypress.healthit.gov/schemas/measures.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "array",
  "items": { "$ref": "measure" }
}

Secured by basic

/qrda_validation

QRDA Validations on the system

/qrda_validation get

get

View a list of all avaliable QRDA Validations

Secured by basic

This API supports Basic Authentication.

Response
Security

HTTP status code 200

Body

Type: application/json

Schema:

{
  "title": "QRDA Validatons",
  "id": "http://cypress.healthit.gov/schemas/qrda_validatons.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "array",
  "items": { "$ref": "qrda_validaton" }
}

Secured by basic

/qrda_validation/{year}/{qrda_type}/{implementation_guide} post

post

Upload a new test artifact

Secured by basic

This API supports Basic Authentication.

URI Parameters

Performance Period: required (string)
QRDA Type (I or III): required (string)
Implementation Guide (CMS or HL7): required (string)

Body

Type: multipart/form-data

Form Parameters

file: required (file)
Artifact to be tested

HTTP status code 201

File Uploaded Successfully. Cypress is checking data for accuracy and correctness

Body

Type: application/json

Schema:

{
  "title": "QRDA Validation",
  "id": "http://cypress.healthit.gov/schemas/qrda_validation.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "validator": {"type": "string"},
    "path": {"type": "string"},
    "execution_errors": {"type": "array", "items": { "$ref": "execution_error" } }
  }
}

HTTP status code 422

File uploaded is not processable by Cypress

Body

Type: application/json

Schema:

{
  "title": "Errors",
  "id": "http://cypress.healthit.gov/schemas/errors.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "messages": {
            "type": "array",
            "items": { "type" : "string" }
          }
        }
      }
    }
  }
}

Secured by basic

/version

Cypress Version

/version get

get

Get the version of the Cypress instance

Secured by basic

This API supports Basic Authentication.

Response
Security

HTTP status code 200

Body

Type: application/json

Schema:

{
  "title": "Version",
  "id": "http://cypress.healthit.gov/schemas/version.json",
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "version": {"type": "string"}
  }
}

Cypress API documentation version v1

Vendors

get /vendors

HTTP status code 200

Body

Secured by basic

post /vendors

Body

HTTP status code 201

Body

HTTP status code 422

Body

Secured by basic

get /vendors/{id}

URI Parameters

HTTP status code 200

Body

Secured by basic

put /vendors/{id}

URI Parameters

Body

HTTP status code 200

Secured by basic

delete /vendors/{id}

URI Parameters

HTTP status code 200

Secured by basic

get /vendors/{id}/products

URI Parameters

HTTP status code 200

Body

Secured by basic

post /vendors/{id}/products

URI Parameters

Body

HTTP status code 201

Body

HTTP status code 422

Body

Secured by basic

get /vendors/{id}/products/{product_id}

URI Parameters

HTTP status code 200

Body

Secured by basic

delete /vendors/{id}/products/{product_id}

URI Parameters

Secured by basic

Product Tests (Single Measure Testing and Filter Tests)

get /products/{product_id}/product_tests

URI Parameters

HTTP status code 200

Body

Secured by basic

get /products/{product_id}/product_tests/{id}

URI Parameters

HTTP status code 200

Body

Secured by basic

/product_tests/{product_test_id}/tasks

get /product_tests/{product_test_id}/tasks

URI Parameters

HTTP status code 200

Body

Secured by basic

get /product_tests/{product_test_id}/tasks/{id}

URI Parameters

HTTP status code 200

Body

Secured by basic

Task

get /tasks/{task_id}/test_executions

URI Parameters

HTTP status code 200

Body

Secured by basic

post /tasks/{task_id}/test_executions

URI Parameters

Body

HTTP status code 201