Aggregator Adapter for QuickFHIR
1.0.0 - draft

Aggregator 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] for Medication Statements (http://hl7.org/fhir/R4/search.html) 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 Medication Statements for a patient from multiple endpoints.

For example:

  • Get using patient identifier (nhs number) 
    GET 'https://8a856cad160f4d3fa6.develop.eu-west-2.quickfhir.cloud/fhir/MedicationStatement?patient.identifier=https:%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9449303789'
  • Get using patient nhs number and status 
    GET 'https://8a856cad160f4d3fa6.develop.eu-west-2.quickfhir.cloud/fhir/MedicationStatement?patient.identifier=https:%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9449303789&status=intended'
  • Get using patient nhs number and effective date range 
    GET 'https://8a856cad160f4d3fa6.develop.eu-west-2.quickfhir.cloud/fhir/MedicationStatement?patient.identifier=https:%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9449303789&effective=ge2020-01-01&effective=le2021-12-31'
  • Get using patient nhs number and date of birth for EMIS endpoint 
    GET 'https://8a856cad160f4d3fa6.develop.eu-west-2.quickfhir.cloud/fhir/MedicationStatement?patient.identifier=https:%2F%2Ffhir.nhs.uk%2FId%2Fnhs-number%7C9449303789&patient.birthdate=2011-06-14'

The response will be a Bundle of MedicationStatement resources matching the search parameters. It will include further information about the result of the search in the OperationOutcome resource.

When an InformationSource is provided by the endpoint it will be included in both the MedicationStatement and the OperationOutcome. If the endpoint does not provide an InformationSource in the response the value in the adaptor configuration for the given endpoint will be used.

An OperationOutcome issue will be provided for every configured endpoint providing further details for both success and failed requests. In addition, issues from OperationOutcome resources returned by each configured endpoint will be included with the diagnostics will be prefixed with the information source.