ActivityDefinition
This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 15 of 22 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
urlΣ | 0..1 | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) |
identifierΣ | 0..* | Identifier | Additional identifier for the activity definition |
versionΣ | 0..1 | string | Business version of the activity definition |
nameΣ | 0..1 | string | Name for this activity definition (computer friendly) |
titleΣ | 0..1 | string | Name for this activity definition (human friendly) |
subtitle | 0..1 | string | Subordinate title of the activity definition |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
subject[x] | 0..1 | CodeableConcept | Reference(Group) | Type of individual the activity definition is intended forBinding (extensible): subject-type |
dateΣ | 0..1 | dateTime | Date last changed |
publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
contactΣ | 0..* | ContactDetail | Contact details for the publisher |
descriptionΣ | 0..1 | markdown | Natural language description of the activity definition |
useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for activity definition (if applicable)Binding (extensible): jurisdiction |
purpose | 0..1 | markdown | Why this activity definition is defined |
usage | 0..1 | string | Describes the clinical usage of the activity definition |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
approvalDate | 0..1 | date | When the activity definition was approved by publisher |
lastReviewDate | 0..1 | date | When the activity definition was last reviewed |
effectivePeriodΣ | 0..1 | Period | When the activity definition is expected to be used |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc.Binding (example): definition-topic |
author | 0..* | ContactDetail | Who authored the content |
editor | 0..* | ContactDetail | Who edited the content |
reviewer | 0..* | ContactDetail | Who reviewed the content |
endorser | 0..* | ContactDetail | Who endorsed the content |
relatedArtifact | 0..* | RelatedArtifact | Additional documentation, citations, etc. |
library | 0..* | canonical(Library) | Logic used by the activity definition |
kindΣ | 0..1 | code | Kind of resourceBinding (required): request-resource-types |
profile | 0..1 | canonical(StructureDefinition) | What profile the resource needs to conform to |
codeΣ | 0..1 | CodeableConcept | Detail type of activityBinding (example): procedure-code |
intent | 0..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | optionBinding (required): request-intent |
priority | 0..1 | code | routine | urgent | asap | statBinding (required): request-priority |
doNotPerform?!Σ | 0..1 | boolean | True if the activity should not be performed |
timing[x] | 0..1 | Timing | dateTime | Age | Period | Range | Duration | When activity is to occur |
location | 0..1 | Reference(Location) | Where it should happen |
participant | 0..* | BackboneElement | Who should participate in the action |
typeRequired | 1..1 | code | patient | practitioner | related-person | deviceBinding (required): action-participant-type |
role | 0..1 | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc.Binding (example): action-participant-role |
product[x] | 0..1 | Reference(Medication | Substance) | CodeableConcept | What's administered/suppliedBinding (example): medication-codes |
quantity | 0..1 | Quantity | How much is administered/consumed/supplied |
dosage | 0..* | Dosage | Detailed dosage instructions |
bodySite | 0..* | CodeableConcept | What part of body to perform onBinding (example): body-site |
specimenRequirement | 0..* | Reference(SpecimenDefinition) | What specimens are required to perform this action |
observationRequirement | 0..* | Reference(ObservationDefinition) | What observations are required to perform this action |
observationResultRequirement | 0..* | Reference(ObservationDefinition) | What observations must be produced by this action |
transform | 0..1 | canonical(StructureMap) | Transform to apply the template |
dynamicValue | 0..* | BackboneElement | Dynamic aspects of the definition |
pathRequired | 1..1 | string | The path to the element to be set dynamically |
expressionRequired | 1..1 | Expression | An expression that provides the dynamic value for the customization |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/ActivityDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
composed-of | reference | What resource is being referenced ActivityDefinition.relatedArtifact.where(type='composed-of').resource | ||
context | token | A use context assigned to the activity definition (ActivityDefinition.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the activity definition (ActivityDefinition.useContext.value.ofType(Quantity)) | (ActivityDefinition.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the activity definition ActivityDefinition.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the activity definition ActivityDefinition.useContext | ||
context-type-value | composite | A use context type and value assigned to the activity definition ActivityDefinition.useContext | ||
date | date | The activity definition publication date ActivityDefinition.date | ||
depends-on | reference | What resource is being referenced ActivityDefinition.relatedArtifact.where(type='depends-on').resource | ActivityDefinition.library | ||
derived-from | reference | What resource is being referenced ActivityDefinition.relatedArtifact.where(type='derived-from').resource | ||
description | string | The description of the activity definition ActivityDefinition.description | ||
effective | date | The time during which the activity definition is intended to be in use ActivityDefinition.effectivePeriod | ||
identifier | token | External identifier for the activity definition ActivityDefinition.identifier | ||
jurisdiction | token | Intended jurisdiction for the activity definition ActivityDefinition.jurisdiction | ||
name | string | Computationally friendly name of the activity definition ActivityDefinition.name | ||
predecessor | reference | What resource is being referenced ActivityDefinition.relatedArtifact.where(type='predecessor').resource | ||
publisher | string | Name of the publisher of the activity definition ActivityDefinition.publisher | ||
status | token | The current status of the activity definition ActivityDefinition.status | ||
successor | reference | What resource is being referenced ActivityDefinition.relatedArtifact.where(type='successor').resource | ||
title | string | The human-friendly name of the activity definition ActivityDefinition.title | ||
topic | token | Topics associated with the module ActivityDefinition.topic | ||
url | uri | The uri that identifies the activity definition ActivityDefinition.url | ||
version | token | The business version of the activity definition ActivityDefinition.version |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken