Find entities by id, even when their id is set by a rule #1198
Conversation
When fishing for an Instance, the id of the Instance may be set by a rule. The rule could be directly on the Instance, or it might be contained within a RuleSet. Examine these rules to find potential matches.
When exporting FHIR, apply insert rules on all FSH definitions before exporting any resources. Each exporter provides a method to apply insert rules on all of the definitions for the resource type it exports. This allows functions that are called during export to assume that all insert rules have already been applied, which can help detect rules that override metadata. FSH entities that can be fished by id now have a get method for their id that accounts for the presence of id-setting rules.
|
Full regression showed two IGs with differences. Both are good. In exhibit A, we see some canonical URLs changed to more properly reflect the correct ID: In exhibit B, we see some relative references changed to properly include the resourceType. Honestly, I'm not 100% sure why this was affected, but I'll take it: |
Small helper function to find a CaretValueRule that provides an id.
There was a problem hiding this comment.
Thanks, Mint! I think this makes sense. I was going back and forth on if it would help to have a findIdAssignmentRule function next to the findIdCaretRule function with a note that says to change the two together, but they probably are distinct enough that I think it's okay as is. But if you or Chris like the idea, I'm certainly not against it.
I didn't notice anything else!
There was a problem hiding this comment.
Julia suggested creating a findIdAssignmentRule. I think that's probably a good idea, because I just found at least one other place that looks for an id assignment rule (and it actually isn't as good as yours, @mint-thompson).
So I suggest creating findIdAssignmentRule and using it in the relevant location in this PR as well as the other place I found similar code:
Lines 433 to 435 in 0238364
Similarly, I also found a place where findIdCaretRule can be used:
Lines 64 to 67 in 0238364
Also note the use of _.findLast above, which seems pretty nice.
Instances can have an id set by an AssignmentRule, so they get a slightly different helper function. Refactor replaceReferences function and Instance class to use this new helper function. HasId.validateId now looks for an id AssignmentRule when operating on an Instance, which helps it give more accurate line numbers in error logs.
| // If the instance has a rule setting id, that overrides instance.id | ||
| const idRule = instance.rules.find( | ||
| r => r.path === 'id' && r instanceof AssignmentRule | ||
| ) as AssignmentRule; | ||
| const id = idRule?.value ?? instance.id; |
There was a problem hiding this comment.
Oh... right! We don't even need this anymore. How exciting!
| if (fshDefinition instanceof Instance) { | ||
| idRule = findIdAssignmentRule(fshDefinition.rules); |
mint-thompson
deleted the
cimpl-1052-resolve-reference-from-assignment
branch
Fixes #1183 and completes task CIMPL-1052.
When fishing for most FSH entities, one of the conditions for a match is that the provided string matches the entity's
id. However, an entity'sidmay be set by one of its rules. To make this more reliable, this PR introduces two main changes:id.These two changes together help to make sure that references to resources defined in FSH that have a rule for setting the
idwill resolve correctly.In addition to the test cases added as part of the PR, the sample FSH in the linked issue will now resolve all references correctly.
This change applies only to FSH entities that can be fished up by
id. This is whyMappingis not changed, even though it has anid.