ActivityDefinition - FHIR Resource (r4)
This ActivityDefinition Resource uses the FHIR API standard for access and structure.
Validate an ActivityDefinition FHIR Resource (r4)
ActivityDefinition Attributes
AttributeField is listTypeDescription
Description: Canonical identifier for this activity definition, represented as a URI (globally unique)
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": "http://motivemi.com/artifacts/ActivityDefinition/referralPrimaryCareMentalHealth"Learn more about the (ActivityDefinition) url FHIR attribute
Description: Additional identifier for the activity definition
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"use": "official",
"system": "http://motivemi.com/artifacts",
"value": "referralPrimaryCareMentalHealth"
}
]Learn more about the (ActivityDefinition) identifier FHIR attribute
Description: Business version of the activity definition
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": "1.1.0"Learn more about the (ActivityDefinition) version FHIR attribute
Description: C? Name for this activity definition (computer friendly)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "ReferralPrimaryCareMentalHealth"Learn more about the (ActivityDefinition) name FHIR attribute
Description: Name for this activity definition (human friendly)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": "Referral to Primary Care Mental Health"Learn more about the (ActivityDefinition) title FHIR attribute
Description: Subordinate title of the activity definition
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subtitle": Learn more about the (ActivityDefinition) subtitle FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (ActivityDefinition) status FHIR attribute
Description: For testing purposes, not real usage
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": trueLearn more about the (ActivityDefinition) experimental FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"subject[x]": Learn more about the (ActivityDefinition) subject[x] FHIR attribute
Description: Date last changed
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2017-03-03T14:06:00Z"Learn more about the (ActivityDefinition) date FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": "Motive Medical Intelligence"Learn more about the (ActivityDefinition) publisher FHIR attribute
Description: Contact details for the publisher
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": [
{
"telecom": [
{
"system": "phone",
"value": "415-362-4007",
"use": "work"
},
{
"system": "email",
"value": "info@motivemi.com",
"use": "work"
}
]
}
]Learn more about the (ActivityDefinition) contact FHIR attribute
Description: Natural language description of the activity definition
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "refer to primary care mental-health integrated care program for evaluation and treatment of mental health conditions now"Learn more about the (ActivityDefinition) description FHIR attribute
Description: The context that the content is intended to support
FHIR Version: r4
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
]
}
}
]Learn more about the (ActivityDefinition) useContext FHIR attribute
Description: Intended jurisdiction for activity definition (if applicable)
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
]Learn more about the (ActivityDefinition) jurisdiction FHIR attribute
Description: Why this activity definition is defined
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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."Learn more about the (ActivityDefinition) purpose FHIR attribute
Description: Describes the clinical usage of the activity definition
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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."Learn more about the (ActivityDefinition) usage FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: r4
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"copyright": "© Copyright 2016 Motive Medical Intelligence. All rights reserved."Learn more about the (ActivityDefinition) copyright FHIR attribute
Description: When the activity definition was approved by publisher
FHIR Version: r4
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"approvalDate": "2017-03-01"Learn more about the (ActivityDefinition) approvalDate FHIR attribute
Description: When the activity definition was last reviewed
FHIR Version: r4
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lastReviewDate": "2017-03-01"Learn more about the (ActivityDefinition) lastReviewDate FHIR attribute
Description: When the activity definition is expected to be used
FHIR Version: r4
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"effectivePeriod": {
"start": "2017-03-01",
"end": "2017-12-31"
}Learn more about the (ActivityDefinition) effectivePeriod FHIR attribute
Description: E.g. Education, Treatment, Assessment, etc.
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"topic": [
{
"text": "Mental Health Referral"
}
]Learn more about the (ActivityDefinition) topic FHIR attribute
Description: Who authored the content
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"author": [
{
"name": "Motive Medical Intelligence",
"telecom": [
{
"system": "phone",
"value": "415-362-4007",
"use": "work"
},
{
"system": "email",
"value": "info@motivemi.com",
"use": "work"
}
]
}
]Learn more about the (ActivityDefinition) author FHIR attribute
Description: Who edited the content
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"editor": Learn more about the (ActivityDefinition) editor FHIR attribute
Description: Who reviewed the content
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reviewer": Learn more about the (ActivityDefinition) reviewer FHIR attribute
Description: Who endorsed the content
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"endorser": Learn more about the (ActivityDefinition) endorser FHIR attribute
Description: Additional documentation, citations, etc.
FHIR Version: r4
Attribute Type : RelatedArtifact
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
]Learn more about the (ActivityDefinition) relatedArtifact FHIR attribute
Description: Logic used by the activity definition
FHIR Version: r4
Attribute Type : canonical(Library)
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"library": Learn more about the (ActivityDefinition) library FHIR attribute
Description: Kind of resource
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"kind": "ServiceRequest"Learn more about the (ActivityDefinition) kind FHIR attribute
Description: What profile the resource needs to conform to
FHIR Version: r4
Attribute Type : canonical(StructureDefinition)
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"profile": Learn more about the (ActivityDefinition) profile FHIR attribute
Description: Detail type of activity
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "306206005"
}
],
"text": "Referral to service (procedure)"
}Learn more about the (ActivityDefinition) code FHIR attribute
Description: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"intent": Learn more about the (ActivityDefinition) intent FHIR attribute
Description: routine | urgent | asap | stat
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"priority": Learn more about the (ActivityDefinition) priority FHIR attribute
Description: True if the activity should not be performed
FHIR Version: r4
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"doNotPerform": Learn more about the (ActivityDefinition) doNotPerform FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Timing|dateTime|Age|Period|Range|Duration
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"timing[x]": Learn more about the (ActivityDefinition) timing[x] FHIR attribute
Description: Where it should happen
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": Learn more about the (ActivityDefinition) location FHIR attribute
Description: Who should participate in the action
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"participant": [
{
"type": "practitioner"
}
]Learn more about the (ActivityDefinition) participant FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"product[x]": Learn more about the (ActivityDefinition) product[x] FHIR attribute
Description: How much is administered/consumed/supplied
FHIR Version: r4
Attribute Type : SimpleQuantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"quantity": Learn more about the (ActivityDefinition) quantity FHIR attribute
Description: Detailed dosage instructions
FHIR Version: r4
Attribute Type : Dosage
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dosage": Learn more about the (ActivityDefinition) dosage FHIR attribute
Description: What part of body to perform on
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"bodySite": Learn more about the (ActivityDefinition) bodySite FHIR attribute
Description: What specimens are required to perform this action
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"specimenRequirement": Learn more about the (ActivityDefinition) specimenRequirement FHIR attribute
Description: What observations are required to perform this action
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"observationRequirement": Learn more about the (ActivityDefinition) observationRequirement FHIR attribute
Description: What observations must be produced by this action
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"observationResultRequirement": Learn more about the (ActivityDefinition) observationResultRequirement FHIR attribute
Description: Transform to apply the template
FHIR Version: r4
Attribute Type : canonical(StructureMap)
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"transform": Learn more about the (ActivityDefinition) transform FHIR attribute
Description: Dynamic aspects of the definition
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dynamicValue": Learn more about the (ActivityDefinition) dynamicValue FHIR attribute
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 Parameter | Field Type | Resource Fields Searched |
|---|---|---|
composed-of | reference | relatedArtifact.where |
context | text | useContext.value |
context-quantity | quantity | useContext.value |
context-type | text | useContext.code |
context-type-quantity | composite | useContext |
context-type-value | composite | useContext |
date | date | date |
depends-on | reference | relatedArtifact.where |
derived-from | reference | relatedArtifact.where |
description | text | description |
effective | date | effectivePeriod |
identifier | text | identifier |
jurisdiction | text | jurisdiction |
name | text | name |
predecessor | reference | relatedArtifact.where |
publisher | text | publisher |
status | text | status |
successor | reference | relatedArtifact.where |
title | text | title |
topic | text | topic |
url | uri | url |
version | text | version |
