listMessages

/in /door

Deze methode geeft een lijst van berichten terug van een patiënt.

Opmerkingen:

  • Als de datum leeg is, worden alle berichten teruggegeven.  Let op dat dit een grote lijst kan zijn. De maxResults en SkipResults parameters kunnen gebruikt worden om ‘paging’ toe te passen. Er is een limiet van 1000. Mocht maxResults groter zijn dan 1000 of de methode resulteren in meer dan 1000 rijen dan wordt foutmelding Y003 teruggegeven.
  • Alleen berichten die in Ysis gericht zijn aan de ‘Verzorging’ worden teruggegeven: berichten verkeer tussen disciplines in Ysis zijn niet vanuit de API te bevragen.
  • De sortering is altijd op datum/tijd van het bericht met het nieuwste bericht bovenaan.
  • reportID is optioneel. Indien het bericht in Ysis is aangemaakt vanuit een rapportage wordt hiernaar verwezen (Deze rapportage kan vervolgens middels de methode getReport worden opgehaald). Als in Ysis een ‘los’ bericht wordt aangemaakt is dit veld leeg. Een bericht is wel altijd gerelateerd aan een BSN.
  • Bij technische, infrastructurele of security issues wordt een SOAP error teruggegeven. Als inhoudelijk de parameters in de request niet kloppen wordt een foutcode in de Response teruggegeven, zie onder de mogelijke fouten).

Zie de WSDL voor de exacte specificatie van de input en output.
WSDL:  https://acceptatie1-webservice.ysis.nl/medicalrecord/query/usermessages/20170214?wsdl
Endpoints:

Mogelijke foutcodes:

  • Y001 – Patient unknown
  • Y003 – Results exceeds maximum of 1000
  • Y004 – “BSN not valid”: BSN nummer is geen valide BSN.

Voorbeeld Requests:
Voorbeeld voor gebruik in batchverwerking
“Geef alle berichten voor patient 123456782 vanaf 15 december 2016”

<soapenv:Body>
    <ns:listMessagesRequest>
        <ns:bsn>039131622</ns:bsn>
        <ns:dateFrom>2016-12-15</ns:dateFrom>
    </ns:listMessagesRequest>
</soapenv:Body>

Voorbeeld voor gebruik bij real-time inzage
“Geef de derde pagina met 20 berichten per pagina voor Patient 123456782”

<soapenv:Body>
    <ns:listMessagesRequest>
        <ns:bsn>039131622</ns:bsn>
        <ns:skipResults>40</ns:skipResults>
        <ns:maxResults>20</ns:maxResults>
    </ns:listMessagesRequest>
</soapenv:Body>

Voorbeeld Responses
correcte response

<SOAP-ENV:Body>
    <ns4:listMessagesResponse xmlns:mr="http://ysis.nl/webservices/medicalrecord" xmlns:ns3="http://ysis.nl/webservices/medicalrecord/20170209" xmlns:ns4="http://ysis.nl/webservices/medicalrecord/usermessages/20170214">
        <ns3:status>OK</ns3:status>
        <ns4:message>
            <ns4:messageId>ad709af2-a53a-437a-b866-769c3a0a2bfc</ns4:messageId>
            <ns4:subject>Dhr. A Amstel, Locatie1/extramuraal</ns4:subject>
            <ns4:text>bericht #1</ns4:text>
            <ns4:creationDate>2017-04-07T17:07:48.000+02:00</ns4:creationDate>
            <ns4:author>Adminuser</ns4:author>
            <ns4:authorDiscipline>MEDICAL</ns4:authorDiscipline>
            <ns4:authorEmployeeNumber>45435345</ns4:authorEmployeeNumber>
            <ns4:authorEmployeeFunction/>
            <ns4:reportId>3</ns4:reportId>
        </ns4:message>
        <ns4:message>
            <ns4:messageId>3afdf5e6-5c76-4501-a815-d2f514bd7877</ns4:messageId>
            <ns4:subject>Dhr. A Amstel (Test Two), Locatie1/extramuraal</ns4:subject>
            <ns4:text>test</ns4:text>
            <ns4:creationDate>2017-04-06T09:20:19.000+02:00</ns4:creationDate>
            <ns4:author>Adminuser</ns4:author>
            <ns4:authorDiscipline>MEDICAL</ns4:authorDiscipline>
            <ns4:authorEmployeeNumber>45435345</ns4:authorEmployeeNumber>
            <ns4:authorEmployeeFunction/>
            <ns4:reportId>2</ns4:reportId>
        </ns4:message>
    </ns4:listMessagesResponse>
</SOAP-ENV:Body>

Functionele fout, moet onderzocht worden door de aanroepende partij, herhalen van de aanroep is niet zinvol

<SOAP-ENV:Body>
    <ns4:listMessagesResponse xmlns:mr="http://ysis.nl/webservices/medicalrecord" xmlns:ns3="http://ysis.nl/webservices/medicalrecord/20170209" xmlns:ns4="http://ysis.nl/webservices/medicalrecord/usermessages/20170214">
        <ns3:status>FAILED</ns3:status>
        <ns4:errorCode>Y003</ns4:errorCode>
        <ns4:errorText>Results exceeds maximum of 1000</ns4:errorText>
    </ns4:listMessagesResponse>
</SOAP-ENV:Body>

Technische fout

<SOAP-ENV:Body>
    <SOAP-ENV:Fault>
        <faultcode>SOAP-ENV:Server</faultcode>
        <faultstring xml:lang="en">een technische onvoorziene foutsituatie</faultstring>
    </SOAP-ENV:Fault>
</SOAP-ENV:Body>