API Reference

Create a new PlanDefinition

PlanDefinition on the FHIR specification website.

This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.

The body should be a valid FHIR object for PlanDefinition.

Here is an example:

{
  "resourceType": "PlanDefinition",
  "id": "options-example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">[Put rendering here]</div>"
  },
  "contained": [
    {
      "resourceType": "ActivityDefinition",
      "id": "activitydefinition-medicationrequest-1",
      "status": "draft",
      "kind": "MedicationRequest",
      "productCodeableConcept": {
        "text": "Medication 1"
      }
    },
    {
      "resourceType": "ActivityDefinition",
      "id": "activitydefinition-medicationrequest-2",
      "status": "draft",
      "kind": "MedicationRequest",
      "productCodeableConcept": {
        "text": "Medication 2"
      }
    }
  ],
  "title": "This example illustrates relationships between actions.",
  "status": "draft",
  "action": [
    {
      "groupingBehavior": "logical-group",
      "selectionBehavior": "all",
      "action": [
        {
          "id": "medication-action-1",
          "title": "Administer Medication 1",
          "definitionCanonical": "#activitydefinition-medicationrequest-1"
        },
        {
          "id": "medication-action-2",
          "title": "Administer Medication 2",
          "relatedAction": [
            {
              "actionId": "medication-action-1",
              "relationship": "after-end",
              "offsetDuration": {
                "value": 1,
                "unit": "h"
              }
            }
          ],
          "definitionCanonical": "#activitydefinition-medicationrequest-2"
        }
      ]
    }
  ]
}

You can reference the FHIR documentation to determine the format for PlanDefinition.

Language
Authorization
Click Try It! to start a request and see the response here!