FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Operation-servicedefinition-data-requirements

Clinical Decision Support Work Group

Maturity Level: N/A

Ballot Status: Informative

Compartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML or JSON format.

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).

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.