Upload Document

This endpoint returns the DocumentReference ID and a URL to enable you to upload your patients’ medical documents, making them available to other HIEs.

​

Overview

To use this endpoint, you will need to follow these steps:

1. Create a DocumentReference to describe the document that’s being uploaded (see sections below for details on the expected fields and format).

2. Execute the endpoint and receive a URL to use for the document upload.

3. Upload the document by executing a PUT request using the URL with a Content-Length header specifying the size of the document.

​

Query Params

​

Body

A FHIR DocumentReference.

Example Payload:

{
  description: "Third degree wrist burn treatment",
  type: {
    text: "Burn management Hospital Progress note",
    coding: [
      {
        code: "100556-0",
        system: "http://loinc.org",
        display: "Burn management Hospital Progress note"
      },
    ],
  },
  context: {
    period: {
      start: "2023-10-10T14:14:17Z",
      end: "2023-10-10T15:30:30Z",
    },
    facilityType: {
      text: "John Snow Clinic - Acute Care Centre",
    },
  },
};

​

Response

The DocumentReference ID and a URL to be used for file upload.

{
  "documentReferenceId": "<DocumentReference-ID-string>",
  "uploadUrl": "<url-string>"
}