Skip to content
API reference/
API Reference
/
/
Update Submission Type

Update Submission Type

Request

Updates a submission type for the requesting practice group.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
titlestring
descriptionstring or null
in_hoursboolean
out_of_hoursboolean
suspendedboolean
form_idstring or null^\d+$
external_urlstring or null, (uri)
external_url_namestring or null
typestring or null
Enum:"admin_request""clinical_request""other_request"
default_prioritystring
Enum:"lowest""low""medium""high""highest"
daily_limitinteger or null, > 0
patient_eligibility_checkboolean or null
assignee_idstring or null^\d+$
assignee_typestring or null
Enum:"Admin""AdminTeam"
orderinteger, > 0
curl -i -X PATCH \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/care-nav/submission-types/{id}' \
  -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",
    "description": "string",
    "in_hours": true,
    "out_of_hours": true,
    "suspended": true,
    "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

Ok

Bodyapplication/json
idstring^\d+$required
pathway_idstring^\d+$required
form_idstring or null^\d+$required
titlestringrequired
descriptionstring or nullrequired
in_hoursbooleanrequired
out_of_hoursbooleanrequired
suspendedbooleanrequired
external_urlstring or nullrequired
external_url_namestring or nullrequired
typestring or nullrequired
Enum:"admin_request""clinical_request""other_request"
default_prioritystringrequired
Enum:"lowest""low""medium""high""highest"
daily_limitinteger or nullrequired
forms_submitted_todayinteger, >= 0required

Number of forms submitted for this submission type on the current day.

patient_eligibility_checkboolean or nullrequired
assignee_idstring or null^\d+$required
assignee_typestring or nullrequired
Enum:"Admin""AdminTeam"
ordernumber or nullrequired
created_atstring or null, (date-time)required
updated_atstring or null, (date-time)required
Response
{
  "id": "string",
  "pathway_id": "string",
  "form_id": "string",
  "title": "string",
  "description": "string",
  "in_hours": true,
  "out_of_hours": true,
  "suspended": true,
  "external_url": "string",
  "external_url_name": "string",
  "type": "admin_request",
  "default_priority": "lowest",
  "daily_limit": 0,
  "forms_submitted_today": 0,
  "patient_eligibility_check": true,
  "assignee_id": "string",
  "assignee_type": "Admin",
  "order": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}