Skip to main content

ActivityDefinition

Trial Use 4 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

devhttps://api.sandbox.ovok.com/fhir/R5/ActivityDefinition
InteractionMethodPath
ReadGET/fhir/R5/ActivityDefinition/[id]
VreadGET/fhir/R5/ActivityDefinition/[id]/_history/[vid]
UpdatePUT/fhir/R5/ActivityDefinition/[id]
PatchPATCH/fhir/R5/ActivityDefinition/[id]
DeleteDELETE/fhir/R5/ActivityDefinition/[id]
CreatePOST/fhir/R5/ActivityDefinition
SearchGET/fhir/R5/ActivityDefinition?...
HistoryGET/fhir/R5/ActivityDefinition/[id]/_history
Type-historyGET/fhir/R5/ActivityDefinition/_history

Top-level elements

ElementType(s)CardinalityDescription
urluri0..1Canonical identifier for this activity definition, represented as a URI (globally unique)
identifierIdentifier0..*Additional identifier for the activity definition
versionstring0..1Business version of the activity definition
versionAlgorithm[x]string / Coding0..1How to compare versions
namestring0..1Name for this activity definition (computer friendly)
titlestring0..1Name for this activity definition (human friendly)
subtitlestring0..1Subordinate title of the activity definition
statuscode1..1draft
experimentalboolean0..1For testing purposes, not real usage
subject[x]CodeableConcept / Reference / canonical0..1Type of individual the activity definition is intended for
datedateTime0..1Date last changed
publisherstring0..1Name of the publisher/steward (organization or individual)
contactContactDetail0..*Contact details for the publisher
descriptionmarkdown0..1Natural language description of the activity definition
useContextUsageContext0..*The context that the content is intended to support
jurisdictionCodeableConcept0..*Intended jurisdiction for activity definition (if applicable)
purposemarkdown0..1Why this activity definition is defined
usagemarkdown0..1Describes the clinical usage of the activity definition
copyrightmarkdown0..1Use and/or publishing restrictions
copyrightLabelstring0..1Copyright holder and year(s)
approvalDatedate0..1When the activity definition was approved by publisher
lastReviewDatedate0..1When the activity definition was last reviewed by the publisher
effectivePeriodPeriod0..1When the activity definition is expected to be used
topicCodeableConcept0..*E.g. Education, Treatment, Assessment, etc
authorContactDetail0..*Who authored the content
editorContactDetail0..*Who edited the content
reviewerContactDetail0..*Who reviewed the content
endorserContactDetail0..*Who endorsed the content
relatedArtifactRelatedArtifact0..*Additional documentation, citations, etc
librarycanonical0..*Logic used by the activity definition
kindcode0..1Kind of resource
profilecanonical0..1What profile the resource needs to conform to
codeCodeableConcept0..1Detail type of activity
intentcode0..1proposal
prioritycode0..1routine
doNotPerformboolean0..1True if the activity should not be performed modifier
timing[x]Timing / Age / Range / Duration0..1When activity is to occur
asNeeded[x]boolean / CodeableConcept0..1Preconditions for service
locationCodeableReference0..1Where it should happen
participantBackboneElement0..*Who should participate in the action
product[x]Reference / CodeableConcept0..1What's administered/supplied
quantityQuantity0..1How much is administered/consumed/supplied
dosageDosage0..*Detailed dosage instructions
bodySiteCodeableConcept0..*What part of body to perform on
specimenRequirementcanonical0..*What specimens are required to perform this action
observationRequirementcanonical0..*What observations are required to perform this action
observationResultRequirementcanonical0..*What observations must be produced by this action
transformcanonical0..1Transform to apply the template
dynamicValueBackboneElement0..*Dynamic aspects of the definition

Resource-specific search parameters

ParameterTypeDescription
composed-ofreferenceWhat resource is being referenced
contexttokenA use context assigned to the activity definition
context-quantityquantityA quantity- or range-valued use context assigned to the activity definition
context-typetokenA type of use context assigned to the activity definition
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the activity definition
context-type-valuecompositeA use context type and value assigned to the activity definition
datedateThe activity definition publication date
depends-onreferenceWhat resource is being referenced
derived-fromreferenceWhat resource is being referenced
descriptionstringThe description of the activity definition
effectivedateThe time during which the activity definition is intended to be in use
identifiertokenExternal identifier for the activity definition
jurisdictiontokenIntended jurisdiction for the activity definition
kindtokenThe kind of activity definition
namestringComputationally friendly name of the activity definition
predecessorreferenceWhat resource is being referenced
publisherstringName of the publisher of the activity definition
statustokenThe current status of the activity definition
successorreferenceWhat resource is being referenced
titlestringThe human-friendly name of the activity definition
topictokenTopics associated with the module
urluriThe uri that identifies the activity definition
versiontokenThe business version of the activity definition

Reference