fhir 1.2.0

Fast Healthcare Interoperability Resources (FHIR) data model for Rust: the complete FHIR R5, R4, and R3 resources, datatypes, and code systems as serde-serializable types, plus a spec-driven code generator.
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
//! Parse FHIR R5 specifications JSON file.
//!
//! For an example see the sibling file of JSON.

use crate::r5::parse::all::*;
use ::serde::{Deserialize, Serialize};

#[serde_with::skip_serializing_none]
#[derive(Debug, Default, Clone, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
#[serde(deny_unknown_fields)]
pub struct Example {
    /// # label
    ///
    /// ## Description
    ///
    /// The `label` key is used in FHIR ElementDefinition within
    /// StructureDefinition resources to provide a concise, human-readable label
    /// for an element. It serves as a brief identifier that can be used in user
    /// interfaces, forms, and documentation.
    ///
    /// ## Purpose
    ///
    /// - Provides concise, human-readable labels for elements
    /// - Supports user interface development and form generation
    /// - Enables better user experience in clinical applications
    /// - Offers standardized labeling for consistent presentation
    /// - Facilitates internationalization and localization efforts
    ///
    /// ## Usage
    ///
    /// The `label` appears in:
    ///
    /// - **StructureDefinition**: Within ElementDefinition for UI labeling
    /// - **Profile definitions**: To specify display labels for elements
    /// - **Form generation**: For automated form creation from profiles
    /// - **User interfaces**: For consistent element labeling
    /// - **Documentation**: For element identification in specifications
    ///
    /// ## Data Type
    ///
    /// **string** - A human-readable label
    ///
    /// - Should be concise and clear
    /// - Typically shorter than the `short` description
    /// - Should be appropriate for UI display
    /// - May be used in form labels and field names
    ///
    /// ## Constraints
    ///
    /// - Should be brief and suitable for UI display
    /// - Should be meaningful to end users
    /// - May be used in contexts with space limitations
    /// - Should align with the element's purpose and meaning
    /// - Can be localized for different languages
    ///
    /// ## Examples
    ///
    /// ### Basic Element Label
    ///
    /// ```json
    ///
    /// {
    ///   "label": "Patient ID"
    /// }
    /// ```
    ///
    /// ### Form Field Label
    ///
    /// ```json
    /// {
    ///   "label": "Birth Date"
    /// }
    /// ```
    ///
    /// ### Clinical Data Label
    ///
    /// ```json
    /// {
    ///   "label": "Blood Pressure"
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `short` - Brief description of the element (usually longer than label)
    /// - `definition` - Complete definition of the element
    /// - `comment` - Additional implementation guidance
    /// - `requirements` - Why the element is needed
    /// - `alias` - Alternative names for the element
    /// - `path` - Element path being labeled
    ///
    /// ## Specification Reference
    ///
    /// - **FHIR R5 Specification**:
    ///   [ElementDefinition](http://hl7.org/fhir/R5/elementdefinition.html)
    /// - **Section**: ElementDefinition.label
    /// - **Context**: Used in structure definitions for UI and documentation
    ///   labeling
    /// - **Best Practices**: Should be concise and user-friendly for interface
    ///   display
    ///
    pub label: String,

