Release 5 Preview #3

This page is part of the FHIR Specification (v4.5.0: R5 Preview #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 . Page versions: R5 R4B R4

12.21.10.2 Operation $data-requirements on ActivityDefinition

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 activity definition and all its dependencies as a single module definition library.

The official URL for this operation definition is

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

Formal Definition (as a OperationDefinition).

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

This is an idempotent operation

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
return1..1Library

The result of the requirements gathering represented as a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the activity definition

Note: as this is 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 activity definition. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the activity definition and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)

12.21.10.2.1 Examples

Request: Request data requirements for the administer zika virus exposure assessment activity definition

GET [base]/ActivityDefinition/administer-zika-virus-exposure-assessment/$data-requirements

Response: Returned on successful evaluation

HTTP/1.1 200 OK

{
  "resourceType": "Library",
  "type": {
    "coding": [
      {
        "code": "module-definition"
      }
    ]
  },
  "relatedArtifact": [
    {
      "type": "depends-on",
      "display": "Zika Affected Areas",
      "resource": {
        "reference": "ValueSet/zika-affected-areas"
      }
    },
    {
      "type": "depends-on",
      "display": "Pregnancy",
      "resource": {
        "identifier": "urn:oid:X.Y.Z",
        "display": "Pregnancy value set"
      }
    },
    {
      "type": "depends-on",
      "display": "Zika Exposure Assessment",
      "resource": {
        "identifier": "urn:oid:X.Y.Z",
        "display": "Zika Virus Exposure Assessment value set"
      }
    },
    {
      "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": {
        "identifier": "urn:oid:2.16.840.1.114222.4.11.7459",
        "display": "Zika Virus Signs and Symptoms value set"
      }
    },
  ]
  "dataRequirement": [
    {
      "type": "Condition",
      "codeFilter": [
        {
          "path": "code",
          "valueSetString": "Pregnancy"
        }
      ]
    },
    {
      "type": "Patient"
    },
    {
      "type": "Observation",
      "codeFilter": [
        {
          "path": "code",
          "valueSetString": [
            "Zika Exposure Assessment"
          ]
        },
        {
          "path": "status",
          "valueCode": [
            "final"
          ]
        }
      ]
    },
    {
      "type": "Condition",
      "codeFilter": [
        {
          "path": "category",
          "valueCode": [
            "diagnosis"
          ]
        },
        {
          "path": "clinicalStatus",
          "valueCode": [
            "confirmed"
          ]
        },
        {
          "path": "code",
          "valueSetString": "Zika Virus Signs and Symptoms"
        }
      ]
    }
  ]
}

 

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