forked from openreferral/specification
-
Notifications
You must be signed in to change notification settings - Fork 0
/
datapackage.json
1527 lines (1523 loc) · 68.5 KB
/
datapackage.json
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
{
"name": "human_services_data",
"title": "Human Services Data Specification Template",
"description":"This is a template datapackage.json file for producing a Tabular Data Package of data according to the Human Services Data Specification. You should provide an edited version of this file as part of any datapackage you provide, updating the title, description, license and homepage information to reflect the data you are publishing.",
"license": {
"url": "https://creativecommons.org/licenses/by-sa/4.0/",
"type": "CC-BY-SA-4.0",
"name": "Creative Commons Attribution-ShareAlike 4.0"
},
"version":"1.0",
"homepage":"http://docs.openreferral.org",
"resources": [
{
"name": "organization",
"path": "organizations.csv",
"description":"The organization record is used to provide basic description and details about each organization delivering services. Each service should be linked to the organization responsible for its delivery. One organization may deliver many services.",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"type": "string",
"description":"Each organization must have a unique identifier.",
"format":"uuid",
"constraints": {
"required":true,
"unique":true
}
},
{
"name": "name",
"type": "string",
"description":"The official or public name of the organization.",
"constraints": {
"required":true
}
},
{
"name": "alternate_name",
"type": "string",
"description":"Alternative or commonly used name for the organization.",
"constraints": {
"required":false
}
},
{
"name": "description",
"type": "string",
"description":"A brief summary about the organization. It can contain markup such as HTML or Markdown.",
"constraints": {
"required":true
}
},
{
"name": "email",
"type": "string",
"description":"The contact e-mail address for the organization.",
"format":"email",
"constraints": {
"required":false
}
},
{
"name": "url",
"type": "string",
"description":"The URL (website address) of the organization.",
"constraints": {
"required":false
}
},
{
"name": "tax_status",
"type": "string",
"description":"Government assigned tax designation for for tax-exempt organizations.",
"constraints": {
"required":false
}
},
{
"name": "tax_id",
"type": "string",
"description":"A government issued identifier used for the purpose of tax administration.",
"constraints": {
"required":false
}
},
{
"name": "year_incorporated",
"type": "date",
"format": "%Y",
"description":"The year in which the organization was legally formed.",
"constraints": {
"required":false
}
},
{
"name": "legal_status",
"type": "string",
"description":"The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.",
"constraints": {
"required":false
}
}
],
"primaryKey": "id"
}
},
{
"name": "program",
"path": "programs.csv",
"description":"Some organizations organise their services into programs. A program brings together a number of related services.",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"type": "string",
"description":"Each program must have a unique identifier.",
"constraints": {
"required":true,
"unique":true
}
},
{
"name": "organization_id",
"type": "string",
"description": "Each program must belong to a single organization. The identifier of the organization should be given here.",
"format":"uuid",
"constraints": {
"required":true
}
},
{
"name": "name",
"description": "The name of the program",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "alternate_name",
"description": "An alternative name for the program",
"type": "string",
"constraints": {
"required":false
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
}
]
}
},
{
"name": "service",
"description":"Services are provided by organizations to a range of different groups. Details on where each service is delivered are contained in the services_at_location table.",
"path": "services.csv",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"type": "string",
"description":"Each service must have a unique identifier.",
"constraints": {
"required":true,
"unique":true
}
},
{
"name": "organization_id",
"type": "string",
"description": "The identifier of the organization that provides this service.",
"constraints": {
"required":true
}
},
{
"name": "location_id",
"description": "The identifier of the location where this service is delivered.",
"type": "string",
"constraints": {
"required":false
}
},
{
"name": "program_id",
"description": "The identifier of the program this service is delivered under.",
"type": "string",
"constraints": {
"required":false
}
},
{
"name": "name",
"description": "The official or public name of the service.",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "alternate_name",
"description": "Alternative or commonly used name for a service.",
"type": "string",
"constraints": {
"required":false
}
},
{
"name":"description",
"description":"A description of the service.",
"type":"string",
"constraints":{
"required":false
}
},
{
"name": "url",
"description": "URL of the service",
"type": "string",
"constraints": {
"required":false
}
},
{
"name": "email",
"description": "Email address for the service",
"type": "string",
"constraints": {
"required":false
}
},
{
"name": "status",
"description": "The current status of the service.",
"type": "string",
"constraints": {
"enum": ["active", "inactive", "defunct", "temporarily closed"],
"required":true
}
},
{
"name": "application_process",
"description": "The steps needed to access the service.",
"type": "string",
"constraints": {
"required":false
}
},
{
"name": "wait_time",
"description": "Time a client may expect to wait before receiving a service.",
"type": "string",
"constraints": {
"required":false
}
},
{
"name":"taxonomy_ids",
"description":"A comma separated list of identifiers from the taxonomy table. Advanced users may also include composite categories, using * to combine two taxonomy terms. For example: 'Food Pantry*Immigrants,Food Pantry*Homeless' (where 'Food Pantry','Immigrants' and 'Homeless' are identifiers in the taxonomy table), would indicate a food pantry service for the homeless or immigrants, but not available to other client groups.",
"type":"string",
"constraints": {
"required":false
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
},
{
"fields": "program_id",
"reference": {
"resource": "program",
"fields": "id"
}
},
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
}
]
}
},
{
"name": "service_at_location",
"path": "services_at_location.csv",
"description":"The services at location table creates a link between a service and a specific location.",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"constraints": {
"required":true,
"unique":true
}
},
{
"name": "service_id",
"description": "The identifier of the service at a given location.",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "location_id",
"description": "The identifier of the location where this service operates.",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "url",
"description": "If the service at this location has a specific URL, that can be provided here.",
"type": "string",
"constraints": {
"required":false
}
},
{
"name": "email",
"description": "If the service at this location has a specific email address, that can be provided here.",
"type": "string",
"constraints": {
"required":false
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
}
]
}
},
{
"name": "location",
"path": "locations.csv",
"description": "The location tables provides details of the locations where organizations operate. Locations may be virtual, and one organization may have may locations.",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each location must have a unique identifier",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "organization_id",
"description": "Each location must belong to a single organization. The identifier of the organization should be given here.",
"type": "string"
},
{
"name": "name",
"description": "The name of the location",
"type": "string"
},
{
"name": "alternate_name",
"description": "An alternative name for the location",
"type": "string"
},
{
"name":"description",
"description":"A description of this location.",
"type":"string",
"constraints":{
"required":false
}
},
{
"name": "transportation",
"description": "A description of the access to public or private transportation to and from the location.",
"type": "string"
},
{
"name": "latitude",
"description": "Y coordinate of location expressed in decimal degrees in WGS84 datum.",
"type": "number"
},
{
"name": "longitude",
"description": "X coordinate of location expressed in decimal degrees in WGS84 datum.",
"type": "number"
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
}
]
}
},
{
"name": "phone",
"path": "phones.csv",
"description": "The phone table contains details of the telephone numbers are used to contact organizations, services, and locations.",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"constraints": {
"required":true
}
},{
"name": "location_id",
"description": "The identifier of the location where this phone number is located",
"type": "string"
},
{
"name": "service_id",
"description": "The identifier of the service for which this is the phone number",
"type": "string"
},
{
"name": "organization_id",
"description": "The identifier of the organisation for which this is the phone number",
"type": "string"
},
{
"name": "contact_id",
"description": "The identifier of the contact for which this is the phone number",
"type": "string"
},
{
"name": "number",
"description": "The phone number",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "extension",
"description": "The extension of the phone number",
"type": "number"
},
{
"name": "type",
"description": "Whether the phone number relates to a fixed or cellular phone",
"type": "string"
},
{
"name": "department",
"description": "The department for which this is the phone number",
"type": "string"
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
},
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
},
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "contact_id",
"reference": {
"resource": "contact",
"fields": "id"
}
}
]
}
},
{
"name": "contact",
"path": "contacts.csv",
"description": "The contact table contains details of the named contacts for services and organizations. Note that in the HSDS data package format, if an individual is the contact for multiple services, their details may be duplicated multiple times in this table, each time with a new identifier, and with the rows containing different service ids.",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each contact must have a unique identifier",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "organization_id",
"description": "The identifier of the organization for which this is a contact",
"type": "string"
},
{
"name": "service_id",
"description": "The identifier of the service for which this is a contact",
"type": "string"
},
{
"name": "name",
"description": "The name of the person",
"type": "string"
},
{
"name": "title",
"description": "The job title of the person",
"type": "string"
},
{
"name": "department",
"description": "The department that the person is part of",
"type": "string"
},
{
"name": "email",
"description": "The email address of the person",
"type": "string"
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
},
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
}
]
}
},
{
"name": "physical_address",
"path": "physical_addresses.csv",
"description": "The addresses table contains the physical addresses for locations",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each physical address must have a unique identifier",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "location_id",
"description": "The identifier of the location for which this is the address",
"type": "string"
},
{
"name": "attention",
"description": "The person or entity whose attention should be sought at the location",
"type": "string"
},
{
"name": "address_1",
"description": "The first line of the address",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "address_2",
"description": "The second line of the address",
"type": "string"
},
{
"name": "address_3",
"description": "The third line of the address",
"type": "string"
},
{
"name": "address_4",
"description": "The fourth line of the address",
"type": "string"
},
{
"name": "city",
"description": "The city in which the address is located",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "state_province",
"description": "The state or province in which the address is located",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "postal_code",
"description": "The postal code for the address",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "country",
"description": "The country in which the address is located. This should be given as an ISO 3361-1 country code (two letter abbreviation)",
"type": "string",
"constraints": {
"required":true
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
}
]
}
},
{
"name": "postal_address",
"path": "postal_addresses.csv",
"description": "The postal_address table contains the postal addresses for mail to a certain location. This may differ from the physical location.",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each postal address must have a unique identifier",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "location_id",
"description": "The identifier of the location for which this is the postal address",
"type": "string"
},
{
"name": "attention",
"description": "The person or entity for whose attention mail should be marked",
"type": "string"
},
{
"name": "address_1",
"description": "The first line of the address",
"type": "string"
},
{
"name": "address_2",
"description": "The second line of the address",
"type": "string"
},
{
"name": "address_3",
"description": "The third line of the address",
"type": "string"
},
{
"name": "address_4",
"description": "The fourth line of the address",
"type": "string"
},
{
"name": "city",
"description": "The city in which the address is located",
"type": "string"
},
{
"name": "state_province",
"description": "The state or province in which the address is located",
"type": "string"
},
{
"name": "postal_code",
"description": "The postal code for the address",
"type": "string"
},
{
"name": "country",
"description": "The country in which the address is located",
"type": "string"
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
}
]
}
},
{
"name": "regular_schedule",
"path": "regular_schedules.csv",
"description": "The regular_schedule table contains details of when a service or location is open under normal circumstances. Each entry in the table can relate to one and only one day of the week.",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "service_id",
"description": "The identifier of the service for which this is the regular schedule",
"type": "string"
},
{
"name": "location_id",
"description": "The identifier of the location for which this is the regular schedule",
"type": "string"
},
{
"name": "weekday",
"description": "The day of the week that this entry relates to",
"type": "integer",
"constraints": {
"required":true
}
},
{
"name": "opens_at",
"description": "The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix 'Z' when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time. ",
"type": "time"
},
{
"name": "closes_at",
"description": "The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix 'Z' when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.",
"type": "time"
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
},
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
}
]
}
},
{
"name": "holiday_schedule",
"path": "holiday_schedules.csv",
"description": "The holiday_schedule table contains details of when a service or location is open during holidays. Each entry in the table describes a period of one or more days, and the operating times on those days.",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "service_id",
"description": "The identifier of the service for which this is the holiday schedule",
"type": "string"
},
{
"name": "location_id",
"description": "The identifier of the location for which this is the holiday schedule",
"type": "string"
},
{
"name": "closed",
"description": "Indicates if a service or location is closed during a public holiday",
"type": "boolean",
"constraints": {
"required":true
}
},
{
"name": "opens_at",
"description": "The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix 'Z' when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.",
"type": "time"
},
{
"name": "closes_at",
"description": "The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix 'Z' when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.",
"type": "time"
},
{
"name": "start_date",
"description": "The first day that a service or location is closed during a public or private holiday",
"type": "date",
"constraints": {
"required":true
}
},
{
"name": "end_date",
"description": "The last day that a service or location is closed during a public or private holiday",
"type": "date",
"constraints": {
"required":true
}
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "location_id",
"reference": {
"resource": "location",
"fields": "id"
}
},
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
}
]
}
},
{
"name": "funding",
"path": "funding.csv",
"description": "The funding table describes the sources of funding for a service or organisation",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "organization_id",
"description": "The identifier of the organization for which this entry describes the source of funding",
"type": "string"
},
{
"name": "service_id",
"description": "The identifier of the service for which this entry describes the source of funding",
"type": "string"
},
{
"name": "source",
"description": "Source of funds for organization or service",
"type": "string"
}
],
"primaryKey": "id",
"foreignKeys": [
{
"fields": "service_id",
"reference": {
"resource": "service",
"fields": "id"
}
},
{
"fields": "organization_id",
"reference": {
"resource": "organization",
"fields": "id"
}
}
]
}
},
{
"name": "eligibility",
"path": "eligibility.csv",
"description": "The eligibility tables contains details of the eligibility criteria for particular services",
"format": "csv",
"mediatype": "text/csv",
"schema": {
"fields": [
{
"name": "id",
"description": "Each entry must have a unique identifier",
"type": "string",
"constraints": {
"required":true
}
},
{
"name": "service_id",
"description": "The identifier of the service for which this entry describes the eligibility criteria",
"type": "string"
},
{
"name": "eligibility",
"description": "The rules or guidelines that determine who can receive the service.",
"type": "string",
"constraints": {
"enum": ["adult","child","teen","family","female","male",
"Transgender", "Transgender - M to F", "Transgender - F to M" ]
}
}