Skip to content

Commit 5ea158f

Browse files
committed
#264: Clarified documentation for actions.
1 parent bdd9982 commit 5ea158f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/specification/1.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ Field | Optionality | Type | Description
409409
----- | ----- | ----- | --------
410410
`type` | REQUIRED | *string* | The type of action being performed. Allowed values are: `create`, `update`, `delete`.
411411
`description` | REQUIRED | *string* | Human-readable description of the suggested action MAY be presented to the end-user.
412-
`resource` | OPTIONAL | *object* | Depending upon the `type` attribute, a new resource or the id of a resource. For a type of `create`, the `resource` attribute contains a new FHIR resource to apply within the current activity (e.g. for `medication-prescribe`, this holds the updated prescription as proposed by the suggestion). For `delete`, this is the id of any resource to remove (e.g. for the `order-review` activity, this would provide a way to remove an order from the pending list). In activities like `medication-prescribe` where only one "content" resource is ever relevant, this field MAY be omitted. For `update`, this holds the updated resource to modify from the current activity (e.g. for the `order-review` activity, this would provide a way to annotate an order from the pending list with an assessment).
412+
`resource` | OPTIONAL | *object* | Depending upon the `type` attribute, a new resource or the id of a resource. When the `type` attribute is `create`, the `resource` attribute contains a new FHIR resource to be created (e.g. for `medication-prescribe`, this holds the updated prescription as proposed by the suggestion). For `delete`, this is the id of any resource to remove (e.g. for the `order-review` hook, this would provide a way to remove an order from the pending list). In hooks like `medication-prescribe` where only one "content" resource is ever relevant, this field MAY be omitted for deletes only. For `update`, this holds the updated resource (e.g. for the `order-review` hook, this would provide a way to annotate an order from the pending list with an assessment).
413413

414414
#### Link
415415

0 commit comments

Comments
 (0)