    /// # value
    ///
    /// ## Description
    ///
    /// The `value` attribute serves as a generic field prefix used throughout
    /// FHIR to represent the actual data content of various data types and
    /// elements. It appears in numerous contexts as part of polymorphic value
    /// fields (like value[x] in extensions and observations) and as the core
    /// data element in primitive data types and complex structures.
    ///
    /// ## Purpose
    ///
    /// The `value` exists to provide a consistent naming pattern for data
    /// content across FHIR, enabling:
    ///
    /// - Polymorphic data representation through value[x] patterns
    /// - Consistent structure for primitive and complex data types
    /// - Clear separation between metadata and actual data content
    /// - Support for type-specific value representations
    /// - Uniform handling of data values in processing systems
    ///
    /// ## Usage
    ///
    /// Use the `value` attribute when:
    ///
    /// - Creating Extension elements with typed values (valueString,
    ///   valueInteger, etc.)
    /// - Representing measurement values in Quantity data types
    /// - Storing actual data content in Observation.value[x] fields
    /// - Implementing primitive data types with additional metadata
    /// - Creating parameters with typed value content
    ///
    /// The value field is often suffixed with a type indicator (e.g.,
    /// valueString, valueCodeableConcept) to specify the data type.
    ///
    /// ## Data Type
    ///
    /// **varies** - The data type depends on the specific context and type
    /// suffix:
    /// - **Primitive types**: string, integer, decimal, boolean, date,
    ///   dateTime, etc.
    /// - **Complex types**: CodeableConcept, Quantity, Reference, Period, etc.
    /// - **Special types**: base64Binary, code, uri, url, canonical
    /// - Type safety ensured through polymorphic naming (value[x])
    ///
    /// ## Constraints
    ///
    /// - **Required**: Conditional - depends on the specific context and
    ///   requirements
    /// - **Cardinality**: Typically 0..1 or 1..1 depending on usage context
    /// - **Type Constraints**: Must conform to the specified data type
    ///   requirements
    /// - **Validation**: Subject to type-specific validation rules
    /// - **Polymorphism**: Only one value[x] variant allowed per element
    ///
    /// ## Examples
    ///
    /// See the accompanying `example.json` file for a complete Observation
    /// resource demonstrating various uses of the `value` attribute in
    /// different typed contexts.
    ///
    /// ## Related Keys
    ///
    /// - `unit` - Unit of measure when value represents a quantity
    /// - `system` - System reference for coded values
    /// - `code` - Coded representation when value is part of coded concepts
    /// - `extension` - Contains value[x] fields for additional data
    /// - `component` - May contain value[x] fields in complex observations
    ///
    /// ## Specification Reference
    ///
    /// Based on FHIR R5 specification. For complete details, refer to the
    /// official FHIR R5 documentation for data types, polymorphic elements, and
    /// the value[x] pattern implementation.
    ///
    pub value: Option<serde_json::Value>,

    /// # valueBoolean
    ///
    /// ## Description
    ///
    /// The `valueBoolean` property contains boolean (true/false) values in FHIR
    /// resources. It represents binary choices, yes/no answers, or toggle
    /// states.
    ///
    /// ## Purpose
    ///
    /// - Represent binary true/false values
    /// - Support yes/no questions and responses
    /// - Enable boolean flags and switches
    /// - Provide simple binary data representation
    /// - Support boolean parameters and extensions
    ///
    /// ## Usage
    ///
    /// The `valueBoolean` property is used throughout FHIR resources for
    /// boolean values, particularly in extensions, parameters, and elements
    /// requiring true/false answers.
    ///
    /// ## Data Type
    ///
    /// **boolean** - Either true or false
    ///
    /// ## Constraints
    ///
    /// - Must be exactly true or false (not null or undefined)
    /// - Cannot be empty or missing when specified
    /// - JSON boolean representation (lowercase true/false)
    ///
    /// ## Examples
    ///
    /// ### Extension with Boolean Value
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/is-emergency",
    ///       "valueBoolean": true
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter Boolean Value
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "includeDefinition",
    ///       "valueBoolean": false
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueInteger` - Integer values
    /// - `valueString` - String values
    /// - `valueCode` - Coded values
    /// - `active` - Boolean status flags
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types:
    /// [boolean](http://hl7.org/fhir/R5/datatypes.html#boolean)
    ///
    pub value_boolean: Option<bool>,

    /// # valueCanonical
    ///
    /// ## Description
    ///
    /// The `valueCanonical` property contains a canonical URL reference to a
    /// FHIR resource. It represents a URI that uniquely identifies a resource
    /// definition, profile, or other FHIR artifact using a canonical
    /// identifier.
    ///
    /// ## Purpose
    ///
    /// - Reference FHIR definitions and profiles using canonical URLs
    /// - Provide version-independent references to FHIR artifacts
    /// - Support profile validation and conformance checking
    /// - Enable cross-referencing between FHIR resources and definitions
    /// - Maintain stable references across resource versions
    ///
    /// ## Usage
    ///
    /// The `valueCanonical` property is used in extensions, parameters, and
    /// elements that need to reference FHIR resource definitions, profiles,
    /// value sets, code systems, or other canonically-identified artifacts.
    ///
    /// ## Data Type
    ///
    /// **canonical** - A URI that refers to a resource by its canonical URL
    ///
    /// ## Constraints
    ///
    /// - Must be a valid URI format
    /// - Should reference an existing FHIR resource with a canonical URL
    /// - May include version information using the format: `url|version`
    /// - Must conform to canonical URI patterns defined in FHIR
    /// - Should be resolvable to a FHIR resource definition
    ///
    /// ## Examples
    ///
    /// ### Extension with Profile Reference
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/conformsToProfile",
    ///       "valueCanonical": "http://hl7.org/fhir/StructureDefinition/Patient"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with ValueSet Reference
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "valueSet",
    ///       "valueCanonical": "http://hl7.org/fhir/ValueSet/administrative-gender|5.0.0"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueUri` - General URI values
    /// - `valueUrl` - URL references
    /// - `canonical` - Direct canonical references
    /// - `profile` - Profile references
    /// - `targetProfile` - Target profile references
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types:
    /// [canonical](http://hl7.org/fhir/R5/datatypes.html#canonical)
    ///
    pub value_canonical: Option<String>,

