ActivityDefinition - FHIR Resource (r4)


This ActivityDefinition Resource uses the FHIR API standard for access and structure.

Validate an ActivityDefinition FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
approvalDatefalsedate# When the activity definition was approved by publisher
authortrueContactDetail# Who authored the content
bodySitetrueCodeableConcept# What part of body to perform on
codefalseCodeableConcept# Detail type of activity
contacttrueContactDetail# Contact details for the publisher
copyrightfalsemarkdown# Use and/or publishing restrictions
datefalsedateTime# Date last changed
descriptionfalsemarkdown# Natural language description of the activity definition
doNotPerformfalseboolean# True if the activity should not be performed
dosagetrueDosage# Detailed dosage instructions
dynamicValuetrueData Type# Dynamic aspects of the definition
editortrueContactDetail# Who edited the content
effectivePeriodfalsePeriod# When the activity definition is expected to be used
endorsertrueContactDetail# Who endorsed the content
experimentalfalseboolean# For testing purposes, not real usage
identifiertrueIdentifier# Additional identifier for the activity definition
intentfalsecode# proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
jurisdictiontrueCodeableConcept# Intended jurisdiction for activity definition (if applicable)
kindfalsecode# Kind of resource
lastReviewDatefalsedate# When the activity definition was last reviewed
librarytruecanonical(Library)# Logic used by the activity definition
locationfalseReference# Where it should happen
namefalsestring# C? Name for this activity definition (computer friendly)
observationRequirementtrueReference# What observations are required to perform this action
observationResultRequirementtrueReference# What observations must be produced by this action
participanttrueData Type# Who should participate in the action
priorityfalsecode# routine | urgent | asap | stat
product[x]falseReference#undefined
profilefalsecanonical(StructureDefinition)# What profile the resource needs to conform to
publisherfalsestring# Name of the publisher (organization or individual)
purposefalsemarkdown# Why this activity definition is defined
quantityfalseSimpleQuantity# How much is administered/consumed/supplied
relatedArtifacttrueRelatedArtifact# Additional documentation, citations, etc.
reviewertrueContactDetail# Who reviewed the content
specimenRequirementtrueReference# What specimens are required to perform this action
statusfalsecode# draft | active | retired | unknown
subject[x]falseReference#undefined
subtitlefalsestring# Subordinate title of the activity definition
timing[x]falseTiming|dateTime|Age|Period|Range|Duration#undefined
titlefalsestring# Name for this activity definition (human friendly)
topictrueCodeableConcept# E.g. Education, Treatment, Assessment, etc.
transformfalsecanonical(StructureMap)# Transform to apply the template
urlfalseuri# Canonical identifier for this activity definition, represented as a URI (globally unique)
usagefalsestring# Describes the clinical usage of the activity definition
useContexttrueUsageContext# The context that the content is intended to support
versionfalsestring# Business version of the activity definition

ActivityDefinition Example

{
  "resourceType": "ActivityDefinition",
  "id": "referralPrimaryCareMentalHealth",
  "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>"
  },
  "url": "http://motivemi.com/artifacts/ActivityDefinition/referralPrimaryCareMentalHealth",
  "identifier": [
    {
      "use": "official",
      "system": "http://motivemi.com/artifacts",
      "value": "referralPrimaryCareMentalHealth"
    }
  ],
  "version": "1.1.0",
  "name": "ReferralPrimaryCareMentalHealth",
  "title": "Referral to Primary Care Mental Health",
  "status": "active",
  "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",
  "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"
          }
        ]
      }
    },
    {
      "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"
          }
        ]
      }
    },
    {
      "code": {
        "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://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://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://terminology.hl7.org/CodeSystem/usage-context-type",
        "code": "user"
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "309343006",
            "display": "Physician"
          }
        ]
      }
    },
    {
      "code": {
        "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": "2017-03-01",
  "lastReviewDate": "2017-03-01",
  "effectivePeriod": {
    "start": "2017-03-01",
    "end": "2017-12-31"
  },
  "topic": [
    {
      "text": "Mental Health Referral"
    }
  ],
  "author": [
    {
      "name": "Motive Medical Intelligence",
      "telecom": [
        {
          "system": "phone",
          "value": "415-362-4007",
          "use": "work"
        },
        {
          "system": "email",
          "value": "info@motivemi.com",
          "use": "work"
        }
      ]
    }
  ],
  "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": "predecessor",
      "resource": "ActivityDefinition/referralPrimaryCareMentalHealth-initial"
    }
  ],
  "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/cqf-expression",
            "valueExpression": {
              "language": "text/cql",
              "expression": "Now()"
            }
          }
        ]
      }
    ]
  },
  "participant": [
    {
      "type": "practitioner"
    }
  ]
}

ActivityDefinition Structure

{
  "resourceType" : "ActivityDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this activity definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the activity definition
  "version" : "<string>", // Business version of the activity definition
  "name" : "<string>", // C? Name for this activity definition (computer friendly)
  "title" : "<string>", // Name for this activity definition (human friendly)
  "subtitle" : "<string>", // Subordinate title of the activity definition
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  // subject[x]: Type of individual the activity definition is intended for. One of these 2:
  "subjectCodeableConcept" : { CodeableConcept },
  "subjectReference" : { Reference(Group) },
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the activity definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for activity definition (if applicable)
  "purpose" : "<markdown>", // Why this activity definition is defined
  "usage" : "<string>", // Describes the clinical usage of the activity definition
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "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
  "topic" : [{ CodeableConcept }], // E.g. Education, Treatment, Assessment, etc.
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatedArtifact" : [{ RelatedArtifact }], // Additional documentation, citations, etc.
  "library" : [{ canonical(Library) }], // Logic used by the activity definition
  "kind" : "<code>", // Kind of resource
  "profile" : { canonical(StructureDefinition) }, // What profile the resource needs to conform to
  "code" : { CodeableConcept }, // Detail type of activity
  "intent" : "<code>", // proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
  "priority" : "<code>", // routine | urgent | asap | stat
  "doNotPerform" : <boolean>, // True if the activity should not be performed
  // timing[x]: When activity is to occur. One of these 6:
  "timingTiming" : { Timing },
  "timingDateTime" : "<dateTime>",
  "timingAge" : { Age },
  "timingPeriod" : { Period },
  "timingRange" : { Range },
  "timingDuration" : { Duration },
  "location" : { Reference(Location) }, // Where it should happen
  "participant" : [{ // Who should participate in the action
    "type" : "<code>", // R!  patient | practitioner | related-person | device
    "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
  "specimenRequirement" : [{ Reference(SpecimenDefinition) }], // What specimens are required to perform this action
  "observationRequirement" : [{ Reference(ObservationDefinition) }], // What observations are required to perform this action
  "observationResultRequirement" : [{ Reference(ObservationDefinition) }], // What observations must be produced by this action
  "transform" : { canonical(StructureMap) }, // Transform to apply the template
  "dynamicValue" : [{ // Dynamic aspects of the definition
    "path" : "<string>", // R!  The path to the element to be set dynamically
    "expression" : { Expression } // R!  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 them like so:

https://api.1up.health/fhir/r4/ActivityDefinition?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
composed-ofreferencerelatedArtifact.where
contexttextuseContext.value
context-quantityquantityuseContext.value
context-typetextuseContext.code
context-type-quantitycompositeuseContext
context-type-valuecompositeuseContext
datedatedate
depends-onreferencerelatedArtifact.where
derived-fromreferencerelatedArtifact.where
descriptiontextdescription
effectivedateeffectivePeriod
identifiertextidentifier
jurisdictiontextjurisdiction
nametextname
predecessorreferencerelatedArtifact.where
publishertextpublisher
statustextstatus
successorreferencerelatedArtifact.where
titletexttitle
topictexttopic
urluriurl
versiontextversion