Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see times).
See the Directory of published versions . Page versions: R5 R4B R4 R3

Activitydefinition-medicationorder-example.json

Example ActivityDefinition/citalopramPrescription (JSON)

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

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

Activity definition to prescribe citalopram to a patient 

{
  "resourceType": "ActivityDefinition",
  "id": "citalopramPrescription",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: citalopramPrescription</p><p><b>contained</b>: , </p><p><b>url</b>: <b>http://motivemi.com/artifacts/ActivityDefinition/citalopramPrescription</b></p><p><b>identifier</b>: citalopramPrescription (OFFICIAL)</p><p><b>version</b>: 1.0.0</p><p><b>name</b>: CitalopramPrescription</p><p><b>title</b>: Citalopram Prescription</p><p><b>status</b>: active</p><p><b>experimental</b>: true</p><p><b>date</b>: 15/08/2015</p><p><b>publisher</b>: Motive Medical Intelligence</p><p><b>contact</b>: </p><p><b>description</b>: Citalopram 20 mg tablet 1 tablet oral 1 time daily now (30 table; 3 refills</p><p><b>useContext</b>: , , , , , , </p><p><b>jurisdiction</b>: United States of America <span>(Details : {urn:iso:std:iso:3166 code 'US' = 'United States of America)</span></p><p><b>purpose</b>: Defines a guideline supported prescription for the treatment of depressive disorders</p><p><b>usage</b>: This activity definition is used as part of various suicide risk order sets</p><p><b>copyright</b>: © Copyright 2016 Motive Medical Intelligence. All rights reserved.</p><p><b>approvalDate</b>: 12/03/2016</p><p><b>lastReviewDate</b>: 15/08/2016</p><p><b>effectivePeriod</b>: 01/01/2016 --&gt; 31/12/2017</p><p><b>topic</b>: Mental Health Treatment <span>(Details )</span></p><p><b>author</b>: </p><p><b>relatedArtifact</b>: , </p><p><b>kind</b>: MedicationRequest</p><p><b>product</b>: id: citalopramMedication; citalopram <span>(Details : {RxNorm code '200371' = 'citalopram 20 MG Oral Tablet)</span>; Tablet dose form <span>(Details : {SNOMED CT code '385055001' = 'Tablet', given as 'Tablet dose form'})</span></p><p><b>dosage</b>: </p><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: dispenseRequest.numberOfRepeatsAllowed</p><p><b>expression</b>: </p></blockquote><blockquote><p><b>dynamicValue</b></p><p><b>path</b>: dispenseRequest.quantity</p><p><b>expression</b>: </p></blockquote></div>"
  },
  "contained": [
    {
      "resourceType": "Medication",
      "id": "citalopramMedication",
      "code": {
        "coding": [
          {
            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
            "code": "200371"
          }
        ],
        "text": "citalopram"
      },
      "form": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "385055001",
            "display": "Tablet dose form"
          }
        ],
        "text": "Tablet dose form"
      },
      "ingredient": [
        {
          "itemReference": {
            "reference": "#citalopramSubstance"
          },
          "strength": {
            "numerator": {
              "value": 20,
              "unit": "mg"
            },
            "denominator": {
              "value": 1,
              "unit": "{tbl}"
            }
          }
        }
      ]
    },
    {
      "resourceType": "Substance",
      "id": "citalopramSubstance",
      "code": {
        "coding": [
          {
            "system": "http://www.nlm.nih.gov/research/umls/rxnorm",
            "code": "2556"
          }
        ],
        "text": "citalopram"
      }
    }
  ],
  "url": "http://motivemi.com/artifacts/ActivityDefinition/citalopramPrescription",
  "identifier": [
    {
      "use": "official",
      "system": "http://motivemi.com",
      "value": "citalopramPrescription"
    }
  ],
  "version": "1.0.0",
  "name": "CitalopramPrescription",
  "title": "Citalopram Prescription",
  "status": "active",
  "experimental": true,
  "date": "2015-08-15",
  "publisher": "Motive Medical Intelligence",
  "contact": [
    {
      "telecom": [
        {
          "system": "phone",
          "value": "415-362-4007",
          "use": "work"
        },
        {
          "system": "email",
          "value": "info@motivemi.com",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Citalopram 20 mg tablet 1 tablet oral 1 time daily now (30 table; 3 refills",
  "useContext": [
    {
      "code": {
        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code": "age"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "https://meshb.nlm.nih.gov",
            "code": "D000328",
            "display": "Adult"
          }
        ]
      }

  "resourceType" : "ActivityDefinition",
  "id" : "citalopramPrescription",
  "contained" : [{
    "resourceType" : "Medication",
    "id" : "citalopramMedication",
    "code" : {
      "coding" : [{
        "system" : "http://www.nlm.nih.gov/research/umls/rxnorm",
        "code" : "200371"
      }],
      "text" : "citalopram"

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

    "doseForm" : {
      "coding" : [{
        "system" : "http://snomed.info/sct",
        "code" : "385055001",
        "display" : "Tablet (basic dose form)"
      }],
      "text" : "Tablet dose form"

    },
    {
      "code": {
        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code": "focus"

    "ingredient" : [{
      "item" : {
        "reference" : {
          "reference" : "#citalopramSubstance"
        }

      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "40379007",
            "display": "Major depression, recurrent, mild"
          }
        ]

      "strengthRatio" : {
        "numerator" : {
          "value" : 20,
          "unit" : "mg"
        },
        "denominator" : {
          "value" : 1,
          "unit" : "{tbl}"
        }

      }
    },
    {
      "code": {
        "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)"
          }
        ]

    }]
  },
  {
    "resourceType" : "Substance",
    "id" : "citalopramSubstance",
    "code" : {
      "concept" : {
        "coding" : [{
          "system" : "http://www.nlm.nih.gov/research/umls/rxnorm",
          "code" : "2556"
        }],
        "text" : "citalopram"

      }
    }
  }],
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "cds"
  }],
  "url" : "http://motivemi.com/artifacts/ActivityDefinition/citalopramPrescription",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.19.6"
  },
  {
    "use" : "official",
    "system" : "http://motivemi.com",
    "value" : "citalopramPrescription"
  }],
  "version" : "1.0.0",
  "name" : "CitalopramPrescription",
  "title" : "Citalopram Prescription",
  "status" : "active",
  "experimental" : true,
  "date" : "2015-08-15",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/dss"
    }]
  }],
  "description" : "Citalopram 20 mg tablet 1 tablet oral 1 time daily now (30 table; 3 refills",
  "useContext" : [{
    "code" : {
      "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
      "code" : "age"

    },
    {
      "code": {
        "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)"
          }
        ]
      }

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

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

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

    },
    {
      "code": {
        "system": "http://terminology.hl7.org/CodeSystem/usage-context-type",
        "code": "venue"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "440655000",
            "display": "Outpatient environment"
          }
        ]
      }

    "valueCodeableConcept" : {
      "coding" : [{
        "system" : "http://snomed.info/sct",
        "code" : "40379007",
        "display" : "Mild recurrent major depression"
      }]

    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]

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

    }
  ],
  "purpose": "Defines a guideline supported prescription for the treatment of depressive disorders",
  "usage": "This activity definition is used as part of various suicide risk order sets",
  "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 Treatment"

  {
    "code" : {
      "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)"
      }]

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

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

    }
  ],
  "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"

  },
  {
    "code" : {
      "system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
      "code" : "venue"

    },
    {
      "type": "composed-of",
      "resource": "#citalopramMedication"

    "valueCodeableConcept" : {
      "coding" : [{
        "system" : "http://snomed.info/sct",
        "code" : "440655000",
        "display" : "Outpatient environment"
      }]

    }
  ],
  "kind": "MedicationRequest",
  "productReference": {
    "reference": "#citalopramMedication"

  }],
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US"
    }]
  }],
  "purpose" : "Defines a guideline supported prescription for the treatment of depressive disorders",
  "usage" : "This activity definition is used as part of various suicide risk order sets",
  "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"

  },
  "dosage": [

  "topic" : [{
    "text" : "Mental Health Treatment"
  }],
  "author" : [{
    "name" : "Motive Medical Intelligence",
    "telecom" : [{
      "system" : "phone",
      "value" : "415-362-4007",
      "use" : "work"
    },

    {
      "text": "1 tablet oral 1 time daily",
      "timing": {
        "repeat": {
          "frequency": 1,
          "period": 1,
          "periodUnit": "d"
        }
      },
      "route": {
        "coding": [
          {
            "code": "26643006",
            "display": "Oral route (qualifier value)"
          }
        ],
        "text": "Oral route (qualifier value)"
      },
      "doseAndRate": [
        {
          "type": {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/dose-rate-type",
                "code": "ordered",
                "display": "Ordered"
              }
            ]
          },
          "doseQuantity": {
            "value": 1,
            "unit": "{tbl}"
          }
        }
      ]

      "system" : "email",
      "value" : "info@motivemi.com",
      "use" : "work"
    }]
  }],
  "relatedArtifact" : [{
    "type" : "citation",
    "display" : "Practice Guideline for the Treatment of Patients with Major Depressive Disorder",
    "document" : {
      "url" : "http://psychiatryonline.org/pb/assets/raw/sitewide/practice_guidelines/guidelines/mdd.pdf"

    }
  ],
  "dynamicValue": [
    {
      "path": "dispenseRequest.numberOfRepeatsAllowed",
      "expression": {
        "description": "dispenseRequest.numberOfRepeatsAllowed is three (3)",
        "language": "text/cql",
        "expression": "3"

  },
  {
    "type" : "composed-of",
    "resource" : "#citalopramMedication"
  }],
  "kind" : "MedicationRequest",
  "productReference" : {
    "reference" : "#citalopramMedication"
  },
  "dosage" : [{
    "text" : "1 tablet oral 1 time daily",
    "timing" : {
      "repeat" : {
        "frequency" : 1,
        "period" : 1,
        "periodUnit" : "d"

      }
    },
    {
      "path": "dispenseRequest.quantity",
      "expression": {
        "description": "dispenseRequest.quantity is thirty (30) tablets",
        "language": "text/cql",
        "expression": "30 '{tbl}'"

    "route" : {
      "coding" : [{
        "code" : "26643006",
        "display" : "Oral route (qualifier value)"
      }],
      "text" : "Oral route (qualifier value)"
    },
    "doseAndRate" : [{
      "type" : {
        "coding" : [{
          "system" : "http://terminology.hl7.org/CodeSystem/dose-rate-type",
          "code" : "ordered",
          "display" : "Ordered"
        }]
      },
      "doseQuantity" : {
        "value" : 1,
        "unit" : "{tbl}"

      }
    }]
  }],
  "dynamicValue" : [{
    "path" : "dispenseRequest.numberOfRepeatsAllowed",
    "expression" : {
      "description" : "dispenseRequest.numberOfRepeatsAllowed is three (3)",
      "language" : "text/cql-expression",
      "expression" : "3"

    }
  ]

  },
  {
    "path" : "dispenseRequest.quantity",
    "expression" : {
      "description" : "dispenseRequest.quantity is thirty (30) tablets",
      "language" : "text/cql-expression",
      "expression" : "30 '{tbl}'"
    }
  }]

}

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.