Skip to content

Commit 531797d

Browse files
JamesW1-NHSJamesW1-NHS
committed
doseNumber[X]
1 parent 31e7100 commit 531797d

File tree

1 file changed

+81
-99
lines changed

1 file changed

+81
-99
lines changed

‎specification/immunisation-fhir-api.yaml‎

Lines changed: 81 additions & 99 deletions
Original file line numberDiff line numberDiff line change
@@ -1146,7 +1146,11 @@ paths:
11461146
type: object
11471147
required:
11481148
- targetDisease
1149-
- "doseNumber[X]"
1149+
oneOf:
1150+
- required:
1151+
- doseNumberPositiveInt
1152+
- required:
1153+
- doseNumberString
11501154
properties:
11511155
targetDisease:
11521156
type: array
@@ -1198,31 +1202,23 @@ paths:
11981202
code in the system, following the rules of
11991203
the system.
12001204
type: string
1201-
"doseNumber[X]":
1202-
type: object
1205+
doseNumberPositiveInt:
12031206
description: >-
1204-
Nominal position in a series. This SHALL be provided
1205-
but may be populated using either of the dataTypes
1206-
available: PositiveInt or String. The use of an
1207-
integer is preferred. Maximum value is 9.
1208-
properties:
1209-
doseNumberPositiveInt:
1210-
description: >-
1211-
Nominal position in a course of vaccines. This
1212-
`SHOULD be populated` where the data is
1213-
available.. Maximum value is 9.
1214-
type: integer
1215-
maximum: 9
1216-
example: 1
1217-
doseNumberString:
1218-
description: >-
1219-
Description of the dose sequence where it is not a
1220-
numeric or a reason a dose number cannot be
1221-
provided.
1207+
Nominal position in a course of vaccines. This
1208+
`SHOULD be populated` where the data is
1209+
available.. Maximum value is 9.
1210+
type: integer
1211+
maximum: 9
1212+
example: 1
1213+
doseNumberString:
1214+
description: >-
1215+
Description of the dose sequence where it is not a
1216+
numeric or a reason a dose number cannot be
1217+
provided.
12221218
1223-
A string should only be used in cases where an
1224-
integer is not available.
1225-
type: string
1219+
A string should only be used in cases where an
1220+
integer is not available.
1221+
type: string
12261222
example:
12271223
resourceType: Immunization
12281224
contained:
@@ -1984,7 +1980,11 @@ paths:
19841980
type: object
19851981
required:
19861982
- targetDisease
1987-
- "doseNumber[X]"
1983+
oneOf:
1984+
- required:
1985+
- doseNumberPositiveInt
1986+
- required:
1987+
- doseNumberString
19881988
properties:
19891989
targetDisease:
19901990
type: array
@@ -2027,34 +2027,24 @@ paths:
20272027
- display
20282028
required:
20292029
- coding
2030-
"doseNumber[X]":
2031-
type: object
2030+
doseNumberPositiveInt:
20322031
description: >-
2033-
Nominal position in a series. This SHALL
2034-
be provided but may be populated using
2035-
either of the dataTypes available:
2036-
PositiveInt or String. The use of an
2037-
integer is preferred. Maximum value is
2038-
9.
2039-
properties:
2040-
doseNumberPositiveInt:
2041-
description: >-
2042-
Nominal position in a course of
2043-
vaccines. This `SHOULD be populated`
2044-
where the data is available. Maximum
2045-
value is 9.
2046-
type: integer
2047-
maximum: 9
2048-
example: 1
2049-
doseNumberString:
2050-
description: >-
2051-
Description of the dose sequence where
2052-
it is not a numeric or a reason a dose
2053-
number cannot be provided.
2032+
Nominal position in a course of
2033+
vaccines. This `SHOULD be populated`
2034+
where the data is available. Maximum
2035+
value is 9.
2036+
type: integer
2037+
maximum: 9
2038+
example: 1
2039+
doseNumberString:
2040+
description: >-
2041+
Description of the dose sequence where
2042+
it is not a numeric or a reason a dose
2043+
number cannot be provided.
20542044
2055-
A string should only be used in cases
2056-
where an integer is not available.
2057-
type: string
2045+
A string should only be used in cases
2046+
where an integer is not available.
2047+
type: string
20582048
- description: Demographic information about the patient receiving an immunisation.
20592049
type: object
20602050
required:
@@ -2832,7 +2822,11 @@ paths:
28322822
type: object
28332823
required:
28342824
- targetDisease
2835-
- "doseNumber[X]"
2825+
oneOf:
2826+
- required:
2827+
- doseNumberPositiveInt
2828+
- required:
2829+
- doseNumberString
28362830
properties:
28372831
targetDisease:
28382832
type: array
@@ -2875,31 +2869,23 @@ paths:
28752869
- display
28762870
required:
28772871
- coding
2878-
"doseNumber[X]":
2879-
type: object
2872+
doseNumberPositiveInt:
28802873
description: >-
2881-
Nominal position in a series. This SHALL be provided
2882-
but may be populated using either of the dataTypes
2883-
available: PositiveInt or String. The use of an
2884-
integer is preferred. Maximum value is 9.
2885-
properties:
2886-
doseNumberPositiveInt:
2887-
description: >-
2888-
Nominal position in a course of vaccines. This
2889-
`SHOULD be populated` where the data is
2890-
available. Maximum value is 9.
2891-
type: integer
2892-
maximum: 9
2893-
example: 1
2894-
doseNumberString:
2895-
description: >-
2896-
Description of the dose sequence where it is not
2897-
a numeric or a reason a dose number cannot be
2898-
provided.
2874+
Nominal position in a course of vaccines. This
2875+
`SHOULD be populated` where the data is
2876+
available. Maximum value is 9.
2877+
type: integer
2878+
maximum: 9
2879+
example: 1
2880+
doseNumberString:
2881+
description: >-
2882+
Description of the dose sequence where it is not
2883+
a numeric or a reason a dose number cannot be
2884+
provided.
28992885
2900-
A string should only be used in cases where an
2901-
integer is not available.
2902-
type: string
2886+
A string should only be used in cases where an
2887+
integer is not available.
2888+
type: string
29032889
example:
29042890
resourceType: Immunization
29052891
id: 12a33650-6f94-4e8f-a971-1c5c41da5b22
@@ -3758,7 +3744,11 @@ paths:
37583744
type: object
37593745
required:
37603746
- targetDisease
3761-
- "doseNumber[X]"
3747+
oneOf:
3748+
- required:
3749+
- doseNumberPositiveInt
3750+
- required:
3751+
- doseNumberString
37623752
properties:
37633753
targetDisease:
37643754
type: array
@@ -3810,31 +3800,23 @@ paths:
38103800
code in the system, following the rules of
38113801
the system.
38123802
type: string
3813-
"doseNumber[X]":
3814-
type: object
3803+
doseNumberPositiveInt:
38153804
description: >-
3816-
Nominal position in a series. This SHALL be provided
3817-
but may be populated using either of the dataTypes
3818-
available: PositiveInt or String. The use of an
3819-
integer is preferred. Maximum value is 9.
3820-
properties:
3821-
doseNumberPositiveInt:
3822-
description: >-
3823-
Nominal position in a course of vaccines. This
3824-
`SHOULD be populated` where the data is available.
3825-
Maximum value is 9.
3826-
type: integer
3827-
maximum: 9
3828-
example: 1
3829-
doseNumberString:
3830-
description: >-
3831-
Description of the dose sequence where it is not a
3832-
numeric or a reason a dose number cannot be
3833-
provided.
3805+
Nominal position in a course of vaccines. This
3806+
`SHOULD be populated` where the data is available.
3807+
Maximum value is 9.
3808+
type: integer
3809+
maximum: 9
3810+
example: 1
3811+
doseNumberString:
3812+
description: >-
3813+
Description of the dose sequence where it is not a
3814+
numeric or a reason a dose number cannot be
3815+
provided.
38343816
3835-
A string should only be used in cases where an
3836-
integer is not available.
3837-
type: string
3817+
A string should only be used in cases where an
3818+
integer is not available.
3819+
type: string
38383820
example:
38393821
resourceType: Immunization
38403822
id: 4ff607e0-c6e9-4fe0-a2b6-3bcd7fdc44c9

0 commit comments

Comments
 (0)