ActivityDefinition - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
approvalDatefalsedate When the activity definition was approved by publisher
bodySitetrueCodeableConcept What part of body to perform on
codefalseCodeableConcept Detail type of activity
contacttrueContactDetail Contact details for the publisher
contributortrueContributor A content contributor
copyrightfalsemarkdown Use and/or publishing restrictions
datefalsedateTime Date this was last changed
descriptionfalsemarkdown Natural language description of the activity definition
dosagetrueDosage Detailed dosage instructions
dynamicValuetrueData Type Dynamic aspects of the definition
effectivePeriodfalsePeriod When the activity definition is expected to be used
experimentalfalseboolean For testing purposes, not real usage
identifiertrueIdentifier Additional identifier for the activity definition
jurisdictiontrueCodeableConcept Intended jurisdiction for activity definition (if applicable)
kindfalsecode Kind of resource
lastReviewDatefalsedate When the activity definition was last reviewed
librarytrueReference Logic used by the asset
locationfalseReference Where it should happen
namefalsestring Name for this activity definition (computer friendly)
participanttrueData Type Who should participate in the action
productCodeableConceptfalseCodeableConcept "productCodeableConcept" : { CodeableConcept },
productReferencefalseReference "productReference" : { Reference(Medication|Substance) },
publisherfalsestring Name of the publisher (organization or individual)
purposefalsemarkdown Why this activity definition is defined
quantityfalseQuantity How much is administered/consumed/supplied
relatedArtifacttrueRelatedArtifact Additional documentation, citations, etc
statusfalsecode draft | active | retired | unknown
timingDateTimefalsedateTime "timingDateTime" : "<dateTime>",
timingPeriodfalsePeriod "timingPeriod" : { Period },
timingRangefalseRange "timingRange" : { Range },
timingTimingfalseTiming "timingTiming" : { Timing },
titlefalsestring Name for this activity definition (human friendly)
topictrueCodeableConcept E.g. Education, Treatment, Assessment, etc
transformfalseReference Transform to apply the template
urlfalseuri Logical URI to reference this activity definition (globally unique)
usagefalsestring Describes the clinical usage of the asset
useContexttrueUsageContext Context the content is intended to support
versionfalsestring Business version of the activity definition

ActivityDefinition Example

{
  "code": {
    "text": "Referral to service (procedure)",
    "coding": [
      {
        "code": "306206005",
        "system": "http://snomed.info/sct"
      }
    ]
  },
  "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</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>"
  },
  "jurisdiction": [
    {
      "coding": [
        {
          "code": "US",
          "system": "urn:iso:std:iso:3166"
        }
      ]
    }
  ],
  "topic": [
    {
      "text": "Mental Health Referral"
    }
  ],
  "contributor": [
    {
      "contact": [
        {
          "telecom": [
            {
              "use": "work",
              "system": "phone",
              "value": "415-362-4007"
            },
            {
              "use": "work",
              "system": "email",
              "value": "info@motivemi.com"
            }
          ]
        }
      ],
      "type": "author",
      "name": "Motive Medical Intelligence"
    }
  ],
  "id": "referralPrimaryCareMentalHealth",
  "participant": [
    {
      "type": "practitioner"
    }
  ],
  "copyright": "© Copyright 2016 Motive Medical Intelligence. All rights reserved.",
  "title": "Referral to Primary Care Mental Health",
  "lastReviewDate": "2017-03-01",
  "version": "1.1.0",
  "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.",
  "status": "active",
  "approvalDate": "2017-03-01",
  "description": "refer to primary care mental-health integrated care program for evaluation and treatment of mental health conditions now",
  "timingTiming": {
    "_event": [
      {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/cqif-cqlExpression",
            "valueString": "Now()"
          }
        ]
      }
    ]
  },
  "effectivePeriod": {
    "start": "2017-03-01",
    "end": "2017-12-31"
  },
  "useContext": [
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "D000328",
            "system": "https://meshb.nlm.nih.gov",
            "display": "Adult"
          }
        ]
      },
      "code": {
        "code": "age",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "87512008",
            "system": "http://snomed.info/sct",
            "display": "Mild major depression"
          }
        ]
      },
      "code": {
        "code": "focus",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "40379007",
            "system": "http://snomed.info/sct",
            "display": "Major depression, recurrent, mild"
          }
        ]
      },
      "code": {
        "code": "focus",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "225444004",
            "system": "http://snomed.info/sct",
            "display": "At risk for suicide (finding)"
          }
        ]
      },
      "code": {
        "code": "focus",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "306206005",
            "system": "http://snomed.info/sct",
            "display": "Referral to service (procedure)"
          }
        ]
      },
      "code": {
        "code": "focus",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "309343006",
            "system": "http://snomed.info/sct",
            "display": "Physician"
          }
        ]
      },
      "code": {
        "code": "user",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    },
    {
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "440655000",
            "system": "http://snomed.info/sct",
            "display": "Outpatient environment"
          }
        ]
      },
      "code": {
        "code": "venue",
        "system": "http://hl7.org/fhir/usage-context-type"
      }
    }
  ],
  "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.",
  "date": "2017-03-03T14:06:00Z",
  "publisher": "Motive Medical Intelligence",
  "kind": "ReferralRequest",
  "name": "ReferralPrimaryCareMentalHealth",
  "resourceType": "ActivityDefinition",
  "url": "http://motivemi.com/artifacts/ActivityDefinition/referralPrimaryCareMentalHealth",
  "contact": [
    {
      "telecom": [
        {
          "use": "work",
          "system": "phone",
          "value": "415-362-4007"
        },
        {
          "use": "work",
          "system": "email",
          "value": "info@motivemi.com"
        }
      ]
    }
  ],
  "relatedArtifact": [
    {
      "url": "http://psychiatryonline.org/pb/assets/raw/sitewide/practice_guidelines/guidelines/mdd.pdf",
      "type": "citation",
      "display": "Practice Guideline for the Treatment of Patients with Major Depressive Disorder"
    },
    {
      "resource": {
        "reference": "ActivityDefinition/referralPrimaryCareMentalHealth-initial"
      },
      "type": "predecessor"
    }
  ],
  "identifier": [
    {
      "use": "official",
      "system": "http://motivemi.com/artifacts",
      "value": "referralPrimaryCareMentalHealth"
    }
  ],
  "experimental": true
}

