Jump to

• Request
• Response

Export records uploaded in a date range

post

/v0/export

Specify the inclusive start and end dates and the export format in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

The startDate and and end dates are in UTC format. The export format can be HL7_RAW, CVRS_RAW, CVRS_PROCESSED_REDACTED, or CVRS_PROCESSED_NON_REDACTED. The raw formats specify the uploaded data as received. CVRS_PROCESSED_REDACTED specifies the records as processed by the redacted database and the CVRS_PROCESSED_NON_REDACTED specifies the records as processed by the non-redacted database. ""

Root Schema : schema

Type: object

Show Source

• endDate(required): string (date)
  The end of the inclusive date range in UTC format.
• format(required): string
  Allowed Values: [ "HL7_RAW", "CVRS_RAW", "CVRS_PROCESSED_REDACTED", "CVRS_PROCESSED_NON_REDACTED" ]

  The raw formats return the uploaded data before database processing and the processed format return either the processed data from the redacted or non-redacted database.
• startDate(required): string (date)
  The beginning of the inclusive date range in UTC format.

{
    "required":[
        "endDate",
        "format",
        "startDate"
    ],
    "type":"object",
    "properties":{
        "startDate":{
            "description":"The beginning of the inclusive date range in UTC format.",
            "type":"string",
            "format":"date"
        },
        "endDate":{
            "description":"The end of the inclusive date range in UTC format.",
            "type":"string",
            "format":"date"
        },
        "format":{
            "description":"The raw formats return the uploaded data before database processing and the processed format return either the processed data from the redacted or non-redacted database.",
            "type":"string",
            "enum":[
                "HL7_RAW",
                "CVRS_RAW",
                "CVRS_PROCESSED_REDACTED",
                "CVRS_PROCESSED_NON_REDACTED"
            ]
        }
    }
}

Security

• Authorization(required): apiKey
  Type: apiKey

Back to Top

Response

Supported Media Types

• application/json

Default Response

The API returns the immunization records uploaded between the start date and the end date in JSON format.

Body ()

Root Schema : ExportResponse

Type: object

Show Source

• data: string

{
    "type":"object",
    "properties":{
        "data":{
            "type":"string"
        }
    }
}

Back to Top