Skip to content

Commit 38f2ddf

Browse files
JamesW1-NHSJamesW1-NHS
committed
3. doseNumber[X]
1 parent 0a1a5c7 commit 38f2ddf

File tree

1 file changed

+20
-26
lines changed

1 file changed

+20
-26
lines changed

‎specification/immunisation-fhir-api.json‎

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -676,7 +676,7 @@
676676
},
677677
"doseNumber[X]": {
678678
"type": "object",
679-
"description": "Nominal position in a series. The use of an integer is preferred if known. A string should only be used in cases where an integer is not available.",
679+
"description": "Nominal position in a series. This SHALL be provided but may be populated using either of the dataTypes available: PositiveInt or String. The use of an integer is preferred.",
680680
"properties": {
681681
"doseNumberPositiveInt": {
682682
"description": "Nominal position in a course of vaccines. This `SHOULD be populated` where the data is available.",
@@ -1489,7 +1489,8 @@
14891489
"items": {
14901490
"type": "object",
14911491
"required": [
1492-
"targetDisease"
1492+
"targetDisease",
1493+
"doseNumber[X]"
14931494
],
14941495
"properties": {
14951496
"targetDisease": {
@@ -1532,21 +1533,18 @@
15321533
},
15331534
"doseNumber[X]": {
15341535
"type": "object",
1535-
"description": "Dose number within series. Can be an integer or string. Kindly, refer below elements",
1536+
"description": "Nominal position in a series. This SHALL be provided but may be populated using either of the dataTypes available: PositiveInt or String. The use of an integer is preferred.",
15361537
"properties": {
15371538
"doseNumberPositiveInt": {
1538-
"description": "Dose number within a series of doses.",
1539+
"description": "Nominal position in a course of vaccines. This `SHOULD be populated` where the data is available.",
15391540
"type": "integer",
15401541
"example": 1
15411542
},
15421543
"doseNumberString": {
1543-
"description": "A string should only be used in cases where an integer is not available.",
1544+
"description": "Description of the dose sequence where it is not a numeric or a reason a dose number cannot be provided. \nA string should only be used in cases where an integer is not available.",
15441545
"type": "string"
15451546
}
1546-
},
1547-
"required": [
1548-
"doseNumberPositiveInt"
1549-
]
1547+
}
15501548
}
15511549
}
15521550
}
@@ -2410,7 +2408,8 @@
24102408
"items": {
24112409
"type": "object",
24122410
"required": [
2413-
"targetDisease"
2411+
"targetDisease",
2412+
"doseNumber[X]"
24142413
],
24152414
"properties": {
24162415
"targetDisease": {
@@ -2453,21 +2452,18 @@
24532452
},
24542453
"doseNumber[X]": {
24552454
"type": "object",
2456-
"description": "Dose number within series. Can be an integer or string. Kindly, refer below elements",
2455+
"description": "Nominal position in a series. This SHALL be provided but may be populated using either of the dataTypes available: PositiveInt or String. The use of an integer is preferred.",
24572456
"properties": {
24582457
"doseNumberPositiveInt": {
2459-
"description": "Dose number within a series of doses.",
2458+
"description": "Nominal position in a course of vaccines. This `SHOULD be populated` where the data is available.",
24602459
"type": "integer",
24612460
"example": 1
24622461
},
24632462
"doseNumberString": {
2464-
"description": "A string should only be used in cases where an integer is not available.",
2463+
"description": "Description of the dose sequence where it is not a numeric or a reason a dose number cannot be provided. \nA string should only be used in cases where an integer is not available.",
24652464
"type": "string"
24662465
}
2467-
},
2468-
"required": [
2469-
"doseNumberPositiveInt"
2470-
]
2466+
}
24712467
}
24722468
}
24732469
}
@@ -3384,7 +3380,8 @@
33843380
"items": {
33853381
"type": "object",
33863382
"required": [
3387-
"targetDisease"
3383+
"targetDisease",
3384+
"doseNumber[X]"
33883385
],
33893386
"properties": {
33903387
"targetDisease": {
@@ -3427,21 +3424,18 @@
34273424
},
34283425
"doseNumber[X]": {
34293426
"type": "object",
3430-
"description": "Dose number within series. Can be an integer or string. Kindly, refer below elements",
3427+
"description": "Nominal position in a series. This SHALL be provided but may be populated using either of the dataTypes available: PositiveInt or String. The use of an integer is preferred.",
34313428
"properties": {
34323429
"doseNumberPositiveInt": {
3433-
"description": "Dose number within a series of doses.",
3430+
"description": "Nominal position in a course of vaccines. This `SHOULD be populated` where the data is available.",
34343431
"type": "integer",
34353432
"example": 1
34363433
},
34373434
"doseNumberString": {
3438-
"description": "A string should only be used in cases where an integer is not available.",
3435+
"description": "Description of the dose sequence where it is not a numeric or a reason a dose number cannot be provided. \nA string should only be used in cases where an integer is not available.",
34393436
"type": "string"
34403437
}
3441-
},
3442-
"required": [
3443-
"doseNumberPositiveInt"
3444-
]
3438+
}
34453439
}
34463440
}
34473441
}
@@ -4302,7 +4296,7 @@
43024296
},
43034297
"doseNumber[X]": {
43044298
"type": "object",
4305-
"description": "Nominal position in a series. The use of an integer is preferred if known. A string should only be used in cases where an integer is not available.",
4299+
"description": "Nominal position in a series. This SHALL be provided but may be populated using either of the dataTypes available: PositiveInt or String. The use of an integer is preferred.",
43064300
"properties": {
43074301
"doseNumberPositiveInt": {
43084302
"description": "Nominal position in a course of vaccines. This `SHOULD be populated` where the data is available.",

0 commit comments

Comments
 (0)