Embedded & SDK: API Outputs
The Autoscriber API can generate different types of outputs. In your request you can specify multiple and you will receive all of them in the result.
JSON Output definition:
{ ... rest of body "out": [{ "type": "standard_en", "toggleCodes": true, "coding_systems": ["SNOMED_CT"] }] }
Attributes:
Name |
Description |
Type |
Required/Optional |
type | See here for Dutch templates See here for English templates |
Boolean | Required |
toggleCodes | To indicate if you want to receive medical coding with the note. | Boolean | Optional |
coding_systems | Whether SNOMED_CT or ICD10 medical codes are generated. If coding is needed, then either "SNOMED_CT" or "ICD10" must be included |
String | If If |
JSON Example result:
{ "standard_en": { "final": true, "data": [ { "items": [ { "sentences": [], "text": "Strong heachaches since 5 days" } ], "section": "Subjectief" }, { "items": [ { "sentences": [], "text": "Refer to neurologist" } ], "section": "Plan" } ] } }
Types with episodes
- soap_en
- soap_nl
- soap_de
JSON Example result:
{ "soap_nl": { "final": true, "data": [{ "episode": "Headache", "note": [ { "items": [ { "sentences": [], "text": "Strong heachaches since 5 days" } ], "section": "Subjectief" }, { "items": [ { "sentences": [], "text": "Refer to neurologist" } ], "section": "Plan" } ] }] }, }