FHIR Search for server developers by Martijn Harthoorn

1. SEARCH
for
server developers
Martijn Harthoorn
FHIR Developer Days
November 24, 2014
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

2. Who am I?
 Name: Martijn Harthoorn
 Company: Furore
 Background:
 Programmer in C# (mainly)
 Team leader Furore FHIR team
 Programmer of
 Spark Search Engine
 Spark custom-profile resource validator
2
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

3. 3
Let’s talk about…
Understanding what’s behind the question mark.
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

4. 4
Let’s talk about…
FHIR Paradigm
FHIR client should be easy.
FHIR server needs to solve the complex issues.
Search has some…
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

5. 5
Overview
1. Why we need search?
2. How does FHIR solve that?
3. What does the spec say?
4. How do we implement that technically?
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

6. 6
Fhir without search
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

7. 7
Fhir without search
1. CRUD
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

8. 8
Fhir without search
GET [base]/Patient/[id]
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

9. 9
Use cases
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

10. 10
UC1: The registrar
"patient forgot hospital card (with id)"
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

11. 11
UC2: The doctor
“give me all data on patient x”
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

12. 12
UC3: The researcher
“give me all data on
a specific allergy
that conforms to a set of conditions”
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

13. 13
UC4: The manager
“how many patients did we treat last month”
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

14. 14
UC5: The lab
“Give me the list of tests to process”
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

15. 15
UC6: The nurse
“Alert me on any patient with
a measurement in the danger zone.”
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

16. 16
UC Summary
- the registrar
- the doctor
- the researcher
- the manager
- the lab worker
- the nurse
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

17. 17
Solutions in FHIR
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

18. 18
Search Solutions in FHIR
URL/[resource]?<parameters>
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

19. 19
Search solution 2 of FHIR
Query
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

20. 20
Parameter types
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

21. 21
Parameters types
number
date
string
token
reference
quantity
composite
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

22. 22
FHIR Data types
Primitive data types
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

23. 23
FHIR Data types
Complex data types
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

24. 24
Mapping of number
Parameter data type Content data type
number integer
~/Procedure?date=>2010-01-01&date=<2011-12-31
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

25. 25
Mapping of date
Parameter data type Content data type
date
Date
DateTime
Period
Instant
~/Procedure?date=>2010-01-01&date=<2011-12-31
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

26. 26
Mapping of string
Parameter data type Content data type
string
String
HumanName
~/Patient?name=eve
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

27. 27
Mapping of token
Parameter data type Content data type
token
Coding
Codeable concept
~/Patient?name=eve
Identifier
(Code)
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

28. 28
Mapping of quantity
Parameter data type Content data type
quantity Quantity
~/Patient?name=eve
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

29. 29
Mapping of reference
Parameter data type Content data type
reference Uri
~/condition?subject:Patient=23
(Local id)
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

30. 30
F. Mapping of Value[x]
Parameter data type Content data type
value-concept value[x]
value-date
value-quantity
value-string
~/condition?subject:Patient=23
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

31. 31
Returned parameters
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

32. 32
History
Version 1.
 Patient only
 Per parameter
 No meta data
 No index
Limited
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

33. 33
History
Version 2.
 All resources
 Self generated meta data
 Indexing in Lucene
 Client side joins
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

34. 34
History
Version 3.
 All resources
 Model meta data
 Indexing in Mongo
Even faster!
changes in the standard
are now applied automatically
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

35. 35
Indexing
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

36. 36
Indexing
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

37. 37
Indexing
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

38. 38
Indexing
REST Service
Storage
Index
&
Search
DB
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

39. 39
How to index?
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

40. 40
How to index?
<family value=“Chalmers”>
chalmers
Patient?name=chal
chal*
match
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

41. 41
How to index?
<valueQuantity=“10g”>
0.1
value-quantity=>0.1||kg
> 0.05
kg = kg
http://unitsofmeasure.org =
http://unitsofmeasure.org
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

42. 42
Indexing in Mongo:
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

43. 43
K. Debugging
To test a client – you must have a tested server
To test a server – you must have a tested client
“One fool can ask more questions than seven wise men can answer”
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

44. 44
Debugging
Sprinkler
(testtool)
Spark MongoDB
Fiddler
Visual Studio Visual Studio MongoVue
“One fool can ask more questions than seven wise men can answer”
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

45. 45
Logic and filtering
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

46. 46
Logic and filtering
a=x & c=y & e=z
a=x & a=y
a=b,d
a-b=c$d
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

47. 47
Logic and filtering
URL?a=A&a=A2&c=C1,C2&d-e-=D&E
AND
EQ a=A2 OR
c=C1 c=C2
ELEM
AND
d=D e=E
a A
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

48. 48
_include
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

49. 49
Chained parameters
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

50. 50
Paging
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

51. 51
Canonical search
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

52. 52
Canonical search
UCUM
http://unitsofmeasure.org/
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

53. 53
Fuzzy search
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

54. 54
Fuzzy search
1. STARTS WITH
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

55. 55
Fuzzy search
2. LIKE
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

56. 56
Fuzzy search
3. SOUNDEX
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

57. 57
Fuzzy search
4. Damerau-Lehvenstein
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

58. 58
Fuzzy search
5. More advanced searching
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.

59. 59
Full text search
© 2014 HL7 ® International. Licensed under Creative Commons. HL7 & Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. TM Office.