Stream: implementers
Topic: ImmunizationRecommendation search parameter type mismatch
Steve Munini (Aug 09 2018 at 17:34):
The dose-number and dose-sequence Search Parameters on the ImmunizationRecommendation resource (http://build.fhir.org/immunizationrecommendation.html) are defined as “number” search types. The FHIRPath expression for dose-number, for example, is ImmunizationRecommendation.recommendation.doseNumber which is a Type Choice of both a positiveInt and a String.
The positiveInt makes sense, but the String is not a “number” as declared by the Search Parameter. This is the only instance I have found in the spec of a type mismatch in search parameter definitions.
Is a Search Parameter like this permitted? Is it valid?
If it is, there are some side effects we would need to describe - for example - how should a server handle a greater than search on a doseNumberString?
If it is not valid, should these two Search Parameters be modified to a FHIRPath expression like this: ImmunizationRecommendation.recommendation.doseNumber.as(positiveInt), and then a second, separate Search Parameter be defined for the String types?
Thanks!
Lloyd McKenzie (Aug 09 2018 at 17:40):
@Craig Newman @Joginder Madra
Craig Newman (Aug 09 2018 at 17:54):
We got feedback that doseNumber and seriesDoses should allow the option to include a string to allow things like indicating a dose was booster (e.g. adult tetanus) or yearly (influenza), so we made that change. We didn't intend to disrupt the search types. The best solution is beyond my technical understanding, so if someone can confirm Steve's proposed solution (or suggest a different solution), I'm happy to make the change.
Lloyd McKenzie (Aug 09 2018 at 18:21):
You have a choice of going with 2 search parameters or going with a single "string" one. You might also consider 'token' as you'd always want exact string matches. You need a number based search parameter if you need the ge, le and similar modifiers.
Craig Newman (Aug 09 2018 at 18:34):
I think I lean towards two search parameters. I don't know if there is a real pressing need for ge and le but it seems reasonable to leave open the possibility. I assume they need unique names and would the path be literally ImmunizationRecommendation.recommendation.doseNumber.as(positiveInt) (and a type of number) and ImmunizationRecommendation.recommendation.doseNumber.as(string) (and a type of string).
Lloyd McKenzie (Aug 09 2018 at 18:56):
The first, yes. For the second, string has a base-behavior of starts-with match and case-insensitive/accent insensitive. I suspect 'token' is more the behavior you'd want.
Craig Newman (Aug 09 2018 at 18:58):
sounds good. Thanks
Craig Newman (Aug 10 2018 at 12:35):
@Lloyd McKenzie is this OK to try and do today, or do you want me to wait?
Craig Newman (Aug 10 2018 at 12:38):
And the addition of Immunization.recorded - is that OK to do today as well?
Lloyd McKenzie (Aug 10 2018 at 14:15):
Totally fine to do today
Craig Newman (Aug 10 2018 at 17:28):
I have the following in the spreadsheet:
dose-number number ImmunizationRecommendation.recommendation.doseNumber.as(positiveInt)
dose-number-by-token token ImmunizationRecommendation.recommendation.doseNumber.as(token)
dose-sequence number ImmunizationRecommendation.recommendation.seriesDose.as(positiveInt)
dose-sequence-by-token token ImmunizationRecommendation.recommendation.seriesDose.as(token)
It builds fine locally, but the display doesn't include a path or description. Is there something wrong with the path I added?
Name Type Description Expression In Common
date date Date recommendation(s) created ImmunizationRecommendation.date
dose-number number
dose-number-by-token token
dose-sequence number
dose-sequence-by-token token
identifier token Business identifier ImmunizationRecommendation.identifier
Last updated: Apr 12 2022 at 19:14 UTC
