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

JSON Format: CapabilityStatement-client

Download Raw json

{
  "resourceType" : "CapabilityStatement",
  "id" : "client",
  "text" : {
    "status" : "additional",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t\n\t\t\t<ul id=\"markdown-toc\">\n\t\t\t\t<li>\n\t\t\t\t\t<a href=\"#conformance-requirements-for-the-us-meds-client\" id=\"markdown-toc-conformance-requirements-for-the-us-meds-client\">Conformance requirements for the US Meds Client</a>\n\t\t\t\t\t<ul>\n\t\t\t\t\t\t<li>\n\t\t\t\t\t\t\t<a href=\"#behavior-1\" id=\"markdown-toc-behavior-1\">Behavior</a>\n\t\t\t\t\t\t</li>\n\t\t\t\t\t\t<li>\n\t\t\t\t\t\t\t<a href=\"#security-1\" id=\"markdown-toc-security-1\">Security</a>\n\t\t\t\t\t\t</li>\n\t\t\t\t\t\t<li>\n\t\t\t\t\t\t\t<a href=\"#resource--details-1\" id=\"markdown-toc-resource--details-1\">Resource  Details:</a>\n\t\t\t\t\t\t\t<ul>\n\t\t\t\t\t\t\t\t<li>\n\t\t\t\t\t\t\t\t\t<a href=\"#medication-1\" id=\"markdown-toc-medication-1\">1. Medication</a>\n\t\t\t\t\t\t\t\t</li>\n\t\t\t\t\t\t\t\t<li>\n\t\t\t\t\t\t\t\t\t<a href=\"#medicationadministration-1\" id=\"markdown-toc-medicationadministration-1\">2. MedicationAdministration</a>\n\t\t\t\t\t\t\t\t</li>\n\t\t\t\t\t\t\t\t<li>\n\t\t\t\t\t\t\t\t\t<a href=\"#medicationdispense-1\" id=\"markdown-toc-medicationdispense-1\">3. MedicationDispense</a>\n\t\t\t\t\t\t\t\t</li>\n\t\t\t\t\t\t\t\t<li>\n\t\t\t\t\t\t\t\t\t<a href=\"#medicationrequest-1\" id=\"markdown-toc-medicationrequest-1\">4. MedicationRequest</a>\n\t\t\t\t\t\t\t\t</li>\n\t\t\t\t\t\t\t\t<li>\n\t\t\t\t\t\t\t\t\t<a href=\"#medicationstatement-1\" id=\"markdown-toc-medicationstatement-1\">5. MedicationStatement</a>\n\t\t\t\t\t\t\t\t</li>\n\t\t\t\t\t\t\t</ul>\n\t\t\t\t\t\t</li>\n\t\t\t\t\t</ul>\n\t\t\t\t</li>\n\t\t\t</ul>\n\t\t\t\n\t\t\t<h3 id=\"conformance-requirements-for-the-us-meds-client\">Conformance requirements for the US Meds Client</h3>\n\t\t\t<ul>\n\t\t\t\t<li>FHIR Version: 3.0.0</li>\n\t\t\t\t<li>Supported formats: xml, json</li>\n\t\t\t\t<li>Published: 2017-03-08</li>\n\t\t\t\t<li>Published by: Health Level Seven International Pharmacy Work Group</li>\n\t\t\t</ul>\n\t\t\t<p>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 <a href=\"http://hl7.org/fhir/us/core/capstatements.html\">US Core CapabilityStatement</a>. 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 <strong>MAY</strong> be supported by the client</p>\n\t\t\t<h4 id=\"behavior-1\">Behavior</h4>\n\t\t\t<p>The US Meds Clent <strong>SHALL</strong> support fetching and querying of one or more US Meds profile(s), using the supported RESTful interactions and search parameters declared in the <a href=\"CapabilityStatement-server.html#conformance-requirements-for-the-us-meds-server\">US Meds Server CapabilityStatement</a>\n\t\t\t</p>\n\t\t\t<p>The US Meds Clent <strong>SHOULD</strong> Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.</p>\n\t\t\t<h4 id=\"security-1\">Security</h4>\n\t\t\t<p>US Core Servers <strong>SHALL</strong> implement the security requirements documented in the <a href=\"http://hl7.org/fhir/us/core/security.html\">US-Core IG</a>.</p>\n\t\t\t<p>\n\t\t\t\t<strong>Summary of US Meds search criteria</strong>\n\t\t\t</p>\n\t\t\t<p>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 <em>if</em> the an external reference to Medication is used, the server <strong>SHALL</strong> support the [<code class=\"highlighter-rouge\">_include</code>]((http://hl7.org/fhir/STU3/http.html#include) parameter for searching this element. The client application <strong>SHALL</strong> support all above methods without causing the application to fail.</p>\n\t\t\t<h4 id=\"resource--details-1\">Resource  Details:</h4>\n\t\t\t<h5 id=\"medication-1\">1. Medication</h5>\n\t\t\t<p>Supported Profiles: <a href=\"http://hl7.org/fhir/us/core/StructureDefinition-us-core-medication.html\">US Core Medication Profile</a>\n\t\t\t</p>\n\t\t\t<h5 id=\"medicationadministration-1\">2. MedicationAdministration</h5>\n\t\t\t<p>Supported Profiles:  <a href=\"StructureDefinition-medicationadministration.html\">US Meds MedicationAdministration Profile</a>\n\t\t\t</p>\n\t\t\t<p>Search Criteria:</p>\n\t\t\t<p>A client <strong>SHALL</strong> be capable of fetching a patient’s administered medications using:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationAdministration?patient=[id]</code>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationAdministration?patient=[id]&amp;_include=MedicationAdministration:medication</code>\n\t\t\t\t</li>\n\t\t\t</ul>\n\t\t\t<h5 id=\"medicationdispense-1\">3. MedicationDispense</h5>\n\t\t\t<p>Supported Profiles:  <a href=\"StructureDefinition-medicationdispense.html\">US Meds MedicationDispense Profile</a>\n\t\t\t</p>\n\t\t\t<p>Search Criteria:</p>\n\t\t\t<p>A client <strong>SHALL</strong> be capable of fetching a patient’s dispensed medications using:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationDispense?patient=[id]</code>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationDispense?patient=[id]&amp;_include=MedicationDispense:medication</code>\n\t\t\t\t</li>\n\t\t\t</ul>\n\t\t\t<h5 id=\"medicationrequest-1\">4. MedicationRequest</h5>\n\t\t\t<p>Supported Profiles:  <a href=\"http://hl7.org/fhir/us/core/StructureDefinition-us-core-medicationrequest.html\">US Core MedicationRequest Profile</a>\n\t\t\t</p>\n\t\t\t<p>Search Criteria:</p>\n\t\t\t<p>A client <strong>SHALL</strong> be capable of fetching all patient’s active medications orders using:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationRequest?patient=[id]&amp;status=active</code>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationRequest?patient=[id]&amp;status=active&amp;_include=MedicationRequest:medication</code>\n\t\t\t\t</li>\n\t\t\t</ul>\n\t\t\t<h5 id=\"medicationstatement-1\">5. MedicationStatement</h5>\n\t\t\t<p>Search Criteria:</p>\n\t\t\t<p>A client <strong>SHALL</strong> be capable of fetching all medications for a patient using:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationStatement?patient=[id]</code>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationStatement?patient=[id]&amp;_include=MedicationStatement:medication</code>\n\t\t\t\t</li>\n\t\t\t</ul>\n\t\t\t<p>A client <strong>SHALL</strong> be capable of fetching all active medications for a patient using:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationStatement?patient=[id]&amp;status=active</code>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationStatement?patient=[id]&amp;status=active&amp;_include=MedicationStatement:medication</code>\n\t\t\t\t</li>\n\t\t\t</ul>\n\t\t\t<p>A client <strong>SHALL</strong> be capable of fetching all medications for a patient for an encounter using:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationStatement?patient=[id]&amp;context=[id]</code>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<code class=\"highlighter-rouge\">GET /MedicationStatement?patient=[id]&amp;context=[id]&amp;_include=MedicationStatement:medication</code>\n\t\t\t\t</li>\n\t\t\t</ul>\n\t\t\t<p>\n\t\t\t\t<br/>\n\t\t\t</p>\n\t\t</div>"
  },
  "url" : "http://hl7.org/fhir/us/meds/CapabilityStatement/client",
  "version" : "1.2.0",
  "name" : "US_Meds_Client",
  "status" : "draft",
  "date" : "2017-03-08",
  "publisher" : "Health Level Seven International Pharmacy Work Group",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "other",
          "value" : "http://www.hl7.org/Special/committees/medication/index.cfm"
        }
      ]
    }
  ],
  "description" : "This resource defines the expected capabilities of the US Meds Client 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 Clients.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "xml",
    "json"
  ],
  "rest" : [
    {
      "mode" : "client",
      "resource" : [
        {
          "type" : "Medication",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "search-type",
              "documentation" : "IF the Medication Resource is used in a MedicationStatement or a MedicationRequest.   Allows discovery of existing US Core Medication resources using different search criteria."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "IF the Medication Resource is used in a MedicationStatement or a MedicationRequest.  Allows retrieval of a specific US Core Medication by id"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "history-instance",
              "documentation" : "Allows review of changes to US Core Medication instance over time"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread",
              "documentation" : "Allows retrieval of a historical version of a US Core Medication instance"
            }
          ]
        },
        {
          "type" : "MedicationAdministration",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing US Meds MedicationAdministration resources using different search criteria"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific US Meds MedicationAdministration by id"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "history-instance",
              "documentation" : "Allows review of changes to US Meds MedicationAdministration instance over time"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread",
              "documentation" : "Allows retrieval of a historical version of a US Meds MedicationAdministration instance"
            }
          ],
          "searchInclude" : [
            "MedicationAdministration:medication"
          ],
          "_searchInclude" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ]
            }
          ]
        },
        {
          "type" : "MedicationDispense",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing US Meds MedicationDispense resources using different search criteria"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific US Meds MedicationDispense by id"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "history-instance",
              "documentation" : "Allows review of changes to US Meds MedicationDispense instance over time"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread",
              "documentation" : "Allows retrieval of a historical version of a US Meds MedicationDispense instance"
            }
          ],
          "searchInclude" : [
            "MedicationDispense:medication"
          ],
          "_searchInclude" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ]
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "status"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "MedicationRequest",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing US Core MedicationRequest resources using different search criteria"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific US Core MedicationRequest by id"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "history-instance",
              "documentation" : "Allows review of changes to US Core MedicationRequest instance over time"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread",
              "documentation" : "Allows retrieval of a historical version of a US Core MedicationRequest instance"
            }
          ],
          "searchInclude" : [
            "MedicationRequest:medication"
          ],
          "_searchInclude" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ]
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
              "type" : "token"
            }
          ]
        },
        {
          "extension" : [
            {
              "extension" : [
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "status"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            },
            {
              "extension" : [
                {
                  "url" : "required",
                  "valueString" : "patient"
                },
                {
                  "url" : "required",
                  "valueString" : "context"
                }
              ],
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
            }
          ],
          "type" : "MedicationStatement",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing US Core MedicationStatement resources using different search criteria"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific US Core MedicationStatement by id"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "history-instance",
              "documentation" : "Allows review of changes to US Core MedicationStatement instance over time"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread",
              "documentation" : "Allows retrieval of a historical version of a US Core MedicationStatement instance"
            }
          ],
          "searchInclude" : [
            "MedicationStatement:medication"
          ],
          "_searchInclude" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ]
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "status",
              "definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
              "type" : "token"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "category",
              "definition" : "http://hl7.org/fhir/SearchParameter/MedicationStatement-category",
              "type" : "token"
            }
          ]
        }
      ]
    }
  ]
}