Skip to content
API reference/
API Reference
/
/
Get Care Navigation Submi...

Get Care Navigation Submission

Request

Get a care navigation submission and its fields. An acting admin without the required policies still receives the submission, with the attachment link and file name removed from any attachment answer.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/care-nav/submissions/{id}' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstringrequired
created_atstring, (date-time)required
titlestringrequired
write_to_recordobject or null
typestring or null
Enum:"Admin request""Clinical request""Other request"
descriptionstringrequired
patient_titlestring or nullrequired
patient_descriptionstring or nullrequired
confirmation_messagestring or nullrequired
fieldsArray of objectsrequired
patient_idstring
appointment_idnumber or nullrequired
Response
{
  "id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "title": "string",
  "write_to_record": {
    "write_to_record_at": "2019-08-24T14:15:22Z",
    "status": "string",
    "failure_reason": "string"
  },
  "type": "Admin request",
  "description": "string",
  "patient_title": "string",
  "patient_description": "string",
  "confirmation_message": "string",
  "fields": [
    { … }
  ],
  "patient_id": "string",
  "appointment_id": 0
}