Användningsfall

Syfte

Ingående REST-tjänster

Söka personuppgifter via fil

Begär en sökning på en bifogad lista med identiteter

SearchPersonsByFile

Order/Get

Hämta resultatfil från kriteriesökning

Hämta resultat från en sökning gjord via NTjP tjänstekontrakt som genererat en resultatfil

Order/Get

Hantering av bilagor för reservidentiteter

Inkludera bilagd fil som styrker en reservidentitet

Attachment/Put

Attachment/Get

Attachment/Delete

profile

Obligatorisk parameter för vilken profil som önskas i svaret. Se TKB för beskrivning av profilerna P1-P5. Observera att profilen skall anges med versalt P.

Datatyp: String.

Exempel: P1

fromDate 

Valfri parameter för det datum man är intresserad av förändringar från och med baserat på fältet version i personposten.

Datatyp: LocalDateTime.

Exempel: 2021-10-12T00:00:00

maxResultsPerFile

Valfri parameter för max antal personposter per fil. Ej angivet så returneras alltid resultatet i endast en fil. Detta värde får ej vara lägre än 500.

Datatyp: Integer.

Exempel: 1000

primaryidentities 

Valfri parameter som om satt gör att endast personposter som är markerad som huvudidentitet inkluderas i svaret. En efterfrågad personpost som inte är en huvudidentitet kommer då varken att generera en requestedPersonalIdentity eller en personRecord i svarsfilen.

Datatyp: Boolean.

Exempel: true

Version 1

curl -X POST \
https://api.pu.ineratest.org:443/purest/searchPersonsByFile \
-H 'content-type: multipart/form-data;' \
-F profile=P1 \
-F fromDate=2021-10-12T00:00:00 \
-F maxResultsPerFile=1000 \
-F primaryidentity=true \
-F file=@bilagan.csv

Version 2

curl -X POST \
https://api.pu.ineratest.org:443/purest/v2/searchPersonsByFile \
-H 'content-type: multipart/form-data;' \
-F profile=P1 \
-F fromDate=2021-10-12T00:00:00 \
-F maxResultsPerFile=1000 \
-F primaryidentity=true \
-F file=@bilagan.csv

Statuskod: 201 CREATED
Content-Type: application/json; charset=ISO-8859-1
Transfer-Encoding: chunked
Content:

{
  "orderId": "1028-TO63-15133551"
}

Statuskod: 400 BAD_REQUEST

• Filen är inte av typ CSV

• Filen är tom

• De första raderna innehåller ogiltigt formaterad data

• Den angivna profilen är inte giltig

• Det angivna värdet för max antal personposter per fil är för lågt

Statuskod: 401 UNAUTHORIZED

• Konsumenten saknar behörighet till tjänsten

Statuskod: 500 INTERNAL SERVER ERROR

• Internt oförutsett fel

• Filens storlek i MB överskrider tillåten gräns

• Felaktig datatyp angiven för parameter

Resultat ej klart:

<S:Envelope
 xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
    <ns2:GetFilesForOrderIdResponse
     xmlns:ns2="urn:riv:strategicresourcemanagement:persons:person:GetFilesForOrderIdResponder:3"
     xmlns:ns3="urn:riv:strategicresourcemanagement:persons:person:3"
     xmlns:ns4="urn:riv:itintegration:registry:1">
    </ns2:GetFilesForOrderIdResponse>
  </S:Body>
</S:Envelope>

Resultat klart:

<S:Envelope
 xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
  <S:Body>
    <ns2:GetFilesForOrderIdResponse
     xmlns:ns2="urn:riv:strategicresourcemanagement:persons:person:GetFilesForOrderIdResponder:3"
     xmlns:ns3="urn:riv:strategicresourcemanagement:persons:person:3"
     xmlns:ns4="urn:riv:itintegration:registry:1">
      <ns2:multimedia>
        <ns3:mediaType>application/zip</ns3:mediaType>
        <ns3:reference>https://api.pu.ineratest.org:443/purest/order/get/fd6a78ee-da71-4ec6-a099-cbccc21fe468</ns3:reference>
      </ns2:multimedia>
    </ns2:GetFilesForOrderIdResponse>
  </S:Body>
</S:Envelope>

https://api.pu.ineratest.org:443/purest/order/get/fd6a78ee-da71-4ec6-a099-cbccc21fe468

Statuskod: 200 OK
Content-Type: application/zip
Content-Disposition: attachment; filename="<filnamn>"
Transfer-Encoding: chunked
Content: fil (zippat xmldata enligt strategicresourcemanagement:persons:person)

