US Meds Implementation Guide (Release 1)
This page is part of the US-Medication FHIR IG (v1.0.0: STU 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions 
Formats: Narrative, XML, JSON, Turtle
Raw xml
<CapabilityStatement xmlns="http://hl7.org/fhir/STU3"> <id value="server"/> <text> <status value="additional"/> <div xmlns="http://www.w3.org/1999/xhtml"> <ul id="markdown-toc"> <li> <a href="#conformance-requirements-for-the-us-meds-server" id="markdown-toc-conformance-requirements-for-the-us-meds-server">Conformance requirements for the US Meds Server</a> <ul> <li> <a href="#behavior" id="markdown-toc-behavior">Behavior</a> </li> <li> <a href="#security" id="markdown-toc-security">Security:</a> </li> <li> <a href="#profile-interaction-summary" id="markdown-toc-profile-interaction-summary">Profile Interaction Summary:</a> </li> <li> <a href="#resource--details" id="markdown-toc-resource--details">Resource Details:</a> <ul> <li> <a href="#medication" id="markdown-toc-medication">1. Medication</a> </li> <li> <a href="#medicationadministration" id="markdown-toc-medicationadministration">2. MedicationAdministration</a> </li> <li> <a href="#medicationdispense" id="markdown-toc-medicationdispense">3. MedicationDispense</a> </li> <li> <a href="#medicationrequest" id="markdown-toc-medicationrequest">4. MedicationRequest</a> </li> <li> <a href="#medicationstatement" id="markdown-toc-medicationstatement">5. MedicationStatement</a> </li> </ul> </li> </ul> </li> </ul> <h3 id="conformance-requirements-for-the-us-meds-server">Conformance requirements for the US Meds Server</h3> <ul> <li>FHIR Version: 3.0.0</li> <li>Supported formats: xml, json</li> <li>Published: 2017-03-08</li> <li>Published by: Health Level Seven International Pharmacy Work Group</li> </ul> <p>The section describes the expected capabilities of the US Meds Server actor which is responsible for providing responses to the queries submitted by the US Med Client applications. It is expected that this CapabilityStatement will be used with the <a href="http://hl7.org/fhir/STU3/us/core/STU1/capstmnts.html">US Core CapabilityStatement</a>. Together they describe the complete list of FHIR profiles, RESTful operations, and search parameters supported by US Meds Servers. US Meds Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.</p> <h4 id="behavior">Behavior</h4> <p>Description: The US Meds Server <strong>SHALL</strong>:</p> <ul> <li>Support the <a href="http://hl7.org/fhir/STU3/us/core/STU1/StructureDefinition-us-core-patient.html">US Core Patient</a> resource profile.</li> <li>At a minimum, support the US Core MedicationStatement Profile.</li> <li>Implement the RESTful behavior according to the FHIR specification.</li> <li>Return the following response classes: <ul> <li>(Status 200): successful operation</li> <li>(Status 400): invalid parameter</li> <li>(Status 401/4xx): unauthorized request</li> <li>(Status 403): insufficient scope</li> <li>(Status 404): unknown resource</li> <li>(Status 410): deleted resource.</li> </ul> </li> <li>Support <em>json</em> resource formats for all US Meds interactions.</li> <li>Declare a CapabilityStatement identifying the list of profiles, operations, and search parameters supported.</li> </ul> <p>The US Meds Server <strong>SHOULD</strong>:</p> <ul> <li>Support the following US Core and US Meds resource profiles: <ul> <li>US Core Medication</li> <li>US Meds MedicationAdministration</li> <li>US Meds MedicationDispense</li> <li>US Core MedicationRequest</li> </ul> </li> <li>Support <em>xml</em> resource formats for all US Meds interactions.</li> <li>Identify the US Core profile(s) and US Meds profiles supported as part of the FHIR <code class="highlighter-rouge">meta.profile</code> attribute for each instance.</li> </ul> <p>The US Meds Server <strong>MAY</strong>:</p> <ul> <li>Support other US Core and US Meds resource profile</li> </ul> <h4 id="security">Security:</h4> <p>US Meds Servers <strong>SHALL</strong>:</p> <ul> <li>Implement the security requirements documented in the <a href="http://hl7.org/fhir/STU3/us/core/STU1/security.html">US-Core IG</a>.</li> <li>A server has ensured that every API request includes a valid Authorization token, supplied via: <code class="highlighter-rouge">Authorization: Bearer {server-specific-token-here}</code> </li> <li>A server has rejected any unauthorized requests by returning an <code class="highlighter-rouge">HTTP 401</code> Unauthorized response code.</li> </ul> <h4 id="profile-interaction-summary">Profile Interaction Summary:</h4> <ul> <li>All servers <strong>SHALL</strong> make available the <a href="http://hl7.org/fhir/STU3/STU3/http.html#read">read</a> and <a href="http://hl7.org/fhir/STU3/STU3/http.html#search">search</a> interactions for the Profiles the server chooses to support.</li> <li>All servers <strong>SHOULD</strong> make available the <a href="http://hl7.org/fhir/STU3/STU3/http.html#vread">vread</a> and <a href="http://hl7.org/fhir/STU3/STU3/http.html#history">history-instance</a> interactions for the Profiles the server chooses to support.</li> </ul> <p> <strong>Summary of US Meds search criteria</strong> </p> <p>Specific server 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 <em>if</em> the an external reference to Medication is used, the server <strong>SHALL</strong> support the <a href="http://hl7.org/fhir/STU3/STU3/http.html#include"> <code class="highlighter-rouge">_include</code> </a> parameter for searching this element. The client application must support all methods.</p> <table class="grid"> <thead> <tr> <th>Resource Type</th> <th>Supported Profiles</th> <th>Supported Searches</th> <th>Supported _includes</th> </tr> </thead> <tbody> <tr> <td> <a href="#medication">Medication</a> </td> <td>US Core Medication Profile</td> <td> </td> <td> </td> </tr> <tr> <td> <a href="#medicationadministration">MedicationAdministration</a> </td> <td>US Meds MedicationAdministration Profile</td> <td>patient</td> <td>MedicationAdministration:medication</td> </tr> <tr> <td> <a href="#medicationdispense">MedicationDispense</a> </td> <td>US Meds MedicationDispense Profile</td> <td>patient</td> <td>MedicationDispense:medication</td> </tr> <tr> <td> <a href="#medicationrequest">MedicationRequest</a> </td> <td>US Core MedicationRequest Profile</td> <td>patient, status, patient + status</td> <td>MedicationRequest:medication</td> </tr> <tr> <td> <a href="#medicationstatement">MedicationStatement</a> </td> <td>US Core MedicationStatement Profile</td> <td>patient, status, context, patient + status, patient + context</td> <td>MedicationStatement:medication</td> </tr> </tbody> </table> <h4 id="resource--details">Resource Details:</h4> <h5 id="medication">1. Medication</h5> <p>Supported Profiles: <a href="http://hl7.org/fhir/STU3/us/core/STU1/StructureDefinition-us-core-medication.html">US Core Medication Profile</a> </p> <h5 id="medicationadministration">2. MedicationAdministration</h5> <p>Supported Profiles: <a href="http://hl7.org/fhir/us/meds/STU1/StructureDefinition-medicationadministration.html">US Meds MedicationAdministration Profile</a> </p> <p>Search Criteria:</p> <p>A server <strong>SHALL</strong> be capable of fetching a patient’s administered medications using one of or both:</p> <ul> <li> <code class="highlighter-rouge">GET /MedicationAdministration?patient=[id]</code> </li> <li> <code class="highlighter-rouge">GET /MedicationAdministration?patient=[id]&_include=MedicationAdministration:medication</code> </li> </ul> <p>Search Parameters:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>_include (see documentation)</th> <th>Modifiers</th> </tr> </thead> <tbody> <tr> <td> <strong>SHALL</strong> </td> <td>patient</td> <td>reference</td> <td>MedicationAdministration:medication</td> <td> </td> </tr> </tbody> </table> <h5 id="medicationdispense">3. MedicationDispense</h5> <p>Supported Profiles: <a href="http://hl7.org/fhir/us/meds/STU1/StructureDefinition-medicationdispense.html">US Meds MedicationDispense Profile</a> </p> <p>Search Criteria:</p> <p>A server <strong>SHALL</strong> be capable of returning a patient’s dispensed medications using one of or both:</p> <ul> <li> <code class="highlighter-rouge">GET /MedicationDispense?patient=[id]</code> </li> <li> <code class="highlighter-rouge">GET /MedicationDispense?patient=[id]&_include=MedicationDispense:medication</code> </li> </ul> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>_include (see documentation)</th> <th>Modifiers</th> </tr> </thead> <tbody> <tr> <td> <strong>SHALL</strong> </td> <td>patient</td> <td>reference</td> <td>MedicationDispense:medication</td> <td> </td> </tr> </tbody> </table> <h5 id="medicationrequest">4. MedicationRequest</h5> <p>Supported Profiles: <a href="http://hl7.org/fhir/STU3/us/core/STU1/StructureDefinition-us-core-medicationrequest.html">US Core MedicationRequest Profile</a> </p> <p>Search Criteria:</p> <p>A server <strong>SHALL</strong> be capable of returning a patient’s active medications orders using one of or both:</p> <ul> <li> <code class="highlighter-rouge">GET /MedicationRequest?patient=[id]</code> </li> <li> <code class="highlighter-rouge">GET /MedicationRequest?patient=[id]&_include=MedicationRequest:medication</code> </li> </ul> <p>Search Parameters:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>_include (see documentation)</th> <th>Modifiers</th> </tr> </thead> <tbody> <tr> <td> <strong>SHALL</strong> </td> <td>status + status</td> <td>reference + token</td> <td>MedicationRequest:medication</td> <td> </td> </tr> </tbody> </table> <h5 id="medicationstatement">5. MedicationStatement</h5> <p>Supported Profiles: <a href="http://hl7.org/fhir/STU3/us/core/STU1/StructureDefinition-us-core-medicationstatement.html">US Core MedicationStatement Profile</a> </p> <p>Search Criteria:</p> <p>A server <strong>SHALL</strong> be capable of returning all medications for a patient using one of or both:</p> <ul> <li> <code class="highlighter-rouge">GET /MedicationStatement?patient=[id]</code> </li> <li> <code class="highlighter-rouge">GET /MedicationStatement?patient=[id]&_include=MedicationStatement:medication</code> </li> </ul> <p>A server <strong>SHALL</strong> be capable of returning all active medications for a patient using:</p> <ul> <li> <code class="highlighter-rouge">GET /MedicationStatement?patient=[id]&status=active</code> </li> <li> <code class="highlighter-rouge">GET /MedicationStatement?patient=[id]&status=active&_include=MedicationStatement:medication</code> </li> </ul> <p>A server <strong>SHALL</strong> be capable of returning all medications for a patient for an encounter using:</p> <ul> <li> <code class="highlighter-rouge">GET /MedicationStatement?patient=[id]&context=[id]</code> </li> <li> <code class="highlighter-rouge">GET /MedicationStatement?patient=[id]&context=[id]&_include=MedicationStatement:medication</code> </li> </ul> <p>Search Parameters:</p> <table class="grid"> <thead> <tr> <th>Conformance</th> <th>Parameter</th> <th>Type</th> <th>_include (see documentation)</th> <th>Modifiers</th> </tr> </thead> <tbody> <tr> <td> <strong>SHALL</strong> </td> <td>patient</td> <td>reference</td> <td>MedicationStatement:medication</td> <td> </td> </tr> <tr> <td> <strong>SHALL</strong> </td> <td>patient + status</td> <td>reference + token</td> <td>MedicationStatement:medication</td> <td> </td> </tr> <tr> <td> <strong>SHALL</strong> </td> <td>patient + context</td> <td>reference</td> <td>MedicationStatement:medication</td> <td> </td> </tr> </tbody> </table> <p> <br/> </p> </div> </text> <url value="http://hl7.org/fhir/us/meds/CapabilityStatement/server"/> <version value="1.0.0"/> <name value="US Meds Server"/> <status value="draft"/> <date value="2017-03-08T00:00:00+11:00"/> <publisher value="Health Level Seven International Pharmacy Work Group"/> <contact> <telecom> <system value="other"/> <value value="http://www.hl7.org/Special/committees/medication/index.cfm"/> </telecom> </contact> <description value="This resource defines the expected capabilities of the US Meds Server actor when conforming to the US Meds IG and It is expected that it will be used in conjuction with the US Core CapabilityStatement. Together they describe the complete list of actual profiles, RESTful operations, and search parameters supported by US Meds Servers. US Meds Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements."/> <kind value="requirements"/> <fhirVersion value="3.0.0"/> <acceptUnknown value="extensions"/> <format value="xml"/> <format value="json"/> <profile> <extension url="http://hl7.org/fhir/STU3/us/core/StructureDefinition/us-core-profile-link"> <valueCode value="Medication"/> </extension> <reference value="http://hl7.org/fhir/STU3/us/core/StructureDefinition/us-core-medication"/> <display value="US Core Medication Profile"/> </profile> <profile> <extension url="http://hl7.org/fhir/STU3/us/core/StructureDefinition/us-core-profile-link"> <valueCode value="MedicationAdministration"/> </extension> <reference value="http://hl7.org/fhir/us/meds/StructureDefinition/medicationadministration"/> <display value="US Meds MedicationAdministration Profile"/> </profile> <profile> <extension url="http://hl7.org/fhir/STU3/us/core/StructureDefinition/us-core-profile-link"> <valueCode value="MedicationDispense"/> </extension> <reference value="http://hl7.org/fhir/us/meds/StructureDefinition/medicationdispense"/> <display value="US Meds MedicationDispense Profile"/> </profile> <profile> <extension url="http://hl7.org/fhir/STU3/us/core/StructureDefinition/us-core-profile-link"> <valueCode value="MedicationRequest"/> </extension> <reference value="http://hl7.org/fhir/STU3/us/core/StructureDefinition/us-core-medicationrequest"/> <display value="US Core MedicationRequest Profile"/> </profile> <profile> <extension url="http://hl7.org/fhir/STU3/us/core/StructureDefinition/us-core-profile-link"> <valueCode value="MedicationStatement"/> </extension> <reference value="http://hl7.org/fhir/STU3/us/core/StructureDefinition/us-core-medicationstatement"/> <display value="US Core MedicationStatement Profile"/> </profile> <rest> <mode value="server"/> <resource> <type value="Medication"/> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="search-type"/> <documentation value="IF the Medication Resource is used in a MedicationStatement or a MedicationRequest. Allows discovery of existing US Core Medication resources using different search criteria."/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="read"/> <documentation value="IF the Medication Resource is used in a MedicationStatement or a MedicationRequest. Allows retrieval of a specific US Core Medication by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to US Core Medication instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a US Core Medication instance"/> </interaction> </resource> <resource> <type value="MedicationAdministration"/> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing US Core medicationadmnistration resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific US Core medicationadmnistration by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to US Core medicationadmnistration instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a US Core medicationadmnistration instance"/> </interaction> <searchInclude value="MedicationAdministration:medication"/> <searchParam> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/STU3/SearchParameter/MedicationAdministration-Patient"/> <type value="reference"/> </searchParam> </resource> <resource> <type value="MedicationDispense"/> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing US Core medicationdispense resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific US Core medicationdispense by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to US Core medicationdispense instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a US Core medicationdispense instance"/> </interaction> <searchInclude value="MedicationDispense:medication"/> <searchParam> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/STU3/SearchParameter/MedicationDispense-Patient"/> <type value="reference"/> </searchParam> </resource> <resource> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="status"/> </extension> </extension> <type value="MedicationRequest"/> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing US Core medicationrequest resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific US Core medicationrequest by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to US Core medicationrequest instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a US Core medicationrequest instance"/> </interaction> <searchInclude value="MedicationRequest:medication"/> <searchParam> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/STU3/SearchParameter/MedicationRequest-Patient"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="status"/> <definition value="http://hl7.org/fhir/STU3/SearchParameter/MedicationRequest-Status"/> <type value="token"/> </searchParam> </resource> <resource> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="status"/> </extension> </extension> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="required"> <valueString value="patient"/> </extension> <extension url="required"> <valueString value="context"/> </extension> </extension> <type value="MedicationStatement"/> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing US Core medicationstatement resources using different search criteria"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific US Core medicationstatement by id"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to US Core medicationstatement instance over time"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a US Core medicationstatement instance"/> </interaction> <searchInclude value="MedicationStatement:medication"/> <searchParam> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/STU3/SearchParameter/MedicationStatement-Patient"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="status"/> <definition value="http://hl7.org/fhir/STU3/SearchParameter/MedicationStatement-Status"/> <type value="token"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="context"/> <definition value="http://hl7.org/fhir/STU3/SearchParameter/MedicationStatement-Context"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <name value="category"/> <definition value="http://hl7.org/fhir/STU3/SearchParameter/MedicationStatement-Category"/> <type value="reference"/> </searchParam> </resource> </rest> </CapabilityStatement>
US Meds Version: STU1 (v1.0.0) ®© FHIR Version: 3.0.1 generated on Thu, Jun 15, 2017 16:08+1000. |
