Skip to content

Commit acf9d14

Browse files
authored
OAS documentation for name field characters (#1190)
1 parent 35a663e commit acf9d14

1 file changed

Lines changed: 23 additions & 11 deletions

File tree

specification/immunisation-fhir-api.yaml

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -523,12 +523,14 @@ paths:
523523
properties:
524524
family:
525525
type: string
526-
description: Family name (often called 'Surname')
526+
maxLength: 35
527+
description: Family name (often called 'Surname'). Maximum length 35 characters.
527528
given:
528529
type: array
529-
description: Given names (not always 'first').
530+
description: Given names (not always 'first'). Maximum length 180 characters.
530531
items:
531532
type: string
533+
maxLength: 180
532534
required:
533535
- resourceType
534536
- id
@@ -578,6 +580,7 @@ paths:
578580
properties:
579581
family:
580582
type: string
583+
maxLength: 35
581584
description: Family name (often called 'Surname')
582585
given:
583586
type: array
@@ -586,9 +589,10 @@ paths:
586589
included within this field.
587590
588591
There SHOULD only be one given name supplied
589-
in this element.
592+
in this element. Maximum length 180 characters.
590593
items:
591594
type: string
595+
maxLength: 180
592596
required:
593597
- family
594598
- given
@@ -1601,12 +1605,14 @@ paths:
16011605
properties:
16021606
family:
16031607
type: string
1604-
description: Family name (often called 'Surname')
1608+
maxLength: 35
1609+
description: Family name (often called 'Surname'). Maximum length 35 characters.
16051610
given:
16061611
type: array
1607-
description: Given names (not always 'first').
1612+
description: Given names (not always 'first'). Maximum length 180 characters.
16081613
items:
16091614
type: string
1615+
maxLength: 180
16101616
required:
16111617
- family
16121618
- given
@@ -1648,12 +1654,14 @@ paths:
16481654
properties:
16491655
family:
16501656
type: string
1651-
description: Family name (often called 'Surname')
1657+
maxLength: 35
1658+
description: Family name (often called 'Surname'). Maximum length 35 characters.
16521659
given:
16531660
type: array
1654-
description: Given names (not always 'first').
1661+
description: Given names (not always 'first'). Maximum length 180 characters for batch.
16551662
items:
16561663
type: string
1664+
maxLength: 180
16571665
required:
16581666
- family
16591667
- given
@@ -2368,12 +2376,14 @@ paths:
23682376
properties:
23692377
family:
23702378
type: string
2371-
description: Family name (often called 'Surname')
2379+
maxLength: 35
2380+
description: Family name (often called 'Surname'). Maximum length 35 characters.
23722381
given:
23732382
type: array
2374-
description: Given names (not always 'first').
2383+
description: Given names (not always 'first'). Maximum length 180 characters.
23752384
items:
23762385
type: string
2386+
maxLength: 180
23772387
required:
23782388
- resourceType
23792389
- id
@@ -2423,17 +2433,19 @@ paths:
24232433
properties:
24242434
family:
24252435
type: string
2426-
description: Family name (often called 'Surname')
2436+
maxLength: 35
2437+
description: Family name (often called 'Surname'). Maximum length 35 characters.
24272438
given:
24282439
type: array
24292440
description: >-
24302441
Patient Forename. Middle names are not to be
24312442
included within this field.
24322443
24332444
There SHOULD only be one given name supplied
2434-
in this element.
2445+
in this element. Maximum length 180 characters.
24352446
items:
24362447
type: string
2448+
maxLength: 180
24372449
required:
24382450
- family
24392451
- given

0 commit comments

Comments
 (0)