cliniko: Find Treatment Notes – Appmixer connector library

Basic Information

Name

appmixer.cliniko.core.FindTreatmentNotes

Label

Find Treatment Notes

Version

1.0.0

Visibility

Public

Description

Searches treatment notes by patient, practitioner or draft status. Returns up to 100 treatment notes (one page at the maximum page size). Note that the API key inherits the permissions of its Cliniko user - a user without clinical access gets a 403 here.

Input Ports

in

Field	Type	Description
Patient	text	Start typing to search your patients, or enter a Patient ID directly.
Practitioner	text	Start typing to pick a practitioner, or enter a Practitioner ID directly.
Draft	select	Restrict to draft or finalised notes.
Created After	date-time	-
Updated After	date-time	-
Output Type	select	Choose whether you want to receive the result set as one complete list, first item only, one item at a time, or stream the items to a file.

Output Ports

out

Dynamic variables loaded from /component/appmixer/cliniko/core/FindTreatmentNotes?outPort=out&ignoreAuth=true

notFound

Field	Type	Description
No fields defined for this port

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.cliniko.core.FindTreatmentNotes", "label": "Find Treatment Notes", "description": "Searches treatment notes by patient, practitioner or draft status. Returns up to 100 treatment notes (one page at the maximum page size). Note that the API key inherits the permissions of its Cliniko user - a user without clinical access gets a 403 here.", "author": "Appmixer <info@appmixer.com>", "version": "1.0.0", "auth": { "service": "appmixer:cliniko" }, "quota": { "manager": "appmixer:cliniko", "resources": "requests", "scope": { "userId": "{{userId}}" } }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "patientId": { "type": "string" }, "practitionerId": { "type": "string" }, "draft": { "type": "string" }, "createdAtFrom": { "type": "string", "format": "date-time" }, "updatedAtFrom": { "type": "string", "format": "date-time" }, "outputType": { "type": "string" } } }, "inspector": { "inputs": { "patientId": { "type": "text", "index": 1, "label": "Patient", "tooltip": "Start typing to search your patients, or enter a Patient ID directly.", "source": { "url": "/component/appmixer/cliniko/core/FindPatients?outPort=out", "data": { "transform": "./FindPatients#toSelectArray", "messages": { "in/outputType": "array", "in/isSource": true } } } }, "practitionerId": { "type": "text", "index": 2, "label": "Practitioner", "tooltip": "Start typing to pick a practitioner, or enter a Practitioner ID directly.", "source": { "url": "/component/appmixer/cliniko/core/ListPractitioners?outPort=out", "data": { "transform": "./ListPractitioners#toSelectArray", "messages": { "in/outputType": "array", "in/isSource": true } } } }, "draft": { "type": "select", "index": 3, "label": "Draft", "tooltip": "Restrict to draft or finalised notes.", "options": [ { "label": "Any", "value": "" }, { "label": "Draft only", "value": "true" }, { "label": "Finalised only", "value": "false" } ] }, "createdAtFrom": { "type": "date-time", "index": 4, "label": "Created After" }, "updatedAtFrom": { "type": "date-time", "index": 5, "label": "Updated After" }, "outputType": { "type": "select", "label": "Output Type", "defaultValue": "array", "tooltip": "Choose whether you want to receive the result set as one complete list, first item only, one item at a time, or stream the items to a file.", "options": [ { "label": "First Item Only", "value": "first" }, { "label": "All items at once", "value": "array" }, { "label": "One item at a time", "value": "object" }, { "label": "Store to CSV file", "value": "file" } ], "index": 6 } } } } ], "outPorts": [ { "name": "out", "source": { "url": "/component/appmixer/cliniko/core/FindTreatmentNotes?outPort=out&ignoreAuth=true", "data": { "properties": { "generateOutputPortOptions": true }, "messages": { "in/outputType": "inputs/in/outputType" } } } }, { "name": "notFound" } ], "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA4MCA4MCIgcm9sZT0iaW1nIiBhcmlhLWxhYmVsPSJDbGluaWtvIj48cmVjdCB3aWR0aD0iODAiIGhlaWdodD0iODAiIGZpbGw9IiNGRkZGRkYiLz48ZyB0cmFuc2Zvcm09InRyYW5zbGF0ZSg1LjUsMTAuNSkiPjxnIHN0cm9rZT0ibm9uZSIgc3Ryb2tlLXdpZHRoPSIxIiBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxnIGZpbGwtcnVsZT0ibm9uemVybyI+PHBhdGggZD0iTTMxLjEsMjQuMiBDMzAuNywyMy44IDMwLjYsMjMuMiAzMSwyMi44IEMzMS40LDIyLjQgMzIsMjIuMyAzMi40LDIyLjcgQzM0LjIsMjQuMiAzNi41LDI0LjEgMzgsMjIuNyBDMzguNCwyMi4zIDM5LDIyLjQgMzkuNCwyMi44IEMzOS44LDIzLjIgMzkuNywyMy44IDM5LjMsMjQuMiBDMzcuMSwyNi4yIDMzLjYsMjYuNCAzMS4xLDI0LjIgWiIgZmlsbD0iIzAwQTlDRSI+PC9wYXRoPjxwYXRoIGQ9Ik0xOC43LDQuOCBDMTksNC41IDE4LjgsNC4yIDE5LjUsMy43IEMyMS40LDIuMSAyOCwyLjMgMjguNiw0LjYgQzI4LjgsNS4zIDI5LDQuOSAzMi4zLDUuNyBDMzIuNSw1LjcgMzMuMiw2IDMzLjIsNS43IEMzMy4yLDUuNSAzMi41LDQuNSAzMi4zLDQuMyBDMjgsLTEuMSAxOS43LC0xLjQgMTUuMSwzLjggQzE0LjksNCAxMy41LDUuNSAxNCw1LjggQzE0LjMsNiAxNC41LDUuNyAxOC4xLDUuMSBDMTguNCw1IDE4LjYsNSAxOC43LDQuOCBaIiBmaWxsPSIjNkFEMUUzIj48L3BhdGg+PHBhdGggZD0iTTIzLjcsOS4xIEMyNS4xLDkuMSAyNi44LDYuMSAyNi43LDUuNSBDMjYuNSwzLjggMjAuOSwzLjggMjAuOCw1LjUgQzIwLjgsNiAyMi40LDkuMSAyMy43LDkuMSBaIiBmaWxsPSIjMDBBOUNFIj48L3BhdGg+PHBhdGggZD0iTTM0LjUsOC4zIEMzNC40LDcuOSAzNC4zLDcuNyAzMy45LDcuNiBDMzMuNSw3LjQgMzEuOCw2LjkgMjkuNCw2LjcgQzI4LjgsNi42IDI4LjIsNi40IDI3LjksNyBDMjcuNSw3LjYgMjcuMiw4LjIgMjYuNyw4LjcgQzI0LjQsMTEuNSAyMi43LDExLjcgMjAuMSw3LjQgQzE5LjMsNi4xIDE4LjEsNi42IDE2LjksNi44IEMxNi4xLDcgMTMuNiw3LjUgMTMuMiw3LjcgQzEyLjgsNy45IDEyLjcsOC42IDEyLjYsOS40IEMxMS43LDE0LjUgMTQuNCwxOS40IDE4LjksMjEuNSBDMTkuMiwyMS42IDE5LjYsMjEuOCAxOS41LDIyLjEgQzE5LjQsMjIuNyAxOC4zLDIzIDE3LjksMjMuMyBDMTQuMSwyNS4yIDEwLjUsMjguMyA3LjYsMzIuNCBDMi44LDM5LjQgMS4yLDQ3LjUgMC44LDU2IEMwLjcsNTcuMiAxLjcsNTguMSAyLjgsNTguMSBMNy4zLDU4LjEgQzguMyw1OC4xIDkuMSw1Ny40IDkuMyw1Ni41IEM5LjgsNTEuOCAxMC44LDQ2LjMgMTMsNDIuMSBDMTYuMywzNS40IDIxLjQsMzAuNyAyNi4yLDI4LjQgQzI3LjEsMjggMjguMiwyNy42IDI3LjMsMjYuNSBDMjIuMSwyMCAyNi4yLDExLjMgMzMuNSwxMC4yIEMzNC43LDEwLjEgMzUsMTAgMzQuNSw4LjMgWiIgZmlsbD0iIzZBRDFFMyI+PC9wYXRoPjxwYXRoIGQ9Ik01NC42LDI3IEM1NC4zLDI2LjggNTMuNywyNi41IDUzLjcsMjYuMSBDNTMuNywyNS43IDU0LjIsMjUuNiA1NC41LDI1LjQgQzYzLjIsMjAgNTkuMyw2LjcgNDkuMiw2LjcgQzQ2LjUsNi43IDQzLjksNy44IDQyLjMsOS40IEM0MS44LDkuOSA0MC4yLDExLjMgNDAuOSwxMi4xIEM0MS4yLDEyLjQgNDEuNiwxMi43IDQxLjksMTIuOSBDNDMuOCwxNC43IDQ1LDE3LjMgNDUsMjAuMSBDNDUsMjIuMiA0NC40LDIzLjkgNDMuMywyNS43IEM0MywyNi4zIDQyLjMsMjYuOCA0MywyNy40IEM0NC41LDI4LjYgNTAuNiwzMS42IDU1LjQsMzkuMiBDNTcuOCw0My4xIDU5LjgsNDcuNyA2MC43LDU2LjIgQzYwLjcsNTcuMiA2MS42LDU4LjIgNjIuNyw1OC4yIEw2Nyw1OC4yIEM2OC4xLDU4LjIgNjksNTcuNCA2OSw1Ni4zIEM2OC43LDQ1IDYzLjgsMzMuNCA1NC42LDI3IFoiIGZpbGw9IiMwNUMzREUiPjwvcGF0aD48cGF0aCBkPSJNNTcuNyw1Ni4yIEM1Ny40LDUzLjMgNTYuOSw1MC44IDU2LDQ3LjkgQzUzLjksNDEuMiA0OS43LDM0LjQgNDMuNCwzMS41IEM0Mi4xLDMwLjkgMzguMywyOS42IDM3LjQsMzAuNiBDMzYuOSwzMS4xIDM3LjEsMzIgMzcuNSwzNS43IEMzOC43LDQ3LjYgMzguOCw0OC44IDM4LjgsNDkuNCBDMzguOCw1MC41IDM2LjYsNTIuNSAzNi4yLDUyLjkgQzM1LjksNTMuMiAzNS4zLDUzLjIgMzQuOSw1Mi45IEMzNC42LDUyLjUgMzIuNCw1MC41IDMyLjQsNDkuNSBDMzIuNCw0Ny4xIDM0LjEsMzIgMzQuMSwzMS41IEMzNC4xLDI5LjYgMzEuOSwzMC40IDMwLjksMzAuNiBDMjMsMzIuNCAxNy43LDQwLjIgMTUuMiw0OCBDMTQuMiw1MS4xIDEzLjYsNTQuOSAxMy41LDU2LjEgQzEzLjQsNTcuMiAxNC40LDU4LjIgMTUuNSw1OC4yIEw1NS41LDU4LjIgQzU2LjgsNTguMiA1Ny43LDU3LjIgNTcuNyw1Ni4yIFoiIGZpbGw9IiMwMEE5Q0UiPjwvcGF0aD48L2c+PC9nPjwvZz48L3N2Zz4=" }