FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 R3 R4 R3

Activitydefinition-predecessor-example.json

Clinical Decision Support Work Group Maturity Level : N/A Ballot Standards Status : Informative Compartments : Not linked to any defined compartments

Raw JSON ( canonical form + also see JSON Format Specification )

Example of a predecessor/successor relationship 

{
  "resourceType": "ActivityDefinition",
  "id": "referralPrimaryCareMentalHealth-initial",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Id: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">ActivityDefinition/referralPrimaryCareMentalHealth-initial</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Status: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">draft</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Description: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">refer to primary care mental-health integrated care program for evaluation and treatment of mental health conditions now</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Category: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-left: 25px; padding-right: 25px;\">referral</td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Code: </b>\n               </td>\n            </tr>\n            <tr>\n               <td style=\"padding-right: 25px;\">\n                  <span style=\"padding-left: 25px;\">\n                     <b>text: </b>\n                     <span>Referral to service (procedure)</span>\n                     <br/>\n                  </span>\n                  <span>\n                     <span>\n                        <span style=\"padding-left: 25px;\">\n                           <b>system: </b>\n                           <span>http://snomed.info/sct</span>\n                           <br/>\n                        </span>\n                        <span style=\"padding-left: 25px;\">\n                           <b>code: </b>\n                           <span>306206005</span>\n                           <br/>\n                        </span>\n                     </span>\n                  </span>\n               </td>\n            </tr>\n         </table>\n         <p/>\n         <table class=\"grid dict\">\n            <tr>\n               <td>\n                  <b>Participant: </b>\n               </td>\n            </tr>\n            <tr style=\"vertical-align: top;\">\n               <td style=\"padding-left: 25px; padding-right: 25px;\">practitioner</td>\n            </tr>\n         </table>\n      </div>"
  },
  "url": "http://motivemi.com/artifacts/ActivityDefinition/referralPrimaryCareMentalHealth",
  "identifier": [
    {
      "use": "official",
      "system": "http://motivemi.com/artifacts",
      "value": "referralPrimaryCareMentalHealth"
    }
  ],
  "version": "1.0.0",
  "name": "ReferralPrimaryCareMentalHealth",
  "title": "Referral to Primary Care Mental Health",
  "status": "retired",
  "experimental": true,
  "date": "2017-03-03T14:06:00Z",
  "publisher": "Motive Medical Intelligence",
  "contact": [
    {
      "telecom": [
        {
          "system": "phone",
          "value": "415-362-4007",
          "use": "work"
        },
        {
          "system": "email",
          "value": "info@motivemi.com",
          "use": "work"
        }
      ]
    }
  ],

  "description": "refer to primary care mental-health integrated care program for evaluation and treatment of mental health conditions now",
  "purpose": "Defines a referral to a mental-health integrated care program for use in suicide risk order sets. The definition is independent of the order set in which it appears to allow reuse of the general definition of the referrral.",
  "usage": "This activity definition is used as the definition of a referral request within various suicide risk order sets. Elements that apply universally are defined here, while elements that apply to the specific setting of a referral within a particular order set are defined in the order set.",
  "approvalDate": "2016-03-12",
  "lastReviewDate": "2016-08-15",
  "effectivePeriod": {
    "start": "2016-01-01",
    "end": "2017-12-31"
  },

  "useContext": [
    {
      "code": {
        "system": "http://hl7.org/fhir/usage-context-type",

        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",

        "code": "age"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "https://meshb.nlm.nih.gov",
            "code": "D000328",
            "display": "Adult"
          }
        ]
      }
    },
    {
      "code": {
        "system": "http://hl7.org/fhir/usage-context-type",

        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",

        "code": "focus"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "87512008",
            "display": "Mild major depression"
          }
        ]
      }
    },
    {
      "code": {
        "system": "http://hl7.org/fhir/usage-context-type",

        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",

        "code": "focus"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "40379007",
            "display": "Major depression, recurrent, mild"
          }
        ]
      }
    },
    {
      "code": {
        "system": "http://hl7.org/fhir/usage-context-type",

        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",

        "code": "focus"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "225444004",
            "display": "At risk for suicide (finding)"
          }
        ]
      }
    },
    {
      "code": {
        "system": "http://hl7.org/fhir/usage-context-type",

        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",

        "code": "focus"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "306206005",
            "display": "Referral to service (procedure)"
          }
        ]
      }
    },
    {
      "code": {
        "system": "http://hl7.org/fhir/usage-context-type",

        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",

        "code": "user"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "309343006",
            "display": "Physician"
          }
        ]
      }
    },
    {
      "code": {
        "system": "http://hl7.org/fhir/usage-context-type",

        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",

        "code": "venue"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "440655000",
            "display": "Outpatient environment"
          }
        ]
      }
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "purpose": "Defines a referral to a mental-health integrated care program for use in suicide risk order sets. The definition is independent of the order set in which it appears to allow reuse of the general definition of the referrral.",
  "usage": "This activity definition is used as the definition of a referral request within various suicide risk order sets. Elements that apply universally are defined here, while elements that apply to the specific setting of a referral within a particular order set are defined in the order set.",
  "copyright": "© Copyright 2016 Motive Medical Intelligence. All rights reserved.",
  "approvalDate": "2016-03-12",
  "lastReviewDate": "2016-08-15",
  "effectivePeriod": {
    "start": "2016-01-01",
    "end": "2017-12-31"
  },

  "topic": [
    {
      "text": "Mental Health Referral"
    }
  ],
  "contributor": [

  "author": [

    {
      "type": "author",

      "name": "Motive Medical Intelligence",
      "contact": [
        {
          "telecom": [
            {
              "system": "phone",
              "value": "415-362-4007",
              "use": "work"
            },
            {
              "system": "email",
              "value": "info@motivemi.com",
              "use": "work"
            }
          ]
        }
      ]
    }
  ],
  "contact": [
    {

      "telecom": [
        {
          "system": "phone",
          "value": "415-362-4007",
          "use": "work"
        },
        {
          "system": "email",
          "value": "info@motivemi.com",
          "use": "work"
        }
      ]
    }
  ],
  "copyright": "© Copyright 2016 Motive Medical Intelligence. All rights reserved.",

  "relatedArtifact": [
    {
      "type": "citation",
      "display": "Practice Guideline for the Treatment of Patients with Major Depressive Disorder",
      "url": "http://psychiatryonline.org/pb/assets/raw/sitewide/practice_guidelines/guidelines/mdd.pdf"
    },
    {
      "type": "successor",
      "resource": {
        "reference": "ActivityDefinition/referralPrimaryCareMentalHealth"
      }

      "resource": "ActivityDefinition/referralPrimaryCareMentalHealth"

    }
  ],
  "kind": "ReferralRequest",

  "kind": "ServiceRequest",

  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "306206005"
      }
    ],
    "text": "Referral to service (procedure)"
  },
  "timingTiming": {
    "_event": [
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/cqif-cqlExpression",
            "valueString": "Now()"

            "url": "http://hl7.org/fhir/StructureDefinition/cqf-expression",
            "valueExpression": {
              "language": "text/cql",
              "expression": "Now()"
            }

          }
        ]
      }
    ]
  },
  "participant": [
    {
      "type": "practitioner"
    }
  ]
}

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.