---
title: "Submit Document"
method: POST
path: "/api/v1/documents"
tags: ["Documents"]
---

# Submit Document

`POST /api/v1/documents`

## Request

- Base URL: `https://sandbox.particlehealth.com`
- URL: `https://sandbox.particlehealth.com/api/v1/documents`
- Auth: API key in header `Authorization`

## Request body `multipart/form-data`

- object
  - `file` string, binary, required: Document File Upload
  - `metadata` ApiDocumentMetadata, required: Metadata describing the uploaded document. Sent as a JSON-encoded part of the multipart request.
    - `patient_id` string, required: The unique patient id in an external system. The patient must already exist in Particle MPI.
    - `document_id` string, required: The unique document id in an external system
    - `type` 'CLINICAL' | 'CONSENT', required: The high-level document type
    - `title` string, required: The document's human readable title
    - `mime_type` string, required: The document's mime-type
    - `creation_time` string, date-time, required: The timestamp representing when the document was created. Must be in the format of RFC3339
    - `format_code` string, required: The code specifying the technical format of the document. Reference - https://www.hl7.org/fhir/r4/valueset-formatcodes.html
    - `type_code` string, required: The code specifying the precise type of document from the user perspective (e.g., LOINC code). Reference - https://www.hl7.org/fhir/r4/valueset-doc-typecodes.html. Must be a LOINC code.
    - `class_code` string, required: The code specifying the high-level kind of document (e.g. Prescription, Discharge Summary, Report, etc.). Reference - https://www.hl7.org/fhir/r4/valueset-document-classcodes.html. Must be a LOINC code.
    - `confidentiality_code` string: The code specifying the security classification of the document. Reference -https://terminology.hl7.org/2.1.0/CodeSystem-v3-Confidentiality.html. Defaults to N when omitted or empty.
    - `healthcare_facility_type_code` string: The code specifying the type of organizational setting of the clinical encounter during which the documented act occurred. Reference - https://www.hl7.org/fhir/valueset-c80-facilitycodes.html. Defaults to 394777002 when omitted or empty.
    - `practice_setting_code` string: The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology). Reference - https://www.hl7.org/fhir/valueset-c80-practice-codes.html. Defaults to 394733009 when omitted or empty.
    - `service_start_time` string, date-time: The start time of the service being documented. Must be in the format of RFC3339
    - `service_stop_time` string, date-time: The stop time of the service being documented. Must be in the format of RFC3339

## Response `200`

OK

- ApiDocument
  - `class_code` string, required: The code specifying the high-level kind of document (e.g. Prescription, Discharge Summary, Report, etc.). Reference - https://www.hl7.org/fhir/r4/valueset-document-classcodes.html
  - `confidentiality_code` string: The code specifying the security classification of the document. Reference -https://terminology.hl7.org/2.1.0/CodeSystem-v3-Confidentiality.html
  - `creation_time` string, required: The timestamp representing when the document was created. Must be in the format of RFC3339
  - `document_id` string, required: The unique document id in an external system
  - `format_code` string, required: The code specifying the technical format of the document. Reference - https://www.hl7.org/fhir/r4/valueset-formatcodes.html
  - `healthcare_facility_type_code` string: The code specifying the type of organizational setting of the clinical encounter during which the documented act occurred. Reference - https://www.hl7.org/fhir/valueset-c80-facilitycodes.html
  - `mime_type` string, required: The document's mime-type
  - `patient_id` string, required: The unique patient id in an external system
  - `practice_setting_code` string, required: The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology). Reference - https://www.hl7.org/fhir/valueset-c80-practice-codes.html
  - `service_start_time` string: The start time of the service being documented. Must be in the format of RFC3339
  - `service_stop_time` string: The stop time of the service being documented. Must be in the format of RFC3339
  - `shared_documents` ApiC2CDocumentStatus[]: Document status shared with the subscribers
    - `deleted` string
    - `retrieved` string
    - `status` string
    - `subscriber_project_id` string
    - `updated` string
  - `title` string, required: The document's human readable title
  - `type` string, required: The high-level document type
  - `type_code` string, required: The code specifying the precise type of document from the user perspective (e.g., LOINC code). Reference - https://www.hl7.org/fhir/r4/valueset-doc-typecodes.html

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `406`: Not Acceptable
- `500`: Internal Server Error

## Changes

- **2026-11-03** `b59a5413a488`: 10 breaking, 9 info
  - added the new required request property `metadata/class_code`
  - added the new required request property `metadata/creation_time`
  - added the new required request property `metadata/document_id`
  - added the new required request property `metadata/format_code`
  - …15 more

[Operation history](https://skmtc.dev/particlehealth/apis/particle-health-api/changes/api/v1/documents/post.md)

---

[API](https://skmtc.dev/particlehealth/apis/particle-health-api.md) - [All operations](https://skmtc.dev/particlehealth/apis/particle-health-api/llms.txt) - [OpenAPI document](https://skmtc.dev/particlehealth/apis/particle-health-api/revisions/b59a5413a488?raw)