diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/resource/Resource.java b/fhir-model/src/main/java/com/ibm/fhir/model/resource/Resource.java index 4b32b3e4076..ddf8d1b2c3c 100644 --- a/fhir-model/src/main/java/com/ibm/fhir/model/resource/Resource.java +++ b/fhir-model/src/main/java/com/ibm/fhir/model/resource/Resource.java @@ -93,6 +93,10 @@ public boolean is(Class resourceType) { return resourceType.isInstance(this); } + /** + * @throws ClassCastException + * when this resources cannot be cast to the requested resourceType + */ public T as(Class resourceType) { return resourceType.cast(this); } diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/Element.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/Element.java index ae4a7edd121..46476948b6a 100644 --- a/fhir-model/src/main/java/com/ibm/fhir/model/type/Element.java +++ b/fhir-model/src/main/java/com/ibm/fhir/model/type/Element.java @@ -68,6 +68,10 @@ public boolean is(Class elementType) { return elementType.isInstance(this); } + /** + * @throws ClassCastException + * when this element cannot be cast to the requested elementType + */ public T as(Class elementType) { return elementType.cast(this); } diff --git a/fhir-openapi/src/main/webapp/META-INF/openapi.json b/fhir-openapi/src/main/webapp/META-INF/openapi.json index d4b336fd5a3..d22ccf43ac1 100644 --- a/fhir-openapi/src/main/webapp/META-INF/openapi.json +++ b/fhir-openapi/src/main/webapp/META-INF/openapi.json @@ -3,7 +3,7 @@ "openapi": "3.0.0", "info": { "title": "Simplified FHIR API", - "description": "A simplified version of the FHIR API", + "description": "A simplified version of the HL7 FHIR API", "version": "4.0.0" }, "servers": [ @@ -611,9 +611,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -1002,9 +999,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -1303,9 +1297,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -1640,9 +1631,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -1986,9 +1974,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -2242,9 +2227,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -2597,9 +2579,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -2844,9 +2823,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -3245,9 +3221,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -3645,9 +3618,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -3985,7 +3955,7 @@ }, { "name": "status", - "description": "draft | active | suspended | completed | entered-in-error | cancelled | unknown", + "description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown", "in": "query", "required": false, "schema": { @@ -4018,9 +3988,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -4283,9 +4250,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -4801,9 +4765,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -5129,9 +5090,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -5475,9 +5433,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -5767,9 +5722,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -6035,7 +5987,7 @@ }, { "name": "status", - "description": "draft | completed | entered-in-error", + "description": "in-progress | completed | entered-in-error", "in": "query", "required": false, "schema": { @@ -6077,9 +6029,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -6450,9 +6399,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -6745,7 +6691,7 @@ }, { "name": "status", - "description": "preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error", + "description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown", "in": "query", "required": false, "schema": { @@ -6778,9 +6724,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -7037,7 +6980,7 @@ }, { "name": "priority", - "description": "Message urgency", + "description": "routine | urgent | asap | stat", "in": "query", "required": false, "schema": { @@ -7082,7 +7025,7 @@ }, { "name": "status", - "description": "draft | active | suspended | cancelled | completed | entered-in-error | unknown", + "description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown", "in": "query", "required": false, "schema": { @@ -7115,9 +7058,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -7434,9 +7374,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -7789,9 +7726,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -8216,9 +8150,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -8598,9 +8529,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -8926,9 +8854,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -9209,9 +9134,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -9501,9 +9423,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -9757,9 +9676,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -10031,9 +9947,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -10278,9 +10191,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -10579,9 +10489,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -10799,9 +10706,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -11037,9 +10941,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -11392,9 +11293,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -11621,9 +11519,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -11958,9 +11853,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -12268,9 +12160,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -12686,9 +12575,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -13023,9 +12909,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -13423,9 +13306,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -13670,9 +13550,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -13899,9 +13776,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -14119,9 +13993,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -14393,9 +14264,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -14784,9 +14652,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -15175,9 +15040,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -15566,9 +15428,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -15876,9 +15735,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -16222,9 +16078,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -16496,9 +16349,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -16743,9 +16593,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -17008,9 +16855,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -17327,9 +17171,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -17610,9 +17451,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -17839,9 +17677,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -18140,9 +17975,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -18486,9 +18318,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -18823,9 +18652,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -19079,9 +18905,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -19344,9 +19167,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -19699,9 +19519,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -20018,9 +19835,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -20328,9 +20142,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -20737,9 +20548,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -20957,9 +20765,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -21258,9 +21063,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -21586,9 +21388,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -21977,9 +21776,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -22251,9 +22047,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -22510,7 +22303,7 @@ }, { "name": "status", - "description": "preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown", + "description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown", "in": "query", "required": false, "schema": { @@ -22561,9 +22354,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -22835,9 +22625,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -23145,9 +22932,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -23473,9 +23257,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -23783,9 +23564,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -24120,9 +23898,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -24412,9 +24187,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -24632,9 +24404,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -24870,9 +24639,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -25072,9 +24838,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -25274,9 +25037,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -25648,9 +25408,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -26031,9 +25788,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -26251,9 +26005,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -26453,9 +26204,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -26817,9 +26565,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -27136,9 +26881,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -27446,9 +27188,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -27810,9 +27549,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -28111,9 +27847,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -28646,9 +28379,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -29209,9 +28939,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -29691,9 +29418,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -30010,9 +29734,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -30410,9 +30131,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -30666,9 +30384,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -30931,9 +30646,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -31295,9 +31007,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -31704,9 +31413,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -32050,9 +31756,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -32360,9 +32063,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -32664,7 +32364,7 @@ }, { "name": "status", - "description": "preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown", + "description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown", "in": "query", "required": false, "schema": { @@ -32697,9 +32397,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -32980,9 +32677,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -33344,9 +33038,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -33636,9 +33327,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -33982,9 +33670,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -34301,9 +33986,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -34692,9 +34374,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -35083,9 +34762,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -35393,9 +35069,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -35640,9 +35313,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -35923,9 +35593,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -36260,9 +35927,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -36516,9 +36180,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -36880,9 +36541,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -37148,7 +36806,7 @@ }, { "name": "intent", - "description": "proposal | plan | order +", + "description": "proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option", "in": "query", "required": false, "schema": { @@ -37229,7 +36887,7 @@ }, { "name": "status", - "description": "draft | active | suspended | completed | entered-in-error | cancelled", + "description": "draft | active | on-hold | revoked | completed | entered-in-error | unknown", "in": "query", "required": false, "schema": { @@ -37262,9 +36920,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -37527,9 +37182,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -37828,9 +37480,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -38048,9 +37697,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -38475,9 +38121,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -38803,9 +38446,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -39050,9 +38690,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -39315,9 +38952,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -40353,7 +39987,7 @@ "parameters": [ { "name": "code", - "description": "Codes associated with the substance", + "description": "The specific code", "in": "query", "required": false, "schema": { @@ -40377,9 +40011,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -40615,9 +40246,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -40871,9 +40499,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -41235,9 +40860,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -41554,9 +41176,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -41801,9 +41420,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -42138,9 +41754,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -42493,9 +42106,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -42695,9 +42305,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -42942,9 +42549,6 @@ }, { "$ref": "#/components/parameters/_tagParam" - }, - { - "$ref": "#/components/parameters/_textParam" } ], "responses": { @@ -43203,15 +42807,6 @@ "schema": { "type": "string" } - }, - "_textParam": { - "name": "_text", - "description": "Search on the narrative of the resource", - "in": "query", - "required": false, - "schema": { - "type": "string" - } } }, "requestBodies": { @@ -44725,9 +44320,27 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "Account", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, - "Account_Coverage": { + "Account_Guarantor": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -44735,23 +44348,26 @@ { "type": "object", "properties": { - "coverage": { + "party": { "$ref": "#/components/schemas/Reference", - "description": "The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay).\n\nA coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing." + "description": "The entity who is responsible." }, - "priority": { - "type": "integer", - "format": "int32", - "description": "The priority of the coverage in the context of this account." + "onHold": { + "type": "boolean", + "description": "A guarantor may be placed on credit hold or otherwise have their role temporarily suspended." + }, + "period": { + "$ref": "#/components/schemas/Period", + "description": "The timeframe during which the guarantor accepts responsibility for the account." } } } ], "required": [ - "coverage" + "party" ] }, - "Account_Guarantor": { + "Account_Coverage": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -44759,23 +44375,20 @@ { "type": "object", "properties": { - "party": { + "coverage": { "$ref": "#/components/schemas/Reference", - "description": "The entity who is responsible." - }, - "onHold": { - "type": "boolean", - "description": "A guarantor may be placed on credit hold or otherwise have their role temporarily suspended." + "description": "The party(s) that contribute to payment (or part of) of the charges applied to this account (including self-pay).\n\nA coverage may only be responsible for specific types of charges, and the sequence of the coverages in the account could be important when processing billing." }, - "period": { - "$ref": "#/components/schemas/Period", - "description": "The timeframe during which the guarantor accepts responsibility for the account." + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the coverage in the context of this account." } } } ], "required": [ - "party" + "coverage" ] }, "ActivityDefinition": { @@ -45114,7 +44727,25 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "ActivityDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "ActivityDefinition_DynamicValue": { "allOf": [ @@ -45292,7 +44923,33 @@ "required": [ "actuality", "subject" - ] + ], + "example": { + "resourceType": "AdverseEvent", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_actuality": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "AdverseEvent_SuspectEntity": { "allOf": [ @@ -45473,7 +45130,33 @@ ], "required": [ "patient" - ] + ], + "example": { + "resourceType": "AllergyIntolerance", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "clinicalStatus": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "AllergyIntolerance_Reaction": { "allOf": [ @@ -45686,7 +45369,37 @@ "required": [ "status", "participant" - ] + ], + "example": { + "resourceType": "Appointment", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "participant": [ + { + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } }, "Appointment_Participant": { "allOf": [ @@ -45798,7 +45511,33 @@ "required": [ "appointment", "participantStatus" - ] + ], + "example": { + "resourceType": "AppointmentResponse", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "appointment": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_participantStatus": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "AuditEvent": { "allOf": [ @@ -45887,106 +45626,55 @@ "recorded", "agent", "source" - ] - }, - "AuditEvent_Agent": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "AuditEvent", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Specification of the participation type the user plays when performing the event." - }, - "role": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context." - } - }, - "who": { - "$ref": "#/components/schemas/Reference", - "description": "Reference to who this agent is that was involved in the event." - }, - "altId": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available." - }, - "name": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Human-meaningful name for the agent." - }, - "requestor": { - "type": "boolean", - "description": "Indicator that the user is or is not the requestor, or initiator, for the event being audited." - }, - "location": { - "$ref": "#/components/schemas/Reference", - "description": "Where the event occurred." - }, - "policy": { - "type": "array", - "items": { - "type": "string", - "pattern": "\\S*", - "description": "The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used." - } - }, - "media": { - "$ref": "#/components/schemas/Coding", - "description": "Type of media involved. Used when the event is about exporting/importing onto media." - }, - "network": { - "$ref": "#/components/schemas/AuditEvent_Agent_Network", - "description": "Logical network location for application activity, if the activity has a network location." - }, - "purposeOfUse": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The reason (purpose of use), specific to this agent, that was used during the event being recorded." - } + "type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - } - } - ], - "required": [ - "requestor" - ] - }, - "AuditEvent_Agent_Network": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ] }, - { - "type": "object", - "properties": { - "address": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "An identifier for the network access point of the user device for the audit event." - }, - "type": { - "type": "string", - "enum": [ - "1", - "2", - "3", - "4", - "5" - ], - "description": "An identifier for the type of network access point that originated the audit event." + "_recorded": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } + ] + }, + "agent": [ + { + "_requestor": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ], + "source": { + "observer": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } } - ] + } }, "AuditEvent_Entity": { "allOf": [ @@ -46106,6 +45794,105 @@ "observer" ] }, + "AuditEvent_Agent": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Specification of the participation type the user plays when performing the event." + }, + "role": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context." + } + }, + "who": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to who this agent is that was involved in the event." + }, + "altId": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available." + }, + "name": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Human-meaningful name for the agent." + }, + "requestor": { + "type": "boolean", + "description": "Indicator that the user is or is not the requestor, or initiator, for the event being audited." + }, + "location": { + "$ref": "#/components/schemas/Reference", + "description": "Where the event occurred." + }, + "policy": { + "type": "array", + "items": { + "type": "string", + "pattern": "\\S*", + "description": "The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used." + } + }, + "media": { + "$ref": "#/components/schemas/Coding", + "description": "Type of media involved. Used when the event is about exporting/importing onto media." + }, + "network": { + "$ref": "#/components/schemas/AuditEvent_Agent_Network", + "description": "Logical network location for application activity, if the activity has a network location." + }, + "purposeOfUse": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The reason (purpose of use), specific to this agent, that was used during the event being recorded." + } + } + } + } + ], + "required": [ + "requestor" + ] + }, + "AuditEvent_Agent_Network": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "address": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "An identifier for the network access point of the user device for the audit event." + }, + "type": { + "type": "string", + "enum": [ + "1", + "2", + "3", + "4", + "5" + ], + "description": "An identifier for the type of network access point that originated the audit event." + } + } + } + ] + }, "Basic": { "allOf": [ { @@ -46143,7 +45930,25 @@ ], "required": [ "code" - ] + ], + "example": { + "resourceType": "Basic", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "code": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "BiologicallyDerivedProduct": { "allOf": [ @@ -46226,9 +46031,19 @@ } } } - ] + ], + "example": { + "resourceType": "BiologicallyDerivedProduct", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, - "BiologicallyDerivedProduct_Collection": { + "BiologicallyDerivedProduct_Storage": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -46236,22 +46051,27 @@ { "type": "object", "properties": { - "collector": { - "$ref": "#/components/schemas/Reference", - "description": "Healthcare professional who is performing the collection." + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Description of storage." }, - "source": { - "$ref": "#/components/schemas/Reference", - "description": "The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product." + "temperature": { + "type": "number", + "description": "Storage temperature." }, - "collectedDateTime": { + "scale": { "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "Time of product collection." + "enum": [ + "farenheit", + "celsius", + "kelvin" + ], + "description": "Temperature scale used." }, - "collectedPeriod": { + "duration": { "$ref": "#/components/schemas/Period", - "description": "Time of product collection." + "description": "Storage timeperiod." } } } @@ -46317,7 +46137,7 @@ } ] }, - "BiologicallyDerivedProduct_Storage": { + "BiologicallyDerivedProduct_Collection": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -46325,27 +46145,22 @@ { "type": "object", "properties": { - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Description of storage." + "collector": { + "$ref": "#/components/schemas/Reference", + "description": "Healthcare professional who is performing the collection." }, - "temperature": { - "type": "number", - "description": "Storage temperature." + "source": { + "$ref": "#/components/schemas/Reference", + "description": "The patient or entity, such as a hospital or vendor in the case of a processed/manipulated/manufactured product, providing the product." }, - "scale": { + "collectedDateTime": { "type": "string", - "enum": [ - "farenheit", - "celsius", - "kelvin" - ], - "description": "Temperature scale used." + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", + "description": "Time of product collection." }, - "duration": { + "collectedPeriod": { "$ref": "#/components/schemas/Period", - "description": "Storage timeperiod." + "description": "Time of product collection." } } } @@ -46406,7 +46221,25 @@ ], "required": [ "patient" - ] + ], + "example": { + "resourceType": "BodyStructure", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "CapabilityStatement": { "allOf": [ @@ -46552,7 +46385,8 @@ "3.0.1", "3.3.0", "3.5.0", - "4.0.0" + "4.0.0", + "4.0.1" ], "description": "The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value." }, @@ -46610,7 +46444,62 @@ "kind", "fhirVersion", "format" - ] + ], + "example": { + "resourceType": "CapabilityStatement", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_date": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_kind": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_fhirVersion": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "format": [ + null + ], + "_format": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + ] + } }, "CapabilityStatement_Document": { "allOf": [ @@ -46646,35 +46535,6 @@ "profile" ] }, - "CapabilityStatement_Implementation": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Information about the specific installation that this capability statement relates to." - }, - "url": { - "type": "string", - "pattern": "\\S*", - "description": "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces." - }, - "custodian": { - "$ref": "#/components/schemas/Reference", - "description": "The organization responsible for the management of the instance and oversight of the data on the server at the specified URL." - } - } - } - ], - "required": [ - "description" - ] - }, "CapabilityStatement_Messaging": { "allOf": [ { @@ -46711,7 +46571,7 @@ } ] }, - "CapabilityStatement_Messaging_Endpoint": { + "CapabilityStatement_Messaging_SupportedMessage": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -46719,24 +46579,28 @@ { "type": "object", "properties": { - "protocol": { - "$ref": "#/components/schemas/Coding", - "description": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint." + "mode": { + "type": "string", + "enum": [ + "sender", + "receiver" + ], + "description": "The mode of this event declaration - whether application is sender or receiver." }, - "address": { + "definition": { "type": "string", "pattern": "\\S*", - "description": "The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier." + "description": "Points to a message definition that identifies the messaging event, message structure, allowed responses, etc." } } } ], "required": [ - "protocol", - "address" + "mode", + "definition" ] }, - "CapabilityStatement_Messaging_SupportedMessage": { + "CapabilityStatement_Messaging_Endpoint": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -46744,25 +46608,21 @@ { "type": "object", "properties": { - "mode": { - "type": "string", - "enum": [ - "sender", - "receiver" - ], - "description": "The mode of this event declaration - whether application is sender or receiver." + "protocol": { + "$ref": "#/components/schemas/Coding", + "description": "A list of the messaging transport protocol(s) identifiers, supported by this endpoint." }, - "definition": { + "address": { "type": "string", "pattern": "\\S*", - "description": "Points to a message definition that identifies the messaging event, message structure, allowed responses, etc." + "description": "The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier." } } } ], "required": [ - "mode", - "definition" + "protocol", + "address" ] }, "CapabilityStatement_Rest": { @@ -47145,41 +47005,6 @@ "type" ] }, - "CapabilityStatement_Rest_Resource_Interaction": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "enum": [ - "read", - "vread", - "update", - "patch", - "delete", - "history-instance", - "history-type", - "create", - "search-type" - ], - "description": "Coded identifier of the operation, supported by the system resource." - }, - "documentation": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'." - } - } - } - ], - "required": [ - "code" - ] - }, "CapabilityStatement_Rest_Resource_Operation": { "allOf": [ { @@ -47257,6 +47082,41 @@ "type" ] }, + "CapabilityStatement_Rest_Resource_Interaction": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "enum": [ + "read", + "vread", + "update", + "patch", + "delete", + "history-instance", + "history-type", + "create", + "search-type" + ], + "description": "Coded identifier of the operation, supported by the system resource." + }, + "documentation": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'." + } + } + } + ], + "required": [ + "code" + ] + }, "CapabilityStatement_Rest_Security": { "allOf": [ { @@ -47285,6 +47145,35 @@ } ] }, + "CapabilityStatement_Implementation": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Information about the specific installation that this capability statement relates to." + }, + "url": { + "type": "string", + "pattern": "\\S*", + "description": "An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces." + }, + "custodian": { + "$ref": "#/components/schemas/Reference", + "description": "The organization responsible for the management of the instance and oversight of the data on the server at the specified URL." + } + } + } + ], + "required": [ + "description" + ] + }, "CapabilityStatement_Software": { "allOf": [ { @@ -47484,7 +47373,41 @@ "status", "intent", "subject" - ] + ], + "example": { + "resourceType": "CarePlan", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_intent": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "CarePlan_Activity": { "allOf": [ @@ -47759,7 +47682,17 @@ } } } - ] + ], + "example": { + "resourceType": "CareTeam", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "CareTeam_Participant": { "allOf": [ @@ -47884,7 +47817,33 @@ "required": [ "orderable", "referencedItem" - ] + ], + "example": { + "resourceType": "CatalogEntry", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_orderable": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "referencedItem": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "CatalogEntry_RelatedEntry": { "allOf": [ @@ -48092,7 +48051,41 @@ "status", "code", "subject" - ] + ], + "example": { + "resourceType": "ChargeItem", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "code": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "ChargeItem_Performer": { "allOf": [ @@ -48271,34 +48264,33 @@ "required": [ "url", "status" - ] - }, - "ChargeItemDefinition_Applicability": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "ChargeItemDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A brief, natural language description of the condition that effectively communicates the intended semantics." - }, - "language": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The media type of the language for the expression, e.g. \"text/cql\" for Clinical Query Language expressions or \"text/fhirpath\" for FHIRPath expressions." - }, - "expression": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied." + "_url": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } - ] + } }, "ChargeItemDefinition_PropertyGroup": { "allOf": [ @@ -48365,6 +48357,33 @@ "type" ] }, + "ChargeItemDefinition_Applicability": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A brief, natural language description of the condition that effectively communicates the intended semantics." + }, + "language": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The media type of the language for the expression, e.g. \"text/cql\" for Clinical Query Language expressions or \"text/fhirpath\" for FHIRPath expressions." + }, + "expression": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied." + } + } + } + ] + }, "Claim": { "allOf": [ { @@ -48529,170 +48548,101 @@ "provider", "priority", "insurance" - ] - }, - "Claim_Accident": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "Claim", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "date": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", - "description": "Date of an accident event related to the products and services contained in the claim." - }, - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers." - }, - "locationAddress": { - "$ref": "#/components/schemas/Address", - "description": "The physical location of the accident event." - }, - "locationReference": { - "$ref": "#/components/schemas/Reference", - "description": "The physical location of the accident event." + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - } - } - ], - "required": [ - "date" - ] - }, - "Claim_CareTeam": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ] }, - { - "type": "object", - "properties": { - "sequence": { - "type": "integer", - "format": "int32", - "description": "A number to uniquely identify care team entries." - }, - "provider": { - "$ref": "#/components/schemas/Reference", - "description": "Member of the team who provided the product or service." - }, - "responsible": { - "type": "boolean", - "description": "The party who is billing and/or responsible for the claimed products or services." - }, - "role": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team." - }, - "qualification": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The qualification of the practitioner which is applicable for this service." + "type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - } - } - ], - "required": [ - "sequence", - "provider" - ] - }, - "Claim_Diagnosis": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ] }, - { - "type": "object", - "properties": { - "sequence": { - "type": "integer", - "format": "int32", - "description": "A number to uniquely identify diagnosis entries." - }, - "diagnosisCodeableConcept": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition." - }, - "diagnosisReference": { - "$ref": "#/components/schemas/Reference", - "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition." - }, - "type": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "When the condition was observed or the relative ranking." - } - }, - "onAdmission": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Indication of whether the diagnosis was present on admission to a facility." - }, - "packageCode": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system." + "_use": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - } - } - ], - "required": [ - "sequence" - ] - }, - "Claim_Insurance": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ] }, - { - "type": "object", - "properties": { - "sequence": { - "type": "integer", - "format": "int32", - "description": "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order." - }, - "focal": { - "type": "boolean", - "description": "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true." - }, - "identifier": { - "$ref": "#/components/schemas/Identifier", - "description": "The business identifier to be used when the claim is sent for adjudication against this insurance policy." + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_created": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "provider": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "priority": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "insurance": [ + { + "_sequence": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_focal": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] }, "coverage": { - "$ref": "#/components/schemas/Reference", - "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system." - }, - "businessArrangement": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A business agreement number established between the provider and the insurer for special business processing purposes." - }, - "preAuthRef": { - "type": "array", - "items": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization." - } - }, - "claimResponse": { - "$ref": "#/components/schemas/Reference", - "description": "The result of the adjudication of the line items for the Coverage specified in this insurance." + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } } - } - ], - "required": [ - "sequence", - "focal", - "coverage" - ] + ] + } }, "Claim_Item": { "allOf": [ @@ -48989,7 +48939,7 @@ "productOrService" ] }, - "Claim_Payee": { + "Claim_Accident": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -48997,19 +48947,79 @@ { "type": "object", "properties": { + "date": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", + "description": "Date of an accident event related to the products and services contained in the claim." + }, "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Type of Party to be reimbursed: subscriber, provider, other." + "description": "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers." }, - "party": { + "locationAddress": { + "$ref": "#/components/schemas/Address", + "description": "The physical location of the accident event." + }, + "locationReference": { "$ref": "#/components/schemas/Reference", - "description": "Reference to the individual or organization to whom any payment will be made." + "description": "The physical location of the accident event." } } } ], "required": [ - "type" + "date" + ] + }, + "Claim_Insurance": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "sequence": { + "type": "integer", + "format": "int32", + "description": "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order." + }, + "focal": { + "type": "boolean", + "description": "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true." + }, + "identifier": { + "$ref": "#/components/schemas/Identifier", + "description": "The business identifier to be used when the claim is sent for adjudication against this insurance policy." + }, + "coverage": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system." + }, + "businessArrangement": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A business agreement number established between the provider and the insurer for special business processing purposes." + }, + "preAuthRef": { + "type": "array", + "items": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization." + } + }, + "claimResponse": { + "$ref": "#/components/schemas/Reference", + "description": "The result of the adjudication of the line items for the Coverage specified in this insurance." + } + } + } + ], + "required": [ + "sequence", + "focal", + "coverage" ] }, "Claim_Procedure": { @@ -49059,7 +49069,7 @@ "sequence" ] }, - "Claim_Related": { + "Claim_Diagnosis": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -49067,20 +49077,39 @@ { "type": "object", "properties": { - "claim": { + "sequence": { + "type": "integer", + "format": "int32", + "description": "A number to uniquely identify diagnosis entries." + }, + "diagnosisCodeableConcept": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition." + }, + "diagnosisReference": { "$ref": "#/components/schemas/Reference", - "description": "Reference to a related claim." + "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition." }, - "relationship": { + "type": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "When the condition was observed or the relative ranking." + } + }, + "onAdmission": { "$ref": "#/components/schemas/CodeableConcept", - "description": "A code to convey how the claims are related." + "description": "Indication of whether the diagnosis was present on admission to a facility." }, - "reference": { - "$ref": "#/components/schemas/Identifier", - "description": "An alternate organizational reference to the case or file to which this particular claim pertains." + "packageCode": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system." } } } + ], + "required": [ + "sequence" ] }, "Claim_SupportingInfo": { @@ -49146,6 +49175,90 @@ "category" ] }, + "Claim_CareTeam": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "sequence": { + "type": "integer", + "format": "int32", + "description": "A number to uniquely identify care team entries." + }, + "provider": { + "$ref": "#/components/schemas/Reference", + "description": "Member of the team who provided the product or service." + }, + "responsible": { + "type": "boolean", + "description": "The party who is billing and/or responsible for the claimed products or services." + }, + "role": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team." + }, + "qualification": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The qualification of the practitioner which is applicable for this service." + } + } + } + ], + "required": [ + "sequence", + "provider" + ] + }, + "Claim_Payee": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Type of Party to be reimbursed: subscriber, provider, other." + }, + "party": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to the individual or organization to whom any payment will be made." + } + } + } + ], + "required": [ + "type" + ] + }, + "Claim_Related": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "claim": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to a related claim." + }, + "relationship": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A code to convey how the claims are related." + }, + "reference": { + "$ref": "#/components/schemas/Identifier", + "description": "An alternate organizational reference to the case or file to which this particular claim pertains." + } + } + } + ] + }, "ClaimResponse": { "allOf": [ { @@ -49320,6 +49433,248 @@ "created", "insurer", "outcome" + ], + "example": { + "resourceType": "ClaimResponse", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_use": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_created": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "insurer": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_outcome": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + }, + "ClaimResponse_Error": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "itemSequence": { + "type": "integer", + "format": "int32", + "description": "The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure." + }, + "detailSequence": { + "type": "integer", + "format": "int32", + "description": "The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure." + }, + "subDetailSequence": { + "type": "integer", + "format": "int32", + "description": "The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure." + }, + "code": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "An error code, from a specified code system, which details why the claim could not be adjudicated." + } + } + } + ], + "required": [ + "code" + ] + }, + "ClaimResponse_Insurance": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "sequence": { + "type": "integer", + "format": "int32", + "description": "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order." + }, + "focal": { + "type": "boolean", + "description": "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true." + }, + "coverage": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system." + }, + "businessArrangement": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A business agreement number established between the provider and the insurer for special business processing purposes." + }, + "claimResponse": { + "$ref": "#/components/schemas/Reference", + "description": "The result of the adjudication of the line items for the Coverage specified in this insurance." + } + } + } + ], + "required": [ + "sequence", + "focal", + "coverage" + ] + }, + "ClaimResponse_ProcessNote": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "number": { + "type": "integer", + "format": "int32", + "description": "A number to uniquely identify a note entry." + }, + "type": { + "type": "string", + "enum": [ + "display", + "print", + "printoper" + ], + "description": "The business purpose of the note text." + }, + "text": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The explanation or description associated with the processing." + }, + "language": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A code to define the language used in the text of the note." + } + } + } + ], + "required": [ + "text" + ] + }, + "ClaimResponse_Payment": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Whether this represents partial or complete payment of the benefits payable." + }, + "adjustment": { + "$ref": "#/components/schemas/Money", + "description": "Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication." + }, + "adjustmentReason": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Reason for the payment adjustment." + }, + "date": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", + "description": "Estimated date the payment will be issued or the actual issue date of payment." + }, + "amount": { + "$ref": "#/components/schemas/Money", + "description": "Benefits payable less any payment adjustment." + }, + "identifier": { + "$ref": "#/components/schemas/Identifier", + "description": "Issuer's unique identifier for the payment instrument." + } + } + } + ], + "required": [ + "type", + "amount" + ] + }, + "ClaimResponse_Total": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "category": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item." + }, + "amount": { + "$ref": "#/components/schemas/Money", + "description": "Monetary total amount associated with the category." + } + } + } + ], + "required": [ + "category", + "amount" ] }, "ClaimResponse_AddItem": { @@ -49580,79 +49935,6 @@ "adjudication" ] }, - "ClaimResponse_Error": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "itemSequence": { - "type": "integer", - "format": "int32", - "description": "The sequence number of the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure." - }, - "detailSequence": { - "type": "integer", - "format": "int32", - "description": "The sequence number of the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure." - }, - "subDetailSequence": { - "type": "integer", - "format": "int32", - "description": "The sequence number of the sub-detail within the detail within the line item submitted which contains the error. This value is omitted when the error occurs outside of the item structure." - }, - "code": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "An error code, from a specified code system, which details why the claim could not be adjudicated." - } - } - } - ], - "required": [ - "code" - ] - }, - "ClaimResponse_Insurance": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "sequence": { - "type": "integer", - "format": "int32", - "description": "A number to uniquely identify insurance entries and provide a sequence of coverages to convey coordination of benefit order." - }, - "focal": { - "type": "boolean", - "description": "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true." - }, - "coverage": { - "$ref": "#/components/schemas/Reference", - "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system." - }, - "businessArrangement": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A business agreement number established between the provider and the insurer for special business processing purposes." - }, - "claimResponse": { - "$ref": "#/components/schemas/Reference", - "description": "The result of the adjudication of the line items for the Coverage specified in this insurance." - } - } - } - ], - "required": [ - "sequence", - "focal", - "coverage" - ] - }, "ClaimResponse_Item": { "allOf": [ { @@ -49696,37 +49978,6 @@ "adjudication" ] }, - "ClaimResponse_Item_Adjudication": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "category": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item." - }, - "reason": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A code supporting the understanding of the adjudication result and explaining variance from expected amount." - }, - "amount": { - "$ref": "#/components/schemas/Money", - "description": "Monetary amount associated with the category." - }, - "value": { - "type": "number", - "description": "A non-monetary value associated with the category. Mutually exclusive to the amount element above." - } - } - } - ], - "required": [ - "category" - ] - }, "ClaimResponse_Item_Detail": { "allOf": [ { @@ -49805,7 +50056,7 @@ "subDetailSequence" ] }, - "ClaimResponse_Payment": { + "ClaimResponse_Item_Adjudication": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -49813,99 +50064,27 @@ { "type": "object", "properties": { - "type": { + "category": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Whether this represents partial or complete payment of the benefits payable." - }, - "adjustment": { - "$ref": "#/components/schemas/Money", - "description": "Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication." + "description": "A code to indicate the information type of this adjudication record. Information types may include the value submitted, maximum values or percentages allowed or payable under the plan, amounts that: the patient is responsible for in aggregate or pertaining to this item; amounts paid by other coverages; and, the benefit payable for this item." }, - "adjustmentReason": { + "reason": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Reason for the payment adjustment." - }, - "date": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", - "description": "Estimated date the payment will be issued or the actual issue date of payment." + "description": "A code supporting the understanding of the adjudication result and explaining variance from expected amount." }, "amount": { "$ref": "#/components/schemas/Money", - "description": "Benefits payable less any payment adjustment." - }, - "identifier": { - "$ref": "#/components/schemas/Identifier", - "description": "Issuer's unique identifier for the payment instrument." - } - } - } - ], - "required": [ - "type", - "amount" - ] - }, - "ClaimResponse_ProcessNote": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "number": { - "type": "integer", - "format": "int32", - "description": "A number to uniquely identify a note entry." - }, - "type": { - "type": "string", - "enum": [ - "display", - "print", - "printoper" - ], - "description": "The business purpose of the note text." - }, - "text": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The explanation or description associated with the processing." - }, - "language": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A code to define the language used in the text of the note." - } - } - } - ], - "required": [ - "text" - ] - }, - "ClaimResponse_Total": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "category": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item." + "description": "Monetary amount associated with the category." }, - "amount": { - "$ref": "#/components/schemas/Money", - "description": "Monetary total amount associated with the category." + "value": { + "type": "number", + "description": "A non-monetary value associated with the category. Mutually exclusive to the amount element above." } } } ], "required": [ - "category", - "amount" + "category" ] }, "ClinicalImpression": { @@ -50043,7 +50222,33 @@ "required": [ "status", "subject" - ] + ], + "example": { + "resourceType": "ClinicalImpression", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "ClinicalImpression_Finding": { "allOf": [ @@ -50266,7 +50471,33 @@ "required": [ "status", "content" - ] + ], + "example": { + "resourceType": "CodeSystem", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_content": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "CodeSystem_Concept": { "allOf": [ @@ -50319,35 +50550,6 @@ "code" ] }, - "CodeSystem_Concept_Designation": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "language": { - "type": "string", - "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "The language this designation is defined for." - }, - "use": { - "$ref": "#/components/schemas/Coding", - "description": "A code that details how this designation would be used." - }, - "value": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The text value for this designation." - } - } - } - ], - "required": [ - "value" - ] - }, "CodeSystem_Concept_Property": { "allOf": [ { @@ -50400,7 +50602,7 @@ "code" ] }, - "CodeSystem_Filter": { + "CodeSystem_Concept_Designation": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -50408,45 +50610,24 @@ { "type": "object", "properties": { - "code": { + "language": { "type": "string", "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "The code that identifies this filter when it is used as a filter in [ValueSet](valueset.html#).compose.include.filter." - }, - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A description of how or why the filter is used." + "description": "The language this designation is defined for." }, - "operator": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "=", - "is-a", - "descendent-of", - "is-not-a", - "regex", - "in", - "not-in", - "generalizes", - "exists" - ], - "description": "A list of operators that can be used with the filter." - } + "use": { + "$ref": "#/components/schemas/Coding", + "description": "A code that details how this designation would be used." }, "value": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "A description of what the value for the filter should be." + "description": "The text value for this designation." } } } ], "required": [ - "code", - "operator", "value" ] }, @@ -50494,6 +50675,56 @@ "type" ] }, + "CodeSystem_Filter": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "pattern": "[^\\s]+(\\s[^\\s]+)*", + "description": "The code that identifies this filter when it is used as a filter in [ValueSet](valueset.html#).compose.include.filter." + }, + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A description of how or why the filter is used." + }, + "operator": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "=", + "is-a", + "descendent-of", + "is-not-a", + "regex", + "in", + "not-in", + "generalizes", + "exists" + ], + "description": "A list of operators that can be used with the filter." + } + }, + "value": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A description of what the value for the filter should be." + } + } + } + ], + "required": [ + "code", + "operator", + "value" + ] + }, "Communication": { "allOf": [ { @@ -50661,7 +50892,25 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "Communication", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Communication_Payload": { "allOf": [ @@ -50843,7 +51092,25 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "CommunicationRequest", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "CommunicationRequest_Payload": { "allOf": [ @@ -50972,7 +51239,57 @@ "status", "code", "search" - ] + ], + "example": { + "resourceType": "CompartmentDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_url": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_code": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_search": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "CompartmentDefinition_Resource": { "allOf": [ @@ -51267,9 +51584,61 @@ "date", "author", "title" - ] + ], + "example": { + "resourceType": "Composition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_date": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "author": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + ], + "_title": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, - "Composition_Attester": { + "Composition_Section": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -51277,30 +51646,63 @@ { "type": "object", "properties": { + "title": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents." + }, + "code": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A code identifying the kind of content contained within the section. This must be consistent with the section title." + }, + "author": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reference", + "description": "Identifies who is responsible for the information in this section, not necessarily who typed it in." + } + }, + "focus": { + "$ref": "#/components/schemas/Reference", + "description": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources)." + }, + "text": { + "$ref": "#/components/schemas/Narrative", + "description": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative." + }, "mode": { "type": "string", "enum": [ - "personal", - "professional", - "legal", - "official" + "working", + "snapshot", + "changes" ], - "description": "The type of attestation the authenticator offers." + "description": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted." }, - "time": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "When the composition was attested by the party." + "orderedBy": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Specifies the order applied to the items in the section entries." }, - "party": { - "$ref": "#/components/schemas/Reference", - "description": "Who attested the composition in the specified way." + "entry": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reference", + "description": "A reference to the actual resource from which the narrative in the section is derived." + } + }, + "emptyReason": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason." + }, + "section": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Composition_Section", + "description": "A nested sub-section within this section." + } } } } - ], - "required": [ - "mode" ] }, "Composition_Event": { @@ -51366,7 +51768,7 @@ "code" ] }, - "Composition_Section": { + "Composition_Attester": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -51374,63 +51776,30 @@ { "type": "object", "properties": { - "title": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents." - }, - "code": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A code identifying the kind of content contained within the section. This must be consistent with the section title." - }, - "author": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reference", - "description": "Identifies who is responsible for the information in this section, not necessarily who typed it in." - } - }, - "focus": { - "$ref": "#/components/schemas/Reference", - "description": "The actual focus of the section when it is not the subject of the composition, but instead represents something or someone associated with the subject such as (for a patient subject) a spouse, parent, fetus, or donor. If not focus is specified, the focus is assumed to be focus of the parent section, or, for a section in the Composition itself, the subject of the composition. Sections with a focus SHALL only include resources where the logical subject (patient, subject, focus, etc.) matches the section focus, or the resources have no logical subject (few resources)." - }, - "text": { - "$ref": "#/components/schemas/Narrative", - "description": "A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative." - }, "mode": { "type": "string", "enum": [ - "working", - "snapshot", - "changes" + "personal", + "professional", + "legal", + "official" ], - "description": "How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted." - }, - "orderedBy": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Specifies the order applied to the items in the section entries." - }, - "entry": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reference", - "description": "A reference to the actual resource from which the narrative in the section is derived." - } + "description": "The type of attestation the authenticator offers." }, - "emptyReason": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason." + "time": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", + "description": "When the composition was attested by the party." }, - "section": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Composition_Section", - "description": "A nested sub-section within this section." - } + "party": { + "$ref": "#/components/schemas/Reference", + "description": "Who attested the composition in the specified way." } } } + ], + "required": [ + "mode" ] }, "ConceptMap": { @@ -51557,7 +51926,25 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "ConceptMap", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "ConceptMap_Group": { "allOf": [ @@ -51605,6 +51992,45 @@ "element" ] }, + "ConceptMap_Group_Unmapped": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "mode": { + "type": "string", + "enum": [ + "provided", + "fixed", + "other-map" + ], + "description": "Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL)." + }, + "code": { + "type": "string", + "pattern": "[^\\s]+(\\s[^\\s]+)*", + "description": "The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code." + }, + "display": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The display for the code. The display is only provided to help editors when editing the concept map." + }, + "url": { + "type": "string", + "pattern": "\\S*", + "description": "The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept." + } + } + } + ], + "required": [ + "mode" + ] + }, "ConceptMap_Group_Element": { "allOf": [ { @@ -51730,45 +52156,6 @@ "value" ] }, - "ConceptMap_Group_Unmapped": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "mode": { - "type": "string", - "enum": [ - "provided", - "fixed", - "other-map" - ], - "description": "Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL)." - }, - "code": { - "type": "string", - "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code." - }, - "display": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The display for the code. The display is only provided to help editors when editing the concept map." - }, - "url": { - "type": "string", - "pattern": "\\S*", - "description": "The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept." - } - } - } - ], - "required": [ - "mode" - ] - }, "Condition": { "allOf": [ { @@ -51905,7 +52292,25 @@ ], "required": [ "subject" - ] + ], + "example": { + "resourceType": "Condition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Condition_Evidence": { "allOf": [ @@ -52058,29 +52463,43 @@ "status", "scope", "category" - ] - }, - "Consent_Policy": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "Consent", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "authority": { - "type": "string", - "pattern": "\\S*", - "description": "Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives." - }, - "uri": { - "type": "string", - "pattern": "\\S*", - "description": "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law." + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } + ] + }, + "scope": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "category": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } - } - ] + ] + } }, "Consent_Provision": { "allOf": [ @@ -52166,7 +52585,7 @@ } ] }, - "Consent_Provision_Actor": { + "Consent_Provision_Data": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -52174,23 +52593,29 @@ { "type": "object", "properties": { - "role": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "How the individual is involved in the resources content that is described in the exception." + "meaning": { + "type": "string", + "enum": [ + "instance", + "related", + "dependents", + "authoredby" + ], + "description": "How the resource reference is interpreted when testing consent restrictions." }, "reference": { "$ref": "#/components/schemas/Reference", - "description": "The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers')." + "description": "A reference to a specific resource that defines which resources are covered by this consent." } } } ], "required": [ - "role", + "meaning", "reference" ] }, - "Consent_Provision_Data": { + "Consent_Provision_Actor": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -52198,25 +52623,19 @@ { "type": "object", "properties": { - "meaning": { - "type": "string", - "enum": [ - "instance", - "related", - "dependents", - "authoredby" - ], - "description": "How the resource reference is interpreted when testing consent restrictions." + "role": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "How the individual is involved in the resources content that is described in the exception." }, "reference": { "$ref": "#/components/schemas/Reference", - "description": "A reference to a specific resource that defines which resources are covered by this consent." + "description": "The resource that identifies the actor. To identify actors by type, use group to identify a set of actors by some property they share (e.g. 'admitting officers')." } } } ], "required": [ - "meaning", + "role", "reference" ] }, @@ -52248,6 +52667,28 @@ "verified" ] }, + "Consent_Policy": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "authority": { + "type": "string", + "pattern": "\\S*", + "description": "Entity or Organization having regulatory jurisdiction or accountability for enforcing policies pertaining to Consent Directives." + }, + "uri": { + "type": "string", + "pattern": "\\S*", + "description": "The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law." + } + } + } + ] + }, "Contract": { "allOf": [ { @@ -52465,68 +52906,19 @@ } } } - ] - }, - "Contract_ContentDefinition": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation." - }, - "subType": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Detailed Precusory content type." - }, - "publisher": { - "$ref": "#/components/schemas/Reference", - "description": "The individual or organization that published the Contract precursor content." - }, - "publicationDate": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "The date (and optionally time) when the contract was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the contract changes." - }, - "publicationStatus": { - "type": "string", - "enum": [ - "amended", - "appended", - "cancelled", - "disputed", - "entered-in-error", - "executable", - "executed", - "negotiable", - "offered", - "policy", - "rejected", - "renewed", - "revoked", - "resolved", - "terminated" - ], - "description": "draft | active | retired | unknown." - }, - "copyright": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content." + ], + "example": { + "resourceType": "Contract", + "meta": { + "tag": [ + { + "code": "ibm/minimal" } - } + ] } - ], - "required": [ - "type", - "publicationStatus" - ] + } }, - "Contract_Friendly": { + "Contract_Rule": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -52536,11 +52928,11 @@ "properties": { "contentAttachment": { "$ref": "#/components/schemas/Attachment", - "description": "Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability." + "description": "Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal)." }, "contentReference": { "$ref": "#/components/schemas/Reference", - "description": "Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability." + "description": "Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal)." } } } @@ -52566,7 +52958,7 @@ } ] }, - "Contract_Rule": { + "Contract_Friendly": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -52576,11 +52968,11 @@ "properties": { "contentAttachment": { "$ref": "#/components/schemas/Attachment", - "description": "Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal)." + "description": "Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability." }, "contentReference": { "$ref": "#/components/schemas/Reference", - "description": "Computable Contract conveyed using a policy rule language (e.g. XACML, DKAL, SecPal)." + "description": "Human readable rendering of this Contract in a format and representation intended to enhance comprehension and ensure understandability." } } } @@ -52990,34 +53382,6 @@ } ] }, - "Contract_Term_Asset_Context": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "reference": { - "$ref": "#/components/schemas/Reference", - "description": "Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction." - }, - "code": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location." - } - }, - "text": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Context description." - } - } - } - ] - }, "Contract_Term_Asset_ValuedItem": { "allOf": [ { @@ -53101,6 +53465,34 @@ } ] }, + "Contract_Term_Asset_Context": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "reference": { + "$ref": "#/components/schemas/Reference", + "description": "Asset context reference may include the creator, custodian, or owning Person or Organization (e.g., bank, repository), location held, e.g., building, jurisdiction." + }, + "code": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Coded representation of the context generally or of the Referenced entity, such as the asset holder type or location." + } + }, + "text": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Context description." + } + } + } + ] + }, "Contract_Term_Offer": { "allOf": [ { @@ -53308,6 +53700,65 @@ "classification" ] }, + "Contract_ContentDefinition": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Precusory content structure and use, i.e., a boilerplate, template, application for a contract such as an insurance policy or benefits under a program, e.g., workers compensation." + }, + "subType": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Detailed Precusory content type." + }, + "publisher": { + "$ref": "#/components/schemas/Reference", + "description": "The individual or organization that published the Contract precursor content." + }, + "publicationDate": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", + "description": "The date (and optionally time) when the contract was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the contract changes." + }, + "publicationStatus": { + "type": "string", + "enum": [ + "amended", + "appended", + "cancelled", + "disputed", + "entered-in-error", + "executable", + "executed", + "negotiable", + "offered", + "policy", + "rejected", + "renewed", + "revoked", + "resolved", + "terminated" + ], + "description": "draft | active | retired | unknown." + }, + "copyright": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A copyright statement relating to Contract precursor content. Copyright statements are generally legal restrictions on the use and publishing of the Contract precursor content." + } + } + } + ], + "required": [ + "type", + "publicationStatus" + ] + }, "Coverage": { "allOf": [ { @@ -53416,37 +53867,43 @@ "status", "beneficiary", "payor" - ] - }, - "Coverage_Class": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "Coverage", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan." - }, - "value": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The alphanumeric string value associated with the insurer issued label." - }, - "name": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A short description for the class." + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } + ] + }, + "beneficiary": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "payor": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } - } - ], - "required": [ - "type", - "value" - ] + ] + } }, "Coverage_CostToBeneficiary": { "allOf": [ @@ -53502,6 +53959,36 @@ "type" ] }, + "Coverage_Class": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The type of classification for which an insurer-specific class label or number and optional name is provided, for example may be used to identify a class of coverage or employer group, Policy, Plan." + }, + "value": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The alphanumeric string value associated with the insurer issued label." + }, + "name": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A short description for the class." + } + } + } + ], + "required": [ + "type", + "value" + ] + }, "CoverageEligibilityRequest": { "allOf": [ { @@ -53608,35 +54095,62 @@ "patient", "created", "insurer" - ] - }, - "CoverageEligibilityRequest_Insurance": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "CoverageEligibilityRequest", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "focal": { - "type": "boolean", - "description": "A flag to indicate that this Coverage is to be used for evaluation of this request when set to true." - }, - "coverage": { - "$ref": "#/components/schemas/Reference", - "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system." - }, - "businessArrangement": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A business agreement number established between the provider and the insurer for special business processing purposes." + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } + ] + }, + "purpose": [ + null + ], + "_purpose": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } + ], + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_created": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "insurer": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } - ], - "required": [ - "coverage" - ] + } }, "CoverageEligibilityRequest_Item": { "allOf": [ @@ -53723,6 +54237,34 @@ } ] }, + "CoverageEligibilityRequest_Insurance": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "focal": { + "type": "boolean", + "description": "A flag to indicate that this Coverage is to be used for evaluation of this request when set to true." + }, + "coverage": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system." + }, + "businessArrangement": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A business agreement number established between the provider and the insurer for special business processing purposes." + } + } + } + ], + "required": [ + "coverage" + ] + }, "CoverageEligibilityRequest_SupportingInfo": { "allOf": [ { @@ -53869,7 +54411,78 @@ "request", "outcome", "insurer" - ] + ], + "example": { + "resourceType": "CoverageEligibilityResponse", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "purpose": [ + null + ], + "_purpose": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + ], + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_created": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "request": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_outcome": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "insurer": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "CoverageEligibilityResponse_Error": { "allOf": [ @@ -54146,33 +54759,25 @@ ], "required": [ "status" - ] - }, - "DetectedIssue_Evidence": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "DetectedIssue", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "code": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A manifestation that led to the recording of this detected issue." - } - }, - "detail": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reference", - "description": "Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport." - } + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - } + ] } - ] + } }, "DetectedIssue_Mitigation": { "allOf": [ @@ -54202,6 +54807,32 @@ "action" ] }, + "DetectedIssue_Evidence": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "code": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A manifestation that led to the recording of this detected issue." + } + }, + "detail": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reference", + "description": "Links to resources that constitute evidence for the detected issue such as a GuidanceResponse or MeasureReport." + } + } + } + } + ] + }, "Device": { "allOf": [ { @@ -54361,6 +54992,101 @@ } } } + ], + "example": { + "resourceType": "Device", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } + }, + "Device_Property": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Code that specifies the property DeviceDefinitionPropetyCode (Extensible)." + }, + "valueQuantity": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Quantity", + "description": "Property value as a quantity." + } + }, + "valueCode": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Property value as a code, e.g., NTP4 (synced to NTP)." + } + } + } + } + ], + "required": [ + "type" + ] + }, + "Device_Version": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The type of the device version." + }, + "component": { + "$ref": "#/components/schemas/Identifier", + "description": "A single component of the device version." + }, + "value": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The version text." + } + } + } + ], + "required": [ + "value" + ] + }, + "Device_Specialization": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "systemType": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The standard that is used to operate and communicate." + }, + "version": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The version of the standard that is used to operate and communicate." + } + } + } + ], + "required": [ + "systemType" ] }, "Device_DeviceName": { @@ -54396,63 +55122,6 @@ "type" ] }, - "Device_Property": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Code that specifies the property DeviceDefinitionPropetyCode (Extensible)." - }, - "valueQuantity": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Quantity", - "description": "Property value as a quantity." - } - }, - "valueCode": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Property value as a code, e.g., NTP4 (synced to NTP)." - } - } - } - } - ], - "required": [ - "type" - ] - }, - "Device_Specialization": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "systemType": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The standard that is used to operate and communicate." - }, - "version": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The version of the standard that is used to operate and communicate." - } - } - } - ], - "required": [ - "systemType" - ] - }, "Device_UdiCarrier": { "allOf": [ { @@ -54502,34 +55171,6 @@ } ] }, - "Device_Version": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The type of the device version." - }, - "component": { - "$ref": "#/components/schemas/Identifier", - "description": "A single component of the device version." - }, - "value": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The version text." - } - } - } - ], - "required": [ - "value" - ] - }, "DeviceDefinition": { "allOf": [ { @@ -54676,66 +55317,17 @@ } } } - ] - }, - "DeviceDefinition_Capability": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Type of capability." - }, - "description": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Description of capability." - } - } - } - } ], - "required": [ - "type" - ] - }, - "DeviceDefinition_DeviceName": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The name of the device." - }, - "type": { - "type": "string", - "enum": [ - "udi-label-name", - "user-friendly-name", - "patient-reported-name", - "manufacturer-name", - "model-name", - "other" - ], - "description": "The type of deviceName.\nUDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName." + "example": { + "resourceType": "DeviceDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" } - } + ] } - ], - "required": [ - "name", - "type" - ] + } }, "DeviceDefinition_Material": { "allOf": [ @@ -54797,6 +55389,32 @@ "type" ] }, + "DeviceDefinition_Capability": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Type of capability." + }, + "description": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Description of capability." + } + } + } + } + ], + "required": [ + "type" + ] + }, "DeviceDefinition_Specialization": { "allOf": [ { @@ -54822,6 +55440,39 @@ "systemType" ] }, + "DeviceDefinition_DeviceName": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The name of the device." + }, + "type": { + "type": "string", + "enum": [ + "udi-label-name", + "user-friendly-name", + "patient-reported-name", + "manufacturer-name", + "model-name", + "other" + ], + "description": "The type of deviceName.\nUDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName." + } + } + } + ], + "required": [ + "name", + "type" + ] + }, "DeviceDefinition_UdiDeviceIdentifier": { "allOf": [ { @@ -54936,7 +55587,33 @@ "required": [ "type", "category" - ] + ], + "example": { + "resourceType": "DeviceMetric", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_category": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "DeviceMetric_Calibration": { "allOf": [ @@ -55163,7 +55840,41 @@ "required": [ "intent", "subject" - ] + ], + "example": { + "resourceType": "DeviceRequest", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_intent": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "codeReference": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "DeviceRequest_Parameter": { "allOf": [ @@ -55300,7 +56011,41 @@ "status", "subject", "device" - ] + ], + "example": { + "resourceType": "DeviceUseStatement", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "device": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "DiagnosticReport": { "allOf": [ @@ -55440,7 +56185,33 @@ "required": [ "status", "code" - ] + ], + "example": { + "resourceType": "DiagnosticReport", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "code": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "DiagnosticReport_Media": { "allOf": [ @@ -55551,7 +56322,35 @@ "required": [ "status", "content" - ] + ], + "example": { + "resourceType": "DocumentManifest", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "content": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + ] + } }, "DocumentManifest_Related": { "allOf": [ @@ -55682,30 +56481,37 @@ "required": [ "status", "content" - ] - }, - "DocumentReference_Content": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "DocumentReference", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "content": [ + { "attachment": { - "$ref": "#/components/schemas/Attachment", - "description": "The document or URL of the document along with critical metadata to prove content has integrity." - }, - "format": { - "$ref": "#/components/schemas/Coding", - "description": "An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType." + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } } - } - ], - "required": [ - "attachment" - ] + ] + } }, "DocumentReference_Context": { "allOf": [ @@ -55756,6 +56562,29 @@ } ] }, + "DocumentReference_Content": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "attachment": { + "$ref": "#/components/schemas/Attachment", + "description": "The document or URL of the document along with critical metadata to prove content has integrity." + }, + "format": { + "$ref": "#/components/schemas/Coding", + "description": "An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType." + } + } + } + ], + "required": [ + "attachment" + ] + }, "DocumentReference_RelatesTo": { "allOf": [ { @@ -55993,7 +56822,57 @@ "exposure", "exposureAlternative", "outcome" - ] + ], + "example": { + "resourceType": "EffectEvidenceSynthesis", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "population": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "exposure": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "exposureAlternative": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "outcome": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "EffectEvidenceSynthesis_Certainty": { "allOf": [ @@ -56345,33 +57224,35 @@ "required": [ "status", "class" - ] - }, - "Encounter_ClassHistory": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "Encounter", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "class": { - "$ref": "#/components/schemas/Coding", - "description": "inpatient | outpatient | ambulatory | emergency +." - }, - "period": { - "$ref": "#/components/schemas/Period", - "description": "The time that the episode was in the specified class." + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - } + ] + }, + "class": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } - ], - "required": [ - "class", - "period" - ] + } }, - "Encounter_Diagnosis": { + "Encounter_Location": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -56379,24 +57260,33 @@ { "type": "object", "properties": { - "condition": { + "location": { "$ref": "#/components/schemas/Reference", - "description": "Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure." + "description": "The location where the encounter takes place." }, - "use": { + "status": { + "type": "string", + "enum": [ + "planned", + "active", + "reserved", + "completed" + ], + "description": "The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time." + }, + "physicalType": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)." + "description": "This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query." }, - "rank": { - "type": "integer", - "format": "int32", - "description": "Ranking of the diagnosis (for each role type)." + "period": { + "$ref": "#/components/schemas/Period", + "description": "Time period during which the patient was present at the location." } } } ], "required": [ - "condition" + "location" ] }, "Encounter_Hospitalization": { @@ -56456,7 +57346,7 @@ } ] }, - "Encounter_Location": { + "Encounter_Diagnosis": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -56464,33 +57354,24 @@ { "type": "object", "properties": { - "location": { + "condition": { "$ref": "#/components/schemas/Reference", - "description": "The location where the encounter takes place." - }, - "status": { - "type": "string", - "enum": [ - "planned", - "active", - "reserved", - "completed" - ], - "description": "The status of the participants' presence at the specified location during the period specified. If the participant is no longer at the location, then the period will have an end date/time." + "description": "Reason the encounter takes place, as specified using information from another resource. For admissions, this is the admission diagnosis. The indication will typically be a Condition (with other resources referenced in the evidence.detail), or a Procedure." }, - "physicalType": { + "use": { "$ref": "#/components/schemas/CodeableConcept", - "description": "This will be used to specify the required levels (bed/ward/room/etc.) desired to be recorded to simplify either messaging or query." + "description": "Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)." }, - "period": { - "$ref": "#/components/schemas/Period", - "description": "Time period during which the patient was present at the location." + "rank": { + "type": "integer", + "format": "int32", + "description": "Ranking of the diagnosis (for each role type)." } } } ], "required": [ - "location" + "condition" ] }, "Encounter_Participant": { @@ -56520,6 +57401,30 @@ } ] }, + "Encounter_ClassHistory": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "class": { + "$ref": "#/components/schemas/Coding", + "description": "inpatient | outpatient | ambulatory | emergency +." + }, + "period": { + "$ref": "#/components/schemas/Period", + "description": "The time that the episode was in the specified class." + } + } + } + ], + "required": [ + "class", + "period" + ] + }, "Encounter_StatusHistory": { "allOf": [ { @@ -56642,7 +57547,51 @@ "connectionType", "payloadType", "address" - ] + ], + "example": { + "resourceType": "Endpoint", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "connectionType": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "payloadType": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + ], + "_address": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "EnrollmentRequest": { "allOf": [ @@ -56692,7 +57641,17 @@ } } } - ] + ], + "example": { + "resourceType": "EnrollmentRequest", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "EnrollmentResponse": { "allOf": [ @@ -56753,7 +57712,17 @@ } } } - ] + ], + "example": { + "resourceType": "EnrollmentResponse", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "EpisodeOfCare": { "allOf": [ @@ -56847,7 +57816,33 @@ "required": [ "status", "patient" - ] + ], + "example": { + "resourceType": "EpisodeOfCare", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "EpisodeOfCare_Diagnosis": { "allOf": [ @@ -57092,7 +58087,37 @@ "required": [ "status", "trigger" - ] + ], + "example": { + "resourceType": "EventDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "trigger": [ + { + "_type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } }, "Evidence": { "allOf": [ @@ -57277,7 +58302,33 @@ "required": [ "status", "exposureBackground" - ] + ], + "example": { + "resourceType": "Evidence", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "exposureBackground": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "EvidenceVariable": { "allOf": [ @@ -57460,7 +58511,37 @@ "required": [ "status", "characteristic" - ] + ], + "example": { + "resourceType": "EvidenceVariable", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "characteristic": [ + { + "definitionReference": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } }, "EvidenceVariable_Characteristic": { "allOf": [ @@ -57655,9 +58736,69 @@ ], "required": [ "status" + ], + "example": { + "resourceType": "ExampleScenario", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + }, + "ExampleScenario_Process": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "title": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The diagram title of the group of operations." + }, + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A longer description of the group of operations." + }, + "preConditions": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Description of initial status before the process starts." + }, + "postConditions": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Description of final status after the process ends." + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExampleScenario_Process_Step", + "description": "Each step of the process." + } + } + } + } + ], + "required": [ + "title" ] }, - "ExampleScenario_Actor": { + "ExampleScenario_Process_Step": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -57665,35 +58806,123 @@ { "type": "object", "properties": { - "actorId": { + "process": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExampleScenario_Process", + "description": "Nested process." + } + }, + "pause": { + "type": "boolean", + "description": "If there is a pause in the flow." + }, + "operation": { + "$ref": "#/components/schemas/ExampleScenario_Process_Step_Operation", + "description": "Each interaction or action." + }, + "alternative": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExampleScenario_Process_Step_Alternative", + "description": "Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances." + } + } + } + } + ] + }, + "ExampleScenario_Process_Step_Alternative": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "title": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "ID or acronym of actor." + "description": "The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked." + }, + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A human-readable description of the alternative explaining when the alternative should occur rather than the base step." + }, + "step": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExampleScenario_Process_Step", + "description": "What happens in each alternative option." + } + } + } + } + ], + "required": [ + "title" + ] + }, + "ExampleScenario_Process_Step_Operation": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "number": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The sequential number of the interaction, e.g. 1.2.5." }, "type": { "type": "string", - "enum": [ - "person", - "entity" - ], - "description": "The type of actor - person or system." + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The type of operation - CRUD." }, "name": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The name of the actor as shown in the page." + "description": "The human-friendly name of the interaction." + }, + "initiator": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Who starts the transaction." + }, + "receiver": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Who receives the transaction." }, "description": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The description of the actor." + "description": "A comment to be inserted in the diagram." + }, + "initiatorActive": { + "type": "boolean", + "description": "Whether the initiator is deactivated right after the transaction." + }, + "receiverActive": { + "type": "boolean", + "description": "Whether the receiver is deactivated right after the transaction." + }, + "request": { + "$ref": "#/components/schemas/ExampleScenario_Instance_ContainedInstance", + "description": "Each resource instance used by the initiator." + }, + "response": { + "$ref": "#/components/schemas/ExampleScenario_Instance_ContainedInstance", + "description": "Each resource instance used by the responder." } } } ], "required": [ - "actorId", - "type" + "number" ] }, "ExampleScenario_Instance": { @@ -57946,115 +59175,7 @@ "description" ] }, - "ExampleScenario_Process": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "title": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The diagram title of the group of operations." - }, - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A longer description of the group of operations." - }, - "preConditions": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Description of initial status before the process starts." - }, - "postConditions": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Description of final status after the process ends." - }, - "step": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExampleScenario_Process_Step", - "description": "Each step of the process." - } - } - } - } - ], - "required": [ - "title" - ] - }, - "ExampleScenario_Process_Step": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "process": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExampleScenario_Process", - "description": "Nested process." - } - }, - "pause": { - "type": "boolean", - "description": "If there is a pause in the flow." - }, - "operation": { - "$ref": "#/components/schemas/ExampleScenario_Process_Step_Operation", - "description": "Each interaction or action." - }, - "alternative": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExampleScenario_Process_Step_Alternative", - "description": "Indicates an alternative step that can be taken instead of the operations on the base step in exceptional/atypical circumstances." - } - } - } - } - ] - }, - "ExampleScenario_Process_Step_Alternative": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "title": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The label to display for the alternative that gives a sense of the circumstance in which the alternative should be invoked." - }, - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A human-readable description of the alternative explaining when the alternative should occur rather than the base step." - }, - "step": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExampleScenario_Process_Step", - "description": "What happens in each alternative option." - } - } - } - } - ], - "required": [ - "title" - ] - }, - "ExampleScenario_Process_Step_Operation": { + "ExampleScenario_Actor": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -58062,57 +59183,35 @@ { "type": "object", "properties": { - "number": { + "actorId": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The sequential number of the interaction, e.g. 1.2.5." + "description": "ID or acronym of actor." }, "type": { "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The type of operation - CRUD." + "enum": [ + "person", + "entity" + ], + "description": "The type of actor - person or system." }, "name": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The human-friendly name of the interaction." - }, - "initiator": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Who starts the transaction." - }, - "receiver": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Who receives the transaction." + "description": "The name of the actor as shown in the page." }, "description": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "A comment to be inserted in the diagram." - }, - "initiatorActive": { - "type": "boolean", - "description": "Whether the initiator is deactivated right after the transaction." - }, - "receiverActive": { - "type": "boolean", - "description": "Whether the receiver is deactivated right after the transaction." - }, - "request": { - "$ref": "#/components/schemas/ExampleScenario_Instance_ContainedInstance", - "description": "Each resource instance used by the initiator." - }, - "response": { - "$ref": "#/components/schemas/ExampleScenario_Instance_ContainedInstance", - "description": "Each resource instance used by the responder." + "description": "The description of the actor." } } } ], "required": [ - "number" + "actorId", + "type" ] }, "ExplanationOfBenefit": { @@ -58374,9 +59473,155 @@ "provider", "outcome", "insurance" + ], + "example": { + "resourceType": "ExplanationOfBenefit", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_use": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_created": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "insurer": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "provider": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_outcome": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "insurance": [ + { + "_focal": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "coverage": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } + }, + "ExplanationOfBenefit_BenefitBalance": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "category": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Code to identify the general type of benefits under which products and services are provided." + }, + "excluded": { + "type": "boolean", + "description": "True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage." + }, + "name": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A short name or tag for the benefit." + }, + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A richer description of the benefit or services covered." + }, + "network": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers." + }, + "unit": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Indicates if the benefits apply to an individual or to the family." + }, + "term": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'." + }, + "financial": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExplanationOfBenefit_BenefitBalance_Financial", + "description": "Benefits Used to date." + } + } + } + } + ], + "required": [ + "category" ] }, - "ExplanationOfBenefit_Accident": { + "ExplanationOfBenefit_BenefitBalance_Financial": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -58384,27 +59629,136 @@ { "type": "object", "properties": { - "date": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Classification of benefit being provided." + }, + "allowedUnsignedInt": { + "type": "integer", + "format": "int32", + "description": "The quantity of the benefit which is permitted under the coverage." + }, + "allowedString": { "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", - "description": "Date of an accident event related to the products and services contained in the claim." + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The quantity of the benefit which is permitted under the coverage." + }, + "allowedMoney": { + "$ref": "#/components/schemas/Money", + "description": "The quantity of the benefit which is permitted under the coverage." + }, + "usedUnsignedInt": { + "type": "integer", + "format": "int32", + "description": "The quantity of the benefit which have been consumed to date." + }, + "usedMoney": { + "$ref": "#/components/schemas/Money", + "description": "The quantity of the benefit which have been consumed to date." + } + } + } + ], + "required": [ + "type" + ] + }, + "ExplanationOfBenefit_ProcessNote": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "number": { + "type": "integer", + "format": "int32", + "description": "A number to uniquely identify a note entry." }, "type": { + "type": "string", + "enum": [ + "display", + "print", + "printoper" + ], + "description": "The business purpose of the note text." + }, + "text": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The explanation or description associated with the processing." + }, + "language": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers." + "description": "A code to define the language used in the text of the note." + } + } + } + ] + }, + "ExplanationOfBenefit_Payment": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Whether this represents partial or complete payment of the benefits payable." }, - "locationAddress": { - "$ref": "#/components/schemas/Address", - "description": "The physical location of the accident event." + "adjustment": { + "$ref": "#/components/schemas/Money", + "description": "Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication." }, - "locationReference": { - "$ref": "#/components/schemas/Reference", - "description": "The physical location of the accident event." + "adjustmentReason": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Reason for the payment adjustment." + }, + "date": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", + "description": "Estimated date the payment will be issued or the actual issue date of payment." + }, + "amount": { + "$ref": "#/components/schemas/Money", + "description": "Benefits payable less any payment adjustment." + }, + "identifier": { + "$ref": "#/components/schemas/Identifier", + "description": "Issuer's unique identifier for the payment instrument." } } } ] }, + "ExplanationOfBenefit_Total": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "category": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item." + }, + "amount": { + "$ref": "#/components/schemas/Money", + "description": "Monetary total amount associated with the category." + } + } + } + ], + "required": [ + "category", + "amount" + ] + }, "ExplanationOfBenefit_AddItem": { "allOf": [ { @@ -58660,212 +60014,6 @@ "productOrService" ] }, - "ExplanationOfBenefit_BenefitBalance": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "category": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Code to identify the general type of benefits under which products and services are provided." - }, - "excluded": { - "type": "boolean", - "description": "True if the indicated class of service is excluded from the plan, missing or False indicates the product or service is included in the coverage." - }, - "name": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A short name or tag for the benefit." - }, - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A richer description of the benefit or services covered." - }, - "network": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Is a flag to indicate whether the benefits refer to in-network providers or out-of-network providers." - }, - "unit": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Indicates if the benefits apply to an individual or to the family." - }, - "term": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The term or period of the values such as 'maximum lifetime benefit' or 'maximum annual visits'." - }, - "financial": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ExplanationOfBenefit_BenefitBalance_Financial", - "description": "Benefits Used to date." - } - } - } - } - ], - "required": [ - "category" - ] - }, - "ExplanationOfBenefit_BenefitBalance_Financial": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Classification of benefit being provided." - }, - "allowedUnsignedInt": { - "type": "integer", - "format": "int32", - "description": "The quantity of the benefit which is permitted under the coverage." - }, - "allowedString": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The quantity of the benefit which is permitted under the coverage." - }, - "allowedMoney": { - "$ref": "#/components/schemas/Money", - "description": "The quantity of the benefit which is permitted under the coverage." - }, - "usedUnsignedInt": { - "type": "integer", - "format": "int32", - "description": "The quantity of the benefit which have been consumed to date." - }, - "usedMoney": { - "$ref": "#/components/schemas/Money", - "description": "The quantity of the benefit which have been consumed to date." - } - } - } - ], - "required": [ - "type" - ] - }, - "ExplanationOfBenefit_CareTeam": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "sequence": { - "type": "integer", - "format": "int32", - "description": "A number to uniquely identify care team entries." - }, - "provider": { - "$ref": "#/components/schemas/Reference", - "description": "Member of the team who provided the product or service." - }, - "responsible": { - "type": "boolean", - "description": "The party who is billing and/or responsible for the claimed products or services." - }, - "role": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team." - }, - "qualification": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The qualification of the practitioner which is applicable for this service." - } - } - } - ], - "required": [ - "sequence", - "provider" - ] - }, - "ExplanationOfBenefit_Diagnosis": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "sequence": { - "type": "integer", - "format": "int32", - "description": "A number to uniquely identify diagnosis entries." - }, - "diagnosisCodeableConcept": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition." - }, - "diagnosisReference": { - "$ref": "#/components/schemas/Reference", - "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition." - }, - "type": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "When the condition was observed or the relative ranking." - } - }, - "onAdmission": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Indication of whether the diagnosis was present on admission to a facility." - }, - "packageCode": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system." - } - } - } - ], - "required": [ - "sequence" - ] - }, - "ExplanationOfBenefit_Insurance": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "focal": { - "type": "boolean", - "description": "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true." - }, - "coverage": { - "$ref": "#/components/schemas/Reference", - "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system." - }, - "preAuthRef": { - "type": "array", - "items": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization." - } - } - } - } - ], - "required": [ - "focal", - "coverage" - ] - }, "ExplanationOfBenefit_Item": { "allOf": [ { @@ -59029,37 +60177,6 @@ "productOrService" ] }, - "ExplanationOfBenefit_Item_Adjudication": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "category": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item." - }, - "reason": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A code supporting the understanding of the adjudication result and explaining variance from expected amount." - }, - "amount": { - "$ref": "#/components/schemas/Money", - "description": "Monetary amount associated with the category." - }, - "value": { - "type": "number", - "description": "A non-monetary value associated with the category. Mutually exclusive to the amount element above." - } - } - } - ], - "required": [ - "category" - ] - }, "ExplanationOfBenefit_Item_Detail": { "allOf": [ { @@ -59237,7 +60354,7 @@ "productOrService" ] }, - "ExplanationOfBenefit_Payee": { + "ExplanationOfBenefit_Item_Adjudication": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -59245,19 +60362,30 @@ { "type": "object", "properties": { - "type": { + "category": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Type of Party to be reimbursed: Subscriber, provider, other." + "description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in-aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item." }, - "party": { - "$ref": "#/components/schemas/Reference", - "description": "Reference to the individual or organization to whom any payment will be made." + "reason": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A code supporting the understanding of the adjudication result and explaining variance from expected amount." + }, + "amount": { + "$ref": "#/components/schemas/Money", + "description": "Monetary amount associated with the category." + }, + "value": { + "type": "number", + "description": "A non-monetary value associated with the category. Mutually exclusive to the amount element above." } } } + ], + "required": [ + "category" ] }, - "ExplanationOfBenefit_Payment": { + "ExplanationOfBenefit_Accident": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -59265,36 +60393,28 @@ { "type": "object", "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Whether this represents partial or complete payment of the benefits payable." - }, - "adjustment": { - "$ref": "#/components/schemas/Money", - "description": "Total amount of all adjustments to this payment included in this transaction which are not related to this claim's adjudication." - }, - "adjustmentReason": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Reason for the payment adjustment." - }, "date": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", - "description": "Estimated date the payment will be issued or the actual issue date of payment." + "description": "Date of an accident event related to the products and services contained in the claim." }, - "amount": { - "$ref": "#/components/schemas/Money", - "description": "Benefits payable less any payment adjustment." + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The type or context of the accident event for the purposes of selection of potential insurance coverages and determination of coordination between insurers." }, - "identifier": { - "$ref": "#/components/schemas/Identifier", - "description": "Issuer's unique identifier for the payment instrument." + "locationAddress": { + "$ref": "#/components/schemas/Address", + "description": "The physical location of the accident event." + }, + "locationReference": { + "$ref": "#/components/schemas/Reference", + "description": "The physical location of the accident event." } } } ] }, - "ExplanationOfBenefit_Procedure": { + "ExplanationOfBenefit_Insurance": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -59302,8 +60422,40 @@ { "type": "object", "properties": { - "sequence": { - "type": "integer", + "focal": { + "type": "boolean", + "description": "A flag to indicate that this Coverage is to be used for adjudication of this claim when set to true." + }, + "coverage": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to the insurance card level information contained in the Coverage resource. The coverage issuing insurer will use these details to locate the patient's actual coverage within the insurer's information system." + }, + "preAuthRef": { + "type": "array", + "items": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Reference numbers previously provided by the insurer to the provider to be quoted on subsequent claims containing services or products related to the prior authorization." + } + } + } + } + ], + "required": [ + "focal", + "coverage" + ] + }, + "ExplanationOfBenefit_Procedure": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "sequence": { + "type": "integer", "format": "int32", "description": "A number to uniquely identify procedure entries." }, @@ -59341,7 +60493,7 @@ "sequence" ] }, - "ExplanationOfBenefit_ProcessNote": { + "ExplanationOfBenefit_Diagnosis": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -59349,55 +60501,39 @@ { "type": "object", "properties": { - "number": { + "sequence": { "type": "integer", "format": "int32", - "description": "A number to uniquely identify a note entry." - }, - "type": { - "type": "string", - "enum": [ - "display", - "print", - "printoper" - ], - "description": "The business purpose of the note text." - }, - "text": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The explanation or description associated with the processing." + "description": "A number to uniquely identify diagnosis entries." }, - "language": { + "diagnosisCodeableConcept": { "$ref": "#/components/schemas/CodeableConcept", - "description": "A code to define the language used in the text of the note." - } - } - } - ] - }, - "ExplanationOfBenefit_Related": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "claim": { + "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition." + }, + "diagnosisReference": { "$ref": "#/components/schemas/Reference", - "description": "Reference to a related claim." + "description": "The nature of illness or problem in a coded form or as a reference to an external defined Condition." }, - "relationship": { + "type": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "When the condition was observed or the relative ranking." + } + }, + "onAdmission": { "$ref": "#/components/schemas/CodeableConcept", - "description": "A code to convey how the claims are related." + "description": "Indication of whether the diagnosis was present on admission to a facility." }, - "reference": { - "$ref": "#/components/schemas/Identifier", - "description": "An alternate organizational reference to the case or file to which this particular claim pertains." + "packageCode": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A package billing code or bundle code used to group products and services to a particular health condition (such as heart attack) which is based on a predetermined grouping code system." } } } + ], + "required": [ + "sequence" ] }, "ExplanationOfBenefit_SupportingInfo": { @@ -59463,7 +60599,7 @@ "category" ] }, - "ExplanationOfBenefit_Total": { + "ExplanationOfBenefit_CareTeam": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -59471,20 +60607,77 @@ { "type": "object", "properties": { - "category": { + "sequence": { + "type": "integer", + "format": "int32", + "description": "A number to uniquely identify care team entries." + }, + "provider": { + "$ref": "#/components/schemas/Reference", + "description": "Member of the team who provided the product or service." + }, + "responsible": { + "type": "boolean", + "description": "The party who is billing and/or responsible for the claimed products or services." + }, + "role": { "$ref": "#/components/schemas/CodeableConcept", - "description": "A code to indicate the information type of this adjudication record. Information types may include: the value submitted, maximum values or percentages allowed or payable under the plan, amounts that the patient is responsible for in aggregate or pertaining to this item, amounts paid by other coverages, and the benefit payable for this item." + "description": "The lead, assisting or supervising practitioner and their discipline if a multidisciplinary team." }, - "amount": { - "$ref": "#/components/schemas/Money", - "description": "Monetary total amount associated with the category." + "qualification": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The qualification of the practitioner which is applicable for this service." } } } ], "required": [ - "category", - "amount" + "sequence", + "provider" + ] + }, + "ExplanationOfBenefit_Payee": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Type of Party to be reimbursed: Subscriber, provider, other." + }, + "party": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to the individual or organization to whom any payment will be made." + } + } + } + ] + }, + "ExplanationOfBenefit_Related": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "claim": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to a related claim." + }, + "relationship": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A code to convey how the claims are related." + }, + "reference": { + "$ref": "#/components/schemas/Identifier", + "description": "An alternate organizational reference to the case or file to which this particular claim pertains." + } + } + } ] }, "FamilyMemberHistory": { @@ -59642,7 +60835,41 @@ "status", "patient", "relationship" - ] + ], + "example": { + "resourceType": "FamilyMemberHistory", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "relationship": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "FamilyMemberHistory_Condition": { "allOf": [ @@ -59753,7 +60980,41 @@ "status", "code", "subject" - ] + ], + "example": { + "resourceType": "Flag", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "code": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Goal": { "allOf": [ @@ -59873,7 +61134,41 @@ "lifecycleStatus", "description", "subject" - ] + ], + "example": { + "resourceType": "Goal", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_lifecycleStatus": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "description": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Goal_Target": { "allOf": [ @@ -60181,7 +61476,41 @@ "name", "status", "start" - ] + ], + "example": { + "resourceType": "GraphDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_start": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "GraphDefinition_Link": { "allOf": [ @@ -60549,6 +61878,59 @@ "required": [ "type", "actual" + ], + "example": { + "resourceType": "Group", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_actual": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + }, + "Group_Member": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "entity": { + "$ref": "#/components/schemas/Reference", + "description": "A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same." + }, + "period": { + "$ref": "#/components/schemas/Period", + "description": "The period that the member was in the group, if known." + }, + "inactive": { + "type": "boolean", + "description": "A flag to indicate that the member is no longer in the group, but previously may have been a member." + } + } + } + ], + "required": [ + "entity" ] }, "Group_Characteristic": { @@ -60599,33 +61981,6 @@ "exclude" ] }, - "Group_Member": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "entity": { - "$ref": "#/components/schemas/Reference", - "description": "A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same." - }, - "period": { - "$ref": "#/components/schemas/Period", - "description": "The period that the member was in the group, if known." - }, - "inactive": { - "type": "boolean", - "description": "A flag to indicate that the member is no longer in the group, but previously may have been a member." - } - } - } - ], - "required": [ - "entity" - ] - }, "GuidanceResponse": { "allOf": [ { @@ -60736,7 +62091,33 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "GuidanceResponse", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_moduleUri": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "HealthcareService": { "allOf": [ @@ -60896,6 +62277,40 @@ } } } + ], + "example": { + "resourceType": "HealthcareService", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } + }, + "HealthcareService_NotAvailable": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The reason that can be presented to the user as to why this time is not available." + }, + "during": { + "$ref": "#/components/schemas/Period", + "description": "Service is not available (seasonally or for a public holiday) from this date." + } + } + } + ], + "required": [ + "description" ] }, "HealthcareService_AvailableTime": { @@ -60961,30 +62376,6 @@ } ] }, - "HealthcareService_NotAvailable": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The reason that can be presented to the user as to why this time is not available." - }, - "during": { - "$ref": "#/components/schemas/Period", - "description": "Service is not available (seasonally or for a public holiday) from this date." - } - } - } - ], - "required": [ - "description" - ] - }, "ImagingStudy": { "allOf": [ { @@ -61120,7 +62511,33 @@ "required": [ "status", "subject" - ] + ], + "example": { + "resourceType": "ImagingStudy", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "ImagingStudy_Series": { "allOf": [ @@ -61432,62 +62849,49 @@ "status", "vaccineCode", "patient" - ] - }, - "Immunization_Education": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "Immunization", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "documentType": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Identifier of the material presented to the patient." - }, - "reference": { - "type": "string", - "pattern": "\\S*", - "description": "Reference pointer to the educational material given to the patient if the information was on line." - }, - "publicationDate": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "Date the educational material was published." - }, - "presentationDate": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "Date the educational material was given to the patient." + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - } - } - ] - }, - "Immunization_Performer": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ] }, - { - "type": "object", - "properties": { - "function": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Describes the type of performance (e.g. ordering provider, administering provider, etc.)." - }, - "actor": { - "$ref": "#/components/schemas/Reference", - "description": "The practitioner or organization who performed the action." + "vaccineCode": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_occurrenceDateTime": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } - ], - "required": [ - "actor" - ] + } }, "Immunization_ProtocolApplied": { "allOf": [ @@ -61562,6 +62966,61 @@ } ] }, + "Immunization_Education": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "documentType": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Identifier of the material presented to the patient." + }, + "reference": { + "type": "string", + "pattern": "\\S*", + "description": "Reference pointer to the educational material given to the patient if the information was on line." + }, + "publicationDate": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", + "description": "Date the educational material was published." + }, + "presentationDate": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", + "description": "Date the educational material was given to the patient." + } + } + } + ] + }, + "Immunization_Performer": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "function": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Describes the type of performance (e.g. ordering provider, administering provider, etc.)." + }, + "actor": { + "$ref": "#/components/schemas/Reference", + "description": "The practitioner or organization who performed the action." + } + } + } + ], + "required": [ + "actor" + ] + }, "ImmunizationEvaluation": { "allOf": [ { @@ -61656,7 +63115,57 @@ "targetDisease", "immunizationEvent", "doseStatus" - ] + ], + "example": { + "resourceType": "ImmunizationEvaluation", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "targetDisease": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "immunizationEvent": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "doseStatus": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "ImmunizationRecommendation": { "allOf": [ @@ -61700,7 +63209,45 @@ "patient", "date", "recommendation" - ] + ], + "example": { + "resourceType": "ImmunizationRecommendation", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_date": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "recommendation": [ + { + "forecastStatus": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } }, "ImmunizationRecommendation_Recommendation": { "allOf": [ @@ -62287,7 +63834,8 @@ "3.0.1", "3.3.0", "3.5.0", - "4.0.0" + "4.0.0", + "4.0.1" ], "description": "The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.0. for this version." } @@ -62323,6 +63871,177 @@ "status", "packageId", "fhirVersion" + ], + "example": { + "resourceType": "ImplementationGuide", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_url": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_packageId": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "fhirVersion": [ + null + ], + "_fhirVersion": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + ] + } + }, + "ImplementationGuide_Manifest": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "rendering": { + "type": "string", + "pattern": "\\S*", + "description": "A pointer to official web page, PDF or other rendering of the implementation guide." + }, + "resource": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImplementationGuide_Manifest_Resource", + "description": "A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource." + } + }, + "page": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImplementationGuide_Manifest_Page", + "description": "Information about a page within the IG." + } + }, + "image": { + "type": "array", + "items": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Indicates a relative path to an image that exists within the IG." + } + }, + "other": { + "type": "array", + "items": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG." + } + } + } + } + ], + "required": [ + "resource" + ] + }, + "ImplementationGuide_Manifest_Page": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Relative path to the page." + }, + "title": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc." + }, + "anchor": { + "type": "array", + "items": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The name of an anchor available on the page." + } + } + } + } + ], + "required": [ + "name" + ] + }, + "ImplementationGuide_Manifest_Resource": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "reference": { + "$ref": "#/components/schemas/Reference", + "description": "Where this resource is found." + }, + "exampleBoolean": { + "type": "boolean", + "description": "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile." + }, + "exampleCanonical": { + "type": "string", + "pattern": "\\S*", + "description": "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile." + }, + "relativePath": { + "type": "string", + "pattern": "\\S*", + "description": "The relative path for primary page for this resource within the IG." + } + } + } + ], + "required": [ + "reference" ] }, "ImplementationGuide_Definition": { @@ -62372,7 +64091,7 @@ "resource" ] }, - "ImplementationGuide_Definition_Grouping": { + "ImplementationGuide_Definition_Template": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -62380,21 +64099,64 @@ { "type": "object", "properties": { - "name": { + "code": { + "type": "string", + "pattern": "[^\\s]+(\\s[^\\s]+)*", + "description": "Type of template specified." + }, + "source": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The human-readable title to display for the package of resources when rendering the implementation guide." + "description": "The source location for the template." }, - "description": { + "scope": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "Human readable text describing the package." + "description": "The scope in which the template applies." } } } ], "required": [ - "name" + "code", + "source" + ] + }, + "ImplementationGuide_Definition_Parameter": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "code": { + "type": "string", + "enum": [ + "apply", + "path-resource", + "path-pages", + "path-tx-cache", + "expansion-parameter", + "rule-broken-links", + "generate-xml", + "generate-json", + "generate-turtle", + "html-template" + ], + "description": "apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template." + }, + "value": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Value for named type." + } + } + } + ], + "required": [ + "code", + "value" ] }, "ImplementationGuide_Definition_Page": { @@ -62444,43 +64206,6 @@ "generation" ] }, - "ImplementationGuide_Definition_Parameter": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "enum": [ - "apply", - "path-resource", - "path-pages", - "path-tx-cache", - "expansion-parameter", - "rule-broken-links", - "generate-xml", - "generate-json", - "generate-turtle", - "html-template" - ], - "description": "apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template." - }, - "value": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Value for named type." - } - } - } - ], - "required": [ - "code", - "value" - ] - }, "ImplementationGuide_Definition_Resource": { "allOf": [ { @@ -62518,7 +64243,8 @@ "3.0.1", "3.3.0", "3.5.0", - "4.0.0" + "4.0.0", + "4.0.1" ], "description": "Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion." } @@ -62554,7 +64280,7 @@ "reference" ] }, - "ImplementationGuide_Definition_Template": { + "ImplementationGuide_Definition_Grouping": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -62562,57 +64288,21 @@ { "type": "object", "properties": { - "code": { - "type": "string", - "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "Type of template specified." - }, - "source": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The source location for the template." - }, - "scope": { + "name": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The scope in which the template applies." - } - } - } - ], - "required": [ - "code", - "source" - ] - }, - "ImplementationGuide_DependsOn": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "uri": { - "type": "string", - "pattern": "\\S*", - "description": "A canonical reference to the Implementation guide for the dependency." - }, - "packageId": { - "type": "string", - "pattern": "[A-Za-z0-9\\-\\.]{1,64}", - "description": "The NPM package name for the Implementation Guide that this IG depends on." + "description": "The human-readable title to display for the package of resources when rendering the implementation guide." }, - "version": { + "description": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The version of the IG that is depended on, when the correct version is required to understand the IG correctly." + "description": "Human readable text describing the package." } } } ], "required": [ - "uri" + "name" ] }, "ImplementationGuide_Global": { @@ -62790,7 +64480,7 @@ "profile" ] }, - "ImplementationGuide_Manifest": { + "ImplementationGuide_DependsOn": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -62798,112 +64488,26 @@ { "type": "object", "properties": { - "rendering": { + "uri": { "type": "string", "pattern": "\\S*", - "description": "A pointer to official web page, PDF or other rendering of the implementation guide." - }, - "resource": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImplementationGuide_Manifest_Resource", - "description": "A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resource." - } - }, - "page": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImplementationGuide_Manifest_Page", - "description": "Information about a page within the IG." - } - }, - "image": { - "type": "array", - "items": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Indicates a relative path to an image that exists within the IG." - } + "description": "A canonical reference to the Implementation guide for the dependency." }, - "other": { - "type": "array", - "items": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IG." - } - } - } - } - ], - "required": [ - "resource" - ] - }, - "ImplementationGuide_Manifest_Page": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "name": { + "packageId": { "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Relative path to the page." + "pattern": "[A-Za-z0-9\\-\\.]{1,64}", + "description": "The NPM package name for the Implementation Guide that this IG depends on." }, - "title": { + "version": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc." - }, - "anchor": { - "type": "array", - "items": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The name of an anchor available on the page." - } - } - } - } - ], - "required": [ - "name" - ] - }, - "ImplementationGuide_Manifest_Resource": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "reference": { - "$ref": "#/components/schemas/Reference", - "description": "Where this resource is found." - }, - "exampleBoolean": { - "type": "boolean", - "description": "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile." - }, - "exampleCanonical": { - "type": "string", - "pattern": "\\S*", - "description": "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile." - }, - "relativePath": { - "type": "string", - "pattern": "\\S*", - "description": "The relative path for primary page for this resource within the IG." + "description": "The version of the IG that is depended on, when the correct version is required to understand the IG correctly." } } } ], "required": [ - "reference" + "uri" ] }, "InsurancePlan": { @@ -63007,9 +64611,19 @@ } } } - ] + ], + "example": { + "resourceType": "InsurancePlan", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, - "InsurancePlan_Contact": { + "InsurancePlan_Plan": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -63017,30 +64631,50 @@ { "type": "object", "properties": { - "purpose": { + "identifier": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Identifier", + "description": "Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server." + } + }, + "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Indicates a purpose for which the contact can be reached." + "description": "Type of plan. For example, \"Platinum\" or \"High Deductable\"." }, - "name": { - "$ref": "#/components/schemas/HumanName", - "description": "A name associated with the contact." + "coverageArea": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reference", + "description": "The geographic region in which a health insurance plan's benefits apply." + } }, - "telecom": { + "network": { "type": "array", "items": { - "$ref": "#/components/schemas/ContactPoint", - "description": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted." + "$ref": "#/components/schemas/Reference", + "description": "Reference to the network that providing the type of coverage." } }, - "address": { - "$ref": "#/components/schemas/Address", - "description": "Visiting or postal addresses for the contact." + "generalCost": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InsurancePlan_Plan_GeneralCost", + "description": "Overall costs associated with the plan." + } + }, + "specificCost": { + "type": "array", + "items": { + "$ref": "#/components/schemas/InsurancePlan_Plan_SpecificCost", + "description": "Costs associated with the coverage provided by the product." + } } } } ] }, - "InsurancePlan_Coverage": { + "InsurancePlan_Plan_SpecificCost": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -63048,33 +64682,25 @@ { "type": "object", "properties": { - "type": { + "category": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health)." - }, - "network": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reference", - "description": "Reference to the network that providing the type of coverage." - } + "description": "General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health)." }, "benefit": { "type": "array", "items": { - "$ref": "#/components/schemas/InsurancePlan_Coverage_Benefit", - "description": "Specific benefits under this type of coverage." + "$ref": "#/components/schemas/InsurancePlan_Plan_SpecificCost_Benefit", + "description": "List of the specific benefits under this category of benefit." } } } } ], "required": [ - "type", - "benefit" + "category" ] }, - "InsurancePlan_Coverage_Benefit": { + "InsurancePlan_Plan_SpecificCost_Benefit": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -63086,16 +64712,11 @@ "$ref": "#/components/schemas/CodeableConcept", "description": "Type of benefit (primary care; speciality care; inpatient; outpatient)." }, - "requirement": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The referral requirements to have access/coverage for this benefit." - }, - "limit": { + "cost": { "type": "array", "items": { - "$ref": "#/components/schemas/InsurancePlan_Coverage_Benefit_Limit", - "description": "The specific limits on the benefit." + "$ref": "#/components/schemas/InsurancePlan_Plan_SpecificCost_Benefit_Cost", + "description": "List of the costs associated with a specific benefit." } } } @@ -63105,7 +64726,7 @@ "type" ] }, - "InsurancePlan_Coverage_Benefit_Limit": { + "InsurancePlan_Plan_SpecificCost_Benefit_Cost": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -63113,19 +64734,33 @@ { "type": "object", "properties": { - "value": { - "$ref": "#/components/schemas/Quantity", - "description": "The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses." + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Type of cost (copay; individual cap; family cap; coinsurance; deductible)." }, - "code": { + "applicability": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The specific limit on the benefit." + "description": "Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other)." + }, + "qualifiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA)." + } + }, + "value": { + "$ref": "#/components/schemas/Quantity", + "description": "The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance)." } } } + ], + "required": [ + "type" ] }, - "InsurancePlan_Plan": { + "InsurancePlan_Plan_GeneralCost": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -63133,65 +64768,14 @@ { "type": "object", "properties": { - "identifier": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Identifier", - "description": "Business identifiers assigned to this health insurance plan which remain constant as the resource is updated and propagates from server to server." - } - }, "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Type of plan. For example, \"Platinum\" or \"High Deductable\"." + "description": "Type of cost." }, - "coverageArea": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reference", - "description": "The geographic region in which a health insurance plan's benefits apply." - } - }, - "network": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reference", - "description": "Reference to the network that providing the type of coverage." - } - }, - "generalCost": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InsurancePlan_Plan_GeneralCost", - "description": "Overall costs associated with the plan." - } - }, - "specificCost": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InsurancePlan_Plan_SpecificCost", - "description": "Costs associated with the coverage provided by the product." - } - } - } - } - ] - }, - "InsurancePlan_Plan_GeneralCost": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Type of cost." - }, - "groupSize": { - "type": "integer", - "format": "int32", - "description": "Number of participants enrolled in the plan." + "groupSize": { + "type": "integer", + "format": "int32", + "description": "Number of participants enrolled in the plan." }, "cost": { "$ref": "#/components/schemas/Money", @@ -63206,7 +64790,7 @@ } ] }, - "InsurancePlan_Plan_SpecificCost": { + "InsurancePlan_Coverage": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -63214,25 +64798,33 @@ { "type": "object", "properties": { - "category": { + "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "General category of benefit (Medical; Dental; Vision; Drug; Mental Health; Substance Abuse; Hospice, Home Health)." + "description": "Type of coverage (Medical; Dental; Mental Health; Substance Abuse; Vision; Drug; Short Term; Long Term Care; Hospice; Home Health)." + }, + "network": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to the network that providing the type of coverage." + } }, "benefit": { "type": "array", "items": { - "$ref": "#/components/schemas/InsurancePlan_Plan_SpecificCost_Benefit", - "description": "List of the specific benefits under this category of benefit." + "$ref": "#/components/schemas/InsurancePlan_Coverage_Benefit", + "description": "Specific benefits under this type of coverage." } } } } ], "required": [ - "category" + "type", + "benefit" ] }, - "InsurancePlan_Plan_SpecificCost_Benefit": { + "InsurancePlan_Coverage_Benefit": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -63244,11 +64836,16 @@ "$ref": "#/components/schemas/CodeableConcept", "description": "Type of benefit (primary care; speciality care; inpatient; outpatient)." }, - "cost": { + "requirement": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The referral requirements to have access/coverage for this benefit." + }, + "limit": { "type": "array", "items": { - "$ref": "#/components/schemas/InsurancePlan_Plan_SpecificCost_Benefit_Cost", - "description": "List of the costs associated with a specific benefit." + "$ref": "#/components/schemas/InsurancePlan_Coverage_Benefit_Limit", + "description": "The specific limits on the benefit." } } } @@ -63258,7 +64855,7 @@ "type" ] }, - "InsurancePlan_Plan_SpecificCost_Benefit_Cost": { + "InsurancePlan_Coverage_Benefit_Limit": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -63266,30 +64863,47 @@ { "type": "object", "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Type of cost (copay; individual cap; family cap; coinsurance; deductible)." + "value": { + "$ref": "#/components/schemas/Quantity", + "description": "The maximum amount of a service item a plan will pay for a covered benefit. For examples. wellness visits, or eyeglasses." }, - "applicability": { + "code": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Whether the cost applies to in-network or out-of-network providers (in-network; out-of-network; other)." + "description": "The specific limit on the benefit." + } + } + } + ] + }, + "InsurancePlan_Contact": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "purpose": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Indicates a purpose for which the contact can be reached." }, - "qualifiers": { + "name": { + "$ref": "#/components/schemas/HumanName", + "description": "A name associated with the contact." + }, + "telecom": { "type": "array", "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Additional information about the cost, such as information about funding sources (e.g. HSA, HRA, FSA, RRA)." + "$ref": "#/components/schemas/ContactPoint", + "description": "A contact detail (e.g. a telephone number or an email address) by which the party may be contacted." } }, - "value": { - "$ref": "#/components/schemas/Quantity", - "description": "The actual cost value. (some of the costs may be represented as percentages rather than currency, e.g. 10% coinsurance)." + "address": { + "$ref": "#/components/schemas/Address", + "description": "Visiting or postal addresses for the contact." } } } - ], - "required": [ - "type" ] }, "Invoice": { @@ -63394,7 +65008,25 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "Invoice", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Invoice_LineItem": { "allOf": [ @@ -63690,7 +65322,33 @@ "required": [ "status", "type" - ] + ], + "example": { + "resourceType": "Library", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Linkage": { "allOf": [ @@ -63720,7 +65378,37 @@ ], "required": [ "item" - ] + ], + "example": { + "resourceType": "Linkage", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "item": [ + { + "_type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "resource": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } }, "Linkage_Item": { "allOf": [ @@ -63838,7 +65526,33 @@ "required": [ "status", "mode" - ] + ], + "example": { + "resourceType": "List", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_mode": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "List_Entry": { "allOf": [ @@ -63981,7 +65695,17 @@ } } } - ] + ], + "example": { + "resourceType": "Location", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "Location_HoursOfOperation": { "allOf": [ @@ -64306,9 +66030,27 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "Measure", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, - "Measure_Group": { + "Measure_SupplementalData": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -64318,32 +66060,32 @@ "properties": { "code": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures." - }, - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The human readable description of this population group." + "description": "Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures." }, - "population": { + "usage": { "type": "array", "items": { - "$ref": "#/components/schemas/Measure_Group_Population", - "description": "A population criteria for the measure." + "$ref": "#/components/schemas/CodeableConcept", + "description": "An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation." } }, - "stratifier": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Measure_Group_Stratifier", - "description": "The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path." - } + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The human readable description of this supplemental data." + }, + "criteria": { + "$ref": "#/components/schemas/Expression", + "description": "The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element." } } } + ], + "required": [ + "criteria" ] }, - "Measure_Group_Population": { + "Measure_Group": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -64353,22 +66095,29 @@ "properties": { "code": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The type of population criteria." + "description": "Indicates a meaning for the group. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing groups to be correlated across measures." }, "description": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The human readable description of this population criteria." + "description": "The human readable description of this population group." }, - "criteria": { - "$ref": "#/components/schemas/Expression", - "description": "An expression that specifies the criteria for the population, typically the name of an expression in a library." + "population": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Measure_Group_Population", + "description": "A population criteria for the measure." + } + }, + "stratifier": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Measure_Group_Stratifier", + "description": "The stratifier criteria for the measure report, specified as either the name of a valid CQL expression defined within a referenced library or a valid FHIR Resource Path." + } } } } - ], - "required": [ - "criteria" ] }, "Measure_Group_Stratifier": { @@ -64431,7 +66180,7 @@ "criteria" ] }, - "Measure_SupplementalData": { + "Measure_Group_Population": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -64441,23 +66190,16 @@ "properties": { "code": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Indicates a meaning for the supplemental data. This can be as simple as a unique identifier, or it can establish meaning in a broader context by drawing from a terminology, allowing supplemental data to be correlated across measures." - }, - "usage": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "An indicator of the intended usage for the supplemental data element. Supplemental data indicates the data is additional information requested to augment the measure information. Risk adjustment factor indicates the data is additional information used to calculate risk adjustment factors when applying a risk model to the measure calculation." - } + "description": "The type of population criteria." }, "description": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The human readable description of this supplemental data." + "description": "The human readable description of this population criteria." }, "criteria": { "$ref": "#/components/schemas/Expression", - "description": "The criteria for the supplemental data. This is typically the name of a valid expression defined within a referenced library, but it may also be a path to a specific data element. The criteria defines the data to be returned for this element." + "description": "An expression that specifies the criteria for the population, typically the name of an expression in a library." } } } @@ -64548,7 +66290,49 @@ "type", "measure", "period" - ] + ], + "example": { + "resourceType": "MeasureReport", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_measure": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "period": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "MeasureReport_Group": { "allOf": [ @@ -64584,31 +66368,6 @@ } ] }, - "MeasureReport_Group_Population": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "code": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The type of the population." - }, - "count": { - "type": "integer", - "format": "int32", - "description": "The number of members of the population." - }, - "subjectResults": { - "$ref": "#/components/schemas/Reference", - "description": "This element refers to a List of subject level MeasureReport resources, one for each subject in this population." - } - } - } - ] - }, "MeasureReport_Group_Stratifier": { "allOf": [ { @@ -64669,6 +66428,31 @@ } ] }, + "MeasureReport_Group_Stratifier_Stratum_Population": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The type of the population." + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of members of the population." + }, + "subjectResults": { + "$ref": "#/components/schemas/Reference", + "description": "This element refers to a List of subject level MeasureReport resources, one for each subject in this population." + } + } + } + ] + }, "MeasureReport_Group_Stratifier_Stratum_Component": { "allOf": [ { @@ -64693,7 +66477,7 @@ "value" ] }, - "MeasureReport_Group_Stratifier_Stratum_Population": { + "MeasureReport_Group_Population": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -64855,7 +66639,33 @@ "required": [ "status", "content" - ] + ], + "example": { + "resourceType": "Media", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "content": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Medication": { "allOf": [ @@ -64910,7 +66720,17 @@ } } } - ] + ], + "example": { + "resourceType": "Medication", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "Medication_Batch": { "allOf": [ @@ -65104,7 +66924,49 @@ "required": [ "status", "subject" - ] + ], + "example": { + "resourceType": "MedicationAdministration", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "medicationCodeableConcept": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_effectiveDateTime": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "MedicationAdministration_Dosage": { "allOf": [ @@ -65330,30 +67192,33 @@ ], "required": [ "status" - ] - }, - "MedicationDispense_Performer": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "MedicationDispense", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "function": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker." - }, - "actor": { - "$ref": "#/components/schemas/Reference", - "description": "The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication." + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - } + ] + }, + "medicationCodeableConcept": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } - ], - "required": [ - "actor" - ] + } }, "MedicationDispense_Substitution": { "allOf": [ @@ -65392,6 +67257,29 @@ "wasSubstituted" ] }, + "MedicationDispense_Performer": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "function": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Distinguishes the type of performer in the dispense. For example, date enterer, packager, final checker." + }, + "actor": { + "$ref": "#/components/schemas/Reference", + "description": "The device, practitioner, etc. who performed the action. It should be assumed that the actor is the dispenser of the medication." + } + } + } + ], + "required": [ + "actor" + ] + }, "MedicationKnowledge": { "allOf": [ { @@ -65542,9 +67430,19 @@ } } } - ] + ], + "example": { + "resourceType": "MedicationKnowledge", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, - "MedicationKnowledge_AdministrationGuidelines": { + "MedicationKnowledge_Kinetics": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65552,33 +67450,29 @@ { "type": "object", "properties": { - "dosage": { + "areaUnderCurve": { "type": "array", "items": { - "$ref": "#/components/schemas/MedicationKnowledge_AdministrationGuidelines_Dosage", - "description": "Dosage for the medication for the specific guidelines." + "$ref": "#/components/schemas/SimpleQuantity", + "description": "The drug concentration measured at certain discrete points in time." } }, - "indicationCodeableConcept": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Indication for use that apply to the specific administration guidelines." - }, - "indicationReference": { - "$ref": "#/components/schemas/Reference", - "description": "Indication for use that apply to the specific administration guidelines." - }, - "patientCharacteristics": { + "lethalDose50": { "type": "array", "items": { - "$ref": "#/components/schemas/MedicationKnowledge_AdministrationGuidelines_PatientCharacteristics", - "description": "Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.)." + "$ref": "#/components/schemas/SimpleQuantity", + "description": "The median lethal dose of a drug." } + }, + "halfLifePeriod": { + "$ref": "#/components/schemas/Duration", + "description": "The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half." } } } ] }, - "MedicationKnowledge_AdministrationGuidelines_Dosage": { + "MedicationKnowledge_Regulatory": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65586,26 +67480,36 @@ { "type": "object", "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.)." + "regulatoryAuthority": { + "$ref": "#/components/schemas/Reference", + "description": "The authority that is specifying the regulations." }, - "dosage": { + "substitution": { "type": "array", "items": { - "$ref": "#/components/schemas/Dosage", - "description": "Dosage for the medication for the specific guidelines." + "$ref": "#/components/schemas/MedicationKnowledge_Regulatory_Substitution", + "description": "Specifies if changes are allowed when dispensing a medication from a regulatory perspective." + } + }, + "schedule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MedicationKnowledge_Regulatory_Schedule", + "description": "Specifies the schedule of a medication in jurisdiction." } + }, + "maxDispense": { + "$ref": "#/components/schemas/MedicationKnowledge_Regulatory_MaxDispense", + "description": "The maximum number of units of the medication that can be dispensed in a period." } } } ], "required": [ - "type", - "dosage" + "regulatoryAuthority" ] }, - "MedicationKnowledge_AdministrationGuidelines_PatientCharacteristics": { + "MedicationKnowledge_Regulatory_MaxDispense": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65613,27 +67517,41 @@ { "type": "object", "properties": { - "characteristicCodeableConcept": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender)." - }, - "characteristicQuantity": { + "quantity": { "$ref": "#/components/schemas/SimpleQuantity", - "description": "Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender)." + "description": "The maximum number of units of the medication that can be dispensed." }, - "value": { - "type": "array", - "items": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The specific characteristic (e.g. height, weight, gender, etc.)." - } + "period": { + "$ref": "#/components/schemas/Duration", + "description": "The period that applies to the maximum number of units." } } } + ], + "required": [ + "quantity" ] }, - "MedicationKnowledge_Cost": { + "MedicationKnowledge_Regulatory_Schedule": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "schedule": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Specifies the specific drug schedule." + } + } + } + ], + "required": [ + "schedule" + ] + }, + "MedicationKnowledge_Regulatory_Substitution": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65643,23 +67561,18 @@ "properties": { "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost." - }, - "source": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The source or owner that assigns the price to the medication." + "description": "Specifies the type of substitution allowed." }, - "cost": { - "$ref": "#/components/schemas/Money", - "description": "The price of the medication." + "allowed": { + "type": "boolean", + "description": "Specifies if regulation allows for changes in the medication when dispensing." } } } ], "required": [ "type", - "cost" + "allowed" ] }, "MedicationKnowledge_DrugCharacteristic": { @@ -65696,7 +67609,7 @@ } ] }, - "MedicationKnowledge_Ingredient": { + "MedicationKnowledge_Packaging": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65704,51 +67617,13 @@ { "type": "object", "properties": { - "itemCodeableConcept": { + "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The actual ingredient - either a substance (simple ingredient) or another medication." - }, - "itemReference": { - "$ref": "#/components/schemas/Reference", - "description": "The actual ingredient - either a substance (simple ingredient) or another medication." - }, - "isActive": { - "type": "boolean", - "description": "Indication of whether this ingredient affects the therapeutic action of the drug." - }, - "strength": { - "$ref": "#/components/schemas/Ratio", - "description": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet." - } - } - } - ] - }, - "MedicationKnowledge_Kinetics": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "areaUnderCurve": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SimpleQuantity", - "description": "The drug concentration measured at certain discrete points in time." - } - }, - "lethalDose50": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SimpleQuantity", - "description": "The median lethal dose of a drug." - } + "description": "A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle)." }, - "halfLifePeriod": { - "$ref": "#/components/schemas/Duration", - "description": "The time required for any specified property (e.g., the concentration of a substance in the body) to decrease by half." + "quantity": { + "$ref": "#/components/schemas/SimpleQuantity", + "description": "The number of product units the package would contain if fully loaded." } } } @@ -65780,7 +67655,7 @@ "type" ] }, - "MedicationKnowledge_MonitoringProgram": { + "MedicationKnowledge_AdministrationGuidelines": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65788,20 +67663,33 @@ { "type": "object", "properties": { - "type": { + "dosage": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MedicationKnowledge_AdministrationGuidelines_Dosage", + "description": "Dosage for the medication for the specific guidelines." + } + }, + "indicationCodeableConcept": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Type of program under which the medication is monitored." + "description": "Indication for use that apply to the specific administration guidelines." }, - "name": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Name of the reviewing program." + "indicationReference": { + "$ref": "#/components/schemas/Reference", + "description": "Indication for use that apply to the specific administration guidelines." + }, + "patientCharacteristics": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MedicationKnowledge_AdministrationGuidelines_PatientCharacteristics", + "description": "Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.)." + } } } } ] }, - "MedicationKnowledge_Monograph": { + "MedicationKnowledge_AdministrationGuidelines_PatientCharacteristics": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65809,19 +67697,27 @@ { "type": "object", "properties": { - "type": { + "characteristicCodeableConcept": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The category of documentation about the medication. (e.g. professional monograph, patient education monograph)." + "description": "Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender)." }, - "source": { - "$ref": "#/components/schemas/Reference", - "description": "Associated documentation about the medication." + "characteristicQuantity": { + "$ref": "#/components/schemas/SimpleQuantity", + "description": "Specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender)." + }, + "value": { + "type": "array", + "items": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The specific characteristic (e.g. height, weight, gender, etc.)." + } } } } ] }, - "MedicationKnowledge_Packaging": { + "MedicationKnowledge_AdministrationGuidelines_Dosage": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65831,17 +67727,24 @@ "properties": { "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "A code that defines the specific type of packaging that the medication can be found in (e.g. blister sleeve, tube, bottle)." + "description": "The type of dosage (for example, prophylaxis, maintenance, therapeutic, etc.)." }, - "quantity": { - "$ref": "#/components/schemas/SimpleQuantity", - "description": "The number of product units the package would contain if fully loaded." + "dosage": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Dosage", + "description": "Dosage for the medication for the specific guidelines." + } } } } + ], + "required": [ + "type", + "dosage" ] }, - "MedicationKnowledge_Regulatory": { + "MedicationKnowledge_MonitoringProgram": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65849,36 +67752,20 @@ { "type": "object", "properties": { - "regulatoryAuthority": { - "$ref": "#/components/schemas/Reference", - "description": "The authority that is specifying the regulations." - }, - "substitution": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MedicationKnowledge_Regulatory_Substitution", - "description": "Specifies if changes are allowed when dispensing a medication from a regulatory perspective." - } - }, - "schedule": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MedicationKnowledge_Regulatory_Schedule", - "description": "Specifies the schedule of a medication in jurisdiction." - } + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Type of program under which the medication is monitored." }, - "maxDispense": { - "$ref": "#/components/schemas/MedicationKnowledge_Regulatory_MaxDispense", - "description": "The maximum number of units of the medication that can be dispensed in a period." + "name": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Name of the reviewing program." } } } - ], - "required": [ - "regulatoryAuthority" ] }, - "MedicationKnowledge_Regulatory_MaxDispense": { + "MedicationKnowledge_Cost": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65886,22 +67773,28 @@ { "type": "object", "properties": { - "quantity": { - "$ref": "#/components/schemas/SimpleQuantity", - "description": "The maximum number of units of the medication that can be dispensed." + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost." }, - "period": { - "$ref": "#/components/schemas/Duration", - "description": "The period that applies to the maximum number of units." + "source": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The source or owner that assigns the price to the medication." + }, + "cost": { + "$ref": "#/components/schemas/Money", + "description": "The price of the medication." } } } ], "required": [ - "quantity" + "type", + "cost" ] }, - "MedicationKnowledge_Regulatory_Schedule": { + "MedicationKnowledge_Ingredient": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65909,18 +67802,27 @@ { "type": "object", "properties": { - "schedule": { + "itemCodeableConcept": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Specifies the specific drug schedule." + "description": "The actual ingredient - either a substance (simple ingredient) or another medication." + }, + "itemReference": { + "$ref": "#/components/schemas/Reference", + "description": "The actual ingredient - either a substance (simple ingredient) or another medication." + }, + "isActive": { + "type": "boolean", + "description": "Indication of whether this ingredient affects the therapeutic action of the drug." + }, + "strength": { + "$ref": "#/components/schemas/Ratio", + "description": "Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet." } } } - ], - "required": [ - "schedule" ] }, - "MedicationKnowledge_Regulatory_Substitution": { + "MedicationKnowledge_Monograph": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -65930,18 +67832,14 @@ "properties": { "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Specifies the type of substitution allowed." + "description": "The category of documentation about the medication. (e.g. professional monograph, patient education monograph)." }, - "allowed": { - "type": "boolean", - "description": "Specifies if regulation allows for changes in the medication when dispensing." + "source": { + "$ref": "#/components/schemas/Reference", + "description": "Associated documentation about the medication." } } } - ], - "required": [ - "type", - "allowed" ] }, "MedicationKnowledge_RelatedMedicationKnowledge": { @@ -66190,6 +68088,72 @@ "status", "intent", "subject" + ], + "example": { + "resourceType": "MedicationRequest", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_intent": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "medicationCodeableConcept": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + }, + "MedicationRequest_Substitution": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "allowedBoolean": { + "type": "boolean", + "description": "True if the prescriber allows a different drug to be dispensed from what was prescribed." + }, + "allowedCodeableConcept": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "True if the prescriber allows a different drug to be dispensed from what was prescribed." + }, + "reason": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Indicates the reason for the substitution, or why substitution must or must not be performed." + } + } + } ] }, "MedicationRequest_DispenseRequest": { @@ -66253,30 +68217,6 @@ } ] }, - "MedicationRequest_Substitution": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "allowedBoolean": { - "type": "boolean", - "description": "True if the prescriber allows a different drug to be dispensed from what was prescribed." - }, - "allowedCodeableConcept": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "True if the prescriber allows a different drug to be dispensed from what was prescribed." - }, - "reason": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Indicates the reason for the substitution, or why substitution must or must not be performed." - } - } - } - ] - }, "MedicationStatement": { "allOf": [ { @@ -66406,7 +68346,41 @@ "required": [ "status", "subject" - ] + ], + "example": { + "resourceType": "MedicationStatement", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "medicationCodeableConcept": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "MedicinalProduct": { "allOf": [ @@ -66544,6 +68518,76 @@ ], "required": [ "name" + ], + "example": { + "resourceType": "MedicinalProduct", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "name": [ + { + "_productName": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } + }, + "MedicinalProduct_SpecialDesignation": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "identifier": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Identifier", + "description": "Identifier for the designation, or procedure number." + } + }, + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The type of special designation, e.g. orphan drug, minor use." + }, + "intendedUse": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The intended use of the product, e.g. prevention, treatment." + }, + "indicationCodeableConcept": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Condition for which the medicinal use applies." + }, + "indicationReference": { + "$ref": "#/components/schemas/Reference", + "description": "Condition for which the medicinal use applies." + }, + "status": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "For example granted, pending, expired or withdrawn." + }, + "date": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", + "description": "Date when the designation was granted." + }, + "species": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Animal species for which this applies." + } + } + } ] }, "MedicinalProduct_ManufacturingBusinessOperation": { @@ -66673,54 +68717,6 @@ "type" ] }, - "MedicinalProduct_SpecialDesignation": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "identifier": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Identifier", - "description": "Identifier for the designation, or procedure number." - } - }, - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The type of special designation, e.g. orphan drug, minor use." - }, - "intendedUse": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The intended use of the product, e.g. prevention, treatment." - }, - "indicationCodeableConcept": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Condition for which the medicinal use applies." - }, - "indicationReference": { - "$ref": "#/components/schemas/Reference", - "description": "Condition for which the medicinal use applies." - }, - "status": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "For example granted, pending, expired or withdrawn." - }, - "date": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "Date when the designation was granted." - }, - "species": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Animal species for which this applies." - } - } - } - ] - }, "MedicinalProductAuthorization": { "allOf": [ { @@ -66811,45 +68807,17 @@ } } } - ] - }, - "MedicinalProductAuthorization_JurisdictionalAuthorization": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "identifier": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Identifier", - "description": "The assigned number for the marketing authorization." - } - }, - "country": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Country of authorization." - }, - "jurisdiction": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Jurisdiction within a country." - } - }, - "legalStatusOfSupply": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The legal status of supply in a jurisdiction or region." - }, - "validityPeriod": { - "$ref": "#/components/schemas/Period", - "description": "The start and expected end date of the authorization." + ], + "example": { + "resourceType": "MedicinalProductAuthorization", + "meta": { + "tag": [ + { + "code": "ibm/minimal" } - } + ] } - ] + } }, "MedicinalProductAuthorization_Procedure": { "allOf": [ @@ -66890,89 +68858,45 @@ "type" ] }, - "MedicinalProductContraindication": { + "MedicinalProductAuthorization_JurisdictionalAuthorization": { "allOf": [ { - "$ref": "#/components/schemas/DomainResource" + "$ref": "#/components/schemas/BackboneElement" }, { "type": "object", "properties": { - "subject": { + "identifier": { "type": "array", "items": { - "$ref": "#/components/schemas/Reference", - "description": "The medication for which this is an indication." + "$ref": "#/components/schemas/Identifier", + "description": "The assigned number for the marketing authorization." } }, - "disease": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The disease, symptom or procedure for the contraindication." - }, - "diseaseStatus": { + "country": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The status of the disease or symptom for the contraindication." + "description": "Country of authorization." }, - "comorbidity": { + "jurisdiction": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept", - "description": "A comorbidity (concurrent condition) or coinfection." - } - }, - "therapeuticIndication": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reference", - "description": "Information about the use of the medicinal product in relation to other therapies as part of the indication." - } - }, - "otherTherapy": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MedicinalProductContraindication_OtherTherapy", - "description": "Information about the use of the medicinal product in relation to other therapies described as part of the indication." + "description": "Jurisdiction within a country." } }, - "population": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Population", - "description": "The population group to which this applies." - } - } - } - } - ] - }, - "MedicinalProductContraindication_OtherTherapy": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "therapyRelationshipType": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The type of relationship between the medicinal product indication or contraindication and another therapy." - }, - "medicationCodeableConcept": { + "legalStatusOfSupply": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication." + "description": "The legal status of supply in a jurisdiction or region." }, - "medicationReference": { - "$ref": "#/components/schemas/Reference", - "description": "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication." + "validityPeriod": { + "$ref": "#/components/schemas/Period", + "description": "The start and expected end date of the authorization." } } } - ], - "required": [ - "therapyRelationshipType" ] }, - "MedicinalProductIndication": { + "MedicinalProductContraindication": { "allOf": [ { "$ref": "#/components/schemas/DomainResource" @@ -66987,41 +68911,33 @@ "description": "The medication for which this is an indication." } }, - "diseaseSymptomProcedure": { + "disease": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The disease, symptom or procedure that is the indication for treatment." + "description": "The disease, symptom or procedure for the contraindication." }, "diseaseStatus": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The status of the disease or symptom for which the indication applies." + "description": "The status of the disease or symptom for the contraindication." }, "comorbidity": { "type": "array", "items": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Comorbidity (concurrent condition) or co-infection as part of the indication." + "description": "A comorbidity (concurrent condition) or coinfection." } }, - "intendedEffect": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The intended effect, aim or strategy to be achieved by the indication." - }, - "duration": { - "$ref": "#/components/schemas/Quantity", - "description": "Timing or duration information as part of the indication." - }, - "otherTherapy": { + "therapeuticIndication": { "type": "array", "items": { - "$ref": "#/components/schemas/MedicinalProductIndication_OtherTherapy", - "description": "Information about the use of the medicinal product in relation to other therapies described as part of the indication." + "$ref": "#/components/schemas/Reference", + "description": "Information about the use of the medicinal product in relation to other therapies as part of the indication." } }, - "undesirableEffect": { + "otherTherapy": { "type": "array", "items": { - "$ref": "#/components/schemas/Reference", - "description": "Describe the undesirable effects of the medicinal product." + "$ref": "#/components/schemas/MedicinalProductContraindication_OtherTherapy", + "description": "Information about the use of the medicinal product in relation to other therapies described as part of the indication." } }, "population": { @@ -67033,9 +68949,119 @@ } } } - ] + ], + "example": { + "resourceType": "MedicinalProductContraindication", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, - "MedicinalProductIndication_OtherTherapy": { + "MedicinalProductContraindication_OtherTherapy": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "therapyRelationshipType": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The type of relationship between the medicinal product indication or contraindication and another therapy." + }, + "medicationCodeableConcept": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication." + }, + "medicationReference": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to a specific medication (active substance, medicinal product or class of products) as part of an indication or contraindication." + } + } + } + ], + "required": [ + "therapyRelationshipType" + ] + }, + "MedicinalProductIndication": { + "allOf": [ + { + "$ref": "#/components/schemas/DomainResource" + }, + { + "type": "object", + "properties": { + "subject": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reference", + "description": "The medication for which this is an indication." + } + }, + "diseaseSymptomProcedure": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The disease, symptom or procedure that is the indication for treatment." + }, + "diseaseStatus": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The status of the disease or symptom for which the indication applies." + }, + "comorbidity": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Comorbidity (concurrent condition) or co-infection as part of the indication." + } + }, + "intendedEffect": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The intended effect, aim or strategy to be achieved by the indication." + }, + "duration": { + "$ref": "#/components/schemas/Quantity", + "description": "Timing or duration information as part of the indication." + }, + "otherTherapy": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MedicinalProductIndication_OtherTherapy", + "description": "Information about the use of the medicinal product in relation to other therapies described as part of the indication." + } + }, + "undesirableEffect": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reference", + "description": "Describe the undesirable effects of the medicinal product." + } + }, + "population": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Population", + "description": "The population group to which this applies." + } + } + } + } + ], + "example": { + "resourceType": "MedicinalProductIndication", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } + }, + "MedicinalProductIndication_OtherTherapy": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -67105,6 +69131,50 @@ ], "required": [ "role" + ], + "example": { + "resourceType": "MedicinalProductIngredient", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "role": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + }, + "MedicinalProductIngredient_Substance": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The ingredient substance." + }, + "strength": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MedicinalProductIngredient_SpecifiedSubstance_Strength", + "description": "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product." + } + } + } + } + ], + "required": [ + "code" ] }, "MedicinalProductIngredient_SpecifiedSubstance": { @@ -67231,32 +69301,6 @@ "strength" ] }, - "MedicinalProductIngredient_Substance": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "code": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The ingredient substance." - }, - "strength": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MedicinalProductIngredient_SpecifiedSubstance_Strength", - "description": "Quantity of the substance or specified substance present in the manufactured item or pharmaceutical product." - } - } - } - } - ], - "required": [ - "code" - ] - }, "MedicinalProductInteraction": { "allOf": [ { @@ -67302,7 +69346,17 @@ } } } - ] + ], + "example": { + "resourceType": "MedicinalProductInteraction", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "MedicinalProductInteraction_Interactant": { "allOf": [ @@ -67375,7 +69429,33 @@ "required": [ "manufacturedDoseForm", "quantity" - ] + ], + "example": { + "resourceType": "MedicinalProductManufactured", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "manufacturedDoseForm": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "quantity": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "MedicinalProductPackaged": { "allOf": [ @@ -67445,30 +69525,37 @@ ], "required": [ "packageItem" - ] - }, - "MedicinalProductPackaged_BatchIdentifier": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "MedicinalProductPackaged", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "outerPackaging": { - "$ref": "#/components/schemas/Identifier", - "description": "A number appearing on the outer packaging of a specific batch." + "packageItem": [ + { + "type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] }, - "immediatePackaging": { - "$ref": "#/components/schemas/Identifier", - "description": "A number appearing on the immediate packaging (and not the outer packaging)." + "quantity": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } } - } - ], - "required": [ - "outerPackaging" - ] + ] + } }, "MedicinalProductPackaged_PackageItem": { "allOf": [ @@ -67561,6 +69648,29 @@ "quantity" ] }, + "MedicinalProductPackaged_BatchIdentifier": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "outerPackaging": { + "$ref": "#/components/schemas/Identifier", + "description": "A number appearing on the outer packaging of a specific batch." + }, + "immediatePackaging": { + "$ref": "#/components/schemas/Identifier", + "description": "A number appearing on the immediate packaging (and not the outer packaging)." + } + } + } + ], + "required": [ + "outerPackaging" + ] + }, "MedicinalProductPharmaceutical": { "allOf": [ { @@ -67618,30 +69728,37 @@ "required": [ "administrableDoseForm", "routeOfAdministration" - ] - }, - "MedicinalProductPharmaceutical_Characteristics": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "MedicinalProductPharmaceutical", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { + "administrableDoseForm": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "routeOfAdministration": [ + { "code": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A coded characteristic." - }, - "status": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The status of characteristic e.g. assigned or pending." + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } } - } - ], - "required": [ - "code" - ] + ] + } }, "MedicinalProductPharmaceutical_RouteOfAdministration": { "allOf": [ @@ -67744,6 +69861,29 @@ "value" ] }, + "MedicinalProductPharmaceutical_Characteristics": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "code": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A coded characteristic." + }, + "status": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The status of characteristic e.g. assigned or pending." + } + } + } + ], + "required": [ + "code" + ] + }, "MedicinalProductUndesirableEffect": { "allOf": [ { @@ -67780,7 +69920,17 @@ } } } - ] + ], + "example": { + "resourceType": "MedicinalProductUndesirableEffect", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "MessageDefinition": { "allOf": [ @@ -67954,7 +70104,41 @@ "required": [ "status", "date" - ] + ], + "example": { + "resourceType": "MessageDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_date": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "eventCoding": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "MessageDefinition_AllowedResponse": { "allOf": [ @@ -68235,40 +70419,35 @@ ], "required": [ "source" - ] - }, - "MessageHeader_Destination": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "MessageHeader", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Human-readable name for the target system." - }, - "target": { - "$ref": "#/components/schemas/Reference", - "description": "Identifies the target end system in situations where the initial message transmission is to an intermediary system." - }, - "endpoint": { - "type": "string", - "pattern": "\\S*", - "description": "Indicates where the message should be routed to." - }, - "receiver": { - "$ref": "#/components/schemas/Reference", - "description": "Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient." + "eventCoding": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } + ] + }, + "source": { + "_endpoint": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } } - ], - "required": [ - "endpoint" - ] + } }, "MessageHeader_Response": { "allOf": [ @@ -68343,6 +70522,39 @@ "endpoint" ] }, + "MessageHeader_Destination": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Human-readable name for the target system." + }, + "target": { + "$ref": "#/components/schemas/Reference", + "description": "Identifies the target end system in situations where the initial message transmission is to an intermediary system." + }, + "endpoint": { + "type": "string", + "pattern": "\\S*", + "description": "Indicates where the message should be routed to." + }, + "receiver": { + "$ref": "#/components/schemas/Reference", + "description": "Allows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient." + } + } + } + ], + "required": [ + "endpoint" + ] + }, "MolecularSequence": { "allOf": [ { @@ -68446,6 +70658,152 @@ ], "required": [ "coordinateSystem" + ], + "example": { + "resourceType": "MolecularSequence", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_coordinateSystem": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + }, + "MolecularSequence_StructureVariant": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "variantType": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Information about chromosome structure variation DNA change type." + }, + "exact": { + "type": "boolean", + "description": "Used to indicate if the outer and inner start-end values have the same meaning." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length of the variant chromosome." + }, + "outer": { + "$ref": "#/components/schemas/MolecularSequence_StructureVariant_Outer", + "description": "Structural variant outer." + }, + "inner": { + "$ref": "#/components/schemas/MolecularSequence_StructureVariant_Inner", + "description": "Structural variant inner." + } + } + } + ] + }, + "MolecularSequence_StructureVariant_Inner": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "start": { + "type": "integer", + "format": "int32", + "description": "Structural variant inner start. If the coordinate system is either 0-based or 1-based, then start position is inclusive." + }, + "end": { + "type": "integer", + "format": "int32", + "description": "Structural variant inner end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position." + } + } + } + ] + }, + "MolecularSequence_StructureVariant_Outer": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "start": { + "type": "integer", + "format": "int32", + "description": "Structural variant outer start. If the coordinate system is either 0-based or 1-based, then start position is inclusive." + }, + "end": { + "type": "integer", + "format": "int32", + "description": "Structural variant outer end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position." + } + } + } + ] + }, + "MolecularSequence_Repository": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "directlink", + "openapi", + "login", + "oauth", + "other" + ], + "description": "Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource." + }, + "url": { + "type": "string", + "pattern": "\\S*", + "description": "URI of an external repository which contains further details about the genetics data." + }, + "name": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "URI of an external repository which contains further details about the genetics data." + }, + "datasetId": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository." + }, + "variantsetId": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository." + }, + "readsetId": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Id of the read in this external repository." + } + } + } + ], + "required": [ + "type" ] }, "MolecularSequence_Quality": { @@ -68595,6 +70953,47 @@ } ] }, + "MolecularSequence_Variant": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "start": { + "type": "integer", + "format": "int32", + "description": "Start position of the variant on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive." + }, + "end": { + "type": "integer", + "format": "int32", + "description": "End position of the variant on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position." + }, + "observedAllele": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end." + }, + "referenceAllele": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end." + }, + "cigar": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation [here](http://support.illumina.com/help/SequencingAnalysisWorkflow/Content/Vault/Informatics/Sequencing_Analysis/CASAVA/swSEQ_mCA_ExtendedCIGARFormat.htm)." + }, + "variantPointer": { + "$ref": "#/components/schemas/Reference", + "description": "A pointer to an Observation containing variant information." + } + } + } + ] + }, "MolecularSequence_ReferenceSeq": { "allOf": [ { @@ -68655,175 +71054,6 @@ } ] }, - "MolecularSequence_Repository": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "directlink", - "openapi", - "login", - "oauth", - "other" - ], - "description": "Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource." - }, - "url": { - "type": "string", - "pattern": "\\S*", - "description": "URI of an external repository which contains further details about the genetics data." - }, - "name": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "URI of an external repository which contains further details about the genetics data." - }, - "datasetId": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository." - }, - "variantsetId": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository." - }, - "readsetId": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Id of the read in this external repository." - } - } - } - ], - "required": [ - "type" - ] - }, - "MolecularSequence_StructureVariant": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "variantType": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Information about chromosome structure variation DNA change type." - }, - "exact": { - "type": "boolean", - "description": "Used to indicate if the outer and inner start-end values have the same meaning." - }, - "length": { - "type": "integer", - "format": "int32", - "description": "Length of the variant chromosome." - }, - "outer": { - "$ref": "#/components/schemas/MolecularSequence_StructureVariant_Outer", - "description": "Structural variant outer." - }, - "inner": { - "$ref": "#/components/schemas/MolecularSequence_StructureVariant_Inner", - "description": "Structural variant inner." - } - } - } - ] - }, - "MolecularSequence_StructureVariant_Inner": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "start": { - "type": "integer", - "format": "int32", - "description": "Structural variant inner start. If the coordinate system is either 0-based or 1-based, then start position is inclusive." - }, - "end": { - "type": "integer", - "format": "int32", - "description": "Structural variant inner end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position." - } - } - } - ] - }, - "MolecularSequence_StructureVariant_Outer": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "start": { - "type": "integer", - "format": "int32", - "description": "Structural variant outer start. If the coordinate system is either 0-based or 1-based, then start position is inclusive." - }, - "end": { - "type": "integer", - "format": "int32", - "description": "Structural variant outer end. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position." - } - } - } - ] - }, - "MolecularSequence_Variant": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "start": { - "type": "integer", - "format": "int32", - "description": "Start position of the variant on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive." - }, - "end": { - "type": "integer", - "format": "int32", - "description": "End position of the variant on the reference sequence. If the coordinate system is 0-based then end is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position." - }, - "observedAllele": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end." - }, - "referenceAllele": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "An allele is one of a set of coexisting sequence variants of a gene ([SO:0001023](http://www.sequenceontology.org/browser/current_svn/term/SO:0001023)). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end." - }, - "cigar": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation [here](http://support.illumina.com/help/SequencingAnalysisWorkflow/Content/Vault/Informatics/Sequencing_Analysis/CASAVA/swSEQ_mCA_ExtendedCIGARFormat.htm)." - }, - "variantPointer": { - "$ref": "#/components/schemas/Reference", - "description": "A pointer to an Observation containing variant information." - } - } - } - ] - }, "NamingSystem": { "allOf": [ { @@ -68922,7 +71152,69 @@ "kind", "date", "uniqueId" - ] + ], + "example": { + "resourceType": "NamingSystem", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_kind": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_date": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "uniqueId": [ + { + "_type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_value": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } }, "NamingSystem_UniqueId": { "allOf": [ @@ -69103,7 +71395,49 @@ "intent", "patient", "dateTime" - ] + ], + "example": { + "resourceType": "NutritionOrder", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_intent": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_dateTime": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "NutritionOrder_EnteralFormula": { "allOf": [ @@ -69187,6 +71521,43 @@ } ] }, + "NutritionOrder_Supplement": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement." + }, + "productName": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The product or brand name of the nutritional supplement such as \"Acme Protein Shake\"." + }, + "schedule": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Timing", + "description": "The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present." + } + }, + "quantity": { + "$ref": "#/components/schemas/SimpleQuantity", + "description": "The amount of the nutritional supplement to be given." + }, + "instruction": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Free text or additional instructions or information pertaining to the oral supplement." + } + } + } + ] + }, "NutritionOrder_OralDiet": { "allOf": [ { @@ -69239,26 +71610,6 @@ } ] }, - "NutritionOrder_OralDiet_Nutrient": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "modifier": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The nutrient that is being modified such as carbohydrate or sodium." - }, - "amount": { - "$ref": "#/components/schemas/SimpleQuantity", - "description": "The quantity of the specified nutrient to include in diet." - } - } - } - ] - }, "NutritionOrder_OralDiet_Texture": { "allOf": [ { @@ -69279,7 +71630,7 @@ } ] }, - "NutritionOrder_Supplement": { + "NutritionOrder_OralDiet_Nutrient": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -69287,30 +71638,13 @@ { "type": "object", "properties": { - "type": { + "modifier": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The kind of nutritional supplement product required such as a high protein or pediatric clear liquid supplement." - }, - "productName": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The product or brand name of the nutritional supplement such as \"Acme Protein Shake\"." - }, - "schedule": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Timing", - "description": "The time period and frequency at which the supplement(s) should be given. The supplement should be given for the combination of all schedules if more than one schedule is present." - } + "description": "The nutrient that is being modified such as carbohydrate or sodium." }, - "quantity": { + "amount": { "$ref": "#/components/schemas/SimpleQuantity", - "description": "The amount of the nutritional supplement to be given." - }, - "instruction": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Free text or additional instructions or information pertaining to the oral supplement." + "description": "The quantity of the specified nutrient to include in diet." } } } @@ -69531,7 +71865,33 @@ "required": [ "status", "code" - ] + ], + "example": { + "resourceType": "Observation", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "code": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Observation_Component": { "allOf": [ @@ -69749,7 +72109,25 @@ ], "required": [ "code" - ] + ], + "example": { + "resourceType": "ObservationDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "code": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "ObservationDefinition_QualifiedInterval": { "allOf": [ @@ -70153,7 +72531,73 @@ "system", "type", "instance" - ] + ], + "example": { + "resourceType": "OperationDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_kind": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_code": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_system": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_instance": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "OperationDefinition_Overload": { "allOf": [ @@ -70486,7 +72930,7 @@ "max" ] }, - "OperationDefinition_Parameter_Binding": { + "OperationDefinition_Parameter_ReferencedFrom": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -70494,30 +72938,24 @@ { "type": "object", "properties": { - "strength": { + "source": { "type": "string", - "enum": [ - "required", - "extensible", - "preferred", - "example" - ], - "description": "Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances." + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource." }, - "valueSet": { + "sourceId": { "type": "string", - "pattern": "\\S*", - "description": "Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used." + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The id of the element in the referencing resource that is expected to resolve to this resource." } } } ], "required": [ - "strength", - "valueSet" + "source" ] }, - "OperationDefinition_Parameter_ReferencedFrom": { + "OperationDefinition_Parameter_Binding": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -70525,21 +72963,27 @@ { "type": "object", "properties": { - "source": { + "strength": { "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource." + "enum": [ + "required", + "extensible", + "preferred", + "example" + ], + "description": "Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances." }, - "sourceId": { + "valueSet": { "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The id of the element in the referencing resource that is expected to resolve to this resource." + "pattern": "\\S*", + "description": "Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used." } } } ], "required": [ - "source" + "strength", + "valueSet" ] }, "OperationOutcome": { @@ -70562,7 +73006,37 @@ ], "required": [ "issue" - ] + ], + "example": { + "resourceType": "OperationOutcome", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "issue": [ + { + "_severity": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_code": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } }, "OperationOutcome_Issue": { "allOf": [ @@ -70725,7 +73199,17 @@ } } } - ] + ], + "example": { + "resourceType": "Organization", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "Organization_Contact": { "allOf": [ @@ -70840,7 +73324,17 @@ } } } - ] + ], + "example": { + "resourceType": "OrganizationAffiliation", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "Patient": { "allOf": [ @@ -70960,6 +73454,46 @@ } } } + ], + "example": { + "resourceType": "Patient", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } + }, + "Patient_Link": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "other": { + "$ref": "#/components/schemas/Reference", + "description": "The other patient resource that the link refers to." + }, + "type": { + "type": "string", + "enum": [ + "replaced-by", + "replaces", + "refer", + "seealso" + ], + "description": "The type of link between this patient resource and another patient resource." + } + } + } + ], + "required": [ + "other", + "type" ] }, "Patient_Communication": { @@ -71037,36 +73571,6 @@ } ] }, - "Patient_Link": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "other": { - "$ref": "#/components/schemas/Reference", - "description": "The other patient resource that the link refers to." - }, - "type": { - "type": "string", - "enum": [ - "replaced-by", - "replaces", - "refer", - "seealso" - ], - "description": "The type of link between this patient resource and another patient resource." - } - } - } - ], - "required": [ - "other", - "type" - ] - }, "PaymentNotice": { "allOf": [ { @@ -71143,7 +73647,57 @@ "payment", "recipient", "amount" - ] + ], + "example": { + "resourceType": "PaymentNotice", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_created": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "payment": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "recipient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "amount": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "PaymentReconciliation": { "allOf": [ @@ -71245,6 +73799,74 @@ "created", "paymentDate", "paymentAmount" + ], + "example": { + "resourceType": "PaymentReconciliation", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_created": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_paymentDate": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "paymentAmount": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + }, + "PaymentReconciliation_ProcessNote": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "display", + "print", + "printoper" + ], + "description": "The business purpose of the note text." + }, + "text": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The explanation or description associated with the processing." + } + } + } ] }, "PaymentReconciliation_Detail": { @@ -71303,32 +73925,6 @@ "type" ] }, - "PaymentReconciliation_ProcessNote": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "display", - "print", - "printoper" - ], - "description": "The business purpose of the note text." - }, - "text": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The explanation or description associated with the processing." - } - } - } - ] - }, "Person": { "allOf": [ { @@ -71401,7 +73997,17 @@ } } } - ] + ], + "example": { + "resourceType": "Person", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "Person_Link": { "allOf": [ @@ -71632,7 +74238,25 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "PlanDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "PlanDefinition_Action": { "allOf": [ @@ -71859,34 +74483,6 @@ } ] }, - "PlanDefinition_Action_Condition": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "applicability", - "start", - "stop" - ], - "description": "The kind of condition." - }, - "expression": { - "$ref": "#/components/schemas/Expression", - "description": "An expression that returns true or false, indicating whether the condition is satisfied." - } - } - } - ], - "required": [ - "kind" - ] - }, "PlanDefinition_Action_DynamicValue": { "allOf": [ { @@ -71981,6 +74577,34 @@ "relationship" ] }, + "PlanDefinition_Action_Condition": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "kind": { + "type": "string", + "enum": [ + "applicability", + "start", + "stop" + ], + "description": "The kind of condition." + }, + "expression": { + "$ref": "#/components/schemas/Expression", + "description": "An expression that returns true or false, indicating whether the condition is satisfied." + } + } + } + ], + "required": [ + "kind" + ] + }, "PlanDefinition_Goal": { "allOf": [ { @@ -72143,7 +74767,17 @@ } } } - ] + ], + "example": { + "resourceType": "Practitioner", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "Practitioner_Qualification": { "allOf": [ @@ -72273,6 +74907,40 @@ } } } + ], + "example": { + "resourceType": "PractitionerRole", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } + }, + "PractitionerRole_NotAvailable": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The reason that can be presented to the user as to why this time is not available." + }, + "during": { + "$ref": "#/components/schemas/Period", + "description": "Service is not available (seasonally or for a public holiday) from this date." + } + } + } + ], + "required": [ + "description" ] }, "PractitionerRole_AvailableTime": { @@ -72317,30 +74985,6 @@ } ] }, - "PractitionerRole_NotAvailable": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The reason that can be presented to the user as to why this time is not available." - }, - "during": { - "$ref": "#/components/schemas/Period", - "description": "Service is not available (seasonally or for a public holiday) from this date." - } - } - } - ], - "required": [ - "description" - ] - }, "Procedure": { "allOf": [ { @@ -72548,7 +75192,33 @@ "required": [ "status", "subject" - ] + ], + "example": { + "resourceType": "Procedure", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Procedure_FocalDevice": { "allOf": [ @@ -72680,41 +75350,47 @@ "target", "recorded", "agent" - ] - }, - "Provenance_Agent": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "Provenance", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The participation the agent had with respect to the activity." - }, - "role": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity." + "target": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - }, + ] + } + ], + "_recorded": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "agent": [ + { "who": { - "$ref": "#/components/schemas/Reference", - "description": "The individual, device or organization that participated in the event." - }, - "onBehalfOf": { - "$ref": "#/components/schemas/Reference", - "description": "The individual, device, or organization for whom the change was made." + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } } - } - ], - "required": [ - "who" - ] + ] + } }, "Provenance_Entity": { "allOf": [ @@ -72754,6 +75430,40 @@ "what" ] }, + "Provenance_Agent": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The participation the agent had with respect to the activity." + }, + "role": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity." + } + }, + "who": { + "$ref": "#/components/schemas/Reference", + "description": "The individual, device or organization that participated in the event." + }, + "onBehalfOf": { + "$ref": "#/components/schemas/Reference", + "description": "The individual, device, or organization for whom the change was made." + } + } + } + ], + "required": [ + "who" + ] + }, "Questionnaire": { "allOf": [ { @@ -73047,7 +75757,25 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "Questionnaire", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Questionnaire_Item": { "allOf": [ @@ -73173,6 +75901,72 @@ "type" ] }, + "Questionnaire_Item_Initial": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "valueBoolean": { + "type": "boolean", + "description": "The actual value to for an initial answer." + }, + "valueDecimal": { + "type": "number", + "description": "The actual value to for an initial answer." + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "The actual value to for an initial answer." + }, + "valueDate": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", + "description": "The actual value to for an initial answer." + }, + "valueDateTime": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", + "description": "The actual value to for an initial answer." + }, + "valueTime": { + "type": "string", + "pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?", + "description": "The actual value to for an initial answer." + }, + "valueString": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The actual value to for an initial answer." + }, + "valueUri": { + "type": "string", + "pattern": "\\S*", + "description": "The actual value to for an initial answer." + }, + "valueAttachment": { + "$ref": "#/components/schemas/Attachment", + "description": "The actual value to for an initial answer." + }, + "valueCoding": { + "$ref": "#/components/schemas/Coding", + "description": "The actual value to for an initial answer." + }, + "valueQuantity": { + "$ref": "#/components/schemas/Quantity", + "description": "The actual value to for an initial answer." + }, + "valueReference": { + "$ref": "#/components/schemas/Reference", + "description": "The actual value to for an initial answer." + } + } + } + ] + }, "Questionnaire_Item_AnswerOption": { "allOf": [ { @@ -73296,72 +76090,6 @@ "operator" ] }, - "Questionnaire_Item_Initial": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "valueBoolean": { - "type": "boolean", - "description": "The actual value to for an initial answer." - }, - "valueDecimal": { - "type": "number", - "description": "The actual value to for an initial answer." - }, - "valueInteger": { - "type": "integer", - "format": "int32", - "description": "The actual value to for an initial answer." - }, - "valueDate": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", - "description": "The actual value to for an initial answer." - }, - "valueDateTime": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "The actual value to for an initial answer." - }, - "valueTime": { - "type": "string", - "pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?", - "description": "The actual value to for an initial answer." - }, - "valueString": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The actual value to for an initial answer." - }, - "valueUri": { - "type": "string", - "pattern": "\\S*", - "description": "The actual value to for an initial answer." - }, - "valueAttachment": { - "$ref": "#/components/schemas/Attachment", - "description": "The actual value to for an initial answer." - }, - "valueCoding": { - "$ref": "#/components/schemas/Coding", - "description": "The actual value to for an initial answer." - }, - "valueQuantity": { - "$ref": "#/components/schemas/Quantity", - "description": "The actual value to for an initial answer." - }, - "valueReference": { - "$ref": "#/components/schemas/Reference", - "description": "The actual value to for an initial answer." - } - } - } - ] - }, "QuestionnaireResponse": { "allOf": [ { @@ -73437,7 +76165,25 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "QuestionnaireResponse", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "QuestionnaireResponse_Item": { "allOf": [ @@ -73645,7 +76391,25 @@ ], "required": [ "patient" - ] + ], + "example": { + "resourceType": "RelatedPerson", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "RelatedPerson_Communication": { "allOf": [ @@ -73812,7 +76576,33 @@ "required": [ "status", "intent" - ] + ], + "example": { + "resourceType": "RequestGroup", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_intent": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "RequestGroup_Action": { "allOf": [ @@ -73977,34 +76767,6 @@ } ] }, - "RequestGroup_Action_Condition": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "kind": { - "type": "string", - "enum": [ - "applicability", - "start", - "stop" - ], - "description": "The kind of condition." - }, - "expression": { - "$ref": "#/components/schemas/Expression", - "description": "An expression that returns true or false, indicating whether or not the condition is satisfied." - } - } - } - ], - "required": [ - "kind" - ] - }, "RequestGroup_Action_RelatedAction": { "allOf": [ { @@ -74049,6 +76811,34 @@ "relationship" ] }, + "RequestGroup_Action_Condition": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "kind": { + "type": "string", + "enum": [ + "applicability", + "start", + "stop" + ], + "description": "The kind of condition." + }, + "expression": { + "$ref": "#/components/schemas/Expression", + "description": "An expression that returns true or false, indicating whether or not the condition is satisfied." + } + } + } + ], + "required": [ + "kind" + ] + }, "ResearchDefinition": { "allOf": [ { @@ -74261,7 +77051,33 @@ "required": [ "status", "population" - ] + ], + "example": { + "resourceType": "ResearchDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "population": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "ResearchElementDefinition": { "allOf": [ @@ -74485,7 +77301,45 @@ "status", "type", "characteristic" - ] + ], + "example": { + "resourceType": "ResearchElementDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "characteristic": [ + { + "definitionCodeableConcept": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } }, "ResearchElementDefinition_Characteristic": { "allOf": [ @@ -74768,9 +77622,27 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "ResearchStudy", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, - "ResearchStudy_Arm": { + "ResearchStudy_Objective": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -74781,25 +77653,17 @@ "name": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "Unique, human-readable label for this arm of the study." + "description": "Unique, human-readable label for this objective of the study." }, "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Categorization of study arm, e.g. experimental, active comparator, placebo comparater." - }, - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A succinct description of the path through the study that would be followed by a subject adhering to this arm." + "description": "The kind of study objective." } } } - ], - "required": [ - "name" ] }, - "ResearchStudy_Objective": { + "ResearchStudy_Arm": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -74810,14 +77674,22 @@ "name": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "Unique, human-readable label for this objective of the study." + "description": "Unique, human-readable label for this arm of the study." }, "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The kind of study objective." + "description": "Categorization of study arm, e.g. experimental, active comparator, placebo comparater." + }, + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A succinct description of the path through the study that would be followed by a subject adhering to this arm." } } } + ], + "required": [ + "name" ] }, "ResearchSubject": { @@ -74887,7 +77759,41 @@ "status", "study", "individual" - ] + ], + "example": { + "resourceType": "ResearchSubject", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "study": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "individual": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "RiskAssessment": { "allOf": [ @@ -75005,7 +77911,33 @@ "required": [ "status", "subject" - ] + ], + "example": { + "resourceType": "RiskAssessment", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "RiskAssessment_Prediction": { "allOf": [ @@ -75243,7 +78175,41 @@ "status", "population", "outcome" - ] + ], + "example": { + "resourceType": "RiskEvidenceSynthesis", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "population": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "outcome": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "RiskEvidenceSynthesis_Certainty": { "allOf": [ @@ -75470,7 +78436,27 @@ ], "required": [ "actor" - ] + ], + "example": { + "resourceType": "Schedule", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "actor": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + ] + } }, "SearchParameter": { "allOf": [ @@ -75983,7 +78969,78 @@ "code", "base", "type" - ] + ], + "example": { + "resourceType": "SearchParameter", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_url": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_description": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_code": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "base": [ + null + ], + "_base": [ + { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + ], + "_type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "SearchParameter_Component": { "allOf": [ @@ -76263,7 +79320,41 @@ "status", "intent", "subject" - ] + ], + "example": { + "resourceType": "ServiceRequest", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_intent": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "subject": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Slot": { "allOf": [ @@ -76347,7 +79438,49 @@ "status", "start", "end" - ] + ], + "example": { + "resourceType": "Slot", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "schedule": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_start": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_end": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Specimen": { "allOf": [ @@ -76439,56 +79572,17 @@ } } } - ] - }, - "Specimen_Collection": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "collector": { - "$ref": "#/components/schemas/Reference", - "description": "Person who collected the specimen." - }, - "collectedDateTime": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "Time when specimen was collected from subject - the physiologically relevant time." - }, - "collectedPeriod": { - "$ref": "#/components/schemas/Period", - "description": "Time when specimen was collected from subject - the physiologically relevant time." - }, - "duration": { - "$ref": "#/components/schemas/Duration", - "description": "The span of time over which the collection of a specimen occurred." - }, - "quantity": { - "$ref": "#/components/schemas/SimpleQuantity", - "description": "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample." - }, - "method": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A coded value specifying the technique that is used to perform the procedure." - }, - "bodySite": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens." - }, - "fastingStatusCodeableConcept": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection." - }, - "fastingStatusDuration": { - "$ref": "#/components/schemas/Duration", - "description": "Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection." + ], + "example": { + "resourceType": "Specimen", + "meta": { + "tag": [ + { + "code": "ibm/minimal" } - } + ] } - ] + } }, "Specimen_Container": { "allOf": [ @@ -76571,6 +79665,55 @@ } ] }, + "Specimen_Collection": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "collector": { + "$ref": "#/components/schemas/Reference", + "description": "Person who collected the specimen." + }, + "collectedDateTime": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", + "description": "Time when specimen was collected from subject - the physiologically relevant time." + }, + "collectedPeriod": { + "$ref": "#/components/schemas/Period", + "description": "Time when specimen was collected from subject - the physiologically relevant time." + }, + "duration": { + "$ref": "#/components/schemas/Duration", + "description": "The span of time over which the collection of a specimen occurred." + }, + "quantity": { + "$ref": "#/components/schemas/SimpleQuantity", + "description": "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample." + }, + "method": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A coded value specifying the technique that is used to perform the procedure." + }, + "bodySite": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens." + }, + "fastingStatusCodeableConcept": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection." + }, + "fastingStatusDuration": { + "$ref": "#/components/schemas/Duration", + "description": "Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection." + } + } + } + ] + }, "SpecimenDefinition": { "allOf": [ { @@ -76615,7 +79758,17 @@ } } } - ] + ], + "example": { + "resourceType": "SpecimenDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "SpecimenDefinition_TypeTested": { "allOf": [ @@ -76675,6 +79828,35 @@ "preference" ] }, + "SpecimenDefinition_TypeTested_Handling": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "temperatureQualifier": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element." + }, + "temperatureRange": { + "$ref": "#/components/schemas/Range", + "description": "The temperature interval for this set of handling instructions." + }, + "maxDuration": { + "$ref": "#/components/schemas/Duration", + "description": "The maximum time interval of preservation of the specimen with these conditions." + }, + "instruction": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'." + } + } + } + ] + }, "SpecimenDefinition_TypeTested_Container": { "allOf": [ { @@ -76749,35 +79931,6 @@ } ] }, - "SpecimenDefinition_TypeTested_Handling": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "temperatureQualifier": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "It qualifies the interval of temperature, which characterizes an occurrence of handling. Conditions that are not related to temperature may be handled in the instruction element." - }, - "temperatureRange": { - "$ref": "#/components/schemas/Range", - "description": "The temperature interval for this set of handling instructions." - }, - "maxDuration": { - "$ref": "#/components/schemas/Duration", - "description": "The maximum time interval of preservation of the specimen with these conditions." - }, - "instruction": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Additional textual instructions for the preservation or transport of the specimen. For instance, 'Protect from light exposure'." - } - } - } - ] - }, "StructureDefinition": { "allOf": [ { @@ -76903,7 +80056,8 @@ "3.0.1", "3.3.0", "3.5.0", - "4.0.0" + "4.0.0", + "4.0.1" ], "description": "The version of the FHIR specification on which this StructureDefinition is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.0.0. for this version." }, @@ -76979,37 +80133,65 @@ "kind", "abstract", "type" - ] - }, - "StructureDefinition_Context": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" + ], + "example": { + "resourceType": "StructureDefinition", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] }, - { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "fhirpath", - "element", - "extension" - ], - "description": "Defines how to interpret the expression that defines what the context of the extension is." - }, - "expression": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "An expression that defines where an extension can be used in resources." + "_url": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" } - } + ] + }, + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_kind": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_abstract": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] } - ], - "required": [ - "type", - "expression" - ] + } }, "StructureDefinition_Differential": { "allOf": [ @@ -77033,6 +80215,58 @@ "element" ] }, + "StructureDefinition_Snapshot": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "element": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ElementDefinition", + "description": "Captures constraints on each element within the resource." + } + } + } + } + ], + "required": [ + "element" + ] + }, + "StructureDefinition_Context": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "fhirpath", + "element", + "extension" + ], + "description": "Defines how to interpret the expression that defines what the context of the extension is." + }, + "expression": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "An expression that defines where an extension can be used in resources." + } + } + } + ], + "required": [ + "type", + "expression" + ] + }, "StructureDefinition_Mapping": { "allOf": [ { @@ -77068,28 +80302,6 @@ "identity" ] }, - "StructureDefinition_Snapshot": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "element": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ElementDefinition", - "description": "Captures constraints on each element within the resource." - } - } - } - } - ], - "required": [ - "element" - ] - }, "StructureMap": { "allOf": [ { @@ -77215,7 +80427,105 @@ "name", "status", "group" - ] + ], + "example": { + "resourceType": "StructureMap", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_url": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "group": [ + { + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_typeMode": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "input": [ + { + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_mode": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ], + "rule": [ + { + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "source": [ + { + "_context": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } + ] + } + ] + } }, "StructureMap_Group": { "allOf": [ @@ -77273,45 +80583,6 @@ "rule" ] }, - "StructureMap_Group_Input": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "[A-Za-z0-9\\-\\.]{1,64}", - "description": "Name for this instance of data." - }, - "type": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Type for this instance of data." - }, - "mode": { - "type": "string", - "enum": [ - "source", - "target" - ], - "description": "Mode for this instance of data." - }, - "documentation": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Documentation for this instance of data." - } - } - } - ], - "required": [ - "name", - "mode" - ] - }, "StructureMap_Group_Rule": { "allOf": [ { @@ -77395,6 +80666,124 @@ "variable" ] }, + "StructureMap_Group_Rule_Target": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "context": { + "type": "string", + "pattern": "[A-Za-z0-9\\-\\.]{1,64}", + "description": "Type or variable this rule applies to." + }, + "contextType": { + "type": "string", + "enum": [ + "type", + "variable" + ], + "description": "How to interpret the context." + }, + "element": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Field to create in the context." + }, + "variable": { + "type": "string", + "pattern": "[A-Za-z0-9\\-\\.]{1,64}", + "description": "Named context for field, if desired, and a field is specified." + }, + "listMode": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "first", + "share", + "last", + "collate" + ], + "description": "If field is a list, how to manage the list." + } + }, + "listRuleId": { + "type": "string", + "pattern": "[A-Za-z0-9\\-\\.]{1,64}", + "description": "Internal rule reference for shared list items." + }, + "transform": { + "type": "string", + "enum": [ + "create", + "copy", + "truncate", + "escape", + "cast", + "append", + "translate", + "reference", + "dateOp", + "uuid", + "pointer", + "evaluate", + "cc", + "c", + "qty", + "id", + "cp" + ], + "description": "How the data is copied / created." + }, + "parameter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StructureMap_Group_Rule_Target_Parameter", + "description": "Parameters to the transform." + } + } + } + } + ] + }, + "StructureMap_Group_Rule_Target_Parameter": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "valueId": { + "type": "string", + "pattern": "[A-Za-z0-9\\-\\.]{1,64}", + "description": "Parameter value - variable or literal." + }, + "valueString": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Parameter value - variable or literal." + }, + "valueBoolean": { + "type": "boolean", + "description": "Parameter value - variable or literal." + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "Parameter value - variable or literal." + }, + "valueDecimal": { + "type": "number", + "description": "Parameter value - variable or literal." + } + } + } + ] + }, "StructureMap_Group_Rule_Source": { "allOf": [ { @@ -77612,6 +81001,10 @@ "$ref": "#/components/schemas/UsageContext", "description": "A value to use if there is no existing value in the source object." }, + "defaultValueMeta": { + "$ref": "#/components/schemas/Meta", + "description": "A value to use if there is no existing value in the source object." + }, "element": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", @@ -77655,7 +81048,7 @@ "context" ] }, - "StructureMap_Group_Rule_Target": { + "StructureMap_Group_Input": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -77663,114 +81056,35 @@ { "type": "object", "properties": { - "context": { + "name": { "type": "string", "pattern": "[A-Za-z0-9\\-\\.]{1,64}", - "description": "Type or variable this rule applies to." - }, - "contextType": { - "type": "string", - "enum": [ - "type", - "variable" - ], - "description": "How to interpret the context." + "description": "Name for this instance of data." }, - "element": { + "type": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "Field to create in the context." - }, - "variable": { - "type": "string", - "pattern": "[A-Za-z0-9\\-\\.]{1,64}", - "description": "Named context for field, if desired, and a field is specified." - }, - "listMode": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "first", - "share", - "last", - "collate" - ], - "description": "If field is a list, how to manage the list." - } - }, - "listRuleId": { - "type": "string", - "pattern": "[A-Za-z0-9\\-\\.]{1,64}", - "description": "Internal rule reference for shared list items." + "description": "Type for this instance of data." }, - "transform": { + "mode": { "type": "string", "enum": [ - "create", - "copy", - "truncate", - "escape", - "cast", - "append", - "translate", - "reference", - "dateOp", - "uuid", - "pointer", - "evaluate", - "cc", - "c", - "qty", - "id", - "cp" + "source", + "target" ], - "description": "How the data is copied / created." - }, - "parameter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StructureMap_Group_Rule_Target_Parameter", - "description": "Parameters to the transform." - } - } - } - } - ] - }, - "StructureMap_Group_Rule_Target_Parameter": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "valueId": { - "type": "string", - "pattern": "[A-Za-z0-9\\-\\.]{1,64}", - "description": "Parameter value - variable or literal." + "description": "Mode for this instance of data." }, - "valueString": { + "documentation": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "Parameter value - variable or literal." - }, - "valueBoolean": { - "type": "boolean", - "description": "Parameter value - variable or literal." - }, - "valueInteger": { - "type": "integer", - "format": "int32", - "description": "Parameter value - variable or literal." - }, - "valueDecimal": { - "type": "number", - "description": "Parameter value - variable or literal." + "description": "Documentation for this instance of data." } } } + ], + "required": [ + "name", + "mode" ] }, "StructureMap_Structure": { @@ -77871,7 +81185,51 @@ "reason", "criteria", "channel" - ] + ], + "example": { + "resourceType": "Subscription", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_reason": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_criteria": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "channel": { + "_type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + } }, "Subscription_Channel": { "allOf": [ @@ -77976,7 +81334,25 @@ ], "required": [ "code" - ] + ], + "example": { + "resourceType": "Substance", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "code": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Substance_Ingredient": { "allOf": [ @@ -78062,7 +81438,17 @@ } } } - ] + ], + "example": { + "resourceType": "SubstanceNucleicAcid", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "SubstanceNucleicAcid_Subunit": { "allOf": [ @@ -78117,7 +81503,7 @@ } ] }, - "SubstanceNucleicAcid_Subunit_Linkage": { + "SubstanceNucleicAcid_Subunit_Sugar": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -78125,30 +81511,25 @@ { "type": "object", "properties": { - "connectivity": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The entity that links the sugar residues together should also be captured for nearly all naturally occurring nucleic acid the linkage is a phosphate group. For many synthetic oligonucleotides phosphorothioate linkages are often seen. Linkage connectivity is assumed to be 3’-5’. If the linkage is either 3’-3’ or 5’-5’ this should be specified." - }, "identifier": { "$ref": "#/components/schemas/Identifier", - "description": "Each linkage will be registered as a fragment and have an ID." + "description": "The Substance ID of the sugar or sugar-like component that make up the nucleotide." }, "name": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage." + "description": "The name of the sugar or sugar-like component that make up the nucleotide." }, "residueSite": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "Residues shall be captured as described in 5.3.6.8.3." + "description": "The residues that contain a given sugar will be captured. The order of given residues will be captured in the 5‘-3‘direction consistent with the base sequences listed above." } } } ] }, - "SubstanceNucleicAcid_Subunit_Sugar": { + "SubstanceNucleicAcid_Subunit_Linkage": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -78156,19 +81537,24 @@ { "type": "object", "properties": { + "connectivity": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The entity that links the sugar residues together should also be captured for nearly all naturally occurring nucleic acid the linkage is a phosphate group. For many synthetic oligonucleotides phosphorothioate linkages are often seen. Linkage connectivity is assumed to be 3’-5’. If the linkage is either 3’-3’ or 5’-5’ this should be specified." + }, "identifier": { "$ref": "#/components/schemas/Identifier", - "description": "The Substance ID of the sugar or sugar-like component that make up the nucleotide." + "description": "Each linkage will be registered as a fragment and have an ID." }, "name": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The name of the sugar or sugar-like component that make up the nucleotide." + "description": "Each linkage will be registered as a fragment and have at least one name. A single name shall be assigned to each linkage." }, "residueSite": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The residues that contain a given sugar will be captured. The order of given residues will be captured in the 5‘-3‘direction consistent with the base sequences listed above." + "description": "Residues shall be captured as described in 5.3.6.8.3." } } } @@ -78221,58 +81607,17 @@ } } } - ] - }, - "SubstancePolymer_MonomerSet": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "ratioType": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Todo." - }, - "startingMaterial": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubstancePolymer_MonomerSet_StartingMaterial", - "description": "Todo." - } - } - } - } - ] - }, - "SubstancePolymer_MonomerSet_StartingMaterial": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "material": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Todo." - }, - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Todo." - }, - "isDefining": { - "type": "boolean", - "description": "Todo." - }, - "amount": { - "$ref": "#/components/schemas/SubstanceAmount", - "description": "Todo." + ], + "example": { + "resourceType": "SubstancePolymer", + "meta": { + "tag": [ + { + "code": "ibm/minimal" } - } + ] } - ] + } }, "SubstancePolymer_Repeat": { "allOf": [ @@ -78346,6 +81691,31 @@ } ] }, + "SubstancePolymer_Repeat_RepeatUnit_StructuralRepresentation": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Todo." + }, + "representation": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Todo." + }, + "attachment": { + "$ref": "#/components/schemas/Attachment", + "description": "Todo." + } + } + } + ] + }, "SubstancePolymer_Repeat_RepeatUnit_DegreeOfPolymerisation": { "allOf": [ { @@ -78366,7 +81736,7 @@ } ] }, - "SubstancePolymer_Repeat_RepeatUnit_StructuralRepresentation": { + "SubstancePolymer_MonomerSet": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -78374,17 +81744,43 @@ { "type": "object", "properties": { + "ratioType": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Todo." + }, + "startingMaterial": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubstancePolymer_MonomerSet_StartingMaterial", + "description": "Todo." + } + } + } + } + ] + }, + "SubstancePolymer_MonomerSet_StartingMaterial": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "material": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Todo." + }, "type": { "$ref": "#/components/schemas/CodeableConcept", "description": "Todo." }, - "representation": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", + "isDefining": { + "type": "boolean", "description": "Todo." }, - "attachment": { - "$ref": "#/components/schemas/Attachment", + "amount": { + "$ref": "#/components/schemas/SubstanceAmount", "description": "Todo." } } @@ -78425,7 +81821,17 @@ } } } - ] + ], + "example": { + "resourceType": "SubstanceProtein", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "SubstanceProtein_Subunit": { "allOf": [ @@ -78519,6 +81925,72 @@ } } } + ], + "example": { + "resourceType": "SubstanceReferenceInformation", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } + }, + "SubstanceReferenceInformation_Target": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "target": { + "$ref": "#/components/schemas/Identifier", + "description": "Todo." + }, + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Todo." + }, + "interaction": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Todo." + }, + "organism": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Todo." + }, + "organismType": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Todo." + }, + "amountQuantity": { + "$ref": "#/components/schemas/Quantity", + "description": "Todo." + }, + "amountRange": { + "$ref": "#/components/schemas/Range", + "description": "Todo." + }, + "amountString": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Todo." + }, + "amountType": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Todo." + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reference", + "description": "Todo." + } + } + } + } ] }, "SubstanceReferenceInformation_Classification": { @@ -78555,6 +82027,33 @@ } ] }, + "SubstanceReferenceInformation_GeneElement": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Todo." + }, + "element": { + "$ref": "#/components/schemas/Identifier", + "description": "Todo." + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reference", + "description": "Todo." + } + } + } + } + ] + }, "SubstanceReferenceInformation_Gene": { "allOf": [ { @@ -78582,89 +82081,6 @@ } ] }, - "SubstanceReferenceInformation_GeneElement": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Todo." - }, - "element": { - "$ref": "#/components/schemas/Identifier", - "description": "Todo." - }, - "source": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reference", - "description": "Todo." - } - } - } - } - ] - }, - "SubstanceReferenceInformation_Target": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "target": { - "$ref": "#/components/schemas/Identifier", - "description": "Todo." - }, - "type": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Todo." - }, - "interaction": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Todo." - }, - "organism": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Todo." - }, - "organismType": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Todo." - }, - "amountQuantity": { - "$ref": "#/components/schemas/Quantity", - "description": "Todo." - }, - "amountRange": { - "$ref": "#/components/schemas/Range", - "description": "Todo." - }, - "amountString": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Todo." - }, - "amountType": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Todo." - }, - "source": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reference", - "description": "Todo." - } - } - } - } - ] - }, "SubstanceSourceMaterial": { "allOf": [ { @@ -78748,9 +82164,19 @@ } } } - ] + ], + "example": { + "resourceType": "SubstanceSourceMaterial", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, - "SubstanceSourceMaterial_FractionDescription": { + "SubstanceSourceMaterial_PartDescription": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -78758,14 +82184,13 @@ { "type": "object", "properties": { - "fraction": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "This element is capturing information about the fraction of a plant part, or human plasma for fractionation." + "part": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Entity of anatomical origin of source material within an organism." }, - "materialType": { + "partLocation": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1." + "description": "The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply." } } } @@ -78819,7 +82244,7 @@ } ] }, - "SubstanceSourceMaterial_Organism_Author": { + "SubstanceSourceMaterial_Organism_OrganismGeneral": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -78827,14 +82252,21 @@ { "type": "object", "properties": { - "authorType": { + "kingdom": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name." + "description": "The kingdom of an organism shall be specified." }, - "authorDescription": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank)." + "phylum": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The phylum of an organism shall be specified." + }, + "class": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The class of an organism shall be specified." + }, + "order": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The order of an organism shall be specified,." } } } @@ -78876,7 +82308,7 @@ } ] }, - "SubstanceSourceMaterial_Organism_OrganismGeneral": { + "SubstanceSourceMaterial_Organism_Author": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -78884,27 +82316,20 @@ { "type": "object", "properties": { - "kingdom": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The kingdom of an organism shall be specified." - }, - "phylum": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The phylum of an organism shall be specified." - }, - "class": { + "authorType": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The class of an organism shall be specified." + "description": "The type of author of an organism species shall be specified. The parenthetical author of an organism species refers to the first author who published the plant/animal name (of any rank). The primary author of an organism species refers to the first author(s), who validly published the plant/animal name." }, - "order": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The order of an organism shall be specified,." + "authorDescription": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The author of an organism species shall be specified. The author year of an organism shall also be specified when applicable; refers to the year in which the first author(s) published the infraspecific plant/animal name (of any rank)." } } } ] }, - "SubstanceSourceMaterial_PartDescription": { + "SubstanceSourceMaterial_FractionDescription": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -78912,13 +82337,14 @@ { "type": "object", "properties": { - "part": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Entity of anatomical origin of source material within an organism." + "fraction": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "This element is capturing information about the fraction of a plant part, or human plasma for fractionation." }, - "partLocation": { + "materialType": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The detailed anatomic location when the part can be extracted from different anatomical locations of the organism. Multiple alternative locations may apply." + "description": "The specific type of the material constituting the component. For Herbal preparations the particulars of the extracts (liquid/dry) is described in Specified Substance Group 1." } } } @@ -79033,46 +82459,19 @@ } } } - ] - }, - "SubstanceSpecification_Code": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "code": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "The specific code." - }, - "status": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Status of the code assignment." - }, - "statusDate": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "The date at which the code status is changed as part of the terminology maintenance." - }, - "comment": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Any comment can be provided in this field, if necessary." - }, - "source": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Reference", - "description": "Supporting literature." - } + ], + "example": { + "resourceType": "SubstanceSpecification", + "meta": { + "tag": [ + { + "code": "ibm/minimal" } - } + ] } - ] + } }, - "SubstanceSpecification_Moiety": { + "SubstanceSpecification_Relationship": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -79080,40 +82479,53 @@ { "type": "object", "properties": { - "role": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "Role that the moiety is playing." - }, - "identifier": { - "$ref": "#/components/schemas/Identifier", - "description": "Identifier by which this moiety substance is known." - }, - "name": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Textual name for this moiety substance." + "substanceReference": { + "$ref": "#/components/schemas/Reference", + "description": "A pointer to another substance, as a resource or just a representational code." }, - "stereochemistry": { + "substanceCodeableConcept": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Stereochemistry type." + "description": "A pointer to another substance, as a resource or just a representational code." }, - "opticalActivity": { + "relationship": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Optical activity type." + "description": "For example \"salt to parent\", \"active moiety\", \"starting material\"." }, - "molecularFormula": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Molecular formula." + "isDefining": { + "type": "boolean", + "description": "For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships." }, "amountQuantity": { "$ref": "#/components/schemas/Quantity", - "description": "Quantitative value for this moiety." + "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other." + }, + "amountRange": { + "$ref": "#/components/schemas/Range", + "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other." + }, + "amountRatio": { + "$ref": "#/components/schemas/Ratio", + "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other." }, "amountString": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "Quantitative value for this moiety." + "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other." + }, + "amountRatioLowLimit": { + "$ref": "#/components/schemas/Ratio", + "description": "For use when the numeric." + }, + "amountType": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "An operator for the amount, for example \"average\", \"approximately\", \"less than\"." + }, + "source": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Reference", + "description": "Supporting literature." + } } } } @@ -79225,7 +82637,7 @@ } ] }, - "SubstanceSpecification_Property": { + "SubstanceSpecification_Code": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -79233,88 +82645,23 @@ { "type": "object", "properties": { - "category": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A category for this property, e.g. Physical, Chemical, Enzymatic." - }, "code": { "$ref": "#/components/schemas/CodeableConcept", - "description": "Property type e.g. viscosity, pH, isoelectric point." - }, - "parameters": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)." - }, - "definingSubstanceReference": { - "$ref": "#/components/schemas/Reference", - "description": "A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)." + "description": "The specific code." }, - "definingSubstanceCodeableConcept": { + "status": { "$ref": "#/components/schemas/CodeableConcept", - "description": "A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)." - }, - "amountQuantity": { - "$ref": "#/components/schemas/Quantity", - "description": "Quantitative value for this property." + "description": "Status of the code assignment." }, - "amountString": { + "statusDate": { "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Quantitative value for this property." - } - } - } - ] - }, - "SubstanceSpecification_Relationship": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "substanceReference": { - "$ref": "#/components/schemas/Reference", - "description": "A pointer to another substance, as a resource or just a representational code." - }, - "substanceCodeableConcept": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "A pointer to another substance, as a resource or just a representational code." - }, - "relationship": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "For example \"salt to parent\", \"active moiety\", \"starting material\"." - }, - "isDefining": { - "type": "boolean", - "description": "For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships." - }, - "amountQuantity": { - "$ref": "#/components/schemas/Quantity", - "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other." - }, - "amountRange": { - "$ref": "#/components/schemas/Range", - "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other." - }, - "amountRatio": { - "$ref": "#/components/schemas/Ratio", - "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other." + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", + "description": "The date at which the code status is changed as part of the terminology maintenance." }, - "amountString": { + "comment": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other." - }, - "amountRatioLowLimit": { - "$ref": "#/components/schemas/Ratio", - "description": "For use when the numeric." - }, - "amountType": { - "$ref": "#/components/schemas/CodeableConcept", - "description": "An operator for the amount, for example \"average\", \"approximately\", \"less than\"." + "description": "Any comment can be provided in this field, if necessary." }, "source": { "type": "array", @@ -79382,6 +82729,31 @@ } ] }, + "SubstanceSpecification_Structure_Representation": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "type": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "The type of structure (e.g. Full, Partial, Representative)." + }, + "representation": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX." + }, + "attachment": { + "$ref": "#/components/schemas/Attachment", + "description": "An attached file with the structural representation." + } + } + } + ] + }, "SubstanceSpecification_Structure_Isotope": { "allOf": [ { @@ -79438,7 +82810,7 @@ } ] }, - "SubstanceSpecification_Structure_Representation": { + "SubstanceSpecification_Property": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -79446,18 +82818,82 @@ { "type": "object", "properties": { - "type": { + "category": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The type of structure (e.g. Full, Partial, Representative)." + "description": "A category for this property, e.g. Physical, Chemical, Enzymatic." }, - "representation": { + "code": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Property type e.g. viscosity, pH, isoelectric point." + }, + "parameters": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX." + "description": "Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)." }, - "attachment": { - "$ref": "#/components/schemas/Attachment", - "description": "An attached file with the structural representation." + "definingSubstanceReference": { + "$ref": "#/components/schemas/Reference", + "description": "A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)." + }, + "definingSubstanceCodeableConcept": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)." + }, + "amountQuantity": { + "$ref": "#/components/schemas/Quantity", + "description": "Quantitative value for this property." + }, + "amountString": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Quantitative value for this property." + } + } + } + ] + }, + "SubstanceSpecification_Moiety": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "role": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Role that the moiety is playing." + }, + "identifier": { + "$ref": "#/components/schemas/Identifier", + "description": "Identifier by which this moiety substance is known." + }, + "name": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Textual name for this moiety substance." + }, + "stereochemistry": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Stereochemistry type." + }, + "opticalActivity": { + "$ref": "#/components/schemas/CodeableConcept", + "description": "Optical activity type." + }, + "molecularFormula": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Molecular formula." + }, + "amountQuantity": { + "$ref": "#/components/schemas/Quantity", + "description": "Quantitative value for this moiety." + }, + "amountString": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Quantitative value for this moiety." } } } @@ -79544,7 +82980,17 @@ } } } - ] + ], + "example": { + "resourceType": "SupplyDelivery", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + } + } }, "SupplyDelivery_SuppliedItem": { "allOf": [ @@ -79687,7 +83133,33 @@ ], "required": [ "quantity" - ] + ], + "example": { + "resourceType": "SupplyRequest", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "itemCodeableConcept": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "quantity": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "SupplyRequest_Parameter": { "allOf": [ @@ -79922,9 +83394,35 @@ "required": [ "status", "intent" - ] + ], + "example": { + "resourceType": "Task", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_intent": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, - "Task_Input": { + "Task_Output": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -79934,196 +83432,200 @@ "properties": { "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "A code or description indicating how the input is intended to be used as part of the task execution." + "description": "The name of the Output parameter." }, "valueBase64Binary": { "type": "string", "pattern": "(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueBoolean": { "type": "boolean", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueCanonical": { "type": "string", "pattern": "\\S*", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueCode": { "type": "string", "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueDate": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueDateTime": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueDecimal": { "type": "number", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueId": { "type": "string", "pattern": "[A-Za-z0-9\\-\\.]{1,64}", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueInstant": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueInteger": { "type": "integer", "format": "int32", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueMarkdown": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueOid": { "type": "string", "pattern": "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valuePositiveInt": { "type": "integer", "format": "int32", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueString": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueTime": { "type": "string", "pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueUnsignedInt": { "type": "integer", "format": "int32", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueUri": { "type": "string", "pattern": "\\S*", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueUrl": { "type": "string", "pattern": "\\S*", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueUuid": { "type": "string", "pattern": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueAddress": { "$ref": "#/components/schemas/Address", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueAge": { "$ref": "#/components/schemas/Age", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueAnnotation": { "$ref": "#/components/schemas/Annotation", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueAttachment": { "$ref": "#/components/schemas/Attachment", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueCodeableConcept": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueCoding": { "$ref": "#/components/schemas/Coding", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueContactPoint": { "$ref": "#/components/schemas/ContactPoint", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueCount": { "$ref": "#/components/schemas/Count", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueDistance": { "$ref": "#/components/schemas/Distance", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueDuration": { "$ref": "#/components/schemas/Duration", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueHumanName": { "$ref": "#/components/schemas/HumanName", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueIdentifier": { "$ref": "#/components/schemas/Identifier", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueMoney": { "$ref": "#/components/schemas/Money", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valuePeriod": { "$ref": "#/components/schemas/Period", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueQuantity": { "$ref": "#/components/schemas/Quantity", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueRange": { "$ref": "#/components/schemas/Range", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueRatio": { "$ref": "#/components/schemas/Ratio", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueReference": { "$ref": "#/components/schemas/Reference", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueSampledData": { "$ref": "#/components/schemas/SampledData", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueSignature": { "$ref": "#/components/schemas/Signature", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueTiming": { "$ref": "#/components/schemas/Timing", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueContactDetail": { "$ref": "#/components/schemas/ContactDetail", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueRelatedArtifact": { "$ref": "#/components/schemas/RelatedArtifact", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." }, "valueUsageContext": { "$ref": "#/components/schemas/UsageContext", - "description": "The value of the input parameter as a basic type." + "description": "The value of the Output parameter as a basic type." + }, + "valueMeta": { + "$ref": "#/components/schemas/Meta", + "description": "The value of the Output parameter as a basic type." } } } @@ -80132,7 +83634,7 @@ "type" ] }, - "Task_Output": { + "Task_Input": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -80142,196 +83644,200 @@ "properties": { "type": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The name of the Output parameter." + "description": "A code or description indicating how the input is intended to be used as part of the task execution." }, "valueBase64Binary": { "type": "string", "pattern": "(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueBoolean": { "type": "boolean", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueCanonical": { "type": "string", "pattern": "\\S*", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueCode": { "type": "string", "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueDate": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueDateTime": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueDecimal": { "type": "number", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueId": { "type": "string", "pattern": "[A-Za-z0-9\\-\\.]{1,64}", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueInstant": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueInteger": { "type": "integer", "format": "int32", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueMarkdown": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueOid": { "type": "string", "pattern": "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valuePositiveInt": { "type": "integer", "format": "int32", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueString": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueTime": { "type": "string", "pattern": "([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueUnsignedInt": { "type": "integer", "format": "int32", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueUri": { "type": "string", "pattern": "\\S*", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueUrl": { "type": "string", "pattern": "\\S*", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueUuid": { "type": "string", "pattern": "urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueAddress": { "$ref": "#/components/schemas/Address", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueAge": { "$ref": "#/components/schemas/Age", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueAnnotation": { "$ref": "#/components/schemas/Annotation", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueAttachment": { "$ref": "#/components/schemas/Attachment", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueCodeableConcept": { "$ref": "#/components/schemas/CodeableConcept", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueCoding": { "$ref": "#/components/schemas/Coding", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueContactPoint": { "$ref": "#/components/schemas/ContactPoint", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueCount": { "$ref": "#/components/schemas/Count", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueDistance": { "$ref": "#/components/schemas/Distance", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueDuration": { "$ref": "#/components/schemas/Duration", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueHumanName": { "$ref": "#/components/schemas/HumanName", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueIdentifier": { "$ref": "#/components/schemas/Identifier", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueMoney": { "$ref": "#/components/schemas/Money", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valuePeriod": { "$ref": "#/components/schemas/Period", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueQuantity": { "$ref": "#/components/schemas/Quantity", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueRange": { "$ref": "#/components/schemas/Range", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueRatio": { "$ref": "#/components/schemas/Ratio", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueReference": { "$ref": "#/components/schemas/Reference", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueSampledData": { "$ref": "#/components/schemas/SampledData", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueSignature": { "$ref": "#/components/schemas/Signature", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueTiming": { "$ref": "#/components/schemas/Timing", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueContactDetail": { "$ref": "#/components/schemas/ContactDetail", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueRelatedArtifact": { "$ref": "#/components/schemas/RelatedArtifact", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." }, "valueUsageContext": { "$ref": "#/components/schemas/UsageContext", - "description": "The value of the Output parameter as a basic type." + "description": "The value of the input parameter as a basic type." + }, + "valueMeta": { + "$ref": "#/components/schemas/Meta", + "description": "The value of the input parameter as a basic type." } } } @@ -80515,7 +84021,41 @@ "status", "date", "kind" - ] + ], + "example": { + "resourceType": "TerminologyCapabilities", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_date": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_kind": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "TerminologyCapabilities_Closure": { "allOf": [ @@ -80533,6 +84073,105 @@ } ] }, + "TerminologyCapabilities_Translation": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "needsMap": { + "type": "boolean", + "description": "Whether the client must identify the map." + } + } + } + ], + "required": [ + "needsMap" + ] + }, + "TerminologyCapabilities_ValidateCode": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "translations": { + "type": "boolean", + "description": "Whether translations are validated." + } + } + } + ], + "required": [ + "translations" + ] + }, + "TerminologyCapabilities_Expansion": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "hierarchical": { + "type": "boolean", + "description": "Whether the server can return nested value sets." + }, + "paging": { + "type": "boolean", + "description": "Whether the server supports paging on expansion." + }, + "incomplete": { + "type": "boolean", + "description": "Allow request for incomplete expansions?" + }, + "parameter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TerminologyCapabilities_Expansion_Parameter", + "description": "Supported expansion parameter." + } + }, + "textFilter": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Documentation about text searching works." + } + } + } + ] + }, + "TerminologyCapabilities_Expansion_Parameter": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "name": { + "type": "string", + "pattern": "[^\\s]+(\\s[^\\s]+)*", + "description": "Expansion Parameter name." + }, + "documentation": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Description of support for parameter." + } + } + } + ], + "required": [ + "name" + ] + }, "TerminologyCapabilities_CodeSystem": { "allOf": [ { @@ -80638,67 +84277,6 @@ "op" ] }, - "TerminologyCapabilities_Expansion": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "hierarchical": { - "type": "boolean", - "description": "Whether the server can return nested value sets." - }, - "paging": { - "type": "boolean", - "description": "Whether the server supports paging on expansion." - }, - "incomplete": { - "type": "boolean", - "description": "Allow request for incomplete expansions?" - }, - "parameter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TerminologyCapabilities_Expansion_Parameter", - "description": "Supported expansion parameter." - } - }, - "textFilter": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Documentation about text searching works." - } - } - } - ] - }, - "TerminologyCapabilities_Expansion_Parameter": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "name": { - "type": "string", - "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "Expansion Parameter name." - }, - "documentation": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Description of support for parameter." - } - } - } - ], - "required": [ - "name" - ] - }, "TerminologyCapabilities_Implementation": { "allOf": [ { @@ -80749,44 +84327,6 @@ "name" ] }, - "TerminologyCapabilities_Translation": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "needsMap": { - "type": "boolean", - "description": "Whether the client must identify the map." - } - } - } - ], - "required": [ - "needsMap" - ] - }, - "TerminologyCapabilities_ValidateCode": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "translations": { - "type": "boolean", - "description": "Whether translations are validated." - } - } - } - ], - "required": [ - "translations" - ] - }, "TestReport": { "allOf": [ { @@ -80871,9 +84411,65 @@ "status", "testScript", "result" + ], + "example": { + "resourceType": "TestReport", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "testScript": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_result": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + }, + "TestReport_Teardown": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "action": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestReport_Teardown_Action", + "description": "The teardown action will only contain an operation." + } + } + } + } + ], + "required": [ + "action" ] }, - "TestReport_Participant": { + "TestReport_Teardown_Action": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -80881,31 +84477,67 @@ { "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "test-engine", - "client", - "server" - ], - "description": "The type of participant." - }, - "uri": { + "operation": { + "$ref": "#/components/schemas/TestReport_Setup_Action_Operation", + "description": "The operation performed." + } + } + } + ], + "required": [ + "operation" + ] + }, + "TestReport_Test": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "name": { "type": "string", - "pattern": "\\S*", - "description": "The uri of the participant. An absolute URL is preferred." + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The name of this test used for tracking/logging purposes by test engines." }, - "display": { + "description": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The display name of the participant." + "description": "A short description of the test used by test engines for tracking and reporting purposes." + }, + "action": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestReport_Test_Action", + "description": "Action would contain either an operation or an assertion." + } } } } ], "required": [ - "type", - "uri" + "action" + ] + }, + "TestReport_Test_Action": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "operation": { + "$ref": "#/components/schemas/TestReport_Setup_Action_Operation", + "description": "The operation performed." + }, + "assert": { + "$ref": "#/components/schemas/TestReport_Setup_Action_Assert", + "description": "The results of the assertion performed on the previous operations." + } + } + } ] }, "TestReport_Setup": { @@ -81022,48 +84654,7 @@ "result" ] }, - "TestReport_Teardown": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "action": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TestReport_Teardown_Action", - "description": "The teardown action will only contain an operation." - } - } - } - } - ], - "required": [ - "action" - ] - }, - "TestReport_Teardown_Action": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "operation": { - "$ref": "#/components/schemas/TestReport_Setup_Action_Operation", - "description": "The operation performed." - } - } - } - ], - "required": [ - "operation" - ] - }, - "TestReport_Test": { + "TestReport_Participant": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -81071,48 +84662,31 @@ { "type": "object", "properties": { - "name": { + "type": { "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The name of this test used for tracking/logging purposes by test engines." + "enum": [ + "test-engine", + "client", + "server" + ], + "description": "The type of participant." }, - "description": { + "uri": { "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A short description of the test used by test engines for tracking and reporting purposes." + "pattern": "\\S*", + "description": "The uri of the participant. An absolute URL is preferred." }, - "action": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TestReport_Test_Action", - "description": "Action would contain either an operation or an assertion." - } + "display": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The display name of the participant." } } } ], "required": [ - "action" - ] - }, - "TestReport_Test_Action": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "operation": { - "$ref": "#/components/schemas/TestReport_Setup_Action_Operation", - "description": "The operation performed." - }, - "assert": { - "$ref": "#/components/schemas/TestReport_Setup_Action_Assert", - "description": "The results of the assertion performed on the previous operations." - } - } - } + "type", + "uri" ] }, "TestScript": { @@ -81268,9 +84842,43 @@ "url", "name", "status" - ] + ], + "example": { + "resourceType": "TestScript", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_url": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_name": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, - "TestScript_Destination": { + "TestScript_Teardown": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -81278,24 +84886,21 @@ { "type": "object", "properties": { - "index": { - "type": "integer", - "format": "int32", - "description": "Abstract name given to a destination server in this test script. The name is provided as a number starting at 1." - }, - "profile": { - "$ref": "#/components/schemas/Coding", - "description": "The type of destination profile the test system supports." + "action": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestScript_Teardown_Action", + "description": "The teardown action will only contain an operation." + } } } } ], "required": [ - "index", - "profile" + "action" ] }, - "TestScript_Fixture": { + "TestScript_Teardown_Action": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -81303,27 +84908,18 @@ { "type": "object", "properties": { - "autocreate": { - "type": "boolean", - "description": "Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section." - }, - "autodelete": { - "type": "boolean", - "description": "Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section." - }, - "resource": { - "$ref": "#/components/schemas/Reference", - "description": "Reference to the resource (containing the contents of the resource needed for operations)." + "operation": { + "$ref": "#/components/schemas/TestScript_Setup_Action_Operation", + "description": "The operation to perform." } } } ], "required": [ - "autocreate", - "autodelete" + "operation" ] }, - "TestScript_Metadata": { + "TestScript_Test": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -81331,28 +84927,31 @@ { "type": "object", "properties": { - "link": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TestScript_Metadata_Link", - "description": "A link to the FHIR specification that this test is covering." - } + "name": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The name of this test used for tracking/logging purposes by test engines." }, - "capability": { + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A short description of the test used by test engines for tracking and reporting purposes." + }, + "action": { "type": "array", "items": { - "$ref": "#/components/schemas/TestScript_Metadata_Capability", - "description": "Capabilities that must exist and are assumed to function correctly on the FHIR server being tested." + "$ref": "#/components/schemas/TestScript_Test_Action", + "description": "Action would contain either an operation or an assertion." } } } } ], "required": [ - "capability" + "action" ] }, - "TestScript_Metadata_Capability": { + "TestScript_Test_Action": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -81360,102 +84959,16 @@ { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Whether or not the test execution will require the given capabilities of the server in order for this test script to execute." - }, - "validated": { - "type": "boolean", - "description": "Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute." - }, - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Description of the capabilities that this test script is requiring the server to support." + "operation": { + "$ref": "#/components/schemas/TestScript_Setup_Action_Operation", + "description": "The operation to perform." }, - "origin": { - "type": "array", - "items": { - "type": "integer", - "format": "int32", - "description": "Which origin server these requirements apply to." - } - }, - "destination": { - "type": "integer", - "format": "int32", - "description": "Which server these requirements apply to." - }, - "link": { - "type": "array", - "items": { - "type": "string", - "pattern": "\\S*", - "description": "Links to the FHIR specification that describes this interaction and the resources involved in more detail." - } - }, - "capabilities": { - "type": "string", - "pattern": "\\S*", - "description": "Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped." - } - } - } - ], - "required": [ - "required", - "validated", - "capabilities" - ] - }, - "TestScript_Metadata_Link": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "url": { - "type": "string", - "pattern": "\\S*", - "description": "URL to a particular requirement or feature within the FHIR specification." - }, - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Short description of the link." + "assert": { + "$ref": "#/components/schemas/TestScript_Setup_Action_Assert", + "description": "Evaluates the results of previous operations to determine if the server under test behaves appropriately." } } } - ], - "required": [ - "url" - ] - }, - "TestScript_Origin": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "index": { - "type": "integer", - "format": "int32", - "description": "Abstract name given to an origin server in this test script. The name is provided as a number starting at 1." - }, - "profile": { - "$ref": "#/components/schemas/Coding", - "description": "The type of origin profile the test system supports." - } - } - } - ], - "required": [ - "index", - "profile" ] }, "TestScript_Setup": { @@ -82217,7 +85730,7 @@ "value" ] }, - "TestScript_Teardown": { + "TestScript_Variable": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -82225,21 +85738,54 @@ { "type": "object", "properties": { - "action": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TestScript_Teardown_Action", - "description": "The teardown action will only contain an operation." - } + "name": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Descriptive name for this variable." + }, + "defaultValue": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A default, hard-coded, or user-defined value for this variable." + }, + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A free text natural language description of the variable and its purpose." + }, + "expression": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified." + }, + "headerField": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Will be used to grab the HTTP header field value from the headers that sourceId is pointing to." + }, + "hint": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Displayable text string with hint help information to the user when entering a default value." + }, + "path": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified." + }, + "sourceId": { + "type": "string", + "pattern": "[A-Za-z0-9\\-\\.]{1,64}", + "description": "Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable." } } } ], "required": [ - "action" + "name" ] }, - "TestScript_Teardown_Action": { + "TestScript_Fixture": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -82247,18 +85793,27 @@ { "type": "object", "properties": { - "operation": { - "$ref": "#/components/schemas/TestScript_Setup_Action_Operation", - "description": "The operation to perform." + "autocreate": { + "type": "boolean", + "description": "Whether or not to implicitly create the fixture during setup. If true, the fixture is automatically created on each server being tested during setup, therefore no create operation is required for this fixture in the TestScript.setup section." + }, + "autodelete": { + "type": "boolean", + "description": "Whether or not to implicitly delete the fixture during teardown. If true, the fixture is automatically deleted on each server being tested during teardown, therefore no delete operation is required for this fixture in the TestScript.teardown section." + }, + "resource": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to the resource (containing the contents of the resource needed for operations)." } } } ], "required": [ - "operation" + "autocreate", + "autodelete" ] }, - "TestScript_Test": { + "TestScript_Metadata": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -82266,31 +85821,28 @@ { "type": "object", "properties": { - "name": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The name of this test used for tracking/logging purposes by test engines." - }, - "description": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A short description of the test used by test engines for tracking and reporting purposes." + "link": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TestScript_Metadata_Link", + "description": "A link to the FHIR specification that this test is covering." + } }, - "action": { + "capability": { "type": "array", "items": { - "$ref": "#/components/schemas/TestScript_Test_Action", - "description": "Action would contain either an operation or an assertion." + "$ref": "#/components/schemas/TestScript_Metadata_Capability", + "description": "Capabilities that must exist and are assumed to function correctly on the FHIR server being tested." } } } } ], "required": [ - "action" + "capability" ] }, - "TestScript_Test_Action": { + "TestScript_Metadata_Capability": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -82298,19 +85850,55 @@ { "type": "object", "properties": { - "operation": { - "$ref": "#/components/schemas/TestScript_Setup_Action_Operation", - "description": "The operation to perform." + "required": { + "type": "boolean", + "description": "Whether or not the test execution will require the given capabilities of the server in order for this test script to execute." }, - "assert": { - "$ref": "#/components/schemas/TestScript_Setup_Action_Assert", - "description": "Evaluates the results of previous operations to determine if the server under test behaves appropriately." + "validated": { + "type": "boolean", + "description": "Whether or not the test execution will validate the given capabilities of the server in order for this test script to execute." + }, + "description": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Description of the capabilities that this test script is requiring the server to support." + }, + "origin": { + "type": "array", + "items": { + "type": "integer", + "format": "int32", + "description": "Which origin server these requirements apply to." + } + }, + "destination": { + "type": "integer", + "format": "int32", + "description": "Which server these requirements apply to." + }, + "link": { + "type": "array", + "items": { + "type": "string", + "pattern": "\\S*", + "description": "Links to the FHIR specification that describes this interaction and the resources involved in more detail." + } + }, + "capabilities": { + "type": "string", + "pattern": "\\S*", + "description": "Minimum capabilities required of server for test script to execute successfully. If server does not meet at a minimum the referenced capability statement, then all tests in this script are skipped." } } } + ], + "required": [ + "required", + "validated", + "capabilities" ] }, - "TestScript_Variable": { + "TestScript_Metadata_Link": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -82318,51 +85906,71 @@ { "type": "object", "properties": { - "name": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Descriptive name for this variable." - }, - "defaultValue": { + "url": { "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A default, hard-coded, or user-defined value for this variable." + "pattern": "\\S*", + "description": "URL to a particular requirement or feature within the FHIR specification." }, "description": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "A free text natural language description of the variable and its purpose." - }, - "expression": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified." - }, - "headerField": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Will be used to grab the HTTP header field value from the headers that sourceId is pointing to." - }, - "hint": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Displayable text string with hint help information to the user when entering a default value." + "description": "Short description of the link." + } + } + } + ], + "required": [ + "url" + ] + }, + "TestScript_Destination": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "index": { + "type": "integer", + "format": "int32", + "description": "Abstract name given to a destination server in this test script. The name is provided as a number starting at 1." }, - "path": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified." + "profile": { + "$ref": "#/components/schemas/Coding", + "description": "The type of destination profile the test system supports." + } + } + } + ], + "required": [ + "index", + "profile" + ] + }, + "TestScript_Origin": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "index": { + "type": "integer", + "format": "int32", + "description": "Abstract name given to an origin server in this test script. The name is provided as a number starting at 1." }, - "sourceId": { - "type": "string", - "pattern": "[A-Za-z0-9\\-\\.]{1,64}", - "description": "Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable." + "profile": { + "$ref": "#/components/schemas/Coding", + "description": "The type of origin profile the test system supports." } } } ], "required": [ - "name" + "index", + "profile" ] }, "ValueSet": { @@ -82477,9 +86085,27 @@ ], "required": [ "status" - ] + ], + "example": { + "resourceType": "ValueSet", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, - "ValueSet_Compose": { + "ValueSet_Expansion": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -82487,37 +86113,48 @@ { "type": "object", "properties": { - "lockedDate": { + "identifier": { "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", - "description": "The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version." + "pattern": "\\S*", + "description": "An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier." }, - "inactive": { - "type": "boolean", - "description": "Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included)." + "timestamp": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", + "description": "The time at which the expansion was produced by the expanding system." }, - "include": { + "total": { + "type": "integer", + "format": "int32", + "description": "The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present." + }, + "parameter": { "type": "array", "items": { - "$ref": "#/components/schemas/ValueSet_Compose_Include", - "description": "Include one or more codes from a code system or other value set(s)." + "$ref": "#/components/schemas/ValueSet_Expansion_Parameter", + "description": "A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion." } }, - "exclude": { + "contains": { "type": "array", "items": { - "$ref": "#/components/schemas/ValueSet_Compose_Include", - "description": "Exclude one or more codes from the value set based on code system filters and/or other value sets." + "$ref": "#/components/schemas/ValueSet_Expansion_Contains", + "description": "The codes that are contained in the value set expansion." } } } } ], "required": [ - "include" + "timestamp" ] }, - "ValueSet_Compose_Include": { + "ValueSet_Expansion_Contains": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -82528,40 +86165,50 @@ "system": { "type": "string", "pattern": "\\S*", - "description": "An absolute URI which is the code system from which the selected codes come from." + "description": "An absolute URI which is the code system in which the code for this item in the expansion is defined." + }, + "abstract": { + "type": "boolean", + "description": "If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value." + }, + "inactive": { + "type": "boolean", + "description": "If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use)." }, "version": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The version of the code system that the codes are selected from, or the special version '*' for all versions." + "description": "The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged." }, - "concept": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ValueSet_Compose_Include_Concept", - "description": "Specifies a concept to be included or excluded." - } + "code": { + "type": "string", + "pattern": "[^\\s]+(\\s[^\\s]+)*", + "description": "The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set." }, - "filter": { + "display": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The recommended display for this item in the expansion." + }, + "designation": { "type": "array", "items": { - "$ref": "#/components/schemas/ValueSet_Compose_Include_Filter", - "description": "Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true." + "$ref": "#/components/schemas/ValueSet_Compose_Include_Concept_Designation", + "description": "Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation." } }, - "valueSet": { + "contains": { "type": "array", "items": { - "type": "string", - "pattern": "\\S*", - "description": "Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets." + "$ref": "#/components/schemas/ValueSet_Expansion_Contains", + "description": "Other codes and entries contained under this entry in the hierarchy." } } } } ] }, - "ValueSet_Compose_Include_Concept": { + "ValueSet_Expansion_Parameter": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -82569,31 +86216,90 @@ { "type": "object", "properties": { - "code": { + "name": { "type": "string", - "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "Specifies a code for the concept to be included or excluded." + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process." }, - "display": { + "valueString": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system." + "description": "The value of the parameter." }, - "designation": { + "valueBoolean": { + "type": "boolean", + "description": "The value of the parameter." + }, + "valueInteger": { + "type": "integer", + "format": "int32", + "description": "The value of the parameter." + }, + "valueDecimal": { + "type": "number", + "description": "The value of the parameter." + }, + "valueUri": { + "type": "string", + "pattern": "\\S*", + "description": "The value of the parameter." + }, + "valueCode": { + "type": "string", + "pattern": "[^\\s]+(\\s[^\\s]+)*", + "description": "The value of the parameter." + }, + "valueDateTime": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", + "description": "The value of the parameter." + } + } + } + ], + "required": [ + "name" + ] + }, + "ValueSet_Compose": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "lockedDate": { + "type": "string", + "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?", + "description": "The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version." + }, + "inactive": { + "type": "boolean", + "description": "Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included)." + }, + "include": { "type": "array", "items": { - "$ref": "#/components/schemas/ValueSet_Compose_Include_Concept_Designation", - "description": "Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc." + "$ref": "#/components/schemas/ValueSet_Compose_Include", + "description": "Include one or more codes from a code system or other value set(s)." + } + }, + "exclude": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValueSet_Compose_Include", + "description": "Exclude one or more codes from the value set based on code system filters and/or other value sets." } } } } ], "required": [ - "code" + "include" ] }, - "ValueSet_Compose_Include_Concept_Designation": { + "ValueSet_Compose_Include": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -82601,25 +86307,40 @@ { "type": "object", "properties": { - "language": { + "system": { "type": "string", - "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "The language this designation is defined for." - }, - "use": { - "$ref": "#/components/schemas/Coding", - "description": "A code that represents types of uses of designations." + "pattern": "\\S*", + "description": "An absolute URI which is the code system from which the selected codes come from." }, - "value": { + "version": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The text value for this designation." + "description": "The version of the code system that the codes are selected from, or the special version '*' for all versions." + }, + "concept": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValueSet_Compose_Include_Concept", + "description": "Specifies a concept to be included or excluded." + } + }, + "filter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ValueSet_Compose_Include_Filter", + "description": "Select concepts by specify a matching criterion based on the properties (including relationships) defined by the system, or on filters defined by the system. If multiple filters are specified, they SHALL all be true." + } + }, + "valueSet": { + "type": "array", + "items": { + "type": "string", + "pattern": "\\S*", + "description": "Selects the concepts found in this value set (based on its value set definition). This is an absolute URI that is a reference to ValueSet.url. If multiple value sets are specified this includes the union of the contents of all of the referenced value sets." + } } } } - ], - "required": [ - "value" ] }, "ValueSet_Compose_Include_Filter": { @@ -82664,56 +86385,7 @@ "value" ] }, - "ValueSet_Expansion": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "identifier": { - "type": "string", - "pattern": "\\S*", - "description": "An identifier that uniquely identifies this expansion of the valueset, based on a unique combination of the provided parameters, the system default parameters, and the underlying system code system versions etc. Systems may re-use the same identifier as long as those factors remain the same, and the expansion is the same, but are not required to do so. This is a business identifier." - }, - "timestamp": { - "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "The time at which the expansion was produced by the expanding system." - }, - "total": { - "type": "integer", - "format": "int32", - "description": "The total number of concepts in the expansion. If the number of concept nodes in this resource is less than the stated number, then the server can return more using the offset parameter." - }, - "offset": { - "type": "integer", - "format": "int32", - "description": "If paging is being used, the offset at which this resource starts. I.e. this resource is a partial view into the expansion. If paging is not being used, this element SHALL NOT be present." - }, - "parameter": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ValueSet_Expansion_Parameter", - "description": "A parameter that controlled the expansion process. These parameters may be used by users of expanded value sets to check whether the expansion is suitable for a particular purpose, or to pick the correct expansion." - } - }, - "contains": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ValueSet_Expansion_Contains", - "description": "The codes that are contained in the value set expansion." - } - } - } - } - ], - "required": [ - "timestamp" - ] - }, - "ValueSet_Expansion_Contains": { + "ValueSet_Compose_Include_Concept": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -82721,53 +86393,31 @@ { "type": "object", "properties": { - "system": { - "type": "string", - "pattern": "\\S*", - "description": "An absolute URI which is the code system in which the code for this item in the expansion is defined." - }, - "abstract": { - "type": "boolean", - "description": "If true, this entry is included in the expansion for navigational purposes, and the user cannot select the code directly as a proper value." - }, - "inactive": { - "type": "boolean", - "description": "If the concept is inactive in the code system that defines it. Inactive codes are those that are no longer to be used, but are maintained by the code system for understanding legacy data. It might not be known or specified whether an concept is inactive (and it may depend on the context of use)." - }, - "version": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The version of the code system from this code was taken. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged." - }, "code": { "type": "string", "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "The code for this item in the expansion hierarchy. If this code is missing the entry in the hierarchy is a place holder (abstract) and does not represent a valid code in the value set." + "description": "Specifies a code for the concept to be included or excluded." }, "display": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The recommended display for this item in the expansion." + "description": "The text to display to the user for this concept in the context of this valueset. If no display is provided, then applications using the value set use the display specified for the code by the system." }, "designation": { "type": "array", "items": { "$ref": "#/components/schemas/ValueSet_Compose_Include_Concept_Designation", - "description": "Additional representations for this item - other languages, aliases, specialized purposes, used for particular purposes, etc. These are relevant when the conditions of the expansion do not fix to a single correct representation." - } - }, - "contains": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ValueSet_Expansion_Contains", - "description": "Other codes and entries contained under this entry in the hierarchy." + "description": "Additional representations for this concept when used in this value set - other languages, aliases, specialized purposes, used for particular purposes, etc." } } } } + ], + "required": [ + "code" ] }, - "ValueSet_Expansion_Parameter": { + "ValueSet_Compose_Include_Concept_Designation": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -82775,49 +86425,25 @@ { "type": "object", "properties": { - "name": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "Name of the input parameter to the $expand operation; may be a server-assigned name for additional default or other server-supplied parameters used to control the expansion process." - }, - "valueString": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The value of the parameter." - }, - "valueBoolean": { - "type": "boolean", - "description": "The value of the parameter." - }, - "valueInteger": { - "type": "integer", - "format": "int32", - "description": "The value of the parameter." - }, - "valueDecimal": { - "type": "number", - "description": "The value of the parameter." - }, - "valueUri": { - "type": "string", - "pattern": "\\S*", - "description": "The value of the parameter." - }, - "valueCode": { + "language": { "type": "string", "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "The value of the parameter." + "description": "The language this designation is defined for." }, - "valueDateTime": { + "use": { + "$ref": "#/components/schemas/Coding", + "description": "A code that represents types of uses of designations." + }, + "value": { "type": "string", - "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?", - "description": "The value of the parameter." + "pattern": "[ \\r\\n\\t\\S]+", + "description": "The text value for this designation." } } } ], "required": [ - "name" + "value" ] }, "VerificationResult": { @@ -82916,6 +86542,52 @@ ], "required": [ "status" + ], + "example": { + "resourceType": "VerificationResult", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + }, + "VerificationResult_Validator": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "organization": { + "$ref": "#/components/schemas/Reference", + "description": "Reference to the organization validating information." + }, + "identityCertificate": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A digital identity certificate associated with the validator." + }, + "attestationSignature": { + "$ref": "#/components/schemas/Signature", + "description": "Signed assertion by the validator that they have validated the information." + } + } + } + ], + "required": [ + "organization" ] }, "VerificationResult_Attestation": { @@ -83015,34 +86687,6 @@ } ] }, - "VerificationResult_Validator": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "organization": { - "$ref": "#/components/schemas/Reference", - "description": "Reference to the organization validating information." - }, - "identityCertificate": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A digital identity certificate associated with the validator." - }, - "attestationSignature": { - "$ref": "#/components/schemas/Signature", - "description": "Signed assertion by the validator that they have validated the information." - } - } - } - ], - "required": [ - "organization" - ] - }, "VisionPrescription": { "allOf": [ { @@ -83107,7 +86751,77 @@ "dateWritten", "prescriber", "lensSpecification" - ] + ], + "example": { + "resourceType": "VisionPrescription", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_status": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_created": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "patient": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_dateWritten": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "prescriber": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "lensSpecification": [ + { + "product": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + }, + "_eye": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } + ] + } }, "VisionPrescription_LensSpecification": { "allOf": [ @@ -83502,7 +87216,25 @@ ], "required": [ "type" - ] + ], + "example": { + "resourceType": "Bundle", + "meta": { + "tag": [ + { + "code": "ibm/minimal" + } + ] + }, + "_type": { + "extension": [ + { + "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", + "valueCode": "unknown" + } + ] + } + } }, "Bundle_Link": { "allOf": [ @@ -84114,6 +87846,10 @@ "valueUsageContext": { "$ref": "#/components/schemas/UsageContext", "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)." + }, + "valueMeta": { + "$ref": "#/components/schemas/Meta", + "description": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)." } } } @@ -85919,7 +89655,7 @@ "type" ] }, - "DataRequirement_CodeFilter": { + "DataRequirement_Sort": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -85930,27 +89666,22 @@ "path": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept." - }, - "searchParam": { - "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept." + "description": "The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant." }, - "valueSet": { + "direction": { "type": "string", - "pattern": "\\S*", - "description": "The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset." - }, - "code": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Coding", - "description": "The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes." - } + "enum": [ + "ascending", + "descending" + ], + "description": "The direction of the sort, ascending or descending." } } } + ], + "required": [ + "path", + "direction" ] }, "DataRequirement_DateFilter": { @@ -85988,7 +89719,7 @@ } ] }, - "DataRequirement_Sort": { + "DataRequirement_CodeFilter": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -85999,22 +89730,27 @@ "path": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant." + "description": "The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the [Simple FHIRPath Profile](fhirpath.html#simple) for full details). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept." }, - "direction": { + "searchParam": { "type": "string", - "enum": [ - "ascending", - "descending" - ], - "description": "The direction of the sort, ascending or descending." + "pattern": "[ \\r\\n\\t\\S]+", + "description": "A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept." + }, + "valueSet": { + "type": "string", + "pattern": "\\S*", + "description": "The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset." + }, + "code": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Coding", + "description": "The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes." + } } } } - ], - "required": [ - "path", - "direction" ] }, "Population": { @@ -86344,6 +90080,10 @@ "$ref": "#/components/schemas/UsageContext", "description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')." }, + "defaultValueMeta": { + "$ref": "#/components/schemas/Meta", + "description": "The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false')." + }, "meaningWhenMissing": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", @@ -86543,6 +90283,10 @@ "$ref": "#/components/schemas/UsageContext", "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing." }, + "fixedMeta": { + "$ref": "#/components/schemas/Meta", + "description": "Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing." + }, "patternBase64Binary": { "type": "string", "pattern": "(\\s*([0-9a-zA-Z\\+\\=]){4}\\s*)+", @@ -86732,6 +90476,10 @@ "$ref": "#/components/schemas/UsageContext", "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value." }, + "patternMeta": { + "$ref": "#/components/schemas/Meta", + "description": "Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. \n\nWhen pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly.\n\nWhen pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array.\n\nWhen pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e.,\n\n1. If primitive: it must match exactly the pattern value\n2. If a complex object: it must match (recursively) the pattern value\n3. If an array: it must match (recursively) the pattern value." + }, "example": { "type": "array", "items": { @@ -86880,7 +90628,7 @@ "path" ] }, - "ElementDefinition_Base": { + "ElementDefinition_Mapping": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -86888,28 +90636,32 @@ { "type": "object", "properties": { - "path": { + "identity": { "type": "string", - "pattern": "[ \\r\\n\\t\\S]+", - "description": "The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [StructureDefinition](structuredefinition.html#) without a StructureDefinition.base." + "pattern": "[A-Za-z0-9\\-\\.]{1,64}", + "description": "An internal reference to the definition of a mapping." }, - "min": { - "type": "integer", - "format": "int32", - "description": "Minimum cardinality of the base element identified by the path." + "language": { + "type": "string", + "pattern": "[^\\s]+(\\s[^\\s]+)*", + "description": "Identifies the computable language in which mapping.map is expressed." }, - "max": { + "map": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "Maximum cardinality of the base element identified by the path." + "description": "Expresses what part of the target specification corresponds to this element." + }, + "comment": { + "type": "string", + "pattern": "[ \\r\\n\\t\\S]+", + "description": "Comments that provide information about the mapping or its use." } } } ], "required": [ - "path", - "min", - "max" + "identity", + "map" ] }, "ElementDefinition_Binding": { @@ -87203,6 +90955,10 @@ "valueUsageContext": { "$ref": "#/components/schemas/UsageContext", "description": "The actual value for the element, which must be one of the types allowed for this element." + }, + "valueMeta": { + "$ref": "#/components/schemas/Meta", + "description": "The actual value for the element, which must be one of the types allowed for this element." } } } @@ -87211,7 +90967,7 @@ "label" ] }, - "ElementDefinition_Mapping": { + "ElementDefinition_Type": { "allOf": [ { "$ref": "#/components/schemas/BackboneElement" @@ -87219,32 +90975,85 @@ { "type": "object", "properties": { - "identity": { + "code": { "type": "string", - "pattern": "[A-Za-z0-9\\-\\.]{1,64}", - "description": "An internal reference to the definition of a mapping." + "pattern": "\\S*", + "description": "URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models." }, - "language": { - "type": "string", - "pattern": "[^\\s]+(\\s[^\\s]+)*", - "description": "Identifies the computable language in which mapping.map is expressed." + "profile": { + "type": "array", + "items": { + "type": "string", + "pattern": "\\S*", + "description": "Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide." + } }, - "map": { + "targetProfile": { + "type": "array", + "items": { + "type": "string", + "pattern": "\\S*", + "description": "Used when the type is \"Reference\" or \"canonical\", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide." + } + }, + "aggregation": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "contained", + "referenced", + "bundled" + ], + "description": "If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle." + } + }, + "versioning": { + "type": "string", + "enum": [ + "either", + "independent", + "specific" + ], + "description": "Whether this reference needs to be version specific or version independent, or whether either can be used." + } + } + } + ], + "required": [ + "code" + ] + }, + "ElementDefinition_Base": { + "allOf": [ + { + "$ref": "#/components/schemas/BackboneElement" + }, + { + "type": "object", + "properties": { + "path": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "Expresses what part of the target specification corresponds to this element." + "description": "The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [StructureDefinition](structuredefinition.html#) without a StructureDefinition.base." }, - "comment": { + "min": { + "type": "integer", + "format": "int32", + "description": "Minimum cardinality of the base element identified by the path." + }, + "max": { "type": "string", "pattern": "[ \\r\\n\\t\\S]+", - "description": "Comments that provide information about the mapping or its use." + "description": "Maximum cardinality of the base element identified by the path." } } } ], "required": [ - "identity", - "map" + "path", + "min", + "max" ] }, "ElementDefinition_Slicing": { @@ -87319,63 +91128,6 @@ "path" ] }, - "ElementDefinition_Type": { - "allOf": [ - { - "$ref": "#/components/schemas/BackboneElement" - }, - { - "type": "object", - "properties": { - "code": { - "type": "string", - "pattern": "\\S*", - "description": "URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. \"string\" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models." - }, - "profile": { - "type": "array", - "items": { - "type": "string", - "pattern": "\\S*", - "description": "Identifies a profile structure or implementation Guide that applies to the datatype this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the type SHALL conform to at least one profile defined in the implementation guide." - } - }, - "targetProfile": { - "type": "array", - "items": { - "type": "string", - "pattern": "\\S*", - "description": "Used when the type is \"Reference\" or \"canonical\", and identifies a profile structure or implementation Guide that applies to the target of the reference this element refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide." - } - }, - "aggregation": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "contained", - "referenced", - "bundled" - ], - "description": "If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle." - } - }, - "versioning": { - "type": "string", - "enum": [ - "either", - "independent", - "specific" - ], - "description": "Whether this reference needs to be version specific or version independent, or whether either can be used." - } - } - } - ], - "required": [ - "code" - ] - }, "Contributor": { "allOf": [ { diff --git a/fhir-swagger-generator/README.md b/fhir-swagger-generator/README.md new file mode 100644 index 00000000000..915eb749edc --- /dev/null +++ b/fhir-swagger-generator/README.md @@ -0,0 +1,40 @@ +# FHIR Swagger Generator + +This module provides classes for generating Swagger and/or OpenAPI definitions for the FHIR HTTP interface. + +It uses a combination of the HL7-provided specification artifacts and the generated java classes from `fhir-model`. + +## Usage + +Both the FHIRSwaggerGenerator and the FHIROpenApiGenerator are designed to generate one interface definition (swagger 2.0 or openapi 3.0) per resource type. +The main driver for this approach is the assumption that most users of FHIR will be focused on a specific subset of the FHIR Resources. By default, the FHIRSwagger generates these files at `src/main/resources/swagger` whereas the OpenApiGenerator places them at `src/main/resources/openapi`. + +Additionally, the FHIROpenApiGenerator will generate an "all-in-one" definition called all-openapi.json. This is the version of the OpenAPI definition that we ship with our server via the `fhir-openapi` project (e.g. see `fhir-openapi/src/main/webapp/META-INF/openapi.json`). + +To limit the number of resource types included in the output directories (and in the all-in-one mentioned above), you may pass a set of semicolon-delimited +filter strings as program arguments. + +For example, to generate definitions for `read, vread, and history` on the Patient API, `create, read, vread, history, and search` on the Contract API, and `read` on the RiskAssessment API (and no other output), you would invoke the generator with the following argument: + +``` +Patient(read,vread,history);Contract(create,read,vread,history,search);RiskAssessment(read) +``` + +## Design decisions + +The FHIR API is [notoriously](https://chat.fhir.org/#narrow/stream/179166-implementers/topic/OpenAPI.20Support) [difficult](https://chat.fhir.org/#narrow/stream/179166-implementers/topic/OpenAPI) to represent in Swagger/OpenAPI. In fact, the value of such an API definition is questionable when the API itself is defined in a balloted HL7 / ISO standard that has such a rich collection of open source clients and servers which provide native support. + +Still, the broad adoption of Swagger/OpenAPI in the marketplace has driven a broad awareness and so many IT practitioners expect such an interface definition for all HTTP interfaces. We provide the generators in this module for these tools and practitioners and this has driven some of the key design decisions. + +Importantly, the Swagger/OpenAPI definitions generated in this project are NOT a full representation of the full HL7 FHIR HTTP interface, nor of the subset of that API supported by the IBM FHIR Server. For example, here are some of the simplifications made to the schema in order to improve approachability from both a tooling and end user standpoint: +* FHIR supports extensions on primitive data types. However, the JSON serialization for that is a bit interesting, and these primitive extensions aren't used much in practice...so the generated swagger omits those. +* FHIR supports "contained" resources, and so each resource type could technically contain any other resource type within it. However, to properly represent that structure, it would require that every endpoint definition include every single resource and datatype definition in the specification. Instead, we include just the elements for the resource(s) being generated. +* FHIR choice elements with a type of `*` (like Extension.value[x]) can technically reference any FHIR data type, including rare/obscure ones like those defined at https://www.hl7.org/fhir/metadatatypes.html. For simplicity, we omit these from the swagger definition unless the Resource has an explicit field with this type. + + +## Alternatives + +For those wishing to represent the full FHIR API in Swagger/OpenAPI (without the simplifications discussed above), we recommend using "external documentation" as described at https://swagger.io/specification/#externalDocumentationObject. Basically, instead of describing the FHIR schema in the subset of JsonSchema supported by OpenAPI, you just use OpenAPI to describe the interactions and reference the external specification as the documentation of the schema. + + +FHIR® is the registered trademark of HL7 and is used with the permission of HL7. \ No newline at end of file diff --git a/fhir-swagger-generator/pom.xml b/fhir-swagger-generator/pom.xml index dc799c8b0db..21bf14c4ac9 100644 --- a/fhir-swagger-generator/pom.xml +++ b/fhir-swagger-generator/pom.xml @@ -11,6 +11,12 @@ fhir-swagger-generator + + ${project.groupId} + fhir-examples + ${project.version} + compile + ${project.groupId} fhir-core diff --git a/fhir-swagger-generator/src/main/java/com/ibm/fhir/openapi/generator/FHIROpenApiGenerator.java b/fhir-swagger-generator/src/main/java/com/ibm/fhir/openapi/generator/FHIROpenApiGenerator.java index 224f518dd0d..b8a91efcbb2 100644 --- a/fhir-swagger-generator/src/main/java/com/ibm/fhir/openapi/generator/FHIROpenApiGenerator.java +++ b/fhir-swagger-generator/src/main/java/com/ibm/fhir/openapi/generator/FHIROpenApiGenerator.java @@ -8,7 +8,9 @@ import java.io.File; import java.io.FileWriter; +import java.io.IOException; import java.io.InputStream; +import java.io.Reader; import java.lang.reflect.Field; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; @@ -30,11 +32,13 @@ import javax.json.JsonBuilderFactory; import javax.json.JsonObject; import javax.json.JsonObjectBuilder; +import javax.json.JsonReader; import javax.json.JsonWriter; import javax.json.JsonWriterFactory; import javax.json.stream.JsonGenerator; import com.ibm.fhir.core.FHIRMediaType; +import com.ibm.fhir.examples.ExamplesUtil; import com.ibm.fhir.model.annotation.Required; import com.ibm.fhir.model.format.Format; import com.ibm.fhir.model.parser.FHIRParser; @@ -98,13 +102,16 @@ * Generate OpenAPI 3.0 from the HL7 FHIR R4 artifacts and IBM FHIR object model. * *

- * By default, this class will create a separate OpenAPI definition for each and every resource type; - * each with all HTTP interactions enabled. + * By default, this class will generate: + *

    + *
  1. an "all-in-one" OpenAPI definition for the entire api + *
  2. a separate OpenAPI definition for each and every resource type; each with all HTTP interactions enabled + *
* *

* To limit the output to a given set of resources and/or interactions, pass a set of semicolon-delimited * filter strings of the form {@code ResourceType1(interaction1,interaction2)}. - * + * * For example: * 

  * Patient(create,read,vread,history,search,update,delete);Contract(create,read,vread,history,search);RiskAssessment(read)
@@ -149,7 +156,7 @@ private static void generateAllInOne(Filter filter) throws Exception {
         JsonObjectBuilder info = factory.createObjectBuilder();
         info.add("title", "Simplified FHIR API");
         info.add("description", "A simplified version of the HL7 FHIR API");
-        info.add("version", "4.0.0");
+        info.add("version", "4.0.1");
         swagger.add("info", info);
 
         JsonArrayBuilder servers = factory.createArrayBuilder();
@@ -1069,10 +1076,23 @@ private static void generateDefinition(Class modelClass, JsonObjectBuilder de
                 definition.add("required", requiredArray);
             }
 
+            if (Resource.class.isAssignableFrom(modelClass)) {
+                addExamples(modelClass, definition);
+            }
+
             definitions.add(getSimpleNameWithEnclosingNames(modelClass), definition);
         }
     }
 
+    public static void addExamples(Class modelClass, JsonObjectBuilder definition) throws IOException {
+        if (!Modifier.isAbstract(modelClass.getModifiers())) {
+            // Change this from "complete-mock" to "minimal" to reduce the size of the generated definition
+            Reader example = ExamplesUtil.resourceReader("json/ibm/complete-mock/" + modelClass.getSimpleName() + "-1.json");
+            JsonReader jsonReader = Json.createReader(example);
+            definition.add("example", jsonReader.readObject());
+        }
+    }
+
     private static String getSimpleNameWithEnclosingNames(Class modelClass) {
         StringBuilder fullName = new StringBuilder(modelClass.getSimpleName());
         while (modelClass.isMemberClass()) {
diff --git a/fhir-swagger-generator/src/main/java/com/ibm/fhir/swagger/generator/FHIRSwaggerGenerator.java b/fhir-swagger-generator/src/main/java/com/ibm/fhir/swagger/generator/FHIRSwaggerGenerator.java
index 2c93d31e34f..75e5818bae0 100644
--- a/fhir-swagger-generator/src/main/java/com/ibm/fhir/swagger/generator/FHIRSwaggerGenerator.java
+++ b/fhir-swagger-generator/src/main/java/com/ibm/fhir/swagger/generator/FHIRSwaggerGenerator.java
@@ -855,6 +855,10 @@ private static void generateDefinition(Class modelClass, JsonObjectBuilder de
                 definition.add("required", requiredArray);
             }
 
+            if (Resource.class.isAssignableFrom(modelClass)) {
+                FHIROpenApiGenerator.addExamples(modelClass, definition);
+            }
+
             definitions.add(getSimpleNameWithEnclosingNames(modelClass), definition);
         }
     }
diff --git a/fhir-tools/src/main/java/com/ibm/fhir/tools/CodeBuilder.java b/fhir-tools/src/main/java/com/ibm/fhir/tools/CodeBuilder.java
index 0ccbf6341f7..73afa241488 100644
--- a/fhir-tools/src/main/java/com/ibm/fhir/tools/CodeBuilder.java
+++ b/fhir-tools/src/main/java/com/ibm/fhir/tools/CodeBuilder.java
@@ -145,6 +145,14 @@ public CodeBuilder javadocReturn(String description) {
         return this;
     }
     
+    public CodeBuilder javadocThrows(String exception, String description) {
+        indent().append(" * @throws").append(" ").append(exception).newLine();
+        for (String line : wrap(escape(normalizeSpace(description)))) {
+            indent().append(" *     ").append(line).newLine();
+        }
+        return this;
+    }
+    
     public CodeBuilder javadocSee(String reference) {
         return indent()
                 .append(" * @see")
diff --git a/fhir-tools/src/main/java/com/ibm/fhir/tools/CodeGenerator.java b/fhir-tools/src/main/java/com/ibm/fhir/tools/CodeGenerator.java
index d9e0670eb75..4b79825a7b1 100644
--- a/fhir-tools/src/main/java/com/ibm/fhir/tools/CodeGenerator.java
+++ b/fhir-tools/src/main/java/com/ibm/fhir/tools/CodeGenerator.java
@@ -1739,6 +1739,9 @@ private void generateIsAsMethods(JsonObject structureDefinition, CodeBuilder cb)
                 ._return("resourceType.isInstance(this)")
             .end().newLine();
             
+            cb.javadocStart()
+                .javadocThrows("ClassCastException", "when this resources cannot be cast to the requested resourceType")
+                .javadocEnd();
             cb.method(mods("public"), " T", "as", params("Class resourceType"))
                 ._return("resourceType.cast(this)")
             .end().newLine();
@@ -1748,6 +1751,9 @@ private void generateIsAsMethods(JsonObject structureDefinition, CodeBuilder cb)
                 ._return("elementType.isInstance(this)")
             .end().newLine();
             
+            cb.javadocStart()
+                .javadocThrows("ClassCastException", "when this element cannot be cast to the requested elementType")
+                .javadocEnd();
             cb.method(mods("public"), " T", "as", params("Class elementType"))
                 ._return("elementType.cast(this)")
             .end().newLine();