v1

latestOpenAPI 3.0.12026-07-2649123153.6 KB

/api/v1/info

Get Suki Medical form templates

Returns Suki-defined Medical form templates. Use each template's template_id as form_template_id when seeding or updating form-filling session context.

get/api/v1/info/suki-medical-form-templates

Headers

sdp_provider_idstring

Example:provider-123

Optional for standard partners.

Required for:

Bearer authentication. Use the same provider_id returned by the Login or Register API.
Single Auth Token authentication. Include the same provider_id on every request as sdp_provider_id.

Response

Request succeeded.

Example response

{
  "form_templates": [
    {
      "description": "Standard vitals collection template for adult patients.",
      "name": "Adult Vitals",
      "template_id": "019d4cdc-9319-7d81-ae2e-fd6de7f1b4f0",
      "type": "VITALS_ASSESSMENT",
      "schema": {
        "items": [
          {
            "code": "Q003",
            "id": "respiratory_pattern",
            "kind": "field",
            "options": [
              {
                "code": null,
                "display": "Regular"
              },
              {
                "code": null,
                "display": "Shallow"
              },
              {
                "code": null,
                "display": "Deep"
              },
              {
                "code": null,
                "display": "Labored"
              },
              {
                "code": null,
                "display": "Tachypneic (rapid breathing)"
              },
              {
                "code": null,
                "display": "Bradypneic (slow breathing)"
              },
              {
                "code": null,
                "display": "Irregular"
              },
              {
                "code": null,
                "display": "Apneic (no spontaneous breathing)"
              }
            ],
            "pattern": "",
            "question": "Respiratory Pattern / Effort",
            "type": "radio"
          }
        ]
      }
    }
  ]
}