Interfaces SDS Server

Selectie en Determinatie Interface

Deze interface is slechts bedoeld voor gebruik door VZVZ-componenten, en kan niet (rechtstreeks) worden gebruikt door GBx-applicaties.

Verkrijgen van InteractionContexts

Een InteractionContext beschrijft het toegestane gebruik van een interactie (interactie-id), die plaatsvindt onder verantwoordelijkheid van een persoon met een bepaalde rol (rolcode), binnen een specifieke context (contextcode). De Selectie en Determinatie Interface biedt de mogelijkheid om een set van InteractionContext objecten te verkrijgen, die horen bij een specifieke contextcode en rolcode.

NB. op termijn is het misschien ook mogelijk dat een InteractionContext wordt gevuld m.b.v. zowel MAP-gegevens als met SDS-gegevens, zodat MAP en SDS middels één enkele API-call kunnen worden toegepast in de flow. SDS restricties kunnen dan ook worden toegepast op ontvangen (gerichte) FHIR-search interacties (dus zonder gebruik van een FHIR-operation). Ook kan het actualiteitsregister dan worden geraadpleegd bij verwerking van gerichte FHIR-searches.

Inhoud en formaat van een getInteractionContextsRequest

Een getInteractionContextsRequest wordt op de volgende wijze verzonden:

POST [base endpointadres]/getInteractionContexts/v1

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

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 getInteractionContextsRequest is:

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

Input parameters:

Inhoud en formaat van een getInteractionContextsResponse

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

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

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

[
    [{
            "interactionId": "jupiter:2.0",
            "dataCategory": [{
                "code": "",
                "codeSystem": ""
            }],
            "parameter": [{
                "name": "",
                "overridable": "",
                "value": ""
            }]
        },
        {
            "interactionId": "jupiter:1.2",
            "dataCategory": [{
                "code": "",
                "codeSystem": ""
            }],
            "parameter": [{
                "name": "",
                "overridable": "",
                "value": ""
            }]
        },
        {
            "interactionId": "jupiter:1.1",
            "dataCategory": [{
                "code": "",
                "codeSystem": ""
            }],
            "parameter": [{
                "name": "",
                "overridable": "",
                "value": ""
            }]
        }
    ],
    [{
            "interactionId": "pluto:1.4",
            "dataCategory": [{
                "code": "",
                "codeSystem": ""
            }],
            "parameter": [{
                "name": "",
                "overridable": "",
                "value": ""
            }]
        },
        {
            "interactionId": "pluto:1.3",
            "dataCategory": [{
                "code": "",
                "codeSystem": ""
            }],
            "parameter": [{
                "name": "",
                "overridable": "",
                "value": ""
            }]
        }
    ]
]

Een getInteractionContextsResponse bestaat uit bestaat uit 0..n JSON InteractionContextSet objecten. Een InteractionContextSet bestaat uit een set van 1..n InteractionContext objecten. De interacties in eenzelfde InteractionContextSet zijn functioneel aan elkaar gelijk.

Een InteractionContext bevat de volgende inhoud:

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.

Voorbeeld van gebruik getInteractionContextsRequest

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

Ontvangen getInteractionContextsRequest:

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

{
    "protocol": "hl7fhir",
    "roleCode": {
        "code": "X",
        "codeSystem": "urn:oid:2.16.840.1.113883.2.4.15.111"
    },
    "contextCode": "MEDGEG"
}

Geretourneerde getInteractionContextsResponse :

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

[
    [{
        "interactionId": "search:mp-MedicationAgreement:*",
        "dataCategory": [{
            "code": "",
            "codeSystem": ""
        }],
        "parameter": [{
            "name": "category",
            "overridable": "false",
            "value": "http://snomed.info/sct|33633005"
        }, {
            "name": "periodofuse",
            "overridable": "true",
            "value": "xxx"
        }]
    }],
    [{
        "interactionId": "search:mp-VariableDosingRegimen:*",
        "dataCategory": [{
            "code": "",
            "codeSystem": ""
        }],
        "parameter": [{
            "name": "category",
            "overridable": "false",
            "value": "http://snomed.info/sct|395067002"
        }]
    }]
]