Organisaatiolle osoitettujen todistusten haku
Sosiaali- ja terveydenhuollon ulkopuolinen organisaatio voi hakea sille osoitettuja todistuksia. Voit lukea tästä lisää käyttötapauksesta: Organisaatiolle osoitettujen todistusten haku.
Välityspyynnön HTTP pyyntö (request)
Haku lähetetään kysely- ja välityspalvelulle HTTP POST-pyyntönä operaatiolla $get-all-documents. Operaation pyynnössä ilmoitetaan välitystä pyytävän henkilön henkilötunnus, todistuksen näkymäkoodi ja todistuksen luontihetken aikaväli.
Rajapinnan OperationDefinition-kuvaus
Invocations
URL: [base]/$get-all-documents
This operation does NOT change content
Parameters (In)
| Name | Cardinality | Type | Binding | Documentation |
|---|---|---|---|---|
| organization | 1..1 | CodeSystem | urn:oid:1.2.246.537.6.40191 (required) | Organisaatio, jolle osoitettuja todistuksia haetaan |
| viewCode | 1..1 | CodeSystem | urn:oid:1.2.246.537.6.12 (required) | Todistuksen tyyppi |
| startDate | 0..1 | date | Välityspyynnön luontiajan alkupäivä | |
| endDate | 0..1 | date | Välityspyynnön luontiajan loppupäivä | |
| reload | 0..1 | boolean | Palauta uudelleen jo haetut mutta kuittaamattomat todistukset |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| results | 1..1 | Bundle | The bundle type is "searchset" |
Sekvenssikaavio
HTTP pyynnön header
HTTP-pyynnön header-tiedot on kuvattu Kanta-palvelujen yhteisessä FHIR- ja REST-soveltamisoppaassa. Voit lukea lisää oppaan sivulla Kanta HTTP header-tiedot FHIR-rajapinnassa
Kannattaa kuitenkin huomioida erityisesti headerin kenttä X-Request-Id, jonka arvo on oltava yksilöllinen jokaiselle http-pyynnölle.
Pyynnön HTTP header esimerkki
POST [base][api] HTTP/1.1
Accept: application/fhir+json
Authorization: Bearer eyJraWQiOiJyc2ExIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJhMTcxYjFmNC04ZDkwLT...
X-Request-Id: 1.2.246.10.1.20241208102307.93.2023.11023072024880604629
Content-Type: application/x-www-form-urlencoded
HTTP pyynnön body
Operaation parametrit välitetään HTTP pyynnön body-osuudessa Parameters-resurssin avulla. Voit lukea lisää Parameters-resurssista FHIR-standardista.
Vastaussanoma virhetilanteessa
Virhetilanteissa vastauksena palautuu HTTP virhestatuskoodi sekä HTTP bodyssa OperationOutcome resurssi-instanssi, jolla ilmaistaan tarkempi virhe. KVP:n Käyttämää OperationOutcome-resurssia ei ole profiloitu.
OperationOutcome-sivulla on kuvattu tarkemmin, miten KVP palauttaa virheilmoitukset OperationOutcome-resussilla.