Warn when reference values do not resolve and have incorrect format #1468
Conversation
…at for a reference.
KaelynJefferson
requested review from
jafeltra,
cmoesel and
mint-thompson
as code owners
There was a problem hiding this comment.
I think there may need to be some extra logic to test if the resulting value conforms to the allowed format for a FHIR Reference. Values that look like Type/Id, such as Patient/MyPatient, are allowed. URLs are also allowed. So, these values should not result in a message that says that the reference does not conform to the FHIR Reference format. There are more details in the documentation for Reference.
… of type/id format or when too/many/parts
src/fhirtypes/common.ts
Outdated
| // ensure it is not an absolute url | ||
| if ( | ||
| value.reference.indexOf('http://') == -1 && | ||
| value.reference.indexOf('https://') == -1 && | ||
| value.reference.indexOf('www.') == -1 | ||
| ) { |
There was a problem hiding this comment.
For checking if the value of the reference is an absolute url, you should be able to use the valid-url package. It is used in a few places in SUSHI for this purpose.
src/fhirtypes/common.ts
Outdated
| if ( | ||
| value.reference.includes('/') && | ||
| value.reference.indexOf('/') !== value.reference.lastIndexOf('/') | ||
| ) { |
There was a problem hiding this comment.
Based on an example in the FHIR documentation, I think that a value with more than one / might actually be acceptable? The last example in the Literal References section shows Observation/1x2/_history/2 as a version-specific reference value. So maybe, only a value without any / would be one that we warn about? I'd like to get opinions from the rest of the team on this.
…arts since acceptable reference format
src/fhirtypes/common.ts
Outdated
| else if (type == null && id == null && value.reference) { | ||
| // if reference does not have type / id reference format | ||
| // example: Patient-oops | ||
| if (!value.reference.includes('/')) { |
There was a problem hiding this comment.
I ran a regression on this branch and noticed there is actually one format that does not include a / but is allowed. You can have a reference to a UUID or OID, which would look like urn:uuid:some-uuid or urn:oid:some-oid. For simplicity and to make sure we catch all the possible cases, we should probably just check if the value starts with urn:. If it does, we should not log the warning.
There was a problem hiding this comment.
This looks good! Thanks for adding that new case and adding a test! I just had one small comment inline.
There are still 24 repos that get new warnings, but from looking through the warning messages, it looks like they're all relevant warnings, so I think that's okay. In case anyone else is curious, this is the list of repos that I see with warnings:
davidhay25/models#main
hl7-be/referral#master
ansforge/IG-fhir-telesurveillance#main
BIH-CEI/interagent#main
cander2/epi-test#master
CEOsys/cpg-on-ebm-on-fhir#master
hl7-be/lab#master
hl7-eu/gravitate-health#master
HL7/codex-radiation-therapy#master
HL7/cqf-recommendations#master
HL7/ReportIIITraveler-ig#master
HL7NZ/nes-ig#master
IHE/PCC.mAPS#master
IHE/PCC.mAPS.us#master
InstitutNationalduCancer/ImplementationGuide_OsirisFHIR#master
Interop-Sante/hl7.fhir.fr.core#main
joofio/ufis-ig#main
joofio/ufis-swe-ig#main
medizininformatik-initiative/kerndatensatz-bildgebung#main
medizininformatik-initiative/kerndatensatzmodul-medikation#master
medizininformatik-initiative/kerndatensatzmodul-onkologie#dev
servicewell/wof-portal-fhir-ig#master
swantrace/ASU-research-consent-on-FHIR#main
tewhatuora/fhir-rheumatic-fever#master
src/fhirtypes/common.ts
Outdated
| if (!value.reference.startsWith('urn:')) { | ||
| if (!value.reference.includes('/')) { |
There was a problem hiding this comment.
The way this logic is written with the nested if statements makes me think there's something else we want to do if the value starts with urn: but does contain a /. I think it would be simpler to just have one if statement with both conditions combined with "and" (i.e. !value.reference.startsWith('urn:') && !value.reference.includes('/')). While that doesn't change the logic as it currently is, I think it makes the intent a little clearer.
There was a problem hiding this comment.
Or there is, of course, the equivalent inverse expression: !(value.reference.startsWith('urn:') || value.reference.includes('/')). Take your pick!
There was a problem hiding this comment.
De Morgan would be proud of this comment.
|
I also noticed we still have #968 open. I think this PR addresses that issue, and we should be able to close it when this gets merged. |
This PR includes: