Vision Adapter for QuickFHIR - Local Development build (v1.0.0). See the Directory of published versions

Implementation

Introduction

The following resources provide additional information to support use of the API.

HL7 FHIR

The adapter provides health care data exchange via a standard HL7 FHIR REST API.

Capability statement

The Capability Statement for the adapter provides formal documentation of the set of capabilities (behaviors) of the adapter when deployed as a FHIR Server.

This can also be retrieved at runtime using the standard capabilities interaction.

SearchParameters

The adapter supports FHIR search using a defined set of Search Parameters.

Postman

Postman is a collaboration platform for API development.

The Postman collection can be used to evaluate the API capabilities. Given access to a QuickFHIR Cell, Postman can be used to exercise the FHIR endpoint.

Common use cases

Find a patient

Search parameters:

• identifier
• birthdate
• family
• given

It is possible (though exceedingly rare!) that the EHR contains records for different individuals with the same identifier (e.g. NHS Number). Consequently, you must check for the case where multiple Patient resources are returned and handle this exceptional condition.

Retrieve specific clinical resources for a patient

To retrieve a subset of the clinical data for a patient (e.g. all AllergyIntolerance resources):

Search parameters:

• identifier

A chained search on patient.identifier can also be used.

Retrieve all resources for a patient

Search parameters:

• patient

A chained search on patient.identifier can also be used.

NB: This returns a Bundle containing different types of resources so isn’t strict FHIR!

Write an encounter for a patient

TODO: Add documentation and examples.