aws-comprehend

A project feature flag for AWS Comprehend. Ovok accepts and stores it, but turning it on by itself does not enable any operation today.

Type	Project feature
Value in features	aws-comprehend
Change with	PATCH /v1/projects/me/features (replaces the whole list)
Who can change it	Project admin. Any practitioner can read the list.
On for new projects	No
Effect when on, by itself	None
Effect when off	None

Where Comprehend analysis comes from

With only aws-comprehend on, the textract operation still answers 400 with AWS Textract not enabled, with or without "comprehend": true.

AWS Comprehend Medical runs as an option of the aws-textract operation. Add "comprehend": true to its body, and the extracted text is analysed for medical entities. That path is governed by the aws-textract feature alone.

curl --request POST \
  --url "https://api.sandbox.ovok.com/fhir/R4/Media/${MEDIA_ID}/\$aws-textract" \
  --header "Authorization: Bearer ${OVOK_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{"comprehend":true}'

What to do

• To get Comprehend Medical analysis, enable aws-textract and send comprehend: true.
• You can add aws-comprehend to the list. It is accepted and stored, and it changes nothing.

Gotchas

• Enabling it is not a way to switch Comprehend on. Do not assume that having the flag means the capability is available, and do not assume that removing it turns an analysis off.
• The flag can be set on a project that cannot use it. The route that uses Comprehend still needs aws-textract and the platform's S3 file storage.
• Your text goes to AWS. See the data-handling notes on aws-textract.

Related

• aws-textract
• Settings and features