Resources
ActivityDefinition
Resources
ActivityDefinition
This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
Properties
| Name | Required | Type | Description |
|---|---|---|---|
| url | No | uri | Canonical identifier for this activity definition, represented as a URI (globally unique) |
| identifier | No | Identifier[] | Additional identifier for the activity definition |
| version | No | string | Business version of the activity definition |
| name | No | string | Name for this activity definition (computer friendly) |
| title | No | string | Name for this activity definition (human friendly) |
| subtitle | No | string | Subordinate title of the activity definition |
| status | Yes | code | draft / active / retired / unknown |
| experimental | No | boolean | For testing purposes, not real usage |
| subject[x] | No | CodeableConcept, Reference<Group> | Type of individual the activity definition is intended for |
| date | No | dateTime | Date last changed |
| publisher | No | string | Name of the publisher (organization or individual) |
| contact | No | ContactDetail[] | Contact details for the publisher |
| description | No | markdown | Natural language description of the activity definition |
| useContext | No | UsageContext[] | The context that the content is intended to support |
| jurisdiction | No | CodeableConcept[] | Intended jurisdiction for activity definition (if applicable) |
| purpose | No | markdown | Why this activity definition is defined |
| usage | No | string | Describes the clinical usage of the activity definition |
| copyright | No | markdown | Use and/or publishing restrictions |
| approvalDate | No | date | When the activity definition was approved by publisher |
| lastReviewDate | No | date | When the activity definition was last reviewed |
| effectivePeriod | No | Period | When the activity definition is expected to be used |
| topic | No | CodeableConcept[] | E.g. Education, Treatment, Assessment, etc. |
| author | No | ContactDetail[] | Who authored the content |
| editor | No | ContactDetail[] | Who edited the content |
| reviewer | No | ContactDetail[] | Who reviewed the content |
| endorser | No | ContactDetail[] | Who endorsed the content |
| relatedArtifact | No | RelatedArtifact[] | Additional documentation, citations, etc. |
| library | No | canonical[] | Logic used by the activity definition |
| kind | No | code | Kind of resource |
| profile | No | canonical | What profile the resource needs to conform to |
| code | No | CodeableConcept | Detail type of activity |
| intent | No | code | proposal / plan / directive / order / original-order / reflex-order / filler-order / instance-order / option |
| priority | No | code | routine / urgent / asap / stat |
| doNotPerform | No | boolean | True if the activity should not be performed |
| timing[x] | No | Timing, dateTime, Age, Period, Range, Duration | When activity is to occur |
| location | No | Reference<Location> | Where it should happen |
| participant | No | ActivityDefinitionParticipant | Who should participate in the action |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - type | Yes | code | patient / practitioner / related-person / device |
| - role | No | CodeableConcept | E.g. Nurse, Surgeon, Parent, etc. |
| product[x] | No | Reference<Medication / Substance>, CodeableConcept | What’s administered/supplied |
| quantity | No | Quantity | How much is administered/consumed/supplied |
| dosage | No | Dosage[] | Detailed dosage instructions |
| bodySite | No | CodeableConcept[] | What part of body to perform on |
| specimenRequirement | No | Reference<SpecimenDefinition>[] | What specimens are required to perform this action |
| observationRequirement | No | Reference<ObservationDefinition>[] | What observations are required to perform this action |
| observationResultRequirement | No | Reference<ObservationDefinition>[] | What observations must be produced by this action |
| transform | No | canonical | Transform to apply the template |
| dynamicValue | No | ActivityDefinitionDynamicValue | Dynamic aspects of the definition |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - path | Yes | string | The path to the element to be set dynamically |
| - expression | Yes | Expression | An expression that provides the dynamic value for the customization |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| composed-of | reference | What resource is being referenced | ActivityDefinition.relatedArtifact |
| context | token | A use context assigned to the activity definition | ActivityDefinition.useContext.value |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the activity definition | ActivityDefinition.useContext.value |
| context-type | token | A type of use context assigned to the activity definition | ActivityDefinition.useContext.code |
| date | date | The activity definition publication date | ActivityDefinition.date |
| depends-on | reference | What resource is being referenced | ActivityDefinition.relatedArtifact |
| derived-from | reference | What resource is being referenced | ActivityDefinition.relatedArtifact |
| 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 |
| 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 |
| 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 |
| 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 |
Inherited Properties
| Name | Required | Type | Description |
|---|---|---|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
To view the FHIR specification for this resource, see ActivityDefinition.