Skip to content

Commit 45b12dc

Browse files
isaacvetterisaacvetter
authored
Merge pull request #430 from cds-hooks/propose-condition-create-hook
create problem-list-item-create
2 parents bcc72e5 + b1e38c8 commit 45b12dc

File tree

2 files changed

+178
-0
lines changed

2 files changed

+178
-0
lines changed

‎docs/hooks/problem-list-item-create.md

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# `problem-list-item-create`
2+
3+
| Metadata | Value
4+
| ---- | ----
5+
| specificationVersion | 1.0
6+
| hookVersion | 0.1.0
7+
| hookMaturity | [1 - Submitted](../../specification/current/#hook-maturity-model)
8+
9+
## Workflow
10+
11+
The `problem-list-item-create` hook fires once a clinician has added one or more new problems to a patient's problem list.
12+
This hook may fire with one or more newly added conditions of category `problem-list-item` that are newly finalized.
13+
The context of the hook includes these new conditions. Note that this hook occurs once the new problem(s) is finalized; thereby enabling the CDS Service to recommend actions related to the problem in lieu of suggesting modifications to the newly created problem.
14+
15+
## Context
16+
17+
Field | Optionality | Prefetch Token | Type | Description
18+
----- | -------- | ---- | ---- | ----
19+
`userId` | REQUIRED | Yes | *string* | The id of the current user.<br />For this hook, the user is expected to be of type [Practitioner](https://www.hl7.org/fhir/practitioner.html) or [PractitionerRole](https://www.hl7.org/fhir/practitioner.html).<br />For example, PractitionerRole/123 or Practitioner/abc.
20+
`patientId` | REQUIRED | Yes | *string* | The FHIR `Patient.id` of the current patient in context
21+
`encounterId` | OPTIONAL | Yes | *string* | The FHIR `Encounter.id` of the current encounter in context
22+
`conditions` | REQUIRED | No | *object* | DSTU2 - FHIR Bundle of Conditions where `category` is `problem-list-item`<br/> STU3 - FHIR Bundle of Conditions where `category` is `problem-list-item`<br/> R4 - FHIR Bundle of Conditions where `category` is `problem-list-item`
23+
24+
### Example (R4)
25+
26+
```json
27+
{
28+
"context": {
29+
"userId": "Practitioner/123",
30+
"patientId": "1288992",
31+
"encounterId": "89284",
32+
"conditions": {
33+
"resourceType": "Bundle",
34+
"entry": [
35+
{
36+
"resource": {
37+
"resourceType": "Condition",
38+
"id": "3a14127f",
39+
"category": "problem-list-item",
40+
"clinicalStatus": {
41+
"coding": [
42+
{
43+
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
44+
"code": "active"
45+
}
46+
]
47+
},
48+
"verificationStatus": {
49+
"coding": [
50+
{
51+
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
52+
"code": "confirmed"
53+
}
54+
]
55+
},
56+
"code": {
57+
"coding": [
58+
{
59+
"system": "http://snomed.info/sct",
60+
"code": "16114001",
61+
"display": "Fracture of ankle"
62+
}
63+
],
64+
"text": "Fracture of ankle"
65+
},
66+
"subject": {
67+
"reference": "Patient/1288992"
68+
},
69+
"onsetDateTime": "2018-10-15T04:13:17-04:00",
70+
"assertedDate": "2018-11-15"
71+
}
72+
}
73+
]
74+
}
75+
}
76+
}
77+
```
78+
79+
### Example (STU3)
80+
81+
```json
82+
{
83+
"context":{
84+
"userId":"Practitioner/123",
85+
"patientId":"1288992",
86+
"encounterId":"89284",
87+
"conditions":{
88+
"resourceType":"Bundle",
89+
"entry":[
90+
{
91+
"resource":{
92+
"resourceType":"Condition",
93+
"id":"3a14127f",
94+
"category":"problem-list-item",
95+
"clinicalStatus":"active",
96+
"verificationStatus":"confirmed",
97+
"code":{
98+
"coding":[
99+
{
100+
"system":"http://snomed.info/sct",
101+
"code":"16114001",
102+
"display":"Fracture of ankle"
103+
}
104+
],
105+
"text":"Fracture of ankle"
106+
},
107+
"subject":{
108+
"reference":"Patient/1288992"
109+
},
110+
"onsetDateTime":"2018-10-15T04:13:17-04:00",
111+
"assertedDate":"2018-11-15"
112+
}
113+
}
114+
]
115+
}
116+
}
117+
}
118+
```
119+
120+
### Example (DSTU2)
121+
122+
```json
123+
{
124+
"context": {
125+
"userId": "Practitioner/123",
126+
"patientId": "1288992",
127+
"encounterId": "89284",
128+
"conditions": {
129+
"resourceType": "Bundle",
130+
"entry": [
131+
{
132+
"resource": {
133+
"resourceType": "Condition",
134+
"id": "smart-Condition-548",
135+
"category": {
136+
"text": "Problem",
137+
"coding": [
138+
{
139+
"system": "http://argonautwiki.hl7.org/extension-codes",
140+
"code": "problem",
141+
"display": "Problem"
142+
}
143+
]
144+
},
145+
"text": {
146+
"status": "generated",
147+
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Vitamin D deficiency</div>"
148+
},
149+
"patient": {
150+
"reference": "Patient/1288992"
151+
},
152+
"code": {
153+
"coding": [
154+
{
155+
"system": "http://snomed.info/sct",
156+
"code": "34713006",
157+
"display": "Vitamin D deficiency"
158+
}
159+
],
160+
"text": "Vitamin D deficiency"
161+
},
162+
"clinicalStatus": "active",
163+
"verificationStatus": "confirmed",
164+
"onsetDateTime": "2018-11-15"
165+
}
166+
}
167+
]
168+
}
169+
}
170+
}
171+
```
172+
173+
## Change Log
174+
175+
Version | Description
176+
---- | ----
177+
0.1.0 | Initial Release

‎mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ nav:
2828
- 'encounter-start 1' : 'hooks/encounter-start.md'
2929
- 'encounter-discharge 1' : 'hooks/encounter-discharge.md'
3030
- 'medication-refill 1' : 'hooks/medication-refill.md'
31+
- 'problem-list-item-create 1' : 'hooks/problem-list-item-create.md'
3132
- Quick Start: 'quickstart.md'
3233
- Cheat Sheet: 'cheat-sheet/Cheat Sheet - Sept 2019.pdf'
3334
- Best Practices: 'best-practices.md'

0 commit comments

Comments
 (0)