Skip to content
API Docs/
/WriteToRecord

WriteToRecord

Check the status of write-to-record operations for messages sent to the EHR.

Operations

Get Write to Record status

Request

Get the latest Write to Record status for a resource.

Security
apiKeyAuth and practiceGroupId
Query
resource_typestring(ResourceType)required

The resource type to check.

Enum:"form_response""communication""consultation""prescription"
Example:resource_type=consultation
resource_idstringrequired

The resource ID to check.

Example:resource_id=12345
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/write-to-record/status?resource_type=consultation&resource_id=12345' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
resource_typestringrequired
Enum:"form_response""communication""consultation""prescription"
resource_idstringrequired
statusstringrequired
Enum:"pending""success""failed""permanent_failure""in_progress"
detailsstring or null
updated_atstring or null, (date-time)required
write_to_record_atstring or null, (date-time)required
Response
{
  "resource_type": "form_response",
  "resource_id": "string",
  "status": "pending",
  "details": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "write_to_record_at": "2019-08-24T14:15:22Z"
}