Table of Contents
GetVaccinationPassportAsPDF
Servicen gør det muligt at hente et vaccinationspas som et PDF-dokument, såfremt borgeren opfylder kriterierne for at få det udstedt.
Svaret vil indeholde et PDF-dokument encoded i BASE64.
Forespørgsel
<GetVaccinationPassportAsPDFRequest> <PersonCivilRegistrationIdentifier>1102014746</PersonCivilRegistrationIdentifier> <VaccinationPlanCategory>COVID_19</VaccinationPlanCategory> <IncludePdf>true</IncludePdf> </GetVaccinationPassportAsPDFRequest>
Feltet VaccinationPlanCategory skal udfyldes. Pt er eneste accepterede værdi “COVID_19”. Feltet IncludePdf er et optionelt felt, der giver mulighed for at fravælge at få pdf-elementet inkluderet i responset.
Svar
<GetVaccinationPassportAsPDFResponse> <DocumentId>100000007</DocumentId> <PersonInfo> <PersonNameStructure> <PersonGivenName>Lone</PersonGivenName> <PersonSurnameName>Knudsen</PersonSurnameName> </PersonNameStructure> <PersonCivilRegistrationIdentifier>1102014746</PersonCivilRegistrationIdentifier> </PersonInfo> <VaccinationAgainst>SARS-CoV-2 (COVID-19)</VaccinationAgainst> <Effectuation> <DrugName>Moderna Covid-19 vaccine</DrugName> <EffectuatedDateTime>2021-01-12T23:00:00Z</EffectuatedDateTime> </Effectuation> <Effectuation> <DrugName>Moderna Covid-19 vaccine</DrugName> <EffectuatedDateTime>2021-02-03T23:00:00Z</EffectuatedDateTime> </Effectuation> <VaccinationPassportAsPDF>...</VaccinationPassportAsPDF> </GetVaccinationPassportAsPDFResponse>
DocumentId angiver en intern id, som bliver udtrukket og persisteret af servicen når passet genereres. Hvis der hentes et pas for samme borger flere gange, vil DocumentId have samme værdi hvis flg. 2 betingelser er opfyldt:
- Servicen lægger de samme, uændrede vaccinationer til grund for at tillade udstedelse af passet.
- En intern versionstæller for passets validerings- og renderingslogik er uændret.
Service-specifikke fejlkoder
Hvis borgeren ikke opfylder kriterierne for et vaccinepas, vil servicen fejle med fejlkode 4105 (Borger er ikke berettiget til at få udstedt et vaccinepas!).
Angives en ukendt værdi i VaccinationPlanCategory, returneres fejl 1004 (En forkert parameter blev anvendt).
Udvidet brug
Følgende 2 flag giver adgang til udvidet brug af servicen:
- IncludeVaccinationStatus: Hvis dette flag inkluderes i request'et med værdien
true, svares der ikke med ovennævnte fejlkode 4105, hvis borgeren ikke er færdigvaccineret. I stedes inkluderes elementet VaccinationStatus med en af værdierneIkke vaccineret,Delvist vaccineretellerVaccineret. - IncludeVaccinesAndDrugs: Hvis dette flag inkluderes med værdien
true, tilføjes yderligere information om de vacciner og tilhørende lægemidler som borgeren er vaccineret med. Dette tilføjes under Effectuation som hhv. Vaccine og SSIDrug. - IncludeEffectuationCountryCode: Hvis dette flag inkluderes med værdien
true, tilføjes landekode til de returnerede vaccinationer. - IncludeAdditionalEffectuations: Hvis dette flag inkluderes med værdien
true, tilføjes yderligere vaccinationer udover det første fuldt gennemførte vaccinationsforløb. Yderligere vaccinationer inkluderes som AdditinalEffectuation-elementer.
Eksempel på udvidet brug
Forespørgsel
<GetVaccinationPassportAsPDFRequest> <PersonCivilRegistrationIdentifier>1102014746</PersonCivilRegistrationIdentifier> <VaccinationPlanCategory>COVID_19</VaccinationPlanCategory> <IncludePdf>false</IncludePdf> <IncludeVaccinationStatus>true</IncludeVaccinationStatus> <IncludeVaccinesAndDrugs>true</IncludeVaccinesAndDrugs> </GetVaccinationPassportAsPDFRequest>
Svar
<GetVaccinationPassportAsPDFResponse> <VaccinationStatus>Vaccineret</VaccinationStatus> <DocumentId>1000384</DocumentId> <PersonInfo> <ns3:PersonNameStructure> <ns2:PersonGivenName>Lone</ns2:PersonGivenName> <ns2:PersonSurnameName>Knudsen</ns2:PersonSurnameName> </ns3:PersonNameStructure> <ns4:PersonCivilRegistrationIdentifier>1102014746</ns4:PersonCivilRegistrationIdentifier> </PersonInfo> <VaccinationAgainst>SARS-CoV-2 (COVID-19)</VaccinationAgainst> <Effectuation> <DrugName>Moderna Covid-19 Vaccine</DrugName> <EffectuatedDateTime>2021-02-09T23:00:00Z</EffectuatedDateTime> <Vaccine> <VaccineIdentifier>32115518136</VaccineIdentifier> <VaccineName>Moderna Covid-19 Vaccine</VaccineName> <Disease> <DiseaseIdentifier>32115515735</DiseaseIdentifier> <DiseaseName>Covid-19</DiseaseName> <DiseaseNameDK>Covid-19 sygdom</DiseaseNameDK> <ATC> <Code>J07BX</Code> <Text>Andre virale vacciner</Text> </ATC> </Disease> <ATC> <Code>J07BX</Code> <Text>Andre virale vacciner</Text> </ATC> <VaccineKeywordsText></VaccineKeywordsText> </Vaccine> <SSIDrug> <ATC /> <DrugIdentifier>32115518135</DrugIdentifier> <DrugName>Moderna Covid-19 vaccine</DrugName> <DrugForm> <DrugFormText>injektionsvæske, suspension</DrugFormText> </DrugForm> <DrugStrength /> </SSIDrug> </Effectuation> <Effectuation> <DrugName>Comirnaty Covid-19 vaccine</DrugName> <EffectuatedDateTime>2021-04-06T22:00:00Z</EffectuatedDateTime> <Vaccine> <VaccineIdentifier>32115517138</VaccineIdentifier> <VaccineName>Comirnaty Covid-19 vaccine</VaccineName> <Disease> <DiseaseIdentifier>32115515735</DiseaseIdentifier> <DiseaseName>Covid-19</DiseaseName> <DiseaseNameDK>Covid-19 sygdom</DiseaseNameDK> <ATC> <Code>J07BX</Code> <Text>Andre virale vacciner</Text> </ATC> </Disease> <ATC> <Code>J07BX</Code> <Text>Andre virale vacciner</Text> </ATC> <VaccineKeywordsText></VaccineKeywordsText> </Vaccine> <SSIDrug> <ATC /> <DrugIdentifier>32115516935</DrugIdentifier> <DrugName>Comirnaty Covid-19 Vaccine</DrugName> <DrugForm> <DrugFormText>injektionsvæske, suspension</DrugFormText> </DrugForm> <DrugStrength /> </SSIDrug> </Effectuation> </GetVaccinationPassportAsPDFResponse>
