Skip to main content

Consultation PDF downloads

The Public API Consultation type now exposes pdfDownloadUrl. The URL downloads the consultation as a PDF and expires after 15 minutes.

query ConsultationPdf($patientId: ID!, $consultationId: String!) {
consultation(patientId: $patientId, consultationId: $consultationId) {
id
pdfDownloadUrl
}
}

The download checks the API credential's current seeNotes permission and consultation visibility. A link stops working if the permission is revoked or the consultation becomes inaccessible through access-group or confidentiality restrictions.

See Consultation for the field reference.