Jump to

• Request
• Response

Create records using HL7 data in a JSON file

post

/v0/upload/hl7/json

Upload new HL7 immunization records in a JSON file or in a zipped JSON file.

Request

Header Parameters

• Referer:
  An optional header that holds the address of a request for purposes of logging, analytics, and so on.

Supported Media Types

• application/zip
• text/plain

Request Body - application/zip ()

A JSON file containing immunization records in HL7 format.

Root Schema : schema

Type: object

A zipped JSON file containing immunization records in HL7 format. The standard format zip file holds a single text file. The zip file cannot include a folder or use extra file attributes such as __MACOSX and .DS_Store.

Request Body - text/plain ()

A JSON file containing immunization records in HL7 format.

Root Schema : schema

Type: object

A JSON file containing immunization records in HL7 format.

Security

• Authorization(required): apiKey
  Type: apiKey

Back to Top

Response

Supported Media Types

• application/json

Default Response

The default response containing a count of valid records in the transaction with a list of validation errors and a count of records processed by the database with a list of database processing errors.

Body ()

Root Schema : UploadStatusResponse

Type: object

Show Source

• id: string (uuid)
  The unique identifier (UUID) of the transaction.
• storageResult: object storageResult
  Additional Properties Allowed: UploadStorageResult

  The UploadStorageResult object contains the processing response from the database on the results of the transaction.
• totalRecords: integer (int32)
  The number of immunization records contained in the transaction.
• truncated: boolean
• validationErrors: array validationErrors
  The list of immunization records containing formatting or other errors that make the record invalid.
• validationErrorsCount: integer (int32)
  The number of validation errors in the transaction.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "description":"The unique identifier (UUID) of the transaction."
        },
        "totalRecords":{
            "type":"integer",
            "description":"The number of immunization records contained in the transaction.",
            "format":"int32"
        },
        "validationErrors":{
            "type":"array",
            "description":"The list of immunization records containing formatting or other errors that make the record invalid.",
            "items":{
                "type":"string",
                "description":"Contains information identifying the invalid record and the validation error message."
            }
        },
        "validationErrorsCount":{
            "type":"integer",
            "description":"The number of validation errors in the transaction.",
            "format":"int32"
        },
        "truncated":{
            "type":"boolean"
        },
        "storageResult":{
            "description":"The UploadStorageResult object contains the processing response from the database on the results of the transaction.",
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/UploadStorageResult"
            }
        }
    }
}

Nested Schema : storageResult

Type: object

Additional Properties Allowed

Show Source

• object UploadStorageResult
  The UploadStorageResult object contains the processing response on the results of the transaction.

{
    "description":"The UploadStorageResult object contains the processing response from the database on the results of the transaction.",
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/UploadStorageResult"
    }
}

The UploadStorageResult object contains the processing response from the database on the results of the transaction.

Nested Schema : validationErrors

Type: array

The list of immunization records containing formatting or other errors that make the record invalid.

Show Source

• Array of: string
  Contains information identifying the invalid record and the validation error message.

{
    "type":"array",
    "description":"The list of immunization records containing formatting or other errors that make the record invalid.",
    "items":{
        "type":"string",
        "description":"Contains information identifying the invalid record and the validation error message."
    }
}

Nested Schema : UploadStorageResult

Type: object

The UploadStorageResult object contains the processing response on the results of the transaction.

Show Source

• message: string
  The text of the database processing error.
• processedCount: integer (int32)
  The number of immunization records the database processed. This number equals the number of records in the transaction minus the count of records with validation errors.
• processingErrors: array processingErrors
  The list of immunization records containing database processing errors.
• processingErrorsCount: integer (int32)
  The number of records with processing errors.
• status: string
  Allowed Values: [ "SUCCESS", "FAILED", "SKIPPED" ]

  Indicates if the database response to the record was successful (SUCCESS) or unsuccessful (FAILED), or if the database did not process the record (SKIPPED).

{
    "type":"object",
    "description":"The UploadStorageResult object contains the processing response on the results of the transaction.",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates if the database response to the record was successful (SUCCESS) or unsuccessful (FAILED), or if the database did not process the record (SKIPPED).",
            "enum":[
                "SUCCESS",
                "FAILED",
                "SKIPPED"
            ]
        },
        "message":{
            "description":"The text of the database processing error.",
            "type":"string"
        },
        "processingErrors":{
            "type":"array",
            "description":"The list of immunization records containing database processing errors.",
            "items":{
                "type":"string"
            }
        },
        "processedCount":{
            "type":"integer",
            "description":"The number of immunization records the database processed. This number equals the number of records in the transaction minus the count of records with validation errors.",
            "format":"int32"
        },
        "processingErrorsCount":{
            "type":"integer",
            "description":"The number of records with processing errors.",
            "format":"int32"
        }
    }
}

Nested Schema : processingErrors

Type: array

The list of immunization records containing database processing errors.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of immunization records containing database processing errors.",
    "items":{
        "type":"string"
    }
}

Back to Top