This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

FHIR Connectathon Brisbane

From HL7Wiki
Revision as of 18:07, 14 June 2015 by David hay (talk | contribs)
Jump to navigation Jump to search


This page describes the FHIR Connectathon that will be held on Thursday June 18 Brisbane. Australia


The meeting will be held at Australian e-Health Research Centre, Level 5, UQ Health Sciences Building 901/16, Royal Brisbane and Women's Hospital, Brisbane, Australia

Important notes:

  • To be added to the skype Implementers chat, skype david hay (david.hay25) or anyone who is already on the chat


This connectathon will have 3 separate themes

  • Basic patient management
    • The patient resource is well defined, and these scenarios are intended for a user new to FHIR to interact with it at a basic level. it covers:
    • search
    • 'CRUD'
    • history
    • extensions
  • Version 2 mapping to FHIR Messages
  • Terminology Services

Note: at every connectathon, participants attend and test functionality other than that described in the scenarios.

Note also that the connectathon will be based on the DSTU-2 Candidate version of FHIR which is posted at [1]

Connectathon Organization

The connectathon will be held over a single day, with most of the day intended for participants to test and develop software in an informal way. Test servers will be available (actually, they are already - FHIR Test Servers ), but some participants may bring other servers along depending on the actors they are fulfilling.

The latter part of the day - likely around 3.30 - will be a 'show and tell' for participants to demonstrate their progress to the group.


If you or your company are interested in participating in the connectathon, please do the following.

  • Read the FHIR Specification and the FHIR wiki if you haven't already done so, to become familiar with the concepts.
  • Read the scenario descriptions below.

email: to register

  • Optionally add your details below (in the 'Registered Participants' section) to indicate the scenarios you intend to participate in

Space at the venue is limited, so please register as soon as possible. Preference will be given to those who are actually participating in the technical event, but observers are welcome if space permits.

For any queries, either contact a member of the planning team, or post your question in the FHIR list server

Registered Participants

Connectathon Planning Team

Test servers

Grahame's server Brett's server Hapi DSTU2

Connectathon tracks

This section lists the scenarios that are proposed for this connectathon. The scenarios are grouped into 3 tracks. Track 1 is for those new to FHIR and requires minimal preparation in advance of the connectathon (at least for client applications). Tracks 2 and 3 are focused on particular implementation activities with FHIR and exercise a more complete set of behavior designed to reflect a full production experience - preparation in advance will be required.

Note that this track - as with all tracks - will use the candidate 'DSTU-2' version of FHIR as described here. If you've been to a connectathon before and done this track, then you may need to change your code, as there have been many important changes to the specification.

Track 1 - Patient

Coordinator: David Hay

If creating a client, this track should require minimal work in advance of the connectathon, though at least a bit of playing is recommended. If creating a server, advanced preparation will be required, but this scenario should somewhat limit the effort involved.

Pre-requisites: none

1. Register a new patient

  • Action: (Patient Demographics consumer) creates a new patient and save to Patient Service. The client can assign the Id.
  • Precondition: Patient does not exist in service prior to action
  • Success Criteria: Patient created correctly on server (use browser to inspect Patient)
  • Bonus point: The Patient resource has an extension

>>Note: the requirement for the client to assign the Id has been relaxed. However, if the server assigns the Id, then the client will need to be able to retrieve the Id from the server response or by a patient query.

2. Update a patient

  • Action: (Patient Demographics consumer) updates the patient created in scenario #1 and updates to Patient Service. The patient is retrieved by Id.
  • Precondition: Patient has been created
  • Success Criteria: Patient updated on server (use browser to inspect Patient)
  • Bonus Point #1: Update a patient that has extensions, but leaving the extension untouched.
  • Bonus Point #2: Update a patient that has extensions, and update the extension also.

3. Retrieve Patient history

  • Action: (Patient Demographics consumer) searches the patient Service for the history of a Patient
  • Precondition: There is a patient that has at least one update
  • Success Criteria: Patient's history displayed in interface. (use browser query Patient Service)
  • Bonus point: The UI allows the user to display previous versions of the Patient

4. Search for a patient on name

  • Action: (Patient Demographics consumer) searches the patient Service for patients with a given name
  • Precondition: Patients with that name have been created
  • Success Criteria: patients displayed in interface. (use browser query to confirm)

Some help links:

Track 2 - v2 Message conversion

The details of this track can be found here: Version 2 - FHIR Mapping Scenarios.

In summary the tracks are:

  1. ADT Query - mapping a v2 query and its response
  2. ADT - mapping a sequence of ADT events
  3. ORU - mapping a sequence of laboratory results messages

Some other resources:

  • Blog post, whitepaper
  • all resources have a mapping page with v2 & v3 mappings (This connectathon is to test them!)

Track 3 - Terminology Services

Coordinator: Rob Hausam

Service Providers

For service providers, implement the following operations from

  • $expand
  • $validate-code (note: there's a set of typos on the terminology service page where this operation is called "validate" but its actually "validate-code" - editorial oversight)
  • $lookup
  • $translate (note: there's a typo on the terminology service page where the example has '$validate' not '$translate')

Service providers are not required to implement all this functionality - it's a lot to do. For new implementers, start at the top and work down (generally)

(note for participants in the first terminology services connectathon: this stream builds on the previous connectathon by adding $lookup and $translate)

There's a fairly specific test script with detail descriptions of scenarios at (for anonymous access, use 'anonymous' with our email as a password). Implementers are not required to implement the full script and pass those particular tests, though it is encouraged to be able to do so

note about the test script: you need a version of Sprinkler to execute it (details to be provided). It looks like a resource, and there is a proposal to actually add it as a resource. On the other hand, we'll be considering alternative proposals in Paris as well as that format. Or you can use any other kind of http based test service; there's nothing magic there.

Client Consumers

Any one of

  • do a value set expansion of one of the value sets in the spec
  • validate a code using the spec against a FHIR value set, a v2 value set, or LOINC or snomed CT
  • look up a display for a code (most appropriate for v2/FHIR conversion)

At least one server supports all these operations ( Other servers, including the Apelon server ( will support some of those operations

Servers (Supporting the messaging interoperability paradigm)

Publicly Available FHIR Servers for testing