PatientDocument

A document that is associated with a patient.

type PatientDocument {
  id: ID!
  title: String
  patient: Patient
  path: String
  name: String
  type: String
  url: String
  parent: ID
  deleted: Boolean
  dateShared: DateTime
  dateCreated: DateTime
  dateModified: DateTime
  uploadUrl: String
  downloadUrl: String
  shareDetails(
    includeDeleted: Boolean = false
    dateRange: DateRange
  ): [SharingRecipient]
}

Fields

PatientDocument.id ● ID! non-null scalar

PatientDocument.title ● String scalar

PatientDocument.patient ● Patient object

PatientDocument.path ● String scalar

Deprecated. Use parent instead.

PatientDocument.name ● String scalar

PatientDocument.type ● String scalar

PatientDocument.url ● String scalar

PatientDocument.parent ● ID scalar

PatientDocument.deleted ● Boolean scalar

PatientDocument.dateShared ● DateTime scalar

PatientDocument.dateCreated ● DateTime scalar

PatientDocument.dateModified ● DateTime scalar

PatientDocument.uploadUrl ● String scalar

A short lived document upload URL. Send a PUT request to this URL with the document as binary data.

  curl -v -X PUT \
    -H "Content-Type: application/octet-stream" \
    --data-binary @/path/to/yourfile.pdf \
    "https://example.com/upload-url"

PatientDocument.downloadUrl ● String scalar

A URL that can be used to download the patient document. This URL expires after two hours and can be used more than once.

PatientDocument.shareDetails ● [SharingRecipient] list object

PatientDocument.shareDetails.includeDeleted ● Boolean scalar

PatientDocument.shareDetails.dateRange ● DateRange input

Returned By

patientDocument query

Member Of

NewPatientDocumentPayload object ● PatientDocumentData object ● QuestionnaireResponsePayloadData object

Implemented By

Attachment union