Skip to content
API reference/
API Reference
/
/
Create Pathway

Create Pathway

Request

Creates a pathway and its initial submission types for the requesting practice group.

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
titlestringrequired
summarystring
in_hoursboolean
Default:false
out_of_hoursboolean
Default:false
suspendedboolean
Default:false
orderinteger, > 0
submission_typesArray of objects, non-emptyrequired
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/care-nav/pathways \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "title": "string",
    "summary": "string",
    "in_hours": false,
    "out_of_hours": false,
    "suspended": false,
    "order": 0,
    "submission_types": [
      {
        "title": "string",
        "description": "string",
        "in_hours": false,
        "out_of_hours": false,
        "suspended": false,
        "form_id": "string",
        "external_url": "http://example.com",
        "external_url_name": "string",
        "type": "admin_request",
        "default_priority": "lowest",
        "daily_limit": 0,
        "patient_eligibility_check": true,
        "assignee_id": "string",
        "assignee_type": "Admin",
        "order": 0
      }
    ]
  }'

Responses

Created

Bodyapplication/json
idstring^\d+$required
titlestringrequired
summarystring or nullrequired
in_hoursboolean or nullrequired
out_of_hoursboolean or nullrequired
suspendedboolean or nullrequired
ordernumber or nullrequired
created_atstring or null, (date-time)required
updated_atstring or null, (date-time)required
Response
{
  "id": "string",
  "title": "string",
  "summary": "string",
  "in_hours": true,
  "out_of_hours": true,
  "suspended": true,
  "order": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}