R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

12.18.1.2 Operation $data-requirements on PlanDefinition

Clinical Decision Support Work Group Maturity Level: 2Trial Use Compartments: N/A

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

The official URL for this operation definition is

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

Formal Definition (as a OperationDefinition).

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

This is not an idempotent operation

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
return1..1Library

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

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 a resource

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

12.18.1.2.1 Examples

Request data requirements for the Zika Virus intervention plan definition (Request):

GET [base]/PlanDefinition/zika-virus-intervention/$data-requirements

Returned on successful evaluation (Response):

HTTP/1.1 200 OK

{
  "resourceType": "Library",
  "type": {
    "coding": [
      {
        "code": "module-definition"
      }
    ]
  },
  "relatedArtifact": [
    {
      "type": "depends-on",
      "display": "Zika Affected Areas"
      "resource": "ValueSet/zika-affected-areas"
    },
    {
      "type": "depends-on",
      "display": "Pregnancy",
      "resource": "urn:oid:X.Y.Z"
    },
    {
      "type": "depends-on",
      "display": "Zika Exposure Assessment",
      "resource": "urn:oid:X.Y.Z"
    },
    {
      "type": "depends-on",
      "display": "Zika Virus Signs and Symptoms",
      "url": "https://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.114222.4.11.7459",
      "resource": "urn:oid:2.16.840.1.114222.4.11.7459"
    },
  ]
  "dataRequirement": [
    {
      "type": "Condition",
      "codeFilter": [
        {
          "path": "code",
          "valueSetUri": "http://example.org/valueset/pregnancy"
        }
      ]
    },
    {
      "type": "Patient"
    },
    {
      "type": "Observation",
      "codeFilter": [
        {
          "path": "code",
          "valueSetUri": "http://example.org/valueset/zika-exposure-assessment"
        },
        {
          "path": "status",
          "code": [
            {
              "code": "final"
            }
          ]
        }
      ]
    },
    {
      "type": "Condition",
      "codeFilter": [
        {
          "path": "category",
          "code": [
            {
              "code": "diagnosis"
            }
          ]
        },
        {
          "path": "clinicalStatus",
          "code": [
            {
              "code": "confirmed"
            }
          ]
        },
        {
          "path": "code",
          "valueSetUri": "urn:oid:2.16.840.1.114222.4.11.7459"
        }
      ]
    }
  ]
}

 

For more information about operations, including how they are invoked, see Operations.