Interfaces MAP Server

MAP Interface

Toetsing van het MAP

Feature	checkRequest
Type	Service
Versie	1.0.0
Groep	Autorisatie
Gepubliceerd	19 Oct 2023
Delta	Initiële versie van feature.
Use case	AOF.UC.MAP.100.v1

Feature	Versie	Dependency	Aanbieder	Afnemer
checkRequest	1.0.0	AORTA Stelseltoken	-	>=*
checkRequest	1.0.0	AORTA-ID HTTP Header	>=1.0.0	>=1.0.0

Inhoud en formaat van een checkRequest

Een checkRequest wordt op de volgende wijze verzonden:

POST [base endpointadres]/check/v1

Bij het verzenden van een checkRequest dienen de volgende HTTP headers te worden meegezonden:

Feature	AORTA-ID HTTP Header
Type	Subfeature
Versie	1.0.0
Groep	HTTP Headers
Gepubliceerd	19 Oct 2023
Delta	Initiële versie van feature.

AORTA-ID: initialRequestID=<UUID conform RFC4122>; requestID=<UUID conform RFC4122>

Het initialRequestID attribuut bevat het ID van het allereerste request in de hele keten en dient te worden opgenomen in de logbestanden van alle partijen in de keten, zodat bij foutopsporing de verschillende logbestanden aan elkaar kunnen worden gerelateerd.

Het requestID is voor iedere request message uniek. In requests wordt deze gegenereerd door de client. Ook het requestID dient te worden opgenomen in de verschillende logbestanden, zodat altijd duidelijk is op welk bericht een log entry van toepassing is.

Content-Type: application/json; charset=utf-8

Het technische formaat van de HTTP body van een checkRequest is:

{

"interactionId": ["", ""],

"roleCode": {
"code": "",
"codeSystem": ""
},

"dataCategory": {
"code": "",
"codeSystem": ""
}

}

Input parameters:

Name	Cardinality	Type	Toelichting
interactionId	1..n	String	Interactie-id van het te verzenden bericht, of van de te verzenden berichten.
roleCode	0..1	String	Rolcode van de verantwoordelijke persoon voor de initiatie van de interactie-set.
roleCode.code	1..1	String	Het attribuut kan bevatten: De rolcode die hoort bij een persoon, ofwel "P" De UZI-rolcode van een zorgverlener, ofwel "<UZI-rolcode>"
roleCode.codeSystem	1..1	String	OID. Toegestane waarden: "2.16.840.1.113883.2.4.3.11.8" (AORTA rolcode) "2.16.840.1.113883.2.4.15.111" (UZI rolcode)
dataCategory	0..1	String	De contextcode die aanduidt binnen welke (zorg)toepassing de interacties worden geïnitieerd.
dataCategory.codeSystem	1..1	String	OID van het object "AORTA contextCodes". Waarde: "urn:oid:2.16.840.1.113883.2.4.3.111.15.1"
dataCategory.code	1..1	String	De feitelijke contextcode die aanduidt binnen welke (zorg)toepassing de interacties worden geïnitieerd. Bijv. “BGZ”.

Inhoud en formaat van een checkResponse

Bij het verzenden van een checkResponse dienen de volgende HTTP headers te worden meegezonden:

Content-Type: application/json; charset=utf-8

Het technische formaat van de HTTP body van een checkResponse is:

[{
"interactionId": "",
"status": ""
}]

Output bestaat uit 0..n JSON objecten die elk bestaan uit de volgende attributen:

Name

Cardinality

Type

Toelichting

interactionId

1..1

String

Interactie-id van het te verzenden bericht.

status

1..1

String

MAP autorisatiebesluit m.b.t. dit interactie-id.

Mogelijke waarden:

"Allow"
"Deny"

HTTP statuscodes

HTTP statuscodes die kunnen worden geretourneerd zijn opgenomen in onderstaande tabel.

Omdat bepaalde Confluence macro’s nog niet worden ondersteund in de publicatie omgeving, bevat de tabel, in de publicatieomgeving, ook informatie over de wijze waarop de betreffende interface wordt geïmplementeerd in de server component. De statuscodes die kunnen worden geretourneerd zijn opgenomen in de kolom “Uitkomst”. De overige informatie mag worden genegeerd.

statuscode 200 OK

statuscode 400 Bad Request

statuscode 406 Not Acceptable

statuscode 415 Unsupported Media Type

statuscode 429 Too Many Requests

statuscode 500 Internal Server Error

Voorbeeld van gebruik MAP Server

Gedeeltelijke vulling van MAP t.b.v. medicatieoverdracht:

roleCode	interactionId	securityLevel	contextCode
roleCode	Gebruikersinteractie
X	search:mp-MedicationAgreement:*	Midden	MEDGEG
X	QUMA_IN991201NL04	Midden	MEDGEG
X	search:mp-VariableDosingRegimen:*	Midden	MEDGEG
X	QUDS_IN000001NL01	Midden	MEDGEG
..

Ontvangen checkRequest:

POST [base endpointadres]/check/v1
Content-Type: application/json; charset=utf-8AORTA-ID: initialRequestID=<UUID conform RFC4122>; requestID=<UUID conform RFC4122>

{

"interactionId": ["search:mp-MedicationAgreement:1.2", "search:mp-MedicationDispense:2"],

"roleCode": {
"code": "X",
"codeSystem": "2.16.840.1.113883.2.4.15.111"
},

"dataCategory": {
"code": "MEDGEG",
"codeSystem": "urn:oid:2.16.840.1.113883.2.4.3.111.15.1"
}

}

Bijbehorende checkResponse:

200 OK
Content-Type: application/json; charset=utf-8

[{
"interactionId": "search:mp-MedicationAgreement:1.2",
"status": "Allow"
},
{
"interactionId": "search:mp-MedicationDispense:2",
"status": "Deny"
}
]