The Documents API is used to manage documents that are linked to patients within Particle Health's Master Patient Index. Documents can be created, updated, retrieved, and deleted. All documents can also be listed for a given patient. The networks ask for C-CDA documents, but the actual format of the document is typically flexible (typically in XML, which is the format that most EMRs use, but PDFs/scans are also acceptable).
Important Notes
Each document requires a patient_id, and this patient_idmust already exist in Particle's Master Patient Index before a document can be successfully uploaded. See Patients API for more information.
Details on acceptable document types can be found in the FAQs.
Successful requests will return a 200 OK, but you can also use a GET request to retrieve a document and verify that it was uploaded successfully.
API Functions
Document Create and Update
Description:
Creates a new document and stores it in Particle Health's system, or updates an existing document.
Note: Learn more about code sets in the response here.
Retrieve Posted Document
Description:
Retrieves a specific document (metadata only) that your organization has uploaded to Particle Health. Can be used to verify that a document has been successfully uploaded.
[
{ Documents Model },
{ Documents Model },
{ Documents Model }
]
Code Value Sets
To enable systems to parse and handle documents successfully, all document metadata must include codes to identify the type, format, and content of the data that the document contains. The following value sets should be used wherever possible:
Code Type
Description
Resource Link
Format Code
The code specifying the technical format of the document. There is no value to default to, so this field is required.
The code specifying the clinical specialty where the act that resulted in the document was performed (e.g., Family Practice, Laboratory, Radiology). If no value is specified, this field will default to “394733009”, which corresponds to “Medical specialty--OTHER--NOT LISTED”
The code specifying the type of organizational setting of the clinical encounter during which the documented act occurred. If no value is specified, this field will default to “394777002”, which corresponds to “Health encounter site--NOT LISTED”.
The code specifying the high-level category of document (e.g. Prescription, Discharge Summary, Report, etc.). There is no value to default to, so this field is required.
The code specifying the precise type of document from the user perspective (e.g. LOINC code). There is no value to default to, so this field is required.