Six ways to exchange

Six ways to exchange. One standard.

FHIR describes six ways to exchange data. None of them is the one correct way. Each has its own strengths and its own place.

Six methods, grouped for learning

The exchange module lists six methods. The RESTful API, and services. Messaging, and documents. And the database or persistent store, and the subscriptions framework. We group them here only to help you remember them. Applications are also allowed to use any other method to exchange resources.

• Ask and answer · navy
• Packaged and sent · amber
• Kept and announced · slate

A situation, and a method

Match the situation to the method. To push and pull data between systems, use the RESTful API. For routed messages between organizations with low process integration and trust, messaging may suit. To share a human readable record across clinical governance borders, use documents. To place FHIR in a wider enterprise architecture, the services framework. To store resources natively so several applications can read and write them, a database. And to send proactive event notifications, subscriptions.

• Push and pull data between systems · RESTful API · share · navy
• Message organizations with low trust · Messaging · text · navy
• Share a readable record across borders · Documents · file · amber
• Place FHIR in an enterprise architecture · Services · gear · slate
• Store resources for several applications · Database / store · box · slate
• Send proactive event notifications · Subscriptions · bolt · slate

Documents and data exchange

Documents and data exchange suit different situations. Exchanging documents is typically associated with sharing clinical information across clinical governance borders. A document wraps the content in a composition, with a fixed presentation for a human reader. Data based exchange through the RESTful API is appropriate within a setting where clinical governance arrangements are well established.

Every exchange must be secured

Whatever the method, exchange must be secured. Production data should be secured using TLS, for example HTTPS. Clients must be authenticated. And for web centric use, OAuth is recommended, and the SMART App Launch guide should be considered.

• Protect · Use TLS · For example, HTTPS. · lock
• Identify · Authenticate clients · Know who is calling. · person
• Authorize · OAuth is recommended · Consider the SMART App Launch guide. · key

Check yourself

Pause and think. Which method sends proactive event notifications from one system to another? The answer: the subscriptions framework.

• The subscriptions framework
• Documents
• Messaging
• The database store

Keep these in mind

FHIR describes six exchange methods. Choose the method that fits the situation. Documents suit crossing governance borders. And secure every exchange, with TLS, authentication, and OAuth.

• FHIR describes six exchange methods
• Choose the method that fits the situation
• Documents suit crossing governance borders
• Secure every exchange: TLS, authentication, OAuth