Struktur för filnamn (både ZIP och XML): <orderId>_<datum>_<löpnummer>.zip (samt .xml)
Exempel: 0622-TO17-09215997_20170622_1.zip

Statuskod: 400 BAD_REQUEST

• Ogiltig context path

• HSA-id för konsument saknas

• Certifikat för OrderId matchar inte certifikat som används vid hämtning av fil

• Filen har redan hämtats

Statuskod: 401 UNAUTHORIZED

• Konsumenten saknar behörighet till tjänsten

Statuskod: 404 NOT FOUND

• Begärd referens (GUID) existerar inte

Statuskod: 500 INTERNAL SERVER ERROR

• Internt oförutsätt fel

actorRoot

root (OID) för aktör

actorExtension

värde för aktör

actorProfessionalRoot

root (OID) för aktörens organisation/vårdgivare

actorProfessionalExtension

värde för aktörens organisation/vårdgivare

patientRoot

root (OID) för patientidentitet

patientExtension

värde patientidentitet

file

bilagan

curl -X PUT \
https://api.pu.ineratest.org:443/purest/attachment/put \
-H 'content-type: multipart/form-data; \
-F actorRoot=HSAID \
-F actorExtension=SE123456789 \
-F actorProfessionalRoot=HSAID \
-F actorProfessionalExtension=SE987654321 \
-F patientRoot=1.2.752.74.9.1 \
-F patientExtension=00002040AA11 \
-F file=@bilagan.jpg

Statuskod: 200 OK
Content-Type: application/json; charset=ISO-8859-1
Transfer-Encoding: chunked
Content:

{
"id": "36a7068d-172b-4fee-bed5-13ecbdfa7ff2",
"mediaType": "image/jpeg",
"value": null,
"reference": "https://api.pu.ineratest.org:443/purest/attachment/get/36a7068d-172b-4fee-bed5-13ecbdfa7ff2"
}

Statuskod: 400 BAD_REQUEST

• Ogiltig context path

• HSA-id för konsument saknas

• Ogiltig patientidentitet / parametrar

Statuskod: 401 UNAUTHORIZED

• Konsumenten saknar behörighet till tjänsten

Statuskod: 500 INTERNAL SERVER ERROR

• Internt oförutsätt fel

curl -X GET \
https://api.pu.ineratest.org:443/purest/attachment/get/e870cddb-5842-4c72-a804-7d39fa4c5478

Statuskod: 200 OK
Content-Type: <aktuell MIME-type>
Content-Disposition: attachment; filename="<filnamn>"
Transfer-Encoding: chunked
Content: filen

Statuskod: 400 BAD_REQUEST

• Ogiltig context path

• HSA-id för konsument saknas

Statuskod: 401 UNAUTHORIZED

• Konsumenten saknar behörighet till tjänsten

Statuskod: 404 NOT FOUND

• Begärd referens (GUID) existerar inte

Statuskod: 500 INTERNAL SERVER ERROR

• Internt oförutsätt fel

actorRoot

root (OID) för aktör

actorExtension

värde för aktör

actorProfessionalRoot

root (OID) för aktörens organisation/vårsgivare

actorProfessionalExtension

värde för aktörens organisation/vårsgivare

patientRoot

root (OID) för patientidentitet

patientExtension

värde patientidentitet

referenceId

bilagans id

curl -X DELETE \
https://api.pu.ineratest.org:443/purest/attachment/delete \
-H 'content-type: multipart/form-data; \
-F actorRoot=HSAID \
-F actorExtension=SE123456789 \
-F actorProfessionalRoot=HSAID \
-F actorProfessionalExtension=SE987654321 \
-F patientRoot=1.2.752.74.9.1 \
-F patientExtension=00002040AA11 \
-F referenceId=e870cddb-5842-4c72-a804-7d39fa4c5478

Statuskod: 200 OK
Content-Type: text/plain; charset=iso-8859-1
Transfer-Encoding: chunked
Content:

File with id: e870cddb-5842-4c72-a804-7d39fa4c5478 was successfully deleted.

Statuskod: 400 BAD_REQUEST

• Ogiltig context path

• HSA-id för konsument saknas

• Ogiltig patientidentitet / parametrar

Statuskod: 401 UNAUTHORIZED

• Konsumenten saknar behörighet till tjänsten

Statuskod: 404 NOT FOUND

• Begärd referens (GUID) existerar inte

Statuskod: 500 INTERNAL SERVER ERROR

• Internt oförutsett fel