ActivityDefinition

Trial Use 2 Specialized — Quality & Testing

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/ActivityDefinition

Interaction	Method	Path
Read	GET	/fhir/R4/ActivityDefinition/[id]
Vread	GET	/fhir/R4/ActivityDefinition/[id]/_history/[vid]
Update	PUT	/fhir/R4/ActivityDefinition/[id]
Patch	PATCH	/fhir/R4/ActivityDefinition/[id]
Delete	DELETE	/fhir/R4/ActivityDefinition/[id]
Create	POST	/fhir/R4/ActivityDefinition
Search	GET	/fhir/R4/ActivityDefinition
History	GET	/fhir/R4/ActivityDefinition/[id]/_history

Top-level elements

Element	Type(s)	Cardinality	Description
url	uri	0..1	Canonical identifier for this activity definition, represented as a URI (globally unique)
identifier	Identifier	0..*	Additional identifier for the activity definition
version	string	0..1	Business version of the activity definition
name	string	0..1	Name for this activity definition (computer friendly)
title	string	0..1	Name for this activity definition (human friendly)
subtitle	string	0..1	Subordinate title of the activity definition
status	code	1..1	draft | active | retired | unknown modifier
experimental	boolean	0..1	For testing purposes, not real usage
subject[x]	CodeableConcept / Reference	0..1	Type of individual the activity definition is intended for
date	dateTime	0..1	Date last changed
publisher	string	0..1	Name of the publisher (organization or individual)
contact	ContactDetail	0..*	Contact details for the publisher
description	markdown	0..1	Natural language description of the activity definition
useContext	UsageContext	0..*	The context that the content is intended to support
jurisdiction	CodeableConcept	0..*	Intended jurisdiction for activity definition (if applicable)
purpose	markdown	0..1	Why this activity definition is defined
usage	string	0..1	Describes the clinical usage of the activity definition
copyright	markdown	0..1	Use and/or publishing restrictions
approvalDate	date	0..1	When the activity definition was approved by publisher
lastReviewDate	date	0..1	When the activity definition was last reviewed
effectivePeriod	Period	0..1	When the activity definition is expected to be used
topic	CodeableConcept	0..*	E.g. Education, Treatment, Assessment, etc.
author	ContactDetail	0..*	Who authored the content
editor	ContactDetail	0..*	Who edited the content
reviewer	ContactDetail	0..*	Who reviewed the content
endorser	ContactDetail	0..*	Who endorsed the content
relatedArtifact	RelatedArtifact	0..*	Additional documentation, citations, etc.
library	canonical	0..*	Logic used by the activity definition
kind	code	0..1	Kind of resource
profile	canonical	0..1	What profile the resource needs to conform to
code	CodeableConcept	0..1	Detail type of activity
intent	code	0..1	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
priority	code	0..1	routine | urgent | asap | stat
doNotPerform	boolean	0..1	True if the activity should not be performed modifier
timing[x]	Timing / dateTime / Age / Period / Range / Duration	0..1	When activity is to occur
location	Reference	0..1	Where it should happen
participant	BackboneElement	0..*	Who should participate in the action
product[x]	Reference / CodeableConcept	0..1	What's administered/supplied
quantity	Quantity	0..1	How much is administered/consumed/supplied
dosage	Dosage	0..*	Detailed dosage instructions
bodySite	CodeableConcept	0..*	What part of body to perform on
specimenRequirement	Reference	0..*	What specimens are required to perform this action
observationRequirement	Reference	0..*	What observations are required to perform this action
observationResultRequirement	Reference	0..*	What observations must be produced by this action
transform	canonical	0..1	Transform to apply the template
dynamicValue	BackboneElement	0..*	Dynamic aspects of the definition

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
code	string	https://medplum.com/fhir/SearchParameter/ActivityDefinition-code
composed-of	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-composed-of
context	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-context
context-quantity	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-quantity
context-type	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-type
context-type-quantity	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-type-quantity
context-type-value	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-context-type-value
date	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-date
depends-on	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-depends-on
derived-from	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-derived-from
description	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-description
effective	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-effective
identifier	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-identifier
jurisdiction	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-jurisdiction
name	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-name
predecessor	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-predecessor
publisher	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-publisher
status	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-status
successor	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-successor
title	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-title
topic	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-topic
url	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-url
version	string	http://hl7.org/fhir/SearchParameter/ActivityDefinition-version

Reference

• Official FHIR R4 spec: ActivityDefinition
• Maturity: Trial Use 2 (FMM 2).