Produced by Araxis Merge on 10/4/2017 8:04:33 AM Central Daylight Time. See www.araxis.com for information about Merge. This report uses XHTML and CSS2, and is best viewed with a modern standards-compliant browser. For optimum results when printing this report, use landscape orientation and enable printing of background images and colours in your browser.
| # | Location | File | Last Modified |
|---|---|---|---|
| 1 | rdk.zip\rdk\product\production\rdk\src\fhir\communication | communication-resource.md | Mon Aug 21 12:51:00 2017 UTC |
| 2 | rdk.zip\rdk\product\production\rdk\src\fhir\communication | communication-resource.md | Tue Oct 3 17:15:06 2017 UTC |
| Description | Between Files 1 and 2 |
|
|---|---|---|
| Text Blocks | Lines | |
| Unchanged | 3 | 324 |
| Changed | 2 | 4 |
| Inserted | 0 | 0 |
| Removed | 0 | 0 |
| Whitespace | |
|---|---|
| Character case | Differences in character case are significant |
| Line endings | Differences in line endings (CR and LF characters) are ignored |
| CR/LF characters | Not shown in the comparison detail |
No regular expressions were active.
| 1 | # Group FH IR | |
| 2 | ||
| 3 | ## Communi cation [{{ {path}}}] | |
| 4 | ||
| 5 | ### Commun ications [ GET {{{pat h}}}{?requ ester.user Id}{&reque ster.ehmpA ppVersion} {&*categor y}{&status .system}{& status.cod e}{&overri dePreferen ces}] | |
| 6 | ||
| 7 | Retrieves system wid e message specified site admin istrators and mainta iners | |
| 8 | ||
| 9 | + Paramete rs | |
| 10 | ||
| 11 | + requ ester.user Id (string , required ) | |
| 12 | ||
| 13 | + requ ester.ehmp AppVersion : `2.0.123 ` (string, required) The versi on applica tion used to make th e request. | |
| 14 | ||
| 15 | + category : `http:// ehmp. DNS /messageCa tegories/a nnouncemen ts-promoti ons` (stri ng, requir ed) Uri, A Uniform R esource Id entifier R eference | |
| 16 | ||
| 17 | + stat us: `http: //hl7.org/ fhir/Value Set/commun ication-st atus/compl ete` (stri ng, option al) Uri, A Uniform R esource Id entifier R eference | |
| 18 | + Default: ` http://hl7 .org/fhir/ ValueSet/c ommunicati on-status/ complete` | |
| 19 | ||
| 20 | + over ridePrefer ences (boo lean, opti onal) - If set to tr ue, return messages even if us er prefere nces dicta te not ret urn messag e | |
| 21 | + Default: ` false` | |
| 22 | ||
| 23 | + Response 200 (appl ication/js on) | |
| 24 | ||
| 25 | :[Response 400]({{{c ommon}}}/r esponses/4 00.md) | |
| 26 | ||
| 27 | :[Response 404]({{{c ommon}}}/r esponses/4 04.md) | |
| 28 | ||
| 29 | :[Response 500]({{{c ommon}}}/r esponses/5 00.md) | |
| 30 | ||
| 31 | + Response 503 (appl ication/js on) | |
| 32 | ||
| 33 | + Body | |
| 34 | ||
| 35 | { | |
| 36 | "mes sage": " S ervice Una vailable." , | |
| 37 | "sta tus": 503 | |
| 38 | } | |
| 39 | ||
| 40 | + Sche ma | |
| 41 | ||
| 42 | :[Schema ]({{{commo n}}}/schem as/message .jsonschem a) | |
| 43 | ||
| 44 | ### Commun ication Me ssage Atta chment [GE T {{{path} }}/{identi fier}/atta chment/{at tachment}] | |
| 45 | ||
| 46 | Retrieves attachment s delivere d with com munication messages | |
| 47 | ||
| 48 | + Paramete rs | |
| 49 | ||
| 50 | + iden tifier (st ring, requ ired) | |
| 51 | + atta chment (st ring, requ ired) | |
| 52 | ||
| 53 | + Response 200 (appl ication/js on) | |
| 54 | ||
| 55 | :[Response 400]({{{c ommon}}}/r esponses/4 00.md) | |
| 56 | ||
| 57 | :[Response 404]({{{c ommon}}}/r esponses/4 04.md) | |
| 58 | ||
| 59 | :[Response 500]({{{c ommon}}}/r esponses/5 00.md) | |
| 60 | ||
| 61 | + Response 503 (appl ication/js on) | |
| 62 | ||
| 63 | + Body | |
| 64 | ||
| 65 | { | |
| 66 | "mes sage": " S ervice Una vailable." , | |
| 67 | "sta tus": 503 | |
| 68 | } | |
| 69 | ||
| 70 | + Sche ma | |
| 71 | ||
| 72 | :[Schema ]({{{commo n}}}/schem as/message .jsonschem a) | |
| 73 | ||
| 74 | ### User M essage Pre ferences [ POST {{{p ath}}}/pre ferences] | |
| 75 | ||
| 76 | Updates us er the pre ferences o n what kin d of messa ges they w ish to rec eive | |
| 77 | ||
| 78 | + Request JSON Messa ge (applic ation/json ) | |
| 79 | ||
| 80 | + Body | |
| 81 | ||
| 82 | { | |
| 83 | "cat egory": { | |
| 84 | "code": "A lert", | |
| 85 | "system": "http://eh mp. DNS /messagety pes" | |
| 86 | }, | |
| 87 | "ena bled": fal se, | |
| 88 | "use rId": "urn :va:user:9 E7A:100000 00270" | |
| 89 | } | |
| 90 | ||
| 91 | + Sche ma | |
| 92 | ||
| 93 | { | |
| 94 | "$sc hema": "ht tp://json- schema.org /draft-04/ schema#", | |
| 95 | "typ e": "objec t", | |
| 96 | "pro perties": { | |
| 97 | "category" : { | |
| 98 | "type" : "object" , | |
| 99 | "requi red": [ | |
| 100 | "c ode", | |
| 101 | "s ystem" | |
| 102 | ], | |
| 103 | "prope rties": { | |
| 104 | "c ode": { | |
| 105 | "type": "string" | |
| 106 | }, | |
| 107 | "s ystem": { | |
| 108 | "type": "string" | |
| 109 | } | |
| 110 | } | |
| 111 | }, | |
| 112 | "enabled": { | |
| 113 | "type" : "boolean " | |
| 114 | }, | |
| 115 | "userId": { | |
| 116 | "type" : "string" | |
| 117 | } | |
| 118 | }, | |
| 119 | "req uired": [ | |
| 120 | "category" , | |
| 121 | "enabled", | |
| 122 | "userId" | |
| 123 | ] | |
| 124 | } | |
| 125 | ||
| 126 | + Response 200 (appl ication/js on) | |
| 127 | ||
| 128 | + Body | |
| 129 | ||
| 130 | { | |
| 131 | "sta tus": 200 | |
| 132 | } | |
| 133 | ||
| 134 | + Sche ma | |
| 135 | ||
| 136 | { | |
| 137 | "$sc hema": "ht tp://json- schema.org /draft-04/ schema#", | |
| 138 | "typ e": "objec t", | |
| 139 | "pro perties": { | |
| 140 | "status": { | |
| 141 | "type" : "number" | |
| 142 | } | |
| 143 | } | |
| 144 | } | |
| 145 | ||
| 146 | :[Response 400]({{{c ommon}}}/r esponses/4 00.md) | |
| 147 | ||
| 148 | :[Response 404]({{{c ommon}}}/r esponses/4 04.md) | |
| 149 | ||
| 150 | :[Response 500]({{{c ommon}}}/r esponses/5 00.md) | |
| 151 | ||
| 152 | ||
| 153 | + Response 503 (appl ication/js on) | |
| 154 | ||
| 155 | + Body | |
| 156 | ||
| 157 | { | |
| 158 | "mes sage": " S ervice Una vailable." , | |
| 159 | "sta tus": 503 | |
| 160 | } | |
| 161 | ||
| 162 | + Sche ma | |
| 163 | ||
| 164 | :[Schema ]({{{commo n}}}/schem as/message .jsonschem a) |
Araxis Merge (but not the data content of this report) is Copyright © 1993-2016 Araxis Ltd (www.araxis.com). All rights reserved.