Implementation Guide (Release 1.2.0)

US_Meds, published by HL7 International - Pharmacy Work Group. This is not an authorized publication; it is the continuous build for version 1.2.0). This version is based on the current content of https://github.com/HL7/FHIR-ONC-Meds/ and changes regularly. See the Directory of published versions

Conformance requirements for the US Meds Client

  • FHIR Version: 3.0.0
  • Supported formats: xml, json
  • Published: 2017-03-08
  • Published by: Health Level Seven International Pharmacy Work Group

This section describes the expected capabilities of a client actor which is responsible for creating and initiating the queries for information about an individual patient.It is expected that this CapabilityStatement will be used with the US Core CapabilityStatement. Together they describe the basic expectations for the capabilities of a conformant client application. The complete list of actual profiles and dependencies on other profiles outside the FHIR specification RESTful interactions which includes the search and read operations that MAY be supported by the client

Behavior

The US Meds Clent SHALL support fetching and querying of one or more US Meds profile(s), using the supported RESTful interactions and search parameters declared in the US Meds Server CapabilityStatement

The US Meds Clent SHOULD Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.

Security

US Core Servers SHALL implement the security requirements documented in the US-Core IG.

Summary of US Meds search criteria

Specific client search capabilities are described in detail below in each of the resource sections. The MedicationAdministration, MedicationDispense, MedicationStatement and MedicationRequest resources can represent a medication using either a code or refer to the Medication resource. When referencing a Medication resource, the resource may be contained or an external resource. The server application can choose any one way or more than one method, but if the an external reference to Medication is used, the server SHALL support the [_include]((http://hl7.org/fhir/STU3/http.html#include) parameter for searching this element. The client application SHALL support all above methods without causing the application to fail.

Resource Details:

1. Medication

Supported Profiles: US Core Medication Profile

2. MedicationAdministration

Supported Profiles: US Meds MedicationAdministration Profile

Search Criteria:

A client SHALL be capable of fetching a patient’s administered medications using:

  • GET /MedicationAdministration?patient=[id]
  • GET /MedicationAdministration?patient=[id]&_include=MedicationAdministration:medication
3. MedicationDispense

Supported Profiles: US Meds MedicationDispense Profile

Search Criteria:

A client SHALL be capable of fetching a patient’s dispensed medications using:

  • GET /MedicationDispense?patient=[id]
  • GET /MedicationDispense?patient=[id]&_include=MedicationDispense:medication
4. MedicationRequest

Supported Profiles: US Core MedicationRequest Profile

Search Criteria:

A client SHALL be capable of fetching all patient’s active medications orders using:

  • GET /MedicationRequest?patient=[id]&status=active
  • GET /MedicationRequest?patient=[id]&status=active&_include=MedicationRequest:medication
5. MedicationStatement

Search Criteria:

A client SHALL be capable of fetching all medications for a patient using:

  • GET /MedicationStatement?patient=[id]
  • GET /MedicationStatement?patient=[id]&_include=MedicationStatement:medication

A client SHALL be capable of fetching all active medications for a patient using:

  • GET /MedicationStatement?patient=[id]&status=active
  • GET /MedicationStatement?patient=[id]&status=active&_include=MedicationStatement:medication

A client SHALL be capable of fetching all medications for a patient for an encounter using:

  • GET /MedicationStatement?patient=[id]&context=[id]
  • GET /MedicationStatement?patient=[id]&context=[id]&_include=MedicationStatement:medication