Update records using HL7 data in a JSON file
put
/v0/upload/hl7/json
Upload updated 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
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
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
Response
Supported Media Types
- application/json
Default Response
The default response contains 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.
Root Schema : UploadStatusResponse
Type:
Show Source
object
-
id: string
(uuid)
The unique identifier (UUID) of the transaction.
-
storageResult: object
storageResult
Additional Properties Allowed: UploadStorageResultThe 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.
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.
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.
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).
Nested Schema : processingErrors
Type:
array
The list of immunization records containing database processing errors.
Show Source