    /// # valueCode
    ///
    /// ## Description
    ///
    /// The `valueCode` property contains a coded value from a defined set of
    /// codes. It represents a single code token that is selected from a
    /// specific code system or value set, providing structured and standardized
    /// data representation.
    ///
    /// ## Purpose
    ///
    /// - Store coded values from predefined code systems
    /// - Ensure data consistency through controlled vocabularies
    /// - Support interoperability with standard coding schemes
    /// - Enable precise and unambiguous data representation
    /// - Facilitate automated processing and validation
    ///
    /// ## Usage
    ///
    /// The `valueCode` property is used in extensions, parameters, and data
    /// elements where a single code value is required from a specific code
    /// system or constrained value set.
    ///
    /// ## Data Type
    ///
    /// **code** - A string that represents a code from a code system
    ///
    /// ## Constraints
    ///
    /// - Must be a valid token (no whitespace, limited punctuation)
    /// - Should come from a defined code system or value set
    /// - Case-sensitive unless explicitly defined otherwise
    /// - Must match the pattern defined by the binding value set
    /// - Should be a meaningful code within its context
    ///
    /// ## Examples
    ///
    /// ### Extension with Status Code
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/approval-status",
    ///       "valueCode": "approved"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with Gender Code
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "gender",
    ///       "valueCode": "female"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueCoding` - Coded values with system and display
    /// - `valueCodeableConcept` - Complex coded concepts
    /// - `code` - Direct code values
    /// - `system` - Code system identifier
    /// - `value` - Generic value field
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types: [code](http://hl7.org/fhir/R5/datatypes.html#code)
    ///
    pub value_code: Option<String>,

    /// # valueDateTime
    ///
    /// ## Description
    ///
    /// The `valueDateTime` property contains date and time values with optional
    /// time zone information. It represents precise temporal data points using
    /// ISO 8601 format, supporting various levels of precision from year to
    /// seconds with fractional seconds.
    ///
    /// ## Purpose
    ///
    /// - Store precise date and time information
    /// - Support temporal queries and calculations
    /// - Enable time-based ordering and filtering
    /// - Provide timezone-aware temporal data
    /// - Support various precision levels as clinically appropriate
    ///
    /// ## Usage
    ///
    /// The `valueDateTime` property is used in extensions, parameters, and data
    /// elements where precise temporal information is required, such as
    /// timestamps, event times, or scheduled dates.
    ///
    /// ## Data Type
    ///
    /// **dateTime** - A date, date-time or partial date (ISO 8601 format)
    ///
    /// ## Constraints
    ///
    /// - Must follow ISO 8601 format (YYYY-MM-DDTHH:MM:SS[.ffffff][±HH:MM|Z])
    /// - Precision can range from year (YYYY) to fractional seconds
    /// - Time zone is recommended for precise timestamps
    /// - Must be a valid date and time combination
    /// - Should use UTC time zone for interoperability when possible
    ///
    /// ## Examples
    ///
    /// ### Extension with Precise Timestamp
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/event-timestamp",
    ///       "valueDateTime": "2024-01-15T10:30:45.123Z"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with Date and Time Zone
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "scheduledTime",
    ///       "valueDateTime": "2024-03-20T14:00:00-05:00"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueDate` - Date only values
    /// - `valueInstant` - Precise timestamps
    /// - `valuePeriod` - Date/time ranges
    /// - `date` - Simple date fields
    /// - `effectiveDateTime` - Effective date/time
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types:
    /// [dateTime](http://hl7.org/fhir/R5/datatypes.html#dateTime)
    ///
    pub value_date_time: Option<String>,

    /// # valueId
    ///
    /// ## Description
    ///
    /// The `valueId` property contains identifier values that conform to FHIR
    /// id constraints. It represents logical identifiers that are used to
    /// reference resources within a server or across FHIR systems, following
    /// specific formatting rules for maximum interoperability.
    ///
    /// ## Purpose
    ///
    /// - Store logical identifiers for FHIR resources
    /// - Provide unique reference mechanisms within systems
    /// - Support resource linking and cross-referencing
    /// - Enable consistent identifier formatting across implementations
    /// - Facilitate resource resolution and retrieval
    ///
    /// ## Usage
    ///
    /// The `valueId` property is used in extensions, parameters, and data
    /// elements where FHIR-compliant identifiers are required for referencing
    /// resources or creating unique logical identifiers.
    ///
    /// ## Data Type
    ///
    /// **id** - A string constrained to contain only valid id characters
    ///
    /// ## Constraints
    ///
    /// - Must be 1-64 characters in length
    /// - Can only contain letters (a-z, A-Z), numbers (0-9), hyphens (-), and
    ///   periods (.)
    /// - Must not start or end with a period
    /// - Case sensitive
    /// - Must be unique within the context where it's used
    ///
    /// ## Examples
    ///
    /// ### Extension with Resource Reference ID
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/linked-resource",
    ///       "valueId": "patient-12345"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with Generated ID
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "resourceId",
    ///       "valueId": "obs-bp-2024-001"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueString` - General string values
    /// - `identifier` - Complex identifier objects
    /// - `id` - Direct resource identifiers
    /// - `reference` - Resource references
    /// - `fullUrl` - Complete resource URLs
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types: [id](http://hl7.org/fhir/R5/datatypes.html#id)
    ///
    pub value_id: Option<String>,

    /// # valueInteger
    ///
    /// ## Description
    ///
    /// The `valueInteger` property contains whole number values within the
    /// 32-bit signed integer range. It represents numeric data for counts,
    /// measurements, ages, durations, and other quantifiable values that don't
    /// require decimal precision.
    ///
    /// ## Purpose
    ///
    /// - Store whole number quantities and measurements
    /// - Represent counts, ages, and duration values
    /// - Support numeric calculations and comparisons
    /// - Provide precise integer-based data capture
    /// - Enable mathematical operations in clinical contexts
    ///
    /// ## Usage
    ///
    /// The `valueInteger` property is used in extensions, parameters, and data
    /// elements where whole number values are required, such as age in years,
    /// count of items, or sequence numbers.
    ///
    /// ## Data Type
    ///
    /// **integer** - A signed 32-bit integer (range: -2,147,483,648 to
    /// 2,147,483,647)
    ///
    /// ## Constraints
    ///
    /// - Must be within the 32-bit signed integer range
    /// - Cannot contain decimal points or fractional parts
    /// - Negative values are permitted
    /// - Must be a valid integer representation
    /// - Leading zeros are typically not significant
    ///
    /// ## Examples
    ///
    /// ### Extension with Age Value
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/age-at-diagnosis",
    ///       "valueInteger": 45
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with Count Value
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "itemCount",
    ///       "valueInteger": 12
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valuePositiveInt` - Positive integers only
    /// - `valueUnsignedInt` - Unsigned integers
    /// - `valueInteger64` - 64-bit integers
    /// - `valueDecimal` - Decimal numbers
    /// - `value` - Generic value field
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types:
    /// [integer](http://hl7.org/fhir/R5/datatypes.html#integer)
    ///
    pub value_integer: Option<i32>,

    /// # valueInteger64
    ///
    /// ## Description
    ///
    /// The `valueInteger64` property contains whole number values within the
    /// 64-bit signed integer range. It represents large numeric values that
    /// exceed the 32-bit integer range, supporting high-precision counts,
    /// timestamps, and large-scale measurements.
    ///
    /// ## Purpose
    ///
    /// - Store large whole number quantities beyond 32-bit range
    /// - Represent high-precision timestamps and counters
    /// - Support large-scale measurements and calculations
    /// - Enable storage of very large identifiers or sequence numbers
    /// - Provide extended range for clinical and research data
    ///
    /// ## Usage
    ///
    /// The `valueInteger64` property is used in extensions, parameters, and
    /// data elements where 64-bit integer precision is required, such as
    /// microsecond timestamps, large patient identifiers, or high-volume
    /// counters.
    ///
    /// ## Data Type
    ///
    /// **integer64** - A signed 64-bit integer (range:
    /// -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807)
    ///
    /// ## Constraints
    ///
    /// - Must be within the 64-bit signed integer range
    /// - Cannot contain decimal points or fractional parts
    /// - Negative values are permitted
    /// - Must be a valid integer representation
    /// - Should be used only when 32-bit integers are insufficient
    ///
    /// ## Examples
    ///
    /// ### Extension with Large Identifier
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/system-generated-id",
    ///       "valueInteger64": "9876543210123456789"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with High-Precision Timestamp
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "microsecondTimestamp",
    ///       "valueInteger64": "1705320645123456"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueInteger` - 32-bit integers
    /// - `valuePositiveInt` - Positive integers only
    /// - `valueUnsignedInt` - Unsigned integers
    /// - `valueDecimal` - Decimal numbers
    /// - `value` - Generic value field
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types:
    /// [integer64](http://hl7.org/fhir/R5/datatypes.html#integer64)
    ///
    pub value_integer_64: Option<String>,

    /// # valueMarkdown
    ///
    /// ## Description
    ///
    /// The `valueMarkdown` property contains text formatted using Markdown
    /// syntax. It supports rich text formatting including headers, lists,
    /// links, emphasis, and other Markdown elements while maintaining
    /// machine-readable structure.
    ///
    /// ## Purpose
    ///
    /// - Store formatted documentation and narrative text
    /// - Provide rich text capabilities for clinical notes
    /// - Support structured documentation with formatting
    /// - Enable consistent text presentation across systems
    /// - Maintain both human-readable and machine-processable content
    ///
    /// ## Usage
    ///
    /// The `valueMarkdown` property is used in extensions, parameters, and data
    /// elements where formatted text content is needed, such as clinical
    /// guidelines, patient instructions, or detailed descriptions.
    ///
    /// ## Data Type
    ///
    /// **markdown** - A string containing Markdown-formatted text
    ///
    /// ## Constraints
    ///
    /// - Must contain valid Markdown syntax
    /// - Should be properly escaped for JSON representation
    /// - Line breaks should use appropriate Markdown formatting
    /// - Embedded HTML should be minimal and safe
    /// - Should render consistently across different viewers
    ///
    /// ## Examples
    ///
    /// ### Extension with Clinical Instructions
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/patient-instructions",
    ///       "valueMarkdown": "## Post-Procedure Care\n\n**Immediately after procedure:**\n- Rest for 24 hours\n- Take prescribed medication every 6 hours\n\n**Follow-up:**\n- Schedule appointment in 2 weeks\n- Call if symptoms worsen\n\n*For emergencies, call 911 immediately.*"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with Formatted Description
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "procedureDescription",
    ///       "valueMarkdown": "### Cardiac Catheterization\n\nA **minimally invasive** procedure involving:\n\n1. Local anesthesia\n2. Catheter insertion\n3. Contrast dye injection\n4. Real-time imaging\n\nExpected duration: *45-90 minutes*"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueString` - Plain text values
    /// - `text` - Narrative content
    /// - `div` - HTML-formatted content
    /// - `documentation` - Technical documentation
    /// - `description` - Simple descriptions
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types:
    /// [markdown](http://hl7.org/fhir/R5/datatypes.html#markdown)
    ///
    pub value_markdown: Option<String>,

    /// # valuePeriod
    ///
    /// ## Description
    ///
    /// The `valuePeriod` property contains a time period defined by start and
    /// end date/time values. It represents duration-based data such as
    /// treatment periods, enrollment spans, validity ranges, or any
    /// time-bounded clinical events.
    ///
    /// ## Purpose
    ///
    /// - Define time ranges for clinical events and treatments
    /// - Specify validity periods for data and authorizations
    /// - Represent duration-based measurements and observations
    /// - Support temporal queries and filtering
    /// - Enable time-based business rule evaluation
    ///
    /// ## Usage
    ///
    /// The `valuePeriod` property is used in extensions, parameters, and data
    /// elements where time ranges need to be specified, such as treatment
    /// periods, coverage spans, or observation intervals.
    ///
    /// ## Data Type
    ///
    /// **Period** - A complex type containing:
    ///
    /// - `start` - Start date/time
    /// - `end` - End date/time
    ///
    /// ## Constraints
    ///
    /// - Start must be before or equal to end if both are present
    /// - At least one of start or end should be present
    /// - Date/time values must be valid ISO 8601 format
    /// - Open-ended periods can omit start or end
    /// - Should include time zones for precision
    ///
    /// ## Examples
    ///
    /// ### Extension with Treatment Period
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/treatment-period",
    ///       "valuePeriod": {
    ///         "start": "2024-01-15T09:00:00Z",
    ///         "end": "2024-03-15T17:00:00Z"
    ///       }
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with Coverage Period
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "coveragePeriod",
    ///       "valuePeriod": {
    ///         "start": "2024-01-01T00:00:00Z",
    ///         "end": "2024-12-31T23:59:59Z"
    ///       }
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueDateTime` - Single date/time values
    /// - `effectivePeriod` - Effective time ranges
    /// - `start` - Period start times
    /// - `end` - Period end times
    /// - `period` - Direct period objects
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types:
    /// [Period](http://hl7.org/fhir/R5/datatypes.html#Period)
    ///
    pub value_period: Option<Period>,

    /// # valuePositiveInt
    ///
    /// ## Description
    ///
    /// The `valuePositiveInt` property contains positive integer values
    /// starting from 1. It represents counts, quantities, and measurements
    /// where zero and negative values are not meaningful or allowed.
    ///
    /// ## Purpose
    ///
    /// - Store counts that must be greater than zero
    /// - Represent quantities where positive values are required
    /// - Ensure data validity for naturally positive measurements
    /// - Support constraints on numeric data entry
    /// - Enable validation of meaningful positive quantities
    ///
    /// ## Usage
    ///
    /// The `valuePositiveInt` property is used in extensions, parameters, and
    /// data elements where only positive integer values make sense, such as
    /// dosage counts, repetition numbers, or sequence positions.
    ///
    /// ## Data Type
    ///
    /// **positiveInt** - An integer greater than 0 (range: 1 to 2,147,483,647)
    ///
    /// ## Constraints
    ///
    /// - Must be greater than 0 (minimum value is 1)
    /// - Cannot be zero or negative
    /// - Must be within 32-bit signed integer positive range
    /// - Should be used when zero values are not meaningful
    /// - Validates that meaningful positive quantities are provided
    ///
    /// ## Examples
    ///
    /// ### Extension with Dosage Count
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/daily-dose-count",
    ///       "valuePositiveInt": 3
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with Repetition Count
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "exerciseRepetitions",
    ///       "valuePositiveInt": 15
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueInteger` - All integers including negative and zero
    /// - `valueUnsignedInt` - Non-negative integers (including zero)
    /// - `valueInteger64` - 64-bit integers
    /// - `count` - Count values
    /// - `value` - Generic value field
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types:
    /// [positiveInt](http://hl7.org/fhir/R5/datatypes.html#positiveInt)
    ///
    pub value_positive_int: Option<i64>,

    /// TODO
    ///
    /// Example: "1" to "9223372036854775807"
    ///
    pub value_positive_int_64: Option<String>,

    /// # valueString
    ///
    /// ## Description
    ///
    /// The `valueString` property contains string values in FHIR resources. It
    /// represents textual data, free-text content, or coded string values that
    /// don't require complex structure.
    ///
    /// ## Purpose
    ///
    /// - Store textual data and free-form content
    /// - Represent simple string-based values
    /// - Support human-readable text content
    /// - Enable flexible text-based data capture
    /// - Provide string values for extensions and parameters
    ///
    /// ## Usage
    ///
    /// The `valueString` property is used extensively throughout FHIR resources
    /// for storing text values, particularly in extensions, parameters, and
    /// simple data elements.
    ///
    /// ## Data Type
    ///
    /// **string** - A sequence of Unicode characters
    ///
    /// ## Constraints
    ///
    /// - Must be valid Unicode text
    /// - Length limitations may apply based on context
    /// - Should not contain control characters unless specifically allowed
    /// - May have format constraints depending on usage context
    ///
    /// ## Examples
    ///
    /// ### Extension with String Value
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/patient-note",
    ///       "valueString": "Patient prefers morning appointments"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter String Value
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "display",
    ///       "valueString": "Blood Pressure Reading"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueCode` - Coded string values
    /// - `valueMarkdown` - Markdown formatted text
    /// - `valueUri` - URI string values
    /// - `text` - Narrative text content
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types:
    /// [string](http://hl7.org/fhir/R5/datatypes.html#string)
    ///
    pub value_string: Option<String>,

    /// # valueUnsignedInt
    ///
    /// ## Description
    ///
    /// The `valueUnsignedInt` property contains non-negative integer values
    /// starting from 0. It represents counts, indices, and measurements where
    /// negative values are not meaningful but zero is acceptable.
    ///
    /// ## Purpose
    ///
    /// - Store counts that can be zero or positive
    /// - Represent array indices and position values
    /// - Support measurements where zero is meaningful
    /// - Enable validation of non-negative quantities
    /// - Provide precise non-negative integer constraints
    ///
    /// ## Usage
    ///
    /// The `valueUnsignedInt` property is used in extensions, parameters, and
    /// data elements where non-negative integers are required, such as array
    /// positions, occurrence counts, or measurements that can be zero.
    ///
    /// ## Data Type
    ///
    /// **unsignedInt** - A non-negative integer (range: 0 to 2,147,483,647)
    ///
    /// ## Constraints
    ///
    /// - Must be greater than or equal to 0
    /// - Cannot be negative
    /// - Must be within 32-bit unsigned integer range
    /// - Should be used when zero values are meaningful
    /// - Validates that non-negative quantities are provided
    ///
    /// ## Examples
    ///
    /// ### Extension with Array Index
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/sequence-position",
    ///       "valueUnsignedInt": 0
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with Count Value
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "errorCount",
    ///       "valueUnsignedInt": 3
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valuePositiveInt` - Positive integers only (minimum 1)
    /// - `valueInteger` - All integers including negative
    /// - `valueInteger64` - 64-bit integers
    /// - `count` - Count values
    /// - `value` - Generic value field
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types:
    /// [unsignedInt](http://hl7.org/fhir/R5/datatypes.html#unsignedInt)
    ///
    pub value_unsigned_int: Option<i64>,

    /// TODO
    ///
    /// Example: "0" to "18446744073709551615"
    ///
    pub value_unsigned_int_64: Option<String>,

    /// # valueUri
    ///
    /// ## Description
    ///
    /// The `valueUri` property contains Uniform Resource Identifier (URI)
    /// values that can reference external resources, namespaces, or
    /// identifiers. It supports both absolute and relative URIs following RFC
    /// 3986 standards.
    ///
    /// ## Purpose
    ///
    /// - Reference external resources and services
    /// - Identify namespaces and vocabularies
    /// - Provide links to documentation and specifications
    /// - Enable resource identification and resolution
    /// - Support distributed system integration
    ///
    /// ## Usage
    ///
    /// The `valueUri` property is used in extensions, parameters, and data
    /// elements where URI references are needed, such as namespace identifiers,
    /// external resource links, or system identifiers.
    ///
    /// ## Data Type
    ///
    /// **uri** - A Uniform Resource Identifier (RFC 3986)
    ///
    /// ## Constraints
    ///
    /// - Must be a valid URI according to RFC 3986
    /// - Can be absolute or relative
    /// - Should be properly encoded for special characters
    /// - Length should be reasonable for practical use
    /// - Should be resolvable when referencing external resources
    ///
    /// ## Examples
    ///
    /// ### Extension with Namespace URI
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/namespace-reference",
    ///       "valueUri": "http://example.org/fhir/namespace/clinical-data"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with Documentation Link
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "documentationUrl",
    ///       "valueUri": "https://example.org/docs/api-guide#section-3"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueUrl` - URLs specifically
    /// - `valueCanonical` - Canonical resource references
    /// - `uri` - Direct URI fields
    /// - `url` - URL fields
    /// - `system` - System identifiers
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types: [uri](http://hl7.org/fhir/R5/datatypes.html#uri)
    ///
    pub value_uri: Option<String>,

    /// # valueUrl
    ///
    /// ## Description
    ///
    /// The `valueUrl` property contains Uniform Resource Locator (URL) values
    /// that specify the location of web-accessible resources. It represents
    /// addresses for web services, documents, images, or other
    /// network-accessible content.
    ///
    /// ## Purpose
    ///
    /// - Reference web-accessible resources and services
    /// - Provide links to external documents and media
    /// - Enable access to remote endpoints and APIs
    /// - Support hyperlink functionality in FHIR resources
    /// - Facilitate integration with web-based systems
    ///
    /// ## Usage
    ///
    /// The `valueUrl` property is used in extensions, parameters, and data
    /// elements where web URLs are needed, such as links to external documents,
    /// web service endpoints, or multimedia content.
    ///
    /// ## Data Type
    ///
    /// **url** - A Uniform Resource Locator (absolute URL)
    ///
    /// ## Constraints
    ///
    /// - Must be an absolute URL (includes scheme and authority)
    /// - Should be accessible over standard web protocols (HTTP/HTTPS)
    /// - Must be properly encoded for special characters
    /// - Should be a valid, well-formed URL
    /// - Should resolve to accessible content when dereferenced
    ///
    /// ## Examples
    ///
    /// ### Extension with Document URL
    ///
    /// ```json
    /// {
    ///   "extension": [
    ///     {
    ///       "url": "http://example.org/fhir/StructureDefinition/patient-photo",
    ///       "valueUrl": "https://example.org/patient-photos/12345.jpg"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ### Parameter with API Endpoint
    ///
    /// ```json
    /// {
    ///   "parameter": [
    ///     {
    ///       "name": "callbackUrl",
    ///       "valueUrl": "https://client-system.example.org/fhir/callback"
    ///     }
    ///   ]
    /// }
    /// ```
    ///
    /// ## Related Keys
    ///
    /// - `valueUri` - General URI references
    /// - `valueCanonical` - Canonical resource references
    /// - `url` - Direct URL fields
    /// - `fullUrl` - Complete resource URLs
    /// - `endpoint` - Service endpoints
    ///
    /// ## Specification Reference
    ///
    /// FHIR R5 Data Types: [url](http://hl7.org/fhir/R5/datatypes.html#url)
    ///
    pub value_url: Option<String>,
}

#[cfg(test)]
mod tests {
    use super::*;
    type T = Example;

    #[test]
    fn test_serde_json_from_reader() {
        let path = crate::r5::parse::all::DIR
            .join("example")
            .join("example.json");
        let file = std::fs::File::open(path).expect("open");
        let reader = std::io::BufReader::new(file);
        let actual: T = ::serde_json::from_reader(reader).unwrap();
        assert_eq!(actual.label, "my label");
    }
}