-
Notifications
You must be signed in to change notification settings - Fork 7
/
index.html
1400 lines (1317 loc) · 47.4 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<title>Vaccination Certificate Vocabulary v0.1</title>
<meta http-equiv=" Content-Type" content="text/html;charset=utf-8">
<script>
console.log('🧪...');
</script>
<script src="https://www.w3.org/Tools/respec/respec-w3c" class="remove"></script>
<script type="text/javascript" class="remove">
const respecPagesJson = {
name: "vaccination-vocab",
status: "UNOFFICIAL",
latest: "https://w3c-ccg.github.io/vaccination-vocab",
repository: "https://github.com/w3c-ccg/vaccination-vocab",
issues: "https://github.com/w3c-ccg/vaccination-vocab/issues",
group: {
name: "Credentials Community Group",
url: "https://www.w3.org/community/credentials/",
list: "public-credentials",
patentUri: "https://www.w3.org/community/about/agreements/cla/",
},
editors: [
{
name: "Tobias Looker",
url: "https://github.com/tplooker",
company: "Mattr",
companyURL: "https://www.mattr.global/",
},
{
name: "Orie Steele",
url: "https://github.com/OR13",
company: "Transmute",
companyURL: "https://www.transmute.industries/",
},
{
name: "Michael Prorock",
url: "https://github.com/mprorock",
company: "Mesur.io",
companyURL: "https://www.mesur.io/",
},
],
bibliography: {
"RDF-DATASET-NORMALIZATION": {
title: "RDF Dataset Normalization 1.0",
href: "http://json-ld.github.io/normalization/spec/",
authors: ["David Longley", "Manu Sporny"],
status: "CGDRAFT",
publisher: "JSON-LD Community Group",
},
},
};
var respecConfig = {
// specification status (e.g., WD, LCWD, NOTE, etc.). If in doubt use ED.
specStatus: respecPagesJson.status,
// the specification's short name, as in http://www.w3.org/TR/short-name/
shortName: respecPagesJson.name,
// if there a publicly available Editor's Draft, this is the link
edDraftURI: respecPagesJson.latest,
// if this is a LCWD, uncomment and set the end of its review period
// lcEnd: "2009-08-05",
// if you want to have extra CSS, append them to this list
// it is recommended that the respec.css stylesheet be kept
//extraCSS: ["spec.css", "prettify.css"],
// editors, add as many as you like
// only "name" is required
editors: respecPagesJson.editors,
// extend the bibliography entries
//localBiblio: webpayments.localBiblio,
// group: "w3c-ccg",
// wg: respecPagesJson.group.name,
// // URI of the public WG page
// wgURI: respecPagesJson.group.url,
// // name (with the @w3c.org) of the public mailing to which comments are due
// wgPublicList: respecPagesJson.group.list,
// URI of the patent status for this WG, for Rec-track documents
// !!!! IMPORTANT !!!!
// This is important for Rec-track documents, do not copy a patent URI from a random
// document unless you know what you're doing. If in doubt ask your friendly neighbourhood
// Team Contact.
// wgPatentURI: respecPagesJson.group.patentUri,
otherLinks: [
{
key: "Source Control",
data: [
{
value: respecPagesJson.repository,
href: respecPagesJson.repository,
},
],
},
{
key: "Issue Tracker",
data: [
{
value: respecPagesJson.issues,
href: respecPagesJson.issues,
},
],
},
],
// URI of the patent status for this WG, for Rec-track documents
// !!!! IMPORTANT !!!!
// This is important for Rec-track documents, do not copy a patent URI from a random
// document unless you know what you're doing. If in doubt ask your friendly neighbourhood
// Team Contact.
// wgPatentURI: "",
maxTocLevel: 2,
/*preProcess: [ webpayments.preProcess ],
alternateFormats: [ {uri: "diff-20111214.html", label: "diff to previous version"} ],
*/
localBiblio: respecPagesJson.bibliography,
};
</script>
<script src="./common.js" class="remove"></script>
</head>
<body>
<section id="abstract">
<p>
This specification describes <b>an experimental vocabulary</b> for asserting
Verifiable Credentials related to vaccination certificates for medical purposes
</p>
</section>
<section id="sotd">
<!--p>
Comments regarding all aspects of this document are welcome.
Please file issues
directly on <a href="github: "https://github.com/mattrglobal/appointment-vocab/issues/">GitHub</a>,
or send them to
<a href="mailto:public-credentials@w3.org">public-credentials@w3.org</a>
(<a href="mailto:public-credentials-request@w3.org?subject=subscribe">subscribe</a>,
<a href="https://lists.w3.org/Archives/Public/public-credentials/">archives</a>).
</p-->
</section>
<section class="informative">
<h2>Introduction</h2>
<p>
This specification describes <b>an experimental vocabulary</b> for asserting
Verifiable Credentials related to vaccination certificates for medical purposes
</p>
<section class="informative">
<h3>Use Cases and Requirements</h3>
<p>
The following use cases outline a number of key scenarios that readers
might find useful:
</p>
<ul>
<li>Proof of Immunization</li>
<li>Continuity of Care</li>
</ul>
</section>
<section class="informative">
<h3>Example</h3>
<p>
The following examples are provided as a simple example of how this
vocabulary can be used in-conjunction with Verifiable Credentials [[VC-DATA-MODEL]]
</p>
<pre class="example" title="A Vaccine Certificate expressed as a W3C Verifiable Credential featuring an Ed25519 Digital Signature">
{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://w3id.org/vaccination/v1"
],
"type": [
"VerifiableCredential",
"VaccinationCertificate"
],
"id": "urn:uvci:af5vshde843jf831j128fj",
"name": "COVID-19 Vaccination Certificate",
"description": "COVID-19 Vaccination Certificate",
"issuanceDate": "2019-12-03T12:19:52Z",
"expirationDate": "2029-12-03T12:19:52Z",
"issuer": "did:key:z6MkiY62766b1LJkExWMsM3QG4WtX7QpY823dxoYzr9qZvJ3",
"credentialSubject": {
"type": "VaccinationEvent",
"batchNumber": "1183738569",
"administeringCentre": "MoH",
"healthProfessional": "MoH",
"countryOfVaccination": "NZ",
"recipient": {
"type": "VaccineRecipient",
"givenName": "JOHN",
"familyName": "SMITH",
"gender": "Male",
"birthDate": "1958-07-17"
},
"vaccine": {
"type": "Vaccine",
"disease": "COVID-19",
"atcCode": "J07BX03",
"medicinalProductName": "COVID-19 Vaccine Moderna",
"marketingAuthorizationHolder": "Moderna Biotech"
}
},
"proof": {
"type": "Ed25519Signature2018",
"created": "2021-02-18T23:00:15Z",
"jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..vD_vXJCWdeGpN-qKHDIlzgGC0auRPcwp3O1sOI-gN8z3UD4pI0HO_77ob5KHhhU1ugLrrwrMsKv71mqHBn-dBg",
"proofPurpose": "assertionMethod",
"verificationMethod": "did:key:z6MkiY62766b1LJkExWMsM3QG4WtX7QpY823dxoYzr9qZvJ3#z6MkiY62766b1LJkExWMsM3QG4WtX7QpY823dxoYzr9qZvJ3"
}
}
</pre>
<pre class="example" title="A Vaccine Certificate expressed as a W3C Verifiable Credential featuring a BBS+ Digital Signature that supports selective disclosure">
{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://w3id.org/vaccination/v1",
"https://w3id.org/security/bbs/v1"
],
"type": [
"VerifiableCredential",
"VaccinationCertificate"
],
"id": "urn:uvci:af5vshde843jf831j128fj",
"name": "COVID-19 Vaccination Certificate",
"description": "COVID-19 Vaccination Certificate",
"issuanceDate": "2019-12-03T12:19:52Z",
"expirationDate": "2029-12-03T12:19:52Z",
"issuer": "did:key:zUC724vuGvHpnCGFG1qqpXb81SiBLu3KLSqVzenwEZNPoY35i2Bscb8DLaVwHvRFs6F2NkNNXRcPWvqnPDUd9ukdjLkjZd3u9zzL4wDZDUpkPAatLDGLEYVo8kkAzuAKJQMr7N2",
"credentialSubject": {
"type": "VaccinationEvent",
"batchNumber": "1183738569",
"administeringCentre": "MoH",
"healthProfessional": "MoH",
"countryOfVaccination": "NZ",
"recipient": {
"type": "VaccineRecipient",
"givenName": "JOHN",
"familyName": "SMITH",
"gender": "Male",
"birthDate": "1958-07-17"
},
"vaccine": {
"type": "Vaccine",
"disease": "COVID-19",
"atcCode": "J07BX03",
"medicinalProductName": "COVID-19 Vaccine Moderna",
"marketingAuthorizationHolder": "Moderna Biotech"
}
},
"proof": {
"type": "BbsBlsSignature2020",
"created": "2021-02-18T23:01:59Z",
"proofPurpose": "assertionMethod",
"proofValue": "kyesJtjITx/qsXTOuBpAu44e1UC9kjwqbEVyPqTiHL0pVPyaD/xeD0pEw/qBtr25SfrmMj3wXhCMfH77cc6+JgpgIaAnmR5wtTKGsxNm03wwlXf8LFZujjbw+Uf9Wm3aNO7rmAdrG3ec8e9VEQZeIw==",
"verificationMethod": "did:key:zUC724vuGvHpnCGFG1qqpXb81SiBLu3KLSqVzenwEZNPoY35i2Bscb8DLaVwHvRFs6F2NkNNXRcPWvqnPDUd9ukdjLkjZd3u9zzL4wDZDUpkPAatLDGLEYVo8kkAzuAKJQMr7N2#zUC724vuGvHpnCGFG1qqpXb81SiBLu3KLSqVzenwEZNPoY35i2Bscb8DLaVwHvRFs6F2NkNNXRcPWvqnPDUd9ukdjLkjZd3u9zzL4wDZDUpkPAatLDGLEYVo8kkAzuAKJQMr7N2"
}
}
</pre>
<pre class="example" title="A Vaccine Certificate expressed as a W3C Verifiable Credential featuring a BBS+ Signature Proof leveraging selective disclosure">
{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://w3id.org/vaccination/v1",
"https://w3id.org/security/bbs/v1"
],
"id": "urn:uvci:af5vshde843jf831j128fj",
"type": [
"VaccinationCertificate",
"VerifiableCredential"
],
"description": "COVID-19 Vaccination Certificate",
"name": "COVID-19 Vaccination Certificate",
"expirationDate": "2029-12-03T12:19:52Z",
"issuanceDate": "2019-12-03T12:19:52Z",
"issuer": "did:key:zUC724vuGvHpnCGFG1qqpXb81SiBLu3KLSqVzenwEZNPoY35i2Bscb8DLaVwHvRFs6F2NkNNXRcPWvqnPDUd9ukdjLkjZd3u9zzL4wDZDUpkPAatLDGLEYVo8kkAzuAKJQMr7N2",
"credentialSubject": {
"id": "urn:bnid:_:c14n2",
"type": "VaccinationEvent",
"batchNumber": "1183738569",
"countryOfVaccination": "NZ"
},
"proof": {
"type": "BbsBlsSignatureProof2020",
"created": "2021-02-18T23:04:28Z",
"nonce": "JNGovx4GGoi341v/YCTcZq7aLWtBtz8UhoxEeCxZFevEGzfh94WUSg8Ly/q+2jLqzzY=",
"proofPurpose": "assertionMethod",
"proofValue": "AB0GQA//jbDwMgaIIJeqP3fRyMYi6WDGhk0JlGJc/sk4ycuYGmyN7CbO4bA7yhIW/YQbHEkOgeMy0QM+usBgZad8x5FRePxfo4v1dSzAbJwWjx87G9F1lAIRgijlD4sYni1LhSo6svptDUmIrCAOwS2raV3G02mVejbwltMOo4+cyKcGlj9CzfjCgCuS1SqAxveDiMKGAAAAdJJF1pO6hBUGkebu/SMmiFafVdLvFgpMFUFEHTvElUQhwNSp6vxJp6Rs7pOVc9zHqAAAAAI7TJuDCf7ramzTo+syb7Njf6ExD11UKNcChaeblzegRBIkg3HoWgwR0hhd4z4D5/obSjGPKpGuD+1DoyTZhC/wqOjUZ03J1EtryZrC+y1DD14b4+khQVLgOBJ9+uvshrGDbu8+7anGezOa+qWT0FopAAAAEG6p07ghODpi8DVeDQyPwMY/iu2Lh7x3JShWniQrewY2GbsACBYOPlkNNm/qSExPRMe2X7UPpdsxpUDwqbObye4EXfAabgKd9gCmj2PNdvcOQAi5rIuJSGa4Vj7AtKoW/2vpmboPoOu4IEM1YviupomCKOzhjEuOof2/y5Adfb8JUVidWqf9Ye/HtxnzTu0HbaXL7jbwsMNn5wYfZuzpmVQgEXss2KePMSkHcfScAQNglnI90YgugHGuU+/DQcfMoA0+JviFcJy13yERAueVuzrDemzc+wJaEuNDn8UiTjAdVhLcgnHqUai+4F6ONbCfH2B3ohB3hSiGB6C7hDnEyXFOO9BijCTHrxPv3yKWNkks+3JfY28m+3NO0e2tlyH71yDX0+F6U388/bvWod/u5s3MpaCibTZEYoAc4sm4jW03HFYMmvYBuWOY6rGGOgIrXxQjx98D0macJJR7Hkh7KJhMkwvtyI4MaTPJsdJGfv8I+RFROxtRM7RcFpa4J5wF/wQnpyorqchwo6xAOKYFqCqKvI9B6Y7Da7/0iOiWsjs8a4zDiYynfYavnz6SdxCMpHLgplEQlnntqCb8C3qly2s5Ko3PGWu4M8Dlfcn4TT8YenkJDJicA91nlLaE8TJbBgsvgyT+zlTsRSXlFzQc+3KfWoODKZIZqTBaRZMft3S/",
"verificationMethod": "did:key:zUC724vuGvHpnCGFG1qqpXb81SiBLu3KLSqVzenwEZNPoY35i2Bscb8DLaVwHvRFs6F2NkNNXRcPWvqnPDUd9ukdjLkjZd3u9zzL4wDZDUpkPAatLDGLEYVo8kkAzuAKJQMr7N2#zUC724vuGvHpnCGFG1qqpXb81SiBLu3KLSqVzenwEZNPoY35i2Bscb8DLaVwHvRFs6F2NkNNXRcPWvqnPDUd9ukdjLkjZd3u9zzL4wDZDUpkPAatLDGLEYVo8kkAzuAKJQMr7N2"
}
}
</pre>
</section>
</section>
<section>
<h2>Representation Size</h2>
<p>
Certain applications of Verifiable Credentials create constraints around the permitted size of a credentials representation, one such example constraint is expressing
a Verifiable Credential in a QR Code.
</p>
<p>
Vaccination Certificates are a particular use-case where a solution involving much of the benefits of Verifiable Credentials can be realized without requiring the
credential subject to possess or have access to digital infrastructure such as a digital wallet. Instead the Verifiable Credential can be issued by the issuer, printed
to a physical medium (e.g paper) and shared with the subject.
</p>
<p>
There are numerous techniques that can be used to keep the representation of a Verifiable Credential small, two of the most notable are:
</p>
<ul>
<li><b>Limiting the included data elements</b>: The resulting representation is a product of the encoded information, less information, smaller representation.</li>
<li><b>Choice of data encoding technology</b>: Different data encoding technologies (e.g JSON, CBOR) have different characteristics around the resulting size of representation.</li>
</ul>
<p>
As an example below the following Vaccination Certificate is issued as a Verifiable Credential using a subset of the vocabulary defined
by this document. The resulting Verifiable Credential is then encoded in both JSON-LD and CBOR-LD to show the compression.
</p>
<pre class="example" title="A Vaccine Certificate expressed as a W3C Verifiable Credential using a limited subset of the defined vocabulary">
{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://w3id.org/vaccination/v1"
],
"type": [
"VerifiableCredential",
"VaccinationCertificate"
],
"id": "urn:uvci:af5vshde843jf831j128fj",
"issuanceDate": "2019-12-03T12:19:52Z",
"expirationDate": "2029-12-03T12:19:52Z",
"issuer": "did:key:z6MkiY62766b1LJkExWMsM3QG4WtX7QpY823dxoYzr9qZvJ3",
"credentialSubject": {
"type": "VaccinationEvent",
"batchNumber": "1183738569",
"administeringCentre": "MoH",
"countryOfVaccination": "NZ",
"recipient": {
"type": "VaccineRecipient",
"givenName": "JOHN",
"familyName": "SMITH",
"gender": "Male",
"birthDate": "1958-07-17"
},
"vaccine": {
"type": "Vaccine",
"atcCode": "J07BX03"
}
},
"proof": {
"type": "Ed25519Signature2018",
"created": "2021-02-18T23:49:52Z",
"jws": "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..a3UqIuKSOmCKrdn2knl_hCjiN4f4Ud1eO5ckwEHb623V9vdCwWCDB7GBHlRBYSI8ek2E-By7xysVFwutcpOeDg",
"proofPurpose": "assertionMethod",
"verificationMethod": "did:key:z6MkiY62766b1LJkExWMsM3QG4WtX7QpY823dxoYzr9qZvJ3#z6MkiY62766b1LJkExWMsM3QG4WtX7QpY823dxoYzr9qZvJ3"
}
}
</pre>
<pre class="example" title="CBOR Diagnostic output for the above W3C Verifiable Credential expressed in CBOR-LD">
d9 -- next 2 bytes
0501 -- Tag #1281
a8 -- Map, 8 pairs
01 -- {Key:0}, 1
82 -- {Val:0}, Array, 2 items
11 -- [0], 17
78 -- String, length next 1 byte
1f -- String, length: 31
68747470733a2f2f773369642e6f72672f76616363696e6174696f6e2f7631 -- [1], "https://w3id.org/vaccination/v1"
18 -- Positive number, next 1 byte
3e -- {Key:1}, 62
82 -- {Val:1}, Array, 2 items
0f -- [0], 15
0b -- [1], 11
18 -- Positive number, next 1 byte
2b -- {Key:2}, 43
78 -- String, length next 1 byte
1f -- String, length: 31
75726e3a757663693a61663576736864653834336a663833316a313238666a -- {Val:2}, "urn:uvci:af5vshde843jf831j128fj"
18 -- Positive number, next 1 byte
2d -- {Key:3}, 45
1a -- Positive number, next 4 bytes
5de652e8 -- {Val:3}, 1575375592
18 -- Positive number, next 1 byte
24 -- {Key:4}, 36
1a -- Positive number, next 4 bytes
70b64a68 -- {Val:4}, 1890994792
18 -- Positive number, next 1 byte
2f -- {Key:5}, 47
82 -- {Val:5}, Array, 2 items
19 -- Positive number, next 2 bytes
0401 -- [0], 1025
58 -- Bytes, length next 1 byte
22 -- Bytes, length: 34
ed013cab50d559e78a1bab71841fd9cbd9e802999038685ef84b7e490d2717c2b110 -- [1], ed013cab50d559e78a1bab71841fd9cbd9e802999038685ef84b7e490d2717c2b110
18 -- Positive number, next 1 byte
1d -- {Key:6}, 29
a6 -- {Val:6}, Map, 6 pairs
18 -- Positive number, next 1 byte
3e -- {Key:0}, 62
0c -- {Val:0}, 12
15 -- {Key:1}, 21
6a -- String, length: 10
31313833373338353639 -- {Val:1}, "1183738569"
11 -- {Key:2}, 17
63 -- String, length: 3
4d6f48 -- {Val:2}, "MoH"
18 -- Positive number, next 1 byte
18 -- {Key:3}, 24
62 -- String, length: 2
4e5a -- {Val:3}, "NZ"
18 -- Positive number, next 1 byte
3a -- {Key:4}, 58
a5 -- {Val:4}, Map, 5 pairs
18 -- Positive number, next 1 byte
3e -- {Key:0}, 62
0e -- {Val:0}, 14
18 -- Positive number, next 1 byte
28 -- {Key:1}, 40
64 -- String, length: 4
4a4f484e -- {Val:1}, "JOHN"
18 -- Positive number, next 1 byte
26 -- {Key:2}, 38
65 -- String, length: 5
534d495448 -- {Val:2}, "SMITH"
18 -- Positive number, next 1 byte
27 -- {Key:3}, 39
64 -- String, length: 4
4d616c65 -- {Val:3}, "Male"
16 -- {Key:4}, 22
6a -- String, length: 10
313935382d30372d3137 -- {Val:4}, "1958-07-17"
18 -- Positive number, next 1 byte
3f -- {Key:5}, 63
a2 -- {Val:5}, Map, 2 pairs
18 -- Positive number, next 1 byte
3e -- {Key:0}, 62
0d -- {Val:0}, 13
13 -- {Key:1}, 19
67 -- String, length: 7
4a303742583033 -- {Val:1}, "J07BX03"
18 -- Positive number, next 1 byte
37 -- {Key:7}, 55
a5 -- {Val:7}, Map, 5 pairs
18 -- Positive number, next 1 byte
3e -- {Key:0}, 62
07 -- {Val:0}, 7
18 -- Positive number, next 1 byte
19 -- {Key:1}, 25
1a -- Positive number, next 4 bytes
602efd20 -- {Val:1}, 1613692192
18 -- Positive number, next 1 byte
30 -- {Key:2}, 48
78 -- String, length next 1 byte
90 -- String, length: 144
65794a68624763694f694a465a45525451534973496d49324e4349365a6d467363325573496d4e79615851694f6c7369596a5930496c31392e2e6133557149754b534f6d434b72646e326b6e6c5f68436a694e346634556431654f35636b7745486236323356397664437757434442374742486c524259534938656b32452d427937787973564677757463704f654467 -- {Val:2}, "eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..a3UqIuKSOmCKrdn2knl_hCjiN4f4Ud1eO5ckwEHb623V9vdCwWCDB7GBHlRBYSI8ek2E-By7xysVFwutcpOeDg"
18 -- Positive number, next 1 byte
38 -- {Key:3}, 56
12 -- {Val:3}, 18
18 -- Positive number, next 1 byte
43 -- {Key:4}, 67
83 -- {Val:4}, Array, 3 items
19 -- Positive number, next 2 bytes
0401 -- [0], 1025
58 -- Bytes, length next 1 byte
22 -- Bytes, length: 34
ed013cab50d559e78a1bab71841fd9cbd9e802999038685ef84b7e490d2717c2b110 -- [1], ed013cab50d559e78a1bab71841fd9cbd9e802999038685ef84b7e490d2717c2b110
58 -- Bytes, length next 1 byte
22 -- Bytes, length: 34
ed013cab50d559e78a1bab71841fd9cbd9e802999038685ef84b7e490d2717c2b110 -- [2], ed013cab50d559e78a1bab71841fd9cbd9e802999038685ef84b7e490d2717c2b110
0xd90501a8018211781f68747470733a2f2f773369642e6f72672f76616363696e6174696f6e2f7631183e820f0b182b781f75726e3a757663693a61663576736864653834336a663833316a313238666a182d1a5de652e818241a70b64a68182f821904015822ed013cab50d559e78a1bab71841fd9cbd9e802999038685ef84b7e490d2717c2b110181da6183e0c156a3131383337333835363911634d6f481818624e5a183aa5183e0e1828644a4f484e182665534d4954481827644d616c65166a313935382d30372d3137183fa2183e0d13674a3037425830331837a5183e0718191a602efd201830789065794a68624763694f694a465a45525451534973496d49324e4349365a6d467363325573496d4e79615851694f6c7369596a5930496c31392e2e6133557149754b534f6d434b72646e326b6e6c5f68436a694e346634556431654f35636b7745486236323356397664437757434442374742486c524259534938656b32452d427937787973564677757463704f6544671838121843831904015822ed013cab50d559e78a1bab71841fd9cbd9e802999038685ef84b7e490d2717c2b1105822ed013cab50d559e78a1bab71841fd9cbd9e802999038685ef84b7e490d2717c2b110
</pre>
<p>
Below illustrates the size difference of the Verifiable Credential example shown above encoded in JSON-LD and CBOR-LD.
</p>
<table class="simple" style="margin-left: auto; margin-right: auto;">
<thead>
<tr>
<th>Encoding Technology</th>
<th>Size (bytes)</th>
</tr>
</thead>
<tbody>
<tr>
<td>JSON-LD</td>
<td>1217</td>
</tr>
<tr>
<td>CBOR-LD</td>
<td>461</td>
</tr>
</tbody>
</table>
<p>
Below shows a QR Code that features the Verifiable Credential example shown above compressed using CBOR-LD converted to
base32 in accordance with [[!RFC4648]] and encoded into a QR Code using the alphanumeric mode.
</p>
<figure id="information-model">
<img style="margin: auto; display: block;"
src="assets/vaccine-certificate-qrcode.png" alt="a qr code based representation of a Verifiable Credential encoded as CBOR-LD"/>
<figcaption style="text-align: center;">
A QR Code based representation of a Verifiable Credential encoded as CBOR-LD
</figcaption>
</figure>
</section>
<section class="informative">
<h2>Terminology</h2>
<div
data-include="./terms.html"
data-oninclude="restrictReferences"
></div>
</section>
<section class="informative">
<h2>Concepts</h2>
<p>
A vaccination certificate contains many different pieces of information
relating to the vaccination of an individual. These pieces can be
organized into the following categories
</p>
<ul>
<li><b>Vaccination Certificate</b>: Information pertaining to the vaccination certificate itself (e.g when the certificate expires)</li>
<li><b>Vaccination Event</b>: Information describing the vaccination event (e.g date the vaccination occurred or how it was administered)</li>
<li><b>Vaccine</b>: Information describing the vaccine that was administered to its recipient (e.g name of vaccine)</li>
<li><b>Vaccine Recipient</b>: Information describing the recipient of the vaccine (e.g first name)</li>
</ul>
<figure id="information-model">
<img style="margin: auto; display: block;"
src="assets/information-model.png" alt="diagram showing
the information model for a vaccination certificate"/>
<figcaption style="text-align: center;">
The information model for a vaccination certificate
</figcaption>
</figure>
</section>
<section class="normative">
<h2>The Vaccination Certificate Vocabulary</h2>
<p>
This vocabulary assumes all terms specified in the base Verifiable
Credentials [[VC-DATA-MODEL]] context. In addition, the following
classes are available for specifying information related to proof
of vaccination for medical purposes
</p>
<table class="simple">
<thead>
<tr>
<th>Class</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>VaccinationCertificate</td>
<td>Specifies that the credential is a vaccination certificate</td>
</tr>
<tr>
<td>VaccinationEvent</td>
<td>Specifies the details of the vaccination event including the administration details.</td>
</tr>
<tr>
<td>VaccineRecipient</td>
<td>Specifies that the subject of the credential is the recipient of a specified vaccine.</td>
</tr>
<tr>
<td>Vaccine</td>
<td>Specifies the details of medical product serving as a vaccine.</td>
</tr>
</tbody>
</table>
<section class="normative" id="VaccinationEvent">
<h3>Vaccination Event</h3>
<table class="simple">
<thead>
<tr>
<th>Term</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
order
</td>
<td>
Order in the vaccination course.
</td>
</tr>
<tr>
<td>
batchNumber
</td>
<td>
A distinctive combination of numbers and/or letters which specifically identifies a batch.
</td>
</tr>
<tr>
<td>
dateOfVaccination
</td>
<td>
Date in which the vaccination event occurred.
</td>
</tr>
<tr>
<td>
administeringCentre
</td>
<td>
Name/code of administering centre or a health authority responsible for the vaccination event.
</td>
</tr>
<tr>
<td>
healthProfessional
</td>
<td>
Name or health professional code responsible for administering the vaccine or prophylaxis.
</td>
</tr>
<tr>
<td>
countryOfVaccination
</td>
<td>
The country in which the vaccine recipient was vaccinated.
</td>
</tr>
<tr>
<td>
nextVaccinationDate
</td>
<td>
Date on which the next vaccination should be administered to the vaccine recipient.
</td>
</tr>
<tr>
<td>
recipient
</td>
<td>
The recipient of the vaccine.
</td>
</tr>
<tr>
<td>
vaccine
</td>
<td>
The details of vaccine administered.
</td>
</tr>
</tbody>
</table>
<section class="normative">
<h4>
Order
</h4>
<p>
Order in the vaccination course.
</p>
<table class="simple">
<tbody>
<tr>
<td>Term</td>
<td>
order
</td>
</tr>
<tr>
<td>URL</td>
<td>
https://w3id.org/vaccination#order
</td>
</tr>
<tr>
<td>Expected Value</td>
<td>
String
</td>
</tr>
</tbody>
</table>
</section>
<section class="normative">
<h4>
Batch Number
</h4>
<p>
A distinctive combination of numbers and/or letters which specifically identifies a batch.
</p>
<table class="simple">
<tbody>
<tr>
<td>Term</td>
<td>
batchNumber
</td>
</tr>
<tr>
<td>URL</td>
<td>
https://w3id.org/vaccination#batchNumber
</td>
</tr>
<tr>
<td>Expected Value</td>
<td>
String
</td>
</tr>
</tbody>
</table>
</section>
<section class="normative">
<h4>
Date Of Vaccination
</h4>
<p>
Date in which the vaccination event occurred.
</p>
<table class="simple">
<tbody>
<tr>
<td>Term</td>
<td>
dateOfVaccination
</td>
</tr>
<tr>
<td>URL</td>
<td>
https://w3id.org/vaccination#dateOfVaccination
</td>
</tr>
<tr>
<td>Expected Value</td>
<td>
Datetime
</td>
</tr>
</tbody>
</table>
</section>
<section class="normative">
<h4>
Administering Centre
</h4>
<p>
Name/code of administering centre or a health authority responsible for the vaccination event.
</p>
<table class="simple">
<tbody>
<tr>
<td>Term</td>
<td>
administeringCentre
</td>
</tr>
<tr>
<td>URL</td>
<td>
https://w3id.org/vaccination#administeringCentre
</td>
</tr>
<tr>
<td>Expected Value</td>
<td>
String
</td>
</tr>
</tbody>
</table>
</section>
<section class="normative">
<h4>
Health Professional
</h4>
<p>
Name or health professional code responsible for administering the vaccine or prophylaxis.
</p>
<table class="simple">
<tbody>
<tr>
<td>Term</td>
<td>
healthProfessional
</td>
</tr>
<tr>
<td>URL</td>
<td>
https://w3id.org/vaccination#healthProfessional
</td>
</tr>
<tr>
<td>Expected Value</td>
<td>
String
</td>
</tr>
</tbody>
</table>
</section>
<section class="normative">
<h4>
Country Of Vaccination
</h4>
<p>
The country in which the vaccine recipient was vaccinated, MUST be a valid country code as per ISO 3166.
</p>
<table class="simple">
<tbody>
<tr>
<td>Term</td>
<td>
countryOfVaccination
</td>
</tr>
<tr>
<td>URL</td>
<td>
https://w3id.org/vaccination#countryOfVaccination
</td>
</tr>
<tr>
<td>Expected Value</td>
<td>
String
</td>
</tr>
</tbody>
</table>
</section>
<section class="normative">
<h4>
Next Vaccination Date
</h4>
<p>
Date on which the next vaccination should be administered to the vaccine recipient.
</p>
<table class="simple">
<tbody>
<tr>
<td>Term</td>
<td>
nextVaccinationDate
</td>
</tr>
<tr>
<td>URL</td>
<td>
https://w3id.org/vaccination#nextVaccinationDate
</td>
</tr>
<tr>
<td>Expected Value</td>
<td>
Datetime
</td>
</tr>
</tbody>
</table>
</section>
<section class="normative">
<h4>
Recipient
</h4>
<p>
The recipient of the vaccine.
</p>
<table class="simple">
<tbody>
<tr>
<td>Term</td>
<td>
recipient
</td>
</tr>
<tr>
<td>URL</td>
<td>
https://w3id.org/vaccination#recipient
</td>
</tr>
<tr>
<td>Expected Value</td>
<td>
https://w3id.org/vaccination#VaccineRecipient
</td>
</tr>
</tbody>
</table>
</section>
<section class="normative" id="VaccineEventVaccine">
<h4>
Vaccine
</h4>
<p>
The details of vaccine administered.
</p>
<table class="simple">
<tbody>
<tr>
<td>Term</td>
<td>
vaccine
</td>
</tr>
<tr>
<td>URL</td>
<td>
https://w3id.org/vaccination#VaccineEventVaccine
</td>
</tr>
<tr>
<td>Expected Value</td>
<td>
https://w3id.org/vaccination#Vaccine
</td>
</tr>
</tbody>
</table>
</section>
</section>
<section class="normative" id="VaccineRecipient">
<h3>Vaccine Recipient</h3>
<p>
This document specifies the following terms for expressing
the details about the vaccine recipient.
</p>
<table class="simple">
<thead>
<tr>
<th>Term</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
birthDate
</td>
<td>
The date on which the vaccine recipient was born.
</td>
</tr>
<tr>
<td>
familyName
</td>
<td>
The name of the family with which the vaccine recipient identifies.
</td>
</tr>
<tr>
<td>