Create integrated template

POST 
/integrated-templates/

Create integrated template

Request

application/json

Body

required

medical_specialty MedicalSpecialty (string)

Possible values: [ALLERGY, ANESTHESIOLOGY, CARDIOLOGY, DERMATOLOGY, ENDOCRINOLOGY, GASTROENTEROLOGY, GERIATRICS, GYNECOLOGY, HEMATOLOGY, INFECTIOUS_DISEASE, INTERNAL_MEDICINE, NEPHROLOGY, NEUROLOGY, OBSTETRICS, ONCOLOGY, OPHTHALMOLOGY, ORTHOPEDICS, OTOLARYNGOLOGY, PATHOLOGY, PEDIATRICS, PSYCHIATRY, PULMONOLOGY, RADIOLOGY, RHEUMATOLOGY, SURGERY, UROLOGY, SPORTS_MEDICINE, MAXILLOFACIAL, VASCULAR, EMERGENCY, NURSING, GENERAL]

Default value: GENERAL

report_metadata_idobject
anyOf
MOD1
integer
generate_report_template Generate Report Template (boolean)

Default value: true

Generate report template from the facility template.

include_ui_layout Include Ui Layout (boolean)

Define UI report section layout.

internal_id Internal Id (string)required
title Title (string)required
custom_jsonobject
anyOf
MOD1
object
fieldsobject

All desired fields correctly defined.

anyOf

MOD1

Array [

internal_id Internal Id (string)required

name Name (string)required

description Description (string)required

type FieldType (string)

Possible values: [TRANSCRIPT, DATETIME, STRING, NUMBER, BOOLEAN, LIST, CONCEPT, CONCEPT_LIST]

Default value: STRING

choice_set_idobject

anyOf

MOD1

integer

defaultobject

anyOf

MOD1

string

MOD2

integer

MOD3

number

MOD4

boolean

required Required (boolean)

mappingobject

JMESPath to field location in custom JSON

anyOf

MOD1

string

optionsobject

anyOf

MOD1

object

choicesobject

anyOf

MOD1

Array [

fhirCodes

object

anyOf

MOD1

object

internalCode

object

anyOf

MOD1

string

conceptSetId

object

anyOf

MOD1

integer

display

object

anyOf

MOD1

string

displayTranslations

object

anyOf

MOD1

property name* string

]

]

Responses

200

Successful Response

application/json

Schema

Schema

payload_specobjectrequired
internal_id Internal Id (string)required
title Title (string)required
custom_json
object
anyOf
MOD1
object
id Id (integer)required
fieldsobject[]required
Array [
internal_id Internal Id (string)required
name Name (string)required
description Description (string)required
type FieldType (string)
Possible values: [TRANSCRIPT, DATETIME, STRING, NUMBER, BOOLEAN, LIST, CONCEPT, CONCEPT_LIST]
Default value: STRING
choice_set_id
object
anyOf
MOD1
integer
default
object
anyOf
MOD1
string
MOD2
integer
MOD3
number
MOD4
boolean
required Required (boolean)
mapping
object
JMESPath to field location in custom JSON
anyOf
MOD1
string
options
object
anyOf
MOD1
object
id Id (integer)required
choice_set
object
anyOf
ConceptSetRead
name Name (string)required
description
object
anyOf
MOD1
string
facility_id
object
anyOf
MOD1
integer
id Id (integer)required
concepts
object[]
required
Array [
fhirCodes
object
anyOf
MOD1
object
internalCode
object
anyOf
MOD1
string
conceptSetId
object
anyOf
MOD1
integer
display Display (string)required
]
]
facility_id Facility Id (integer)required

report_template

object

anyOf

ReportTemplateInfo

questions

object[]

required

Array [

type QuestionType (string)required

Possible values: [STRING, NUMBER, BOOLEAN, LIST, CONCEPT, CONCEPT_LIST, SUBQUESTIONS]

A hint to feed the LLM so that it knows what it's looking for. Also used in the frontend to choose which widget to show (input, select, etc).

widget Widget (string)

Possible values: [TEXTAREA, TEXT, SELECT, LIST, GROUP, MULTISELECT, MULTIWIDGET, SUBQUESTIONS]

Default value: TEXTAREA

resourceType ResourceType (string)

Possible values: [OBSERVATION, CONDITION, MEDICATION_REQUEST, SERVICE_REQUEST, ALLERGY_INTOLERANCE, CARE_PLAN]

Default value: OBSERVATION

coding

object

anyOf

MOD1

object

choiceSetId

object

The id of the choice set.

anyOf

MOD1

integer

facilityId

object

anyOf

MOD1

integer

payloadFieldId

object

The id of the facility field the question is based on.

anyOf

MOD1

integer

parentQuestionId

object

The id of the parent question.

anyOf

MOD1

integer

title Title (string)required

The short description of the question. This is seen by the doctor as a label to the question

prompt

object

The question prompt that is fed to the LLM.

anyOf

MOD1

string

betaPrompt

object

anyOf

MOD1

string

description

object

anyOf

MOD1

string

id Id (integer)required

choices

object

The choices for a question, must be one of our 'Concepts'

anyOf

MOD1

Array [

id Id (integer)required

display Display (string)required

internal_code

object

anyOf

MOD1

string

]

method Method (string)

Possible values: [extractive, generative, manual, action]

Default value: extractive

]

structure

object

required

A report template structure dictates a report's sections, distribution, and entries' definitions by their question and targeting field.

sections

object[]

required

Array [

children

object

anyOf

MOD1

Array [

0

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

]

entries

object

anyOf

MOD1

Array [

question_id Question Id (integer)required

target_field_id

object

Target field pk id of the linked facility map.

anyOf

MOD1

integer

]

title

object

anyOf

MOD1

string

title_translations

object

anyOf

MOD1

property name* string

]

payload_spec_id

object

Facility map ID.

anyOf

MOD1

integer

report_metadata_id Report Metadata Id (integer)required

Id of the linked report metadata.

Example (from schema)

{
  "payload_spec": {
    "internal_id": "string",
    "title": "string",
    "custom_json": {},
    "id": 0,
    "fields": [
      {
        "internal_id": "string",
        "name": "string",
        "description": "string",
        "type": "STRING",
        "choice_set_id": 0,
        "default": "string",
        "required": false,
        "mapping": "string",
        "options": {},
        "id": 0,
        "choice_set": {}
      }
    ],
    "facility_id": 0
  },
  "report_template": {}
}

422

Validation Error

application/json

Schema

Schema

detailobject[]

Array [

locobject[]required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...