|
| 1 | +--- |
| 2 | +nodes: |
| 3 | +- name: ssd_api_data_staging |
| 4 | + fields: |
| 5 | + - name: id |
| 6 | + description: identifier for json record |
| 7 | + item_ref: APIS1001A |
| 8 | + type: nvarchar |
| 9 | + categories: |
| 10 | + - admin |
| 11 | + constraints: |
| 12 | + - pk |
| 13 | + cms: |
| 14 | + - liquid_logic |
| 15 | + - mosaic |
| 16 | + - eclipse |
| 17 | + - azeus |
| 18 | + - caredirector |
| 19 | + guidance: SSD ADMIN only table/field |
| 20 | + - name: person_id |
| 21 | + description: associated person id with json payload, person_id also duplicated |
| 22 | + within payload |
| 23 | + item_ref: APIS1002A |
| 24 | + type: nvarchar |
| 25 | + categories: |
| 26 | + - admin |
| 27 | + returns: |
| 28 | + - Local |
| 29 | + cms: |
| 30 | + - liquid_logic |
| 31 | + - mosaic |
| 32 | + - eclipse |
| 33 | + - azeus |
| 34 | + - caredirector |
| 35 | + guidance: SSD ADMIN only table/field |
| 36 | + - name: json_payload |
| 37 | + description: agreed json data payload in line with api specification |
| 38 | + item_ref: APIS1003A |
| 39 | + type: nvarchar |
| 40 | + categories: |
| 41 | + - admin |
| 42 | + returns: |
| 43 | + - Local |
| 44 | + cms: |
| 45 | + - liquid_logic |
| 46 | + - mosaic |
| 47 | + - eclipse |
| 48 | + - azeus |
| 49 | + - caredirector |
| 50 | + guidance: SSD ADMIN only table/field |
| 51 | + - name: current_hash |
| 52 | + description: computed hash from pending or last sent payload |
| 53 | + item_ref: APIS1004A |
| 54 | + type: BINARY |
| 55 | + categories: |
| 56 | + - admin |
| 57 | + cms: |
| 58 | + - liquid_logic |
| 59 | + - mosaic |
| 60 | + - eclipse |
| 61 | + - azeus |
| 62 | + - caredirector |
| 63 | + guidance: SSD ADMIN only table/field |
| 64 | + - name: previous_hash |
| 65 | + description: computed hash on current data payload |
| 66 | + item_ref: APIS1005A |
| 67 | + type: BINARY |
| 68 | + categories: |
| 69 | + - admin |
| 70 | + cms: |
| 71 | + - liquid_logic |
| 72 | + - mosaic |
| 73 | + - eclipse |
| 74 | + - azeus |
| 75 | + - caredirector |
| 76 | + guidance: SSD ADMIN only table/field |
| 77 | + - name: submission_status |
| 78 | + description: status flag string of json payload in relation to outgoing transmission |
| 79 | + - Pending, Sent, Error |
| 80 | + item_ref: APIS1006A |
| 81 | + type: nvarchar |
| 82 | + categories: |
| 83 | + - admin |
| 84 | + cms: |
| 85 | + - liquid_logic |
| 86 | + - mosaic |
| 87 | + - eclipse |
| 88 | + - azeus |
| 89 | + - caredirector |
| 90 | + guidance: SSD ADMIN only table/field |
| 91 | + - name: submission_timestamp |
| 92 | + description: Generated timestamp from api process GETDATE() |
| 93 | + item_ref: APIS1007A |
| 94 | + type: datetime |
| 95 | + categories: |
| 96 | + - admin |
| 97 | + cms: |
| 98 | + - liquid_logic |
| 99 | + - mosaic |
| 100 | + - eclipse |
| 101 | + - azeus |
| 102 | + - caredirector |
| 103 | + guidance: SSD ADMIN only table/field |
| 104 | + - name: api_response |
| 105 | + description: reponse code and detail returned from api endpoint |
| 106 | + item_ref: APIS1008A |
| 107 | + type: nvarchar |
| 108 | + categories: |
| 109 | + - admin |
| 110 | + cms: |
| 111 | + - liquid_logic |
| 112 | + - mosaic |
| 113 | + - eclipse |
| 114 | + - azeus |
| 115 | + - caredirector |
| 116 | + guidance: SSD ADMIN only table/field |
| 117 | + - name: row_state |
| 118 | + description: status flag string describing whether json record contains new, updated, |
| 119 | + deleted, unchanged data within the record. Only those not flagged unchanged |
| 120 | + are included in any api transmission. |
| 121 | + item_ref: APIS1009A |
| 122 | + type: nvarchar |
| 123 | + categories: |
| 124 | + - admin |
| 125 | + cms: |
| 126 | + - liquid_logic |
| 127 | + - mosaic |
| 128 | + - eclipse |
| 129 | + - azeus |
| 130 | + - caredirector |
| 131 | + guidance: SSD ADMIN only table/field |
| 132 | + - name: last_updated |
| 133 | + description: timestamp for the last time the row json record was updated/extracted |
| 134 | + item_ref: APIS1010A |
| 135 | + type: datetime |
| 136 | + categories: |
| 137 | + - admin |
| 138 | + cms: |
| 139 | + - liquid_logic |
| 140 | + - mosaic |
| 141 | + - eclipse |
| 142 | + - azeus |
| 143 | + - caredirector |
| 144 | + guidance: SSD ADMIN only table/field |
0 commit comments