Creates a consent request to get data about a patient by HIU user. CM should call Gateway - /v0.5/consent-requests/on-init API with the consent-request-id
643 matches
14 actions
Health Data Consent Manager
14 actions
- API for HIP initiated care-context linking for patientPOSTv1.0.0
- Consent notificationPOSTv1.0.0
- Consent notificationPOSTv1.0.0
- Create consent requestPOSTv1.0.0
- Get a patient's authentication modes relevant to specified purposePOSTv1.0.0
- Get consent artefactPOSTv1.0.0
- Get consent request statusGETv1.0.0
- Get consent request statusPOSTv1.0.0
- Identify a patient by her consent-manager user-idPOSTv1.0.0
- Initialize authentication from HIPPOSTv1.0.0
- Request for subscriptionPOSTv1.0.0
- Response to patient's account discovery requestPOSTv1.0.0
- Response to patient's care context link requestPOSTv1.0.0
- Response to patient's share profile requestPOSTv1.0.0
Other/Health Data Consent Manager
Create consent request
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
{
"type": "object",
"required": [
"consent",
"requestId",
"timestamp"
],
"properties": {
"consent": {
"type": "object",
"required": [
"consentNotificationUrl",
"hiTypes",
"hiu",
"patient",
"permission",
"purpose",
"requester"
],
"properties": {
"careContexts": {
"type": "array",
"items": {
"type": "object",
"required": [
"patientReference",
"careContextReference"
],
"properties": {
"careContextReference": {
"type": "string"
},
"patientReference": {
"type": "string"
}
}
}
},
"hiTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"OPConsultation",
"Prescription",
"DischargeSummary",
"DiagnosticReport"
]
}
},
"hip": {
"type": "object"
},
"hiu": {
"type": "object"
},
"patient": {
"type": "object"
},
"permission": {
"type": "object",
"required": [
"accessMode",
"dataEraseAt",
"dateRange",
"frequency"
],
"properties": {
"accessMode": {
"type": "string",
"enum": [
"VIEW",
"STORE",
"QUERY",
"STREAM"
]
},
"dataEraseAt": {
"type": "string",
"format": "date-time"
},
"dateRange": {
"type": "object",
"required": [
"from",
"to"
],
"properties": {
"from": {
"type": "string",
"format": "date-time"
},
"to": {
"type": "string",
"format": "date-time"
}
}
},
"frequency": {
"type": "object",
"properties": {
"repeats": {
"type": "integer"
},
"unit": {
"type": "string",
"enum": [
"HOUR",
"WEEK",
"DAY",
"MONTH",
"YEAR"
]
},
"value": {
"type": "integer"
}
}
}
}
},
"purpose": {
"type": "object",
"required": [
"code",
"text"
],
"properties": {
"code": {
"type": "string",
"description": "From the fixed set, documented at refUri"
},
"refUri": {
"type": "string",
"format": "uri"
},
"text": {
"type": "string"
}
}
},
"requester": {
"type": "object",
"required": [
"name"
],
"properties": {
"identifier": {
"type": "object",
"required": [
"type",
"value"
],
"properties": {
"system": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"name": {
"type": "string"
}
}
}
}
},
"requestId": {
"type": "string",
"format": "uuid",
"description": "a nonce, unique for each HTTP request."
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ"
}
}
}Output
- 1
- 2
- 3
- 4
{
"type": "object",
"additionalProperties": true
}