fix: enforce Extension.url required validation per FHIR spec (Fixes #205) - #206
Open
rtmalikian wants to merge 1 commit into
Open
fix: enforce Extension.url required validation per FHIR spec (Fixes #205)#206rtmalikian wants to merge 1 commit into
rtmalikian wants to merge 1 commit into
Conversation
…azrulworld#205) Extension.url has cardinality 1..1 in the FHIR spec, meaning it is always required. The model had 'element_required: True' in json_schema_extra metadata but this is not enforced by Pydantic v2 — the field also had default=None, making it effectively optional. Added a model_validator(mode='after') to Extension in all three FHIR versions (R4B, R5, STU3) that raises a ValidationError when an Extension has value[x] or nested extensions but no url. This catches the exact case reported in nazrulworld#205 where {'valueCode': 'F'} validates successfully despite missing the required url. Changes: - fhir/resources/R4B/extension.py: Add validate_url_required model_validator - fhir/resources/extension.py (R5): Add validate_url_required model_validator - fhir/resources/STU3/extension.py: Add validate_url_required model_validator - tests/test_extension_url_required.py: 7 tests covering all FHIR versions All 16 tests pass (7 new + 9 existing).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #205
Problem
FHIR Extension.url has cardinality 1..1 in the spec — it is always required. The model had
"element_required": Trueinjson_schema_extrametadata, but Pydantic v2 does not enforce custom metadata during validation. The field also haddefault=None, making it effectively optional.This allowed invalid data like
{"valueCode": "F"}(no url) to pass validation:Solution
Added a
model_validator(mode='after')toExtensionin all three FHIR versions (R4B, R5, STU3) that raisesValidationErrorwhen an Extension hasvalue[x]fields or nested extensions but nourl. Empty extensions (no url, no value) are tolerated for backward compatibility.Verification
About the Author: Raphael Malikian — Clinical AI Solutions Architect. I specialise in building and fixing AI/ML systems for healthcare, including vector databases, RAG pipelines, and clinical NLP. If you need help with your project or think I can add value to your organisation, feel free to reach out — I'd love to connect.
📧 rtmalikian@gmail.com
🔗 GitHub: https://github.com/rtmalikian
🔗 LinkedIn: http://www.linkedin.com/in/raphael-t-malikian-mbbs-bsc-hons-71075436a
Disclosure: This code was developed with assistance from mimo-2.5-pro (Xiaomi) via Hermes Agent (Nous Research). All changes were reviewed, tested against the actual codebase, and verified for correctness.