Documents

Submit Document

Changed on Nov 3, 2026

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

filestring binary required

Document File Upload

Example request

{
  "metadata": {
    "patient_id": "client-patient-identifier-patient1",
    "document_id": "client-patient1-document1",
    "type": "CLINICAL",
    "title": "patent1_standard_lab_results.xml",
    "mime_type": "application/xml",
    "creation_time": "2018-08-12T12:52:00Z",
    "format_code": "urn:ihe:lab:xd-lab:2008",
    "type_code": "11502-2",
    "class_code": "11506-3",
    "confidentiality_code": "N",
    "healthcare_facility_type_code": "394777002",
    "practice_setting_code": "394733009",
    "service_start_time": "2018-08-12T11:18:00Z",
    "service_stop_time": "2018-08-12T12:50:00Z"
  }
}

Response

class_codestring 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_codestring

The code specifying the security classification of the document. Reference -https://terminology.hl7.org/2.1.0/CodeSystem-v3-Confidentiality.html

creation_timestring required

The timestamp representing when the document was created. Must be in the format of RFC3339

document_idstring required

The unique document id in an external system

format_codestring required

The code specifying the technical format of the document. Reference - https://www.hl7.org/fhir/r4/valueset-formatcodes.html

healthcare_facility_type_codestring

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_typestring required

The document's mime-type

patient_idstring required

The unique patient id in an external system

practice_setting_codestring 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_timestring

The start time of the service being documented. Must be in the format of RFC3339

service_stop_timestring

The stop time of the service being documented. Must be in the format of RFC3339

titlestring required

The document's human readable title

typestring required

The high-level document type

type_codestring 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

Example response

{
  "class_code": "11506-3",
  "confidentiality_code": "N",
  "creation_time": "2018-08-12T12:52:00Z",
  "document_id": "client-patient1-document1",
  "format_code": "urn:ihe:lab:xd-lab:2008",
  "healthcare_facility_type_code": "73770003",
  "mime_type": "application/xml",
  "patient_id": "client-patient-identifier-patient1",
  "practice_setting_code": "394802001",
  "service_start_time": "2018-08-12T11:18:00Z",
  "service_stop_time": "2018-08-12T12:50:00Z",
  "shared_documents": [
    {
      "deleted": "2018-08-12T12:52:00Z",
      "retrieved": "2018-08-12T12:52:00Z",
      "status": "RETRIEVED",
      "subscriber_project_id": "client-project-identifier",
      "updated": "2018-08-12T12:52:00Z"
    }
  ],
  "title": "patent1_standard_lab_results.xml",
  "type": "CLINICAL",
  "type_code": "11502-2"
}

Changes

Nov 3, 2026b59a5413a488 Revision changes
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  added the new required request property /
- breaking
  the request property type changed from string to object
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history