HL7 FHIR JSON Schema中多属性互斥(最多一个)的简便实现方法问询
搞定FHIR JSON Schema中onset*互斥属性的纯Schema方案
嘿,刚好在FHIR项目里踩过这个互斥属性校验的坑,给你分享几个纯JSON Schema的实现方案,完全不用写额外代码就能满足你的需求——也就是onsetDateTime、onsetAge、onsetPeriod、onsetRange、onsetString这些属性互斥非必填:同一实例里最多只能出现其中一个,也可以一个都不出现。
方案1:用oneOf直接映射业务规则(最直观)
这个方案完全对应“最多选一个”的逻辑,每个子Schema定义一个必填的onset属性,再用oneOf包裹,同时顶层允许所有onset属性为可选:
{ "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "onsetDateTime": { "type": "string", "format": "date-time" }, "onsetAge": { "$ref": "#/definitions/Age" }, // 复用你已有的FHIR Age定义 "onsetPeriod": { "$ref": "#/definitions/Period" }, "onsetRange": { "$ref": "#/definitions/Range" }, "onsetString": { "type": "string" }, // 其他FHIR资源属性... }, "oneOf": [ { "required": ["onsetDateTime"] }, { "required": ["onsetAge"] }, { "required": ["onsetPeriod"] }, { "required": ["onsetRange"] }, { "required": ["onsetString"] }, // 允许一个onset属性都不填的合法场景 { "not": { "required": ["onsetDateTime", "onsetAge", "onsetPeriod", "onsetRange", "onsetString"] } } ], "definitions": { "Age": { /* 你的FHIR Age Schema定义 */ }, "Period": { /* 你的FHIR Period Schema定义 */ }, "Range": { /* 你的FHIR Range Schema定义 */ } } }
为啥好用?
- 逻辑直白,看一眼就懂每个子项对应的规则
- 能严格校验三种合法场景:选且仅选一个onset*、或者一个都不选
- 对FHIR这类属性命名固定的场景非常友好
方案2:用propertyNames + maxProperties(更灵活)
如果以后可能新增onset*属性(比如FHIR版本更新加了新的onset类型),这个方案更省心,不用每次改Schema:
{ "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "onsetDateTime": { "type": "string", "format": "date-time" }, "onsetAge": { "$ref": "#/definitions/Age" }, "onsetPeriod": { "$ref": "#/definitions/Period" }, "onsetRange": { "$ref": "#/definitions/Range" }, "onsetString": { "type": "string" }, // 其他FHIR资源属性... }, "allOf": [ { // 匹配所有以onset开头、首字母大写的属性(FHIR的命名规范) "propertyNames": { "pattern": "^onset[A-Z].*$" }, // 限制这类属性最多只能有1个 "maxProperties": 1 } ], "definitions": { "Age": { /* 你的FHIR Age Schema定义 */ }, "Period": { /* 你的FHIR Period Schema定义 */ }, "Range": { /* 你的FHIR Range Schema定义 */ } } }
优势在哪?
- 扩展性强,新增符合命名规则的onset*属性会自动纳入互斥校验
- 代码更简洁,不用重复写每个onset属性的规则
- 完美适配FHIR的命名规范,不会误匹配其他属性
针对你提到的“仅onsetString可……”的特殊规则
如果你说的是onsetString有特殊例外(比如可以和某个非onset属性共存),只需要微调规则就行。比如假设onsetString可以和note属性同时存在,其他onset*不行,那可以给方案1的oneOf加个特殊项:
"oneOf": [ // 原有的单onset项... { "required": ["onsetString", "note"] }, // 无onset项... ]
或者在方案2里用dependencies单独给onsetString开特例,灵活得很。
小提醒
- 确保你的JSON Schema解析器支持draft-07及以上版本(现在主流工具都支持)
- 测试的时候一定要覆盖三种场景:单个onset属性、多个onset属性(应该报错)、无onset属性(合法),确保校验逻辑没问题
内容的提问来源于stack exchange,提问作者yesdnil5