ActivityDefinition Structure


  
{
  "resourceType" : "ActivityDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical URI to reference this activity definition (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the activity definition
  "version" : "<string>", // Business version of the activity definition
  "name" : "<string>", // Name for this activity definition (computer friendly)
  "title" : "<string>", // Name for this activity definition (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "description" : "<markdown>", // Natural language description of the activity definition
  "purpose" : "<markdown>", // Why this activity definition is defined
  "usage" : "<string>", // Describes the clinical usage of the asset
  "approvalDate" : "<date>", // When the activity definition was approved by publisher
  "lastReviewDate" : "<date>", // When the activity definition was last reviewed
  "effectivePeriod" : { Period }, // When the activity definition is expected to be used
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for activity definition (if applicable)
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc
  "contributor" : [{ Contributor }], // A content contributor
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc
  "library" : [{ Reference(Library) }], // Logic used by the asset
  "kind" : "<code>", // Kind of resource
  "code" : { CodeableConcept }, // Detail type of activity
  // timing[x]: When activity is to occur. One of these 4:
  "timingTiming" : { Timing },
  "timingDateTime" : "<dateTime>",
  "timingPeriod" : { Period },
  "timingRange" : { Range },
  "location" : { Reference(Location) }, // Where it should happen
  "participant" : [{ // Who should participate in the action
    "type" : "<code>", // R!  patient | practitioner | related-person
    "role" : { CodeableConcept } // E.g. Nurse, Surgeon, Parent, etc
  }],
  // product[x]: What's administered/supplied. One of these 2:
  "productReference" : { Reference(Medication|Substance) },
  "productCodeableConcept" : { CodeableConcept },
  "quantity" : { Quantity(SimpleQuantity) }, // How much is administered/consumed/supplied
  "dosage" : [{ Dosage }], // Detailed dosage instructions
  "bodySite" : [{ CodeableConcept }], // What part of body to perform on
  "transform" : { Reference(StructureMap) }, // Transform to apply the template
  "dynamicValue" : [{ // Dynamic aspects of the definition
    "description" : "<string>", // Natural language description of the dynamic value
    "path" : "<string>", // The path to the element to be set dynamically
    "language" : "<string>", // Language of the expression
    "expression" : "<string>" // An expression that provides the dynamic value for the customization
  }]
}


 

ActivityDefinition Search Parameters

The following search parameters can be used to query ActivityDefinition resources. Just submit the like so:

https://api.1up.health/fhir/stu3/ActivityDefinition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
composed-ofreferencerelatedArtifact.where
datedatedate
depends-onreferencerelatedArtifact.where
derived-fromreferencerelatedArtifact.where
descriptiontextdescription
effectivedateeffectivePeriod
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
predecessorreferencerelatedArtifact.where
publishertextpublisher
statustextstatus
successorreferencerelatedArtifact.where
titletexttitle
topictexttopic
urluriurl
versiontextversion