Catching FHIR - HL7 › wp-content › uploads › 2015 › 03 › HL7... · using...

Catching FHIRHL7 FHIR

Hands-on Training Course

Ewout Kramer

March 2015

Who am I?

Name: Ewout Kramer

Company: Furore, Amsterdam

Background:

FHIR core team, RIMBAA

Software developer & healthcare

architect

Contact:

e.kramer@furore.com

www.thefhirplace.com

Program

Introduction to FHIR

The Resource and REST

Exercise - Requesting a Patient resource

Deconstructing the FHIR data model

Exercise - Editing a Resource Instance

Bundles

Simple search and search demo

INTRODUCTION TO FHIR

Relative – No technology can make integration as fast as we’d like

That’s why we’re here

Building blocks – more on these to follow

The Acronym

FHIR Manifesto

Focus on implementers

Keep common scenarios simple

Leverage existing technologies

Provide human readability

Make content freely available

Demonstrate best practice governance

Implementer Focus

Specification is written for one target audience:

implementers

Rationale, modeling approaches, etc. kept elsewhere

Multiple reference implementations from day 1

Publicly available test servers

Starter APIs published with spec

Delphi, C#, Java – more to come

Connectathons to verify specification approaches

Instances you can read and understand

Lots of examples (and they’re valid too)

using HL7.Fhir.Instance.Model;using HL7.Fhir.Instance.Parsers;using HL7.Fhir.Instance.Support;

XmlReader xr = XmlReader.Create(new StreamRead

IFhirReader r = new XmlFhirReader

// JsonTextReader jr = new JsonTe// new StreamRead// IFhirReader r = new JsonFhirRe

ErrorList errors = new ErrorList(LabReport rep = (LabReport)ResourAssert.IsTrue(errors.Count() == 0

WHAT’S IN THE BOX?

Patient Prescription

Resources

The 80/20 rule

Design for the 80%, not 100%

Only include data elements in the artifacts if 80%

of all implementers of that artifact will use the data

element

Allow easy extension for the remaining 20%

of elements

which often make up 80% of current specs

Vocabulary approach to extension definition

Extensibility

The Case for Extensions

Simple choice – design for absolutely

everything or allow extensions

Everyone needs extensions, everyone

hates them

Define, publish, find extensions

Repository

Documented just like resources

Can be fetched & interpreted by clients

HTTP/1.1 200 OKContent-Type: application/json;charset=utf-8

Content-Length: 627

Content-Location: /fhir/Patient/1/history/1

Last-Modified: Sat, 03 May 2014 16:28:55 GMT

{"resourceType":"Patient","identifier":[{"use":"usu

al","label":"MRN","system":"urn:oid:1.2.36.146.59

5.217.0.1","value":"12345","period":{"start":"2001-

Transport

Just follow the industry...

Exchanges use XML & JSON

Collections represented using ATOM

Same technology that gives you your daily news

summary

Out-of-the-box publish/subscribe

Support for REST: Web calls work the same

way they do for Facebook & Twitter

Rely on HTTPS, OAuth, etc. for security

functions

Paradigms

FHIR supports 4 interoperability paradigms

REST Documents

Messages Services

Repository

Regardless of paradigm

the content is the same

Lab System

Receive a lab result in a message…

FHIR MessageFHIR Document

…Package it in a discharge summary document

National

Exchange

DESIGN OF THE RESOURCE

Looking at FHIR Resources from a software engineering perspective

Resources

“Resources” are:

Small logically discrete units of exchange

Defined behaviour and meaning

Known identity / location

Smallest unit of transaction

“of interest” to healthcare

V2: Sort of like Segments

V3: Sort of like CMETs

What is/isn’t a Resource?

Examples

Administrative

Patient, Location,

Encounter, Organization,

Clinical Concepts

AllergyIntolerance,

Questionnaire, Observation

Infrastructure

Document, Message,

Profile, Conformance

Non-examples

Gender

Too small

Blood Pressure

Too specific

Pregnancy

Too broad

Electronic Health Record

Too big

Resource

Narrative

Elements

ExtensionsExtensions

Structure of a Resource

Metadata

Structure of a Resource(XML example)

Human Readable

CDA taught HL7 a very important lesson

Even if the computers don’t understand 99% of

what you’re sending, that’s ok if they can properly

render it to a human clinician

This doesn’t just hold for documents –

important for messages, services, etc.

In FHIR, every resource is required to

have a human-readable expression

Can be direct rendering or human entered

Resources in the spec

Let’s take a look at some Resources in

the specification….

Composition vs. reference

FHIR makes composition and references

explicit:

References are in between Resources. No

context conduction across references – safe

retrieval as individual resources.

Composition is within a Resource: Components

have no meaning outside resource, no identity, no

separate access path except through resource

Composition of a Resource

Resource Root

Resource Component

Simple & Complex

elements (may be

repeating)

Composition

Diagnostic

Report

Practitioner

Patient

Observation

Resource Reference

Example: part of DiagnosticReport

http://fhirblog.com/2014/01/24/modelling-

encounters-with-fhir/

Not a hierarchy!

Patient

Episode Episode

VisitVisit

Observation Order

Not an “electronic” version of a patient file…

A Resource’s identity

In fact: an URL

http://server.org/fhir/Patient/1

endpoint

resource type

identifier

“Business” identifiers

Patient

MRN 22234

“Ewout Kramer”

30-11-1972

Amsterdam

Resource metadata

Metadata

Resource Identities

http://fhir.hl7.org/Patient/23E455A3B

http://fhir.hl7.org/Patient/23E455A3B/_history/4

Last updated

2013-12-23T23:33:01+01:00

http://hl7.org/fhir/tag/profile

http://hl7.org/fhir/Profile/us-core

http://hl7.org/fhir/tag

http://example.org/fhir/Status#Test

REST SERVICE INTERFACEHow FHIR uses RESTful principles to communicate Resources

“REpresentational State Transfer”

Represent your data as “resources”

Make “Resources” URI addressable

Use HTTP to do CRUD operations

Resources may be exchanged using

different representations

Possibly distributed…

FHIR server @ hospitalA.org

Practitioner

Practitioner/87Organization

Organization/1

FHIR server @ lab.hospitalA.org

DiagnosticReport

DiagnosticReport/4445

Observation

Observation/3ff27

FHIR server @ pat.registry.org

Patient

Patient/223

subject

“Repository” model of healthcare

FHIR server

Patient ObservationPatientPatient Observation

Observation

DiagnosticReportOrganization

CreateUpdate

Lab System

CreateUpdate

Hospital System

CreateUpdate

Query Subscribe

Just a quick GET

GET /fhir/patient/1 HTTP/1.1

HTTP/1.1 200 OK

Content-Type: application/xml+fhir;charset=utf-8

Content-Length: 787

Content-Location:

http://spark.furore.com/fhir/Patient/1/_history/12

Last-Modified: Tue, 29 May 2012 23:45:32 GMT

<?xml version="1.0" encoding="UTF-8"?><Patient xmlns="http://hl7.org/fhir"><identifier><label>SSN</label><identifier><system>

http://hl7.org/fhir/sid/usssn</system><id>444222222</id></identifier></identifier><name><use>official

</use><family>Everywoman</family><given>Eve</given></name><telecom><system>phone</system><value>555-

555 2003</value><use>work</use></telecom><gender><system>http://hl7.org/fhir/sid/v2-0001</system>

<code>F</code></gender><birthDate>1973-05-31</birthDate><address><use>home</use><line>2222 Home

Street</line></address><text><status>generated</status><div

xmlns="http://www.w3.org/1999/xhtml">Everywoman, Eve. SSN:444222222</div></text></Patient>

encoded

See the BOM?

HTTP Verb + path

A Resource’s REST identity

In fact: an URL

http://server.org/fhir/Patient/1

endpoint

resource type

identifier

Note: This URL resolves to the current version of a resource

Patient

MRN 22234

“Ewout Kramer”

30-11-1972

Amsterdam

Remember metadata?

Metadata

Resource Identities

http://fhir.hl7.org/Patient/23E455A3B/_history/4

Last updated

2013-12-23T23:33:01+01:00

Tag metadata

GET /fhir/Patient/1 HTTP/1.1

HTTP/1.1 200 OK

Content-Location: http://server.com/fhir/Patient/1/_history/12

Last-Modified: Tue, 29 May 2012 23:45:32 GMT

Category: http://example.org/fhir/Status#Test; scheme="http://hl7.org/fhir/tag"; label="Our test tag"

http://hl7.org/fhir/tag A general tag

A profile tag - a claim that the Resource

conforms to the profile identified in the

http://hl7.org/fhir/tag/security A security label

Mapping (meta)data toHTTP

Resource data

Resource id

Resource version

Last update date

http body

Content-Location

header

Last-Modified header

Category header

REST “representations”

GET /fhir/Patient/1?_format=json HTTP/1.1

HTTP/1.1 200 OK

Content-Type: application/json+fhir;charset=utf-8

Content-Length: 787

Accept: application/json+fhir

HTTP/1.1 200 OK

Content-Type: application/json+fhir;charset=utf-8

Content-Length: 787

REST – CRUD & VERSIONSUpdating, creating & deleting single resources using REST

One more look at the header

HTTP/1.1 200 OK

Content-Type: application/xml+fhir;charset=utf-8

Content-Length: 787

Content-Location: http://spark.furore.com/fhir/Patient/1/_history/12Last-Modified: Tue, 29 May 2012 23:45:32 GMT

For a specific version…

We have the version-specific URL

http://server.org/fhir/ (continued)

Patient/1/_history/4

endpoint

resource type

identifier version id

Question

DO I REALLY HAVE TO IMPLEMENT

VERSIONS?

NO, You are not required to keep history, and may return

410 (Gone) on a “vread” for any request for an older version

than the current one!

REST in the spec

Let’s look at these operations in the

specification….

Mapping to verbs

create 2.1.10 The create interaction creates a new resource in a server assigned location. The create interaction is performed by an HTTP POST operation as shown:

POST [service-url]/[resourcetype] (?_format=mimeType)

read 2.1.6 The read interaction accesses the current contents of a resource. The interaction is performed by an HTTP GET operation as shown:

GET [service-url]/[resourcetype]/{id} (?_format=mimeType)

update 2.1.8 The update interaction creates a new current version for an existing resource or creates a new resource if no resource already exists for the given id. The update interaction is performed by an HTTP PUT operation as shown:

PUT [service-url]/[resourcetype]/{id} (?_format=mimeType)

delete 2.1.9 The delete interaction removes an existing resource. The interaction is performed by an HTTP DELETE operation as shown:

DELETE [service-url]/[resourcetype]/{id}

Exercise #1

Fiddling around with Fiddler

Getting data from a FHIR test server

(20 minutes)

Exercise #1

Install Fiddler2

Try getting a single patient:

• GET a patient with id ‘example’ (on spark.furore.com/fhir)

• Look at the response headers and validate that they are correct.

• Look at the xml and try to find an extension

• Find a resource reference and fetch the referenced Resource

• Try to get the same patient in JSON

‒ Using the _format parameter

‒ Using an Accept header

When you do a GET on a resource, there is another URL presentin the header. What happens if you try to GET that url?

DECONSTRUCTING THE FHIR DATAMODEL

The basic building blocks of FHIR

The FHIR Elements

Resource

Narrative

Extensions

Metadata

Elements

Extensions

Primitives(integer, boolean,

string, instant)

Derived

Primitives(oid, uuid,

code, id)

Composite

Datatypes(HumanName,

Quantity, Period,

Address, Identifier )

Constrained

Types(Quantity:

Distance, Count,

Duration, Money)

Start at the bottom: Primitives

boolean xs:boolean Values can be either true or false

integer xs:int A signed 32-bit integer

decimal xs:decimalA rational number. A true decimal, with

inbuilt precision (e.g. Java BigDecimal)

base64Binary xs:base64Binary A stream of bytes, base64 encoded

instant xs:dateTime

An instant in time - known at least to the

second and always includes a

timezone.

string xs:string A sequence of Unicode characters.

uri xs:anyURI A Uniform Resource Identifier Reference.

union of xs:date,

xs:gYearMonth,

xs:gYear

A date, or partial date as used in

human communication. No time zone.

dateTime

union of xs:dateTime,

xs:date,

xs:gYearMonth,

xs:gYear

A date, date-time or partial date as used

in human communication. If hours and

minutes are specified, a time zone must

be populated.

Derived primitives

Using the ISO date/time with timezone

“1951”, “1951-06” and “1951-06-04”

“1951-06-04T10:57:34.0321+01”

“1951-06-04T10:57:34.0321Z”

Level up: Composite Datatypes

Datatypes

Let’s take a look at the “Data Types” section of the FHIR

specification at

http://www.hl7.org/implement/standards/fhir/datatypes.html

Coded types

Codes are defined in code systems

Coded types

When used in a Resource, the modelers

include Bindings

Bindings specify which codes can be used

• Publication meta-

• Concepts from 1 or

more existing

systems

• Additional concepts

Level up: resources

“Choice” properties

References

Quick look at extensions

Resource

Narrative

Extensions

Metadata

Elements

Extensions

Organization“ACME Hospital”National Drive 322Orlando, FL

PatientMRN 22234“Ewout Kramer”30-11-1972Amsterdam

+ Haircolor BROWN

+ Taxoffice Id NLOB33233

You can extend:

- Resources

- Elements of Resources

- FHIR Datatypes

Extending a multiple birth

Key = location of formal definition

Value = value according to definition

Complex extensions

Quick look at narrative

Resource

Narrative

Extensions

Metadata

Elements

Extensions

Narrative

Exercise #2

Editing a Resource Instance -

by hand!

(45 minutes)

Exercise #2

Store the patient from last exercise somewhere on your machine.

Look up the Patient resource and update it to match your own situation.Lookup the specification of Patient to see if there are other relevant elements you could use

Try to add an extension for your hair color

Try creating a new patient on the FHIR server withthis data

Why is hair color not a standard element on Patient?Would you make an extension for it? Are there (better?) alternatives for communicating a hair color?

BUNDLESHow FHIR uses Atom to communicate sets of resources

Communicating lists

We need to communicate lists of Resources

Search result

History

Documents or messages

Multiple-resource inserts (“batches”)

So, we need an industry-standard to

represent lists, and a place to put our

metadata

Bundle

Resource

Narrative

Elements

ExtensionsExtensions

Resource

Metadata

Bundle

Metadata

Resource

Bundles

Atom RFC 4287 + Tombstones RFC 6721

Poll-based protocol for keeping up-to-date

with newsfeeds (RSS and Atom)

You can “subscribe” to a FHIR feed and get

updates

An example Bundle

Patient

MRN 22234

“Ewout Kramer”

30-11-1972

Amsterdam

Resource metadata

Metadata

Resource Identity

Last updated

2013-12-23T23:33:01+01:00

Resource Entry

Resource id

Last modified

Resource content

Human-readable form,

just like Resource.text

Version specific id

SEARCH FUNCTIONALITY

Getting “all” patients

http://server.org/fhir/Patient

Always returns a paged feed

Use _count to indicate number of results per page

Special case of the “real” search operation:

http://server.org/fhir/Patient/_search?name=eve

http://server.org/fhir/Patient?name=eve

Search (patient)

Each resource has a set of “standard”

search operations, so not every element

can be searched!:

Our last search

used this one

Performing simple searches

Let’s try this out

WHAT’S NEXT?

Next Steps for you

Read the spec: http://hl7.org/fhir

Try implementing it

Come to a Connectathon!

fhir@lists.hl7.org

Implementor’s Skype Channel

StackOverflow: hl7 fhir tag

International Working Group Meeting

Mark Your Calendar and Join Us!

Paris, France

May 10 – 15

International HL7 FHIR Developer DaysNovember 18-20, 2015 in Amsterdam

Education

Tutorials

Connectathon

Meet fellow developers

Put FHIR to the test

Networking

FHIR experts and authors on hand

http://fhir.furore.com/devdays

The End –

Questions?

Catching FHIR - HL7 › wp-content › uploads › 2015 › 03 › HL7... · using...

Documents

Transcript of Catching FHIR - HL7 › wp-content › uploads › 2015 › 03 › HL7... · using...

Neal Stublen nstublen@jccc.edu. How does XMLReader work? XmlReader.Read() Advances to next node XmlReader properties access node name, value, attributes,

NMI HL7 Case Notification Implementation Guidebook ... · HL7 Case Notification Implementation Guidebook ... HL7 test messages according to the test scenarios ... NMI HL7 Case Notification

National Vital Statistics System...Collaborating with Intermountain Healthcare to test sending death information using the HL7 V2.5.1 message and HL7 V2.6 Utah & DC study to assess

HL7 Templates A means to Manage Complexity. Objectives What is an HL7 Template? What types of constraints can HL7 Templates define? What types of HL7.

The HL7 Evolution: Comparing HL7 versions 2 and 3

HL7 Specifications ADT-MDM - HL7 Reference

HL7 European Office · HL7 EUROPE NEWS HL7 European Office Square de Meeûs 38/40 1000 Brussels Belgium E-mail: EUoffice@HL7.org Website: 05 NEWSLETTER

System.Xml XmlReader - DevX.com · 2005. 8. 22. · The XmlReader was a significant innovation in XML parsing due to its pull model approach and caused a significant amount of acclaim

Hospital Information System using HL7 and DICOM · PDF fileHospital Information System using HL7 and DICOM standards Alin CORDOS1, Bogdan ORZA1, Aurel VLAICU1, Serban MEZA1, Carmen

Getting the Most Out of Your Data using HL7 CDS …...Getting the Most Out of Your Data using HL7 CDS Standards Author jenders@ucla.edu;howard.strasberg@wolterskluwer.com Keywords

Using Da Vinci Quality Measures and Event ... - HL7

More Than You Think HL7 is people, HL7 is ideas, HL7 is collaboration.

VistA Data Extraction Framework (VDEF) - VA.gov …...VistA Data Extraction Framework (VDEF) Extract LIVE data from VistA database Generate HL7 message (using HL7 v2.4 standard) Hand

Using HL7 FHIR to support interoperability: Lessons from a .... Using HL7 FHIR to...Using HL7 FHIR to support interoperability: Lessons from a healthcare provider Scott P. Narus, Ph.D.

Krames On-Demand Integration Using HL7info.krames.com/hs-fs/hub/36339/file-13836341-pdf/docs/hl7... · KOD HL7 Interface Solutions A hospital client must provide an HL7 compliant

Regulatory Initiatives in HL7 Using XML and Structured Documents

CDC Message Development Using HL7 Version 3 Principles

HL7 FHIR NEWSLETTER · HL7 EUROPE08 HL7 European Office Square de Meeûs 38/40 1000 Brussels Belgium E-mail: EUoffice@HL7.org Website: NEWSLETTER MIE …

HL7 Overview Gliwice January 10 th, 2009. What is HL7? HL7 in Healthcare Management Systems Message structure Message encoding schemes HL7 tools.

LimitLIS® HL7 Specification Requirements - RURO Inc. · Although we fully support and recommend using HL7 version 2.7, we may process HL7 files conforming to older versions of the