Upload Document

Upload a document to be ingested into Zus as FHIR resources.

Use this endpoint to upload clinical documents to be transformed into FHIR resources and stored in Zus. Accepts PDF and CCDA formats.

post/upload

Request

  • Base URL
    https://data-transformer.sandbox.zusapi.com
  • URL
    https://data-transformer.sandbox.zusapi.com/upload
  • Auth
    HTTP bearer

Request body

OR

Example request

{
  "data": {
    "attributes": {
      "documentData": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPGNkYQ==",
      "documentMediaType": "application/xml"
    },
    "relationships": {
      "patient": {
        "data": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    }
  }
}

Response

Upload has been successfully started.

Example response

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "attributes": {
      "documentMediaType": "application/xml",
      "documentPeriodEnd": "59284-0",
      "documentPracticeSetting": "394733009",
      "documentFacility": "394777002",
      "documentDescription": "EKG-SCAN",
      "documentAuthor": "Dr. John Smith",
      "builderId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "relationships": {
      "patient": {
        "data": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.