FHIR © HL7.org  |  Server Home  |  Health Intersections FHIR Server v1.0.278  |  FHIR Version 3.0.1  | User: ANONYMOUS (Unknown)  

Resource "ServiceDefinition-data-requirements" Version "1" (OperationDefinition)

Tags:

XML or JSON representation . provenance for this resource

Data Requirements

OPERATION: Data Requirements

The official URL for this operation definition is:

http://hl7.org/fhir/OperationDefinition/ServiceDefinition-data-requirements

The data-requirements operation aggregates and returns the parameters and data requirements for the service module and all its dependencies as a single module definition library.

URL: [base]/ServiceDefinition/[id]/$data-requirements

Parameters

Use Name Cardinality Type Binding Documentation
IN evaluateAtDateTime 0..1 dateTime

An optional date and time specifying that the evaluation should be performed as though it was the given date and time. Data requirements returned will use this as the "Now" point for the purposes of determining the data requirements.

OUT return 1..1 Library

The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the service.

The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the service module. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the service module and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements).


<?xml version="1.0" encoding="UTF-8"?>
<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="ServiceDefinition-data-requirements"/>
  <meta>
    <versionId value="1"/>
    <lastUpdated value="2018-09-06T12:38:07.859Z"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>Data Requirements</h2>
      <p>OPERATION: Data Requirements</p>
      <p>The official URL for this operation definition is: </p>
      <pre>http://hl7.org/fhir/OperationDefinition/ServiceDefinition-data-requirements</pre>
      <div>
        <p>The data-requirements operation aggregates and returns the parameters and data requirements for the service module and all its dependencies as a single module definition library.</p> </div>
      <p>URL: [base]/ServiceDefinition/[id]/$data-requirements</p>
      <p>Parameters</p>
      <table class="grid">
        <tr>
          <td>
            <b>Use</b> </td>
          <td>
            <b>Name</b> </td>
          <td>
            <b>Cardinality</b> </td>
          <td>
            <b>Type</b> </td>
          <td>
            <b>Binding</b> </td>
          <td>
            <b>Documentation</b> </td> </tr>
        <tr>
          <td>IN</td>
          <td>evaluateAtDateTime</td>
          <td>0..1</td>
          <td>dateTime</td>
          <td/>
          <td>
            <div>
              <p>An optional date and time specifying that the evaluation should be performed as though it was the given date and time. Data requirements returned will use this as the "Now" point for the purposes of determining the data requirements.</p> </div> </td> </tr>
        <tr>
          <td>OUT</td>
          <td>return</td>
          <td>1..1</td>
          <td>Library</td>
          <td/>
          <td>
            <div>
              <p>The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the service.</p> </div> </td> </tr> </table>
      <div>
        <p>The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the service module. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the service module and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements).</p> </div> </div>
  </text>
  <url value="http://hl7.org/fhir/OperationDefinition/ServiceDefinition-data-requirements"/>
  <name value="Data Requirements"/>
  <status value="draft"/>
  <kind value="operation"/>
  <date value="2017-04-19T07:44:43+10:00"/>
  <publisher value="HL7 (FHIR Project)"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://hl7.org/fhir"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="fhir@lists.hl7.org"/>
    </telecom>
  </contact>
  <description value="The data-requirements operation aggregates and returns the parameters and data requirements for the service module and all its dependencies as a single module definition library."/>
  <code value="data-requirements"/>
  <comment value="The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the service module. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the service module and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)."/>
  <resource value="ServiceDefinition"/>
  <system value="false"/>
  <type value="false"/>
  <instance value="true"/>
  <parameter>
    <name value="evaluateAtDateTime"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation value="An optional date and time specifying that the evaluation should be performed as though it was the given date and time. Data requirements returned will use this as the &quot;Now&quot; point for the purposes of determining the data requirements."/>
    <type value="dateTime"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the service."/>
    <type value="Library"/>
  </parameter>
</OperationDefinition>