FHIR Release 3 (STU) CI-Build

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 Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3

14.1.10 17.12.10 Resource Library - Operations

Responsible Owner: Clinical Decision Support icon Work Group Maturity Level Standards Status : 2 Informative   Trial Use Security Category : Anonymous Compartments : Not linked to any No defined compartments

This resource has 1 operation operations associated with it:

$data-requirements Data Requirements

For more information about operations, including how they In addition, there are invoked, see Operations . 14.1.10.1 Data Requirements The data-requirements operation aggregates and returns the parameters and data requirements for a resource and operations that apply to all its dependencies as a single module definition The official URL for this operation definition is http://hl7.org/fhir/OperationDefinition/Library-data-requirements Formal Definition (as a OperationDefinition ). URL: [base]/$data-requirements URL: [base]/Library/[id]/$data-requirements This is not an idempotent operation resource types:

In Parameters: Out Parameters:
Name Cardinality Type Binding Profile $validate Documentation Validate a resource
target 0..1 Reference ( Any $convert ) The target of the data requirements operation Name Cardinality Type Binding Profile Documentation Convert from one form to another
return 1..1 Library $graphql The result of the requirements gathering Note: as this the only out parameter, it is a resource, and it has the name 'return', the result of this operation is returned directly as Execute a resource graphql statement

The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for a given target resource. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the target resource and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements) 14.1.10.1.1 Examples Request data requirements for the CMS146 library (Request): GET [base]/Library/library-cms146-example/$data-requirements Returned on successful evaluation (Response): HTTP/1.1 200 OK { "resourceType": "Library", "type": { "coding": [ { "code": "module-definition" } ] }, "relatedArtifact": [ { "type": "depends-on", "resource": { "reference": "Library/library-quick-model-definition" } } ], "dataRequirement": [ { "type": "Condition", "codeFilter": [ { "path": "code", "valueSetString": "Other Female Reproductive Conditions" } ] }, { "type": "Patient" }, { "type": "Condition", "codeFilter": [ { "path": "category", "valueCode": [ "diagnosis" ] }, { "path": "clinicalStatus", "valueCode": [ "confirmed" ] }, { "path": "code", "valueSetString": "2.16.840.1.113883.3.464.1003.102.12.1011" } ] }, { "type": "Condition", "codeFilter": [ { "path": "category", "valueCode": [ "diagnosis" ] }, { "path": "clinicalStatus", "valueCode": [ "confirmed" ] }, { "path": "code", "valueSetString": "2.16.840.1.113883.3.464.1003.102.12.1012" } ] }, { "type": "Encounter", "codeFilter": [ { "path": "status", "valueCode": [ "finished" ] }, { "path": "class", "valueCode": [ "ambulatory" ] }, { "path": "type", "valueSetString": "2.16.840.1.113883.3.464.1003.101.12.1061" } ] }, { "type": "DiagnosticReport", "codeFilter": [ { "path": "diagnosis", "valueSetString": "2.16.840.1.113883.3.464.1003.198.12.1012" } ] }, { "type": "Medication", "codeFilter": [ { "path": "code", "valueSetString": "2.16.840.1.113883.3.464.1003.196.12.1001" } ] }, { "type": "MedicationRequest", "codeFilter": [ { "path": "status", "valueCode": [ "active" ] }, { "path": "medication.code", "valueSetString": "2.16.840.1.113883.3.464.1003.196.12.1001" } ] }, { "type": "MedicationStatement", "codeFilter": [ { "path": "status", "valueCode": [ "completed" ] }, { "path": "medication.code", "valueSetString": "2.16.840.1.113883.3.464.1003.196.12.1001" } ] } ] }   For more information about operations, including how they are invoked, see Operations .