Validating FHIR data - FHIR DevDays · © 2014 HL7 ® International. Licensed under Creative...

HL7®, FHIR® and the flame Design mark are the registered trademarks of Health Level Seven International and are used with permission.

Amsterdam, 14-16 November | @HL7 @FirelyTeam | #fhirdevdays18 | www.fhirdevdays.com

Validating FHIR data

Ewout Kramer

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

Goal....

Take away some of the “black magic” of FHIR validation

We can use a tool to create profiles, but what happens under the hood?

Will show StructureDefinition + validation tools

2


Validation inputs

3

Conformance Resources

StructureDefinition

ValueSet

CodeSystemValidator

Packages

• HL7 International (“core”)

• National

• Your own

Results

OperationOutcome


ElementDefinition

Whever a tool reads or writes profiles, it reads StructureDefinitions, itself collections of ElementDefinitions

Most important parts: path (the dotted part expressing hierarchy: “Patient.identifier.use”) short/definition min/max (cardinality) fixed/pattern typeRef (base data type of element) binding (fhirpath) invariants4


Pet project for this session

5

DocumentBundleSD on Bundle

DocumentCompositionSD on Composition

WeightHeightObservationSD on Observation

SectionTitlesValueSet

WeightQuantitySD on Quantity

HeightQuantitySD on Quantity

constrain document sections (“slicing”)

constrain Quantity.value[x]


WeightQuantity

6

value: 1..1, between 0 and 200comparator: 0..0unit: unchangedsystem: 1..1, fixed to ‘http://unitsofmeasure.org’code: 1..1, fixed to ‘kg’


Forge XML

7



8









Determines possible section codes

√ √


WeightHeightObservation

9

value: 1..1, string OR Quantity

If Quantity, either:WeightQuantity orHeightQuantity

Note: We are using a canonical reference to point to WeightQuantity and HeightQuantity.


Forge XML

10

How is that canonical reference resolved??


Try it out in a validator!

Try remove ‘status’ (core: 1..1) Try valueBoolean Change a unit (Quantity.code) to ‘kgs’

Why multiple errors? Try looking at the informational message!

11



12










√ √

√


DocumentComposition – Easy bits

13

type: a CodeableConcept with at least one LOINC code 18842-5. May optionally specify other elements like text, version, display...

subject: limit to type Patient

author: limit to type Practitioner


Forge XML

14


Pattern...the unloved feature

15

Can even make this ‘*’!



Make a reference to another type for Composition.subject Composition.type:

Add another coding. Add <text> element. Take the first coding, add a <version> element. Take the first coding, change the code.

16


DocumentComposition - Slicing

17

For all sections (1..*)

title: 1..1, max. 20 characters longcode: 1..1, Must come from ValueSet

“SectionTitles”emptyReason: 0..0entry: Must be Observationssection: 0..0 (no subsections)

For sections where code = 8716-3 (1..1)vitalSignscode: 1..1, 8716-3entry: Must be a WeightHeightObservation

For sections where code = 10154-3 (0..1)chiefComplaintscode: 1..1, 10154-3

Other sections are allowed, no additional rules apply.


Forge XML

18


Forge XML

19



Many any section.title > 20 Duplicate the vital signs section give the first duplicate a section.code of

<system value="http://loinc.org"/><code value="8716-3"/>

Change the slice’s <ordered> to “true”

20


FhirPath integration

In the slice intro add:

21



22










√ √

√

√


Other validation tools

Java validator: https://www.hl7.org/fhir/validation.html

.NET Core cross-platform (“Torinox”): https://simplifier.net/downloads/torinox

In your Simplifier projects, integrated Validation: https://simplifier.net/validate

23

https://www.hl7.org/fhir/validation.html


Questions?

24


Play along...

Example data, StructureDefinitions & Validator (Windows) can be found at:

https://github.com/ewoutkramer/Furore.Fhir.ValidationDemo/releases

Includes and executable + examples shown in this tutorial.

25

https://github.com/ewoutkramer/Furore.Fhir.ValidationDemo/releases


Extensions and StructureDefs

Extensions are defined using StructureDefinitions In fact, they are constraints on the Extension datatype!

26

Fix this URL to the extension’s url

Limit to just “Boolean” [1..1]

Don’t allow nested extensions


27


Validation inputs

28


StructureDefinition

ValueSet

CodeSystemValidator

Validator-libraries

Java• JAR• Stand-alone cmdline• Integrated in HAPI• Touchstone

Delphi• Notepad++• Grahame’s server

.NET• NuGet package• Torinox (cmdline)• Simplifier• Windows-tool

Packages


• National

• Your own

Results

OperationOutcome


Validation inputs

29


StructureDefinition

ValueSet

CodeSystemValidator

Validator-libraries

Java• JAR• Stand-alone cmdline• Integrated in HAPI• Touchstone

Delphi• Notepad++• Grahame’s server

.NET• NuGet package• Torinox (cmdline)• Simplifier• Windows-tool

Packages


• National

• Your own

Results

OperationOutcome

Date post:	09-Aug-2021
Category:	Documents
Upload:	others
View:	3 times
Download:	3 times

Validating FHIR data - FHIR DevDays · © 2014 HL7 ® International. Licensed under Creative...

Documents