Pdf-tulosteen haku

Pdf-haku tehdään operaatiolla, jonka kuvaus löytyy sivulta CreatePdf

Pyynnön URL:in muoto noudattaa FHIR määrittelyjä (Style Guide). Eri ympäristöjen käytettävät juuret ilmoitetaan palveluun liittyville tietojärjestelmätoimittajille erikseen eikä niitä julkisteta tässä implementointioppaassa.

Hakuparametreja ei saa lisätä pyynnön URLiin. Perusteena tälle on, että URLin osana hakuparametrien arvot voivat jäädä esimerkiksi verkkolaitteiden lokitietoihin.

HTTP pyynnön header

Haun HTTP-pyynnön header-osuus noudattaa Kanta-palveluiden yhteisiä Kanta FHIR HTTP header ja Kanta JSON Web Token määrittelyitä ja näissä kuvattuja tietoja ja tietojen pakollisuuksia.

Huomioitavaa, koska pdf palautetaan binääridatana, tulee hakiessa antaa Http headerissa Accept arvona application/pdf.

HTTP pyynnön body

Pdf-tulosteen haussa käytettävät hakuparametrit välitetään HTTP pyynnön body-osuudessa.

Pdf-tulosteen haussa on käytettävä seuraavia hakuparametreja.

FHIR-hakuparametri Hakuparametrin tyyppi Pakollisuus FHIR-resurssi ja elementti
patient-identifier identifier Pakollinen 1..1 patient.identifier - Henkilön tunniste
consent-id id Pakollinen 1..1 Consent.id - Sote-luovutusluvan tunniste
language-code code Pakollinen 1..1 Tulosteen kieli - Tulosteen kieli

HTTP pyynnön body esimerkki

Operaation parametrit välitetään HTTP pyynnön body-osuudessa Parameters-resurssin avulla.

{
    "resourceType": "Parameters",
    "parameter": [
        {
            "name": "patient-identifier",
            "valueIdentifier": {
            	"system": "urn:oid:1.2.246.21",
            	"value": "030559-914N"
            }
        },
        {
            "name": "consent-id",
            "valueId": "ce5ea340-adfd-40f2-87d4-a25e4f8bf198"
        },
        {
            "name": "language-code",
            "valueCode": "fi"
        }
    ]
}

Vastaussanoma virhetilanteessa

Virhetilanteissa vastauksena palautuu HTTP virhestatuskoodi sekä HTTP bodyssa OperationOutcome resurssi-instanssi, jolla ilmaistaan tarkempi virhe. Tahdonilmaisupalvelussa käytettävää OperationOutcome-resurssia ei ole profiloitu.

OperationOutcome-sivulla on kuvattu tarkemmin, miten Tahdonilmaisupalvelu palauttaa virheilmoitukset OperationOutcome-resussilla.