Skip to content

Commit 96735b7

Browse files
authored
Merge pull request #449 from cds-hooks/issue/202-add-hook-context-naming-recommendation
Recommend that hook authors name their context fields consistent with other hooks
2 parents 3b8416b + 8435e8b commit 96735b7

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
@@ -830,7 +830,7 @@ Describe the set of contextual data used by this hook. Only data logically and n
830830

831831
All fields defined by the hook's context MUST be defined in a table where each field is described by the following attributes:
832832

833-
- Field: The name of the field in the context JSON object.
833+
- Field: The name of the field in the context JSON object. Hook authors SHOULD name their context fields to be consistent with other existing hooks when referring to the same context field.
834834
- Optionality: A string value of either `REQUIRED` or `OPTIONAL`
835835
- Prefetch Token: A string value of either `Yes` or `No`, indicating whether this field can be tokenized in a prefetch template.
836836
- Type: The type of the field in the context JSON object, expressed as the JSON type, or the name of a FHIR Resource type. Valid types are *boolean*, *string*, *number*, *object*, *array*, or the name of a FHIR resource type. When a field can be of multiple types, type names MUST be separated by a *pipe* (`|`)

0 commit comments

Comments
 (0)