Skip to main content
POST
/
api
/
v2
/
hie
/
documents
/
upload
Python
from samplehc import SampleHealthcare

client = SampleHealthcare(
    api_key="My API Key",
)
response = client.v2.hie.documents.upload(
    description="description",
    document_type={
        "text": "text"
    },
    file_metadata_id="fileMetadataId",
    patient_id="patientId",
)
print(response)
{}

Body

application/json
​
patientId
string
required

The external Patient ID that you store and can use to reference this Patient.

​
fileMetadataId
string
required

The ID of the file metadata to upload.

​
documentType
object
required

The type of document being uploaded.

​
description
string
required

A brief description of the document.

​
facilityName
string

The name and type of facility (e.g., 'John Snow Clinic - Acute Care Centre').

​
dateStart
string

ISO 8601 timestamp for when the document period starts.

​
dateEnd
string

ISO 8601 timestamp for when the document period ends.

Response

200 - application/json

Default Response

The response is of type object.

⌘I