This repository has been archived by the owner on Jun 15, 2021. It is now read-only.
forked from sul-cidr/patent_data_extractor
-
Notifications
You must be signed in to change notification settings - Fork 0
/
uspto-grants.2002-2004.yaml
400 lines (360 loc) · 11.3 KB
/
uspto-grants.2002-2004.yaml
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
PATDOC:
# entity is used for the name of the table and for fieldnames for foreign key
# relations with related entities.
<entity>: patent
# pk is optional -- if supplied, text extracted from the supplied path will be
# used for the primary ket of the table (so it must be unique!). If this key
# is not supplied, an auto-incremented integer will be used for the pk.
<primary_key>: SDOBI/B100/B110/DNUM
# filename_field is optional -- if supplied, the name of the file containing
# the XML parsed to make this record will be saved to a field named for the
# value supplied.
<filename_field>: source_file
<fields>:
SDOBI/B500/B570/B577: num_claims
SDOBI/B500/B540/STEXT: title
SDOCL/CL/CLM:
<entity>: claim
<fields>:
# the asterisk specifies that all sub-elements of each PATDOC/SDOCL/CL/CLM
# will be reduced to their text content, and the results of each such
# reduction (for each PATDOC/SDOCL/CL/CLM element, should there be more
# than one) will be concatenated together with the `joiner` string -- in
# this case, a newline.
"*":
<fieldname>: claim_text
<joiner>: "\n"
SDOBI/B100/B110/DNUM: doc_number
SDOBI/B100/B130: kind_code
SDOBI/B100/B190: country_code
SDOBI/B300:
<entity>: foreign_filing
<fields>:
B310/DNUM: doc_number
B320/DATE: date
B330/CTRY: country_code
SDOBI/B200/B220/DATE: filing_date
SDOBI/B100/B140/DATE: doc_date
SDOBI/B500/B510/B511: IPC_primary
SDOBI/B500/B510/B512:
<fieldname>: IPC_secondary
<joiner>: "|"
SDOBI/B500/B520/B521: USPC_primary
SDOBI/B500/B520/B522:
<fieldname>: USPC_secondary
<joiner>: "|"
SDOBI/B500/B520/B522US: USPC_secondary
SDOBI/B500/B510/B516: IPC_edition
SDOBI/B700/B720/B721:
<entity>: applicant
<fields>:
PARTY-US/NAM/SNM/STEXT: last_name
PARTY-US/NAM/FNM: given_name
PARTY-US/NAM/ONM/STEXT: org_name
PARTY-US/ADR/CITY: res_city
PARTY-US/ADR/STATE: res_state
PARTY-US/ADR/CTRY: res_country
SDOBI/B200/B210/DNUM: app_number
SDOBI/B200/B211US: series_code
SDOBI/B700/B730:
<entity>: assignee
<fields>:
B731/PARTY-US/NAM/ONM/STEXT: org_name
B731/PARTY-US/ADR/STR/PDAT: street
B731/PARTY-US/ADR/CITY/PDAT: city
B731/PARTY-US/ADR/CNTY/PDAT: county
B731/PARTY-US/ADR/STATE/PDAT: state
B731/PARTY-US/ADR/CTRY/PDAT: country
B731/PARTY-US/ADR/PCODE/PDAT: postal_code
B732US: role
SDOBI/B500/B560/B561:
<entity>: citation
<fields>:
PCIT/DOC/DNUM: doc_number
PCIT/DOC/KIND: kind_code
PCIT/DOC/CTRY: country_code
PCIT/PARTY-US/NAM/SNM/STEXT: name
PCIT/DOC/DATE: date
# these fields specify `enum_type` -- this means the value provided (e.g.
# "examiner") will be recorded in the specified field (i.e. "cited_by")
# in the event that an element at the specified path (e.g.
# PATDOC/SDOBI/B500/B560/B561/CITED-BY-EXAMINER) is found. Note that if
# multiple paths are found that reference the same fieldname, as here,
# the value that comes last in order in the config file will prevail.
CITED-BY-EXAMINER:
<fieldname>: cited_by
<enum_type>: examiner
CITED-BY-OTHER:
<fieldname>: cited_by
<enum_type>: other
PCIT/PNC: cited_in
SDOBI/B500/B560/B562:
<entity>: citation
<fields>:
CITED-BY-EXAMINER:
<fieldname>: cited_by
<enum_type>: examiner
CITED-BY-OTHER:
<fieldname>: cited_by
<enum_type>: other
NCIT/STEXT: cited_in_other
SDOBI/B700/B745/B746/PARTY-US/NAM/SNM/STEXT: examiner1_last_name
SDOBI/B700/B745/B746/PARTY-US/NAM/FNM: examiner1_given_name
SDOBI/B700/B745/B748US: examiner1_dep
SDOBI/B700/B745/B747/PARTY-US/NAM/SNM/STEXT: examiner2_last_name
SDOBI/B700/B745/B747/PARTY-US/NAM/FNM: examiner2_first_name
# Related documents
## Parent Documents
SDOBI/B600/B610/PARENT-US/PDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: addition
- <fieldname>: relationship
<enum_type>: parent
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B620/PARENT-US/PDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: division
- <fieldname>: relationship
<enum_type>: parent
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B630/B631/PARENT-US/PDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: continuation
- <fieldname>: relationship
<enum_type>: parent
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B630/B632/PARENT-US/PDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: continuation_in_part
- <fieldname>: relationship
<enum_type>: parent
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B630/B633/PARENT-US/PDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: continuing_reissue
- <fieldname>: relationship
<enum_type>: parent
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B640/PARENT-US/PDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: reissue
- <fieldname>: relationship
<enum_type>: parent
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B641US/PARENT-US/PDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: divisional_reissue
- <fieldname>: relationship
<enum_type>: parent
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B645/PARENT-US/PDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: reexamination
- <fieldname>: relationship
<enum_type>: parent
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
# TODO: This is wrong, but I literally can't find one in the data
# TODO: and this way we at least get to see them in the data
SDOBI/B600/B645US:
<entity>: related_document
<fields>:
PDAT:
- <fieldname>: type
<enum_type>: reexamination_reissue_merger
- <fieldname>: relationship
<enum_type>: parent
# - "*":
# <fieldname>: doc_number
# <joiner>: "|#|"
SDOBI/B600/B650:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: related_publication
- <fieldname>: relationship
<enum_type>: parent
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B660/PARENT-US/PDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: subsitute
- <fieldname>: relationship
<enum_type>: parent
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B680US:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: provisional_application
- <fieldname>: relationship
<enum_type>: parent
DOC/DNUM: doc_number
DOC/DATE: date
## Child Documents
SDOBI/B600/B610/PARENT-US/CDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: addition
- <fieldname>: relationship
<enum_type>: child
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B620/PARENT-US/CDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: division
- <fieldname>: relationship
<enum_type>: child
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B630/B631/PARENT-US/CDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: continuation
- <fieldname>: relationship
<enum_type>: child
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B630/B632/PARENT-US/CDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: continuation_in_part
- <fieldname>: relationship
<enum_type>: child
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B630/B633/PARENT-US/CDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: continuing_reissue
- <fieldname>: relationship
<enum_type>: child
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B640/PARENT-US/CDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: reissue
- <fieldname>: relationship
<enum_type>: child
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B641US/PARENT-US/CDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: divisional_reissue
- <fieldname>: relationship
<enum_type>: child
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B645/PARENT-US/CDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: reexamination
- <fieldname>: relationship
<enum_type>: child
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOBI/B600/B660/PARENT-US/CDOC:
<entity>: related_document
<fields>:
DOC:
- <fieldname>: type
<enum_type>: subsitute
- <fieldname>: relationship
<enum_type>: child
DOC/DNUM: doc_number
DOC/DATE: date
DOC/KIND: kind_code
DOC/CTRY: country_code
SDOAB/BTEXT: abstract