Newer Version Available

This content describes an older version of this product. View Latest

Medication Statements (PUT)

Update existing medication statements for a patient.
Resource
1/connect/health/clinical/patients/${patientId}/medication-statement/${medicationStatementId}
Example
1https://yourInstance.salesforce.com/services/data/v55.0/connect/
2health/clinical/patients/001RM000005PF3BYAW/medication-statement/0juRM00000000dDYAQ
Available version
55.0
Requires Chatter
No
HTTP methods
PUT
Request body for PUT
Root XML tag
<MedStatementInputPayload>
JSON example
1{
2   "medicationStatement":{
3      "identifier":[
4         {
5            "assigner":{
6               "referenceResource":"Organization",
7               "salesforceId":"001RM000005EBfKYAW"
8            },
9            "type":{
10               "text":"Passport number",
11               "coding":[
12                  {
13                     "display":"Passport number",
14                     "code":"PPN",
15                     "isActive":true,
16                     "use":"Identifier"
17                  }
18               ]
19            },
20            "value":"ABCD5678",
21            "use":"Official",
22            "periodStart":"1998-05-26T15:40:30.000Z",
23            "periodEnd":"2021-08-09T15:40:30.000Z",
24            "sourceSystem":"http://sfdc.co",
25            "sourceSystemId":"567890",
26            "sourceSystemModifiedDate":"2012-07-26T15:40:30.000Z"
27         },
28         {
29            "assigner":{
30               "referenceResource":"Organization",
31               "salesforceId":"001RM000005EBfKYAW"
32            },
33            "type":{
34               "text":"Passport number1",
35               "coding":[
36                  {
37                     "display":"Passport number",
38                     "code":"PPN",
39                     "isActive":true,
40                     "use":"Identifier"
41                  }
42               ]
43            },
44            "value":"ABCD5678B",
45            "use":"Official",
46            "periodStart":"1998-05-26T15:40:30.000Z",
47            "periodEnd":"2021-08-09T15:40:30.000Z",
48            "sourceSystem":"http://sfdc.co",
49            "sourceSystemId":"567890",
50            "sourceSystemModifiedDate":"2012-07-26T15:40:30.000Z"
51         }
52      ],
53      "basedOn":[
54         {
55            "referenceResource":"MedicationRequest",
56            "referenceId":"",
57            "salesforceId":"0kmRM0000004CHMYA2",
58            "relationship":""
59         },
60         {
61            "referenceResource":"MedicationRequest",
62            "referenceId":"",
63            "salesforceId":"0kmRM0000004CHMYA2",
64            "relationship":""
65         }
66      ],
67      "partOf":[
68         {
69            "referenceResource":"MedicationStatement",
70            "salesforceId":"0juRM00000000PzYAI",
71            "relationship":""
72         },
73         {
74            "referenceResource":"Procedure",
75            "referenceId":"",
76            "salesforceId":"0jQRM0000004CNU2A2",
77            "relationship":""
78         },
79         {
80            "referenceResource":"Observation",
81            "referenceId":"",
82            "salesforceId":"0hIRM0000004CsM2AU",
83            "relationship":""
84         },
85         {
86            "referenceResource":"MedicationDispense",
87            "referenceId":"",
88            "salesforceId":"0NBRM0000004CGx4AM",
89            "relationship":""
90         },
91         {
92            "referenceResource":"MedicationDispense",
93            "referenceId":"",
94            "salesforceId":"0NBRM00000000Jz4AI",
95            "relationship":""
96         },
97         {
98            "referenceResource":"MedicationDispense",
99            "referenceId":"",
100            "salesforceId":"0NBRM0000004CGx4AM",
101            "relationship":""
102         }
103      ],
104      "status":"active",
105      "statusReason":[
106         {
107            "codeableConcept":{
108               "text":"Burn of Ear status reason",
109               "coding":[
110                  {
111                     "display":"Burn of status reasonn ear",
112                     "code":"1234995607",
113                     "system":"http://sfdc.co",
114                     "version":"2.16.840.1.113883.6.96",
115                     "isActive":true,
116                     "isPrimary":true,
117                     "use":"Clinical",
118                     "userSelected":true,
119                     "startDate":"1993-11-09T15:40:30.000Z",
120                     "endDate":"2021-08-24T17:00:00.000Z"
121                  }
122               ]
123            }
124         },
125         {
126            "codeableConcept":{
127               "text":"Burn of Ear status reason",
128               "coding":[
129                  {
130                     "display":"Burn of status reasonn ear",
131                     "code":"1234785607",
132                     "system":"http://sfdc.co",
133                     "version":"2.16.840.1.113883.6.96",
134                     "isActive":true,
135                     "isPrimary":true,
136                     "use":"Clinical",
137                     "userSelected":true,
138                     "startDate":"1993-11-09T15:40:30.000Z",
139                     "endDate":"2021-08-24T17:00:00.000Z"
140                  }
141               ]
142            }
143         }
144      ],
145      "category":"Inpatient",
146      "medication":{
147         "medicationReference":{
148            "referenceResource":"Medication",
149            "referenceId":"",
150            "salesforceId":"0itRM0000004CUkYAM",
151            "relationship":""
152         }
153      },
154      "context":{
155         "referenceResource":"Encounter",
156         "referenceId":"",
157         "salesforceId":"0kGRM0000004CWZ2A2",
158         "relationship":""
159      },
160      "effectiveStartDateTime":"2012-07-26T15:40:30.000Z",
161      "effectiveEndDateTime":"2012-07-27T15:40:30.000Z",
162      "dateAsserted":"2012-07-26T15:40:30.000Z",
163      "informationSource":{
164         "referenceResource":"Patient",
165         "referenceId":"",
166         "relationship":"",
167         "salesforceId":"001RM000005EBfKYAW"
168      },
169      "derivedFrom":[
170         {
171            "referenceResource":"MedicationRequest",
172            "referenceId":"",
173            "salesforceId":"0kmRM0000004CHMYA2",
174            "relationship":""
175         },
176         {
177            "referenceResource":"MedicationRequest",
178            "referenceId":"",
179            "salesforceId":"0kmRM0000004CHMYA2",
180            "relationship":""
181         },
182         {
183            "referenceResource":"Procedure",
184            "referenceId":"",
185            "salesforceId":"0jQRM0000004CNU2A2",
186            "relationship":""
187         },
188         {
189            "referenceResource":"ServiceRequest",
190            "referenceId":"",
191            "salesforceId":"0jyRM000000000aYAA",
192            "relationship":""
193         },
194         {
195            "referenceResource":"MedicationDispense",
196            "referenceId":"",
197            "salesforceId":"0NBRM0000004CGx4AM",
198            "relationship":""
199         },
200         {
201            "referenceResource":"MedicationStatement",
202            "referenceId":"",
203            "salesforceId":"0juRM00000000TSYAY",
204            "relationship":""
205         },
206         {
207            "referenceResource":"Observation",
208            "referenceId":"",
209            "salesforceId":"0hIRM0000004CsM2AU",
210            "relationship":""
211         },
212         {
213            "referenceResource":"Condition",
214            "salesforceId":"0j4RM0000004CJXYA2",
215            "relationship":""
216         },
217         {
218            "referenceResource":"DiagnosticReport",
219            "salesforceId":"0lQRM000000000k2AA",
220            "relationship":""
221         }
222      ],
223      "reasonCode":[
224         {
225            "salesforceId":"0iPRM0000004CuR2AU"
226         },
227         {
228            "codeableConcept":{
229               "text":"Burn of Ear sdfstatus reason",
230               "coding":[
231                  {
232                     "display":"Burn of status reasonn ear",
233                     "code":"12345dsn607",
234                     "system":"http://sfdc.co",
235                     "version":"2.16.840.1.113883.6.96",
236                     "isActive":true,
237                     "isPrimary":true,
238                     "use":"Clinical",
239                     "userSelected":true,
240                     "startDate":"1993-11-09T15:40:30.000Z",
241                     "endDate":"2021-08-24T17:00:00.000Z"
242                  }
243               ]
244            }
245         }
246      ],
247      "reasonReference":[
248         {
249            "referenceResource":"Condition",
250            "salesforceId":"0j4RM0000004CJXYA2",
251            "relationship":""
252         },
253         {
254            "referenceResource":"Observation",
255            "salesforceId":"0hIRM0000004CsM2AU",
256            "relationship":""
257         },
258         {
259            "referenceResource":"DiagnosticReport",
260            "salesforceId":"0lQRM000000000k2AA",
261            "relationship":""
262         }
263      ],
264      "sourceSystem":"http://sfdc.co",
265      "sourceSystemId":"567890",
266      "sourceSystemModified":"2012-07-26T15:40:30.000Z",
267      "dosage":[
268         {
269            "sequence":"10.0",
270            "text":"commentsText",
271            "additionalInstruction":"Additioanl Instructions",
272            "patientInstruction":"Patient Instructions",
273            "asNeeded":"true",
274            "site":{
275               "codeableConcept":{
276                  "text":"Burn of Ear route2",
277                  "coding":[
278                     {
279                        "display":"Burn of ear route2",
280                        "code":"61234567002",
281                        "system":"http://sfdc.co",
282                        "version":"2.16.840.1.113883.6.96",
283                        "isActive":true,
284                        "isPrimary":true,
285                        "use":"Clinical",
286                        "userSelected":true,
287                        "startDate":"1993-11-09T15:40:30.000Z",
288                        "endDate":"2021-08-24T17:00:00.000Z"
289                     }
290                  ]
291               }
292            },
293            "route":{
294               "codeableConcept":{
295                  "text":"Burn of Ear route",
296                  "coding":[
297                     {
298                        "display":"Burn of ear route",
299                        "code":"12344456700",
300                        "system":"http://sfdc.co",
301                        "version":"2.16.840.1.113883.6.96",
302                        "isActive":true,
303                        "isPrimary":true,
304                        "use":"Clinical",
305                        "userSelected":true,
306                        "startDate":"1993-11-09T15:40:30.000Z",
307                        "endDate":"2021-08-24T17:00:00.000Z"
308                     }
309                  ]
310               }
311            },
312            "method":{
313               "codeableConcept":{
314                  "text":"Burn of Ear Method",
315                  "coding":[
316                     {
317                        "display":"Burn of ear",
318                        "code":"12345637777",
319                        "system":"http://sfdc.co",
320                        "version":"2.16.840.1.113883.6.96",
321                        "isActive":true,
322                        "isPrimary":true,
323                        "use":"Clinical",
324                        "userSelected":true,
325                        "startDate":"1993-11-09T15:40:30.000Z",
326                        "endDate":"2021-08-24T17:00:00.000Z"
327                     }
328                  ]
329               }
330            },
331            "doseAndRate":{
332               "type":"Ordered",
333               "dose":{
334                  "dosageQuantityType":"Dose",
335                  "dosageQuantityNumerator":"10",
336                  "dosageQuantityDenominator":"20",
337                  "dosageUnit":{
338                     "unitOfMeasure":{
339                        "unitCode":"MGTttest",
340                        "description":"MG description",
341                        "type":"Custom"
342                     }
343                  }
344               },
345               "rate":{
346                  "dosageRateType":"Frequency Ratio",
347                  "dosageRateNumerator":"2",
348                  "dosageRateDenominator":"3",
349                  "dosageRateUnit":{
350                     "unitOfMeasure":{
351                        "unitCode":"MGTeste2",
352                        "description":"MG description2",
353                        "type":"Custom"
354                     }
355                  }
356               }
357            },
358            "sourceSystem":"http://sfdc.co",
359            "sourceSystemId":"567890",
360            "sourceSystemModified":"2012-07-26T15:40:30.000Z"
361         },
362         {
363            "sequence":"100.0",
364            "text":"commentsText2",
365            "additionalInstruction":"Additioanl Instructions2",
366            "patientInstruction":"Patient Instructions2",
367            "asNeeded":"false",
368            "site":{
369               "codeableConcept":{
370                  "text":"Burn of Ear route2",
371                  "coding":[
372                     {
373                        "display":"Burn of ear route2",
374                        "code":"12345674002",
375                        "system":"http://sfdc.co",
376                        "version":"2.16.840.1.113883.6.96",
377                        "isActive":true,
378                        "isPrimary":true,
379                        "use":"Clinical",
380                        "userSelected":true,
381                        "startDate":"1993-11-09T15:40:30.000Z",
382                        "endDate":"2021-08-24T17:00:00.000Z"
383                     }
384                  ]
385               }
386            },
387            "route":{
388               "codeableConcept":{
389                  "text":"Burn of Ear route2",
390                  "coding":[
391                     {
392                        "display":"Burn of ear route2",
393                        "code":"12345670032",
394                        "system":"http://sfdc.co",
395                        "version":"2.16.840.1.113883.6.96",
396                        "isActive":true,
397                        "isPrimary":true,
398                        "use":"Clinical",
399                        "userSelected":true,
400                        "startDate":"1993-11-09T15:40:30.000Z",
401                        "endDate":"2021-08-24T17:00:00.000Z"
402                     }
403                  ]
404               }
405            },
406            "method":{
407               "codeableConcept":{
408                  "text":"Burn of Ear Method2",
409                  "coding":[
410                     {
411                        "display":"Burn of ear Method2",
412                        "code":"1234567777577",
413                        "system":"http://sfdc.co",
414                        "version":"2.16.840.1.113883.6.96",
415                        "isActive":true,
416                        "isPrimary":true,
417                        "use":"Clinical",
418                        "userSelected":true,
419                        "startDate":"1993-11-09T15:40:30.000Z",
420                        "endDate":"2021-08-24T17:00:00.000Z"
421                     }
422                  ]
423               }
424            },
425            "doseAndRate":{
426               "type":"Ordered",
427               "dose":{
428                  "dosageQuantityType":"Dose",
429                  "dosageQuantityNumerator":"100",
430                  "dosageQuantityDenominator":"200",
431                  "dosageUnit":{
432                     "unitOfMeasure":{
433                        "unitCode":"MGTest23",
434                        "description":"MG description2",
435                        "type":"Custom"
436                     }
437                  }
438               },
439               "rate":{
440                  "dosageRateType":"Frequency Ratio",
441                  "dosageRateNumerator":"200",
442                  "dosageRateDenominator":"300",
443                  "dosageRateUnit":{
444                     "unitOfMeasure":{
445                        "unitCode":"MGTest24",
446                        "description":"MG description2",
447                        "type":"Custom"
448                     }
449                  }
450               }
451            },
452            "sourceSystem":"http://sfdc.co",
453            "sourceSystemId":"567890",
454            "sourceSystemModified":"2012-07-26T15:40:30.000Z"
455         }
456      ]
457   }
458}
Properties
Name Type Description Required or Optional Available Version
medicationStatement FHIR Medication Statement Represents a record of a patient’s medication statement. Required 54.0
Response body for PUT
Medication Statement Update Output