FHIR Packages and Versioning

Transcription

1 FHIR Packages and Versioning Martijn Harthoorn Amsterdam, #fhirdevdays18 HL7, FHIR and the flame Design mark are the registered trademarks of Health Level Seven International and are used with permission.

2 Who am I? Martijn Harthoorn Lead & Lead Developer & Architect

3 Scouting the area data contracts: profiles conformance resources canonical

4 Data Contracts a.k.a. Conformance Resources a.k.a. Profiles

5 Data Contracts (Conformance Resources) - Are all FHIR resources - Have to be shared (once) between interoperating parties Resource definitions: Profiles (StructureDefinition) Extensions (StructureDefinition) Terminology: ValueSets CodeSystems NamingSystems ConceptMaps LogicalModels Server configuration: CapabilityStatements CompartmentDefinitions OperationDefinitions SearchParameters Primitive Data types: time date boolean string uri code decimal Terminology: Period Range Quantity Address CodeableConcept Age.

6 Canonical FHIR Base Resource Definition for Patient Each data contract can be uniquely identified by a canonical URL. Canonical FHIR Base Resource Definition for Allergy Intolerance FHIR string data type Canadian ereferral Practice Setting Code ValueSet

7 The problem

8 And then came the next version Base Resource Definition for Patient in FHIR DSTU1 Base Resource Definition for Patient in FHIR DSTU2 Base Resource Definition for Patient in FHIR STU3 Base Resource Definition for Patient in FHIR R4 (the final and last version - muhahahaha)

9 Attempt The author solves versioning by changing the canonical.

10 Attempt 1. special syntax Problem 1: Hard to read In Reality:

11 Attempt 1. special syntax In Reality: Problem 2: Mistakes are hard coded

12 Attempt 1. special syntax Problem 3: identification lost In Reality:

13 Attempt The standard solves versioning with special syntax.

14 Attempt 2. Special syntax Problem 1: dependency hell Patient 1.1 Patient 1.2 Diagnostic Report 1.5 Referral Request 1.4

15 Attempt 2. special syntax Problem 2: non synchronous updates A new realization

16 Attempt 3. The authoring tools solve versioning with bulk updates

17 Attempt 3. Bulk version updates Problem 1: false breaking changes

18 Attempt 3. Bulk version updates Problem 2: content changes after procurement Authoring: draft17 Procured: final-draft Release: 1.4

19 Attempt 3. Bulk version updates Problem 3: Yet Another Tool

20 Attempt 3. Bulk version updates Problem 4: You can still choose EHR Lab

21 Real problem Versioning individual resources

22 Scenario Three organizations exchanging data GP A H GP B

23 GP A H Based on GP B Based on

24 GP A H GP B

25 GP A H GP B 2.0

26 GP A H GP B

27 GP A H GP B

28 H API API API GP A GP B

29 H API API API GP A GP B

30 H API API API GP A GP B

31 H API PACKAGE h.org GP A API PACKAGE h.org GP B

32 Don t version the items. Version the set.

33 FHIR FHIR Core Resources already work that way. (by accident) DSTU1 DSTU2 STU3 R4

34 Attempt 4. Don t version the items, version the set. PACKAGES

35 If you can version the package, let s package the version

36 What are packages?

37 What are packages? A collection of resources that can be distributed under one name. A zip file containing the files you want to publish.

38 Packages is / are an Ecosystem

39 Package Client Package Server Tool Package Builder Resource user Author

40 Package Client Package Server Tool Package Builder Resource user Author

41 What are packages?

42

43 The package ecosystem FHIR Server Profile editor

44 The package ecosystem FHIR Server Profile editor

45 Package Cache Package Repository Context FHIR Package Client Package Server Package Cache

46 Resolver Context Local cache Package Server hl7.fhir.core 3.1 us.core.lab 3.1 hl7.fhir.core 3.1 us.core.lab 2.0 us.core.lab 3.1 hl7.fhir.core 3.0 Hl7.fhir.core 3.1 us.core 2.0 us.core 2.1 us.core 3.1 us.core.lab 2.0 Validation tool us.core.lab 3.1

47 Full dependency tree Local cache Package Server Direct Dependencies us.core.lab 3.1 hl7.fhir.core 3.1 us.core.lab 3.1 hl7.fhir.core 3.1 us.core.lab 2.0 us.core.lab 3.1 hl7.fhir.core 3.0 Hl7.fhir.core 3.1 us.core 2.0 us.core 2.1 us.core 3.1 us.core.lab 2.0 us.core.lab 3.1

48 What do solve?? packages

49 What do FHIR packages solve? 1. Maintenance - No need to version individual resources - No cascading profile updates - No version hell

50 What do FHIR packages solve? 2. Distribution - Automated publication - Automated discovery - Automated consumption - Automated updates

51 What do FHIR packages solve? 3. Communication - A unique name for the set of resources - A clear and simple way to communicate updates.

52 So, what do PACKAGES in FHIR look like?

53 1. Unique name Examples: hl7.fhir.core hl7.fhir.us.qicore Names should contain 1. Region 2. Author, organization 3. Subject

54 1. Unique name 2. Content

55 1. Unique name 2. Content 3. Version SemVer Semantic Versioning preview1 MAJOR incompatible changes MINOR backward compatible additions PATCH backward compatible fixes LABEL annotations

56 1. Unique name 2. Content 3. Version Demo.National.PatientCare Demo.National.PatientCare Demo.National.PatientCare Demo.National.PatientCare alpha1 Demo.National.PatientCare alpha2 Demo.National.PatientCare alpha3 Demo.National.PatientCare beta1 Demo.National.PatientCare beta2 Demo.National.PatientCare 1.3.0

57 1. Unique name 2. Content 3. Version 4. Manifest package.json

58 PACKAGES Dependencies

59 Dependencies VA.Vaccination VA.Patient.Care

60 Dependencies VA.Vaccination VA.Observations VA.Patient.Care

61 Dependencies VA.All Meta packages VA.Vaccination VA.Observations VA.Patient.Care

62 Meta Packages hl7.fhir.core hl7.fhir.core.profiles hl7.fhir.core.valuesets hl7.fhir.core.codesystems hl7.fhir.core.extensions

63 Dependencies VA.All Version upgrades VA.Vaccination VA.Observations VA.Patient.Care 1.1

64 Dependencies VA.All Version upgrades VA.Vaccination 1.1 VA.Observations VA.Patient.Care 1.1

65 Dependencies VA.All 1.1 Version upgrades VA.Vaccination 1.1 VA.Observations VA.Patient.Care 1.1

66 PACKAGES Trust

67 Trust Trust

68 Trust A package - cannot be changed - cannot be deleted

69 F.A.Q.

70 What is the state of packages in FHIR?

71 When do I need to create a package?

72 How do you create a package?

73 How do you publish a package?

74 How do I use a package?

75 What sould I put into a package?

76 How big should I make my package? Granularity

77 How can I remove a package from a registry?

78 What about mistakes and deprecations? Delete Unlist

79 No more versioned canonicals?

80 Standard

81 Torinox FHIR command line tool Build tool FHIR IG Build tool Simplifier.net FHIR Registry & publication platform Forge Profile editor HL7 Core packages viewer Official HL7 packages Node package manager NPM command line tool

82 Standard

83 Questions

84