Skip to main content

ActivityDefinition

PropertyValue
Publisher
NameActivityDefinition
URLhttp://hl7.org/fhir/StructureDefinition/ActivityDefinition
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
ActivityDefinition0..*ActivityDefinitionThis resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
ActivityDefinition.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
ActivityDefinition.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
ActivityDefinition.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
ActivityDefinition.language0..1codeThe base language in which the resource is written.
ActivityDefinition.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
ActivityDefinition.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
ActivityDefinition.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ActivityDefinition.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ActivityDefinition.url0..1uriAn absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
ActivityDefinition.identifier0..*IdentifierA formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
ActivityDefinition.version0..1stringThe identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
ActivityDefinition.name0..1stringA natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
ActivityDefinition.title0..1stringA short, descriptive, user-friendly title for the activity definition.
ActivityDefinition.subtitle0..1stringAn explanatory or alternate title for the activity definition giving additional information about its content.
ActivityDefinition.status1..1codeThe status of this activity definition. Enables tracking the life-cycle of the content.
ActivityDefinition.experimental0..1booleanA Boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
ActivityDefinition.subject[x]0..1CodeableConceptA code or group definition that describes the intended subject of the activity being defined.
ActivityDefinition.date0..1dateTimeThe date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.
ActivityDefinition.publisher0..1stringThe name of the organization or individual that published the activity definition.
ActivityDefinition.contact0..*ContactDetailContact details to assist a user in finding and communicating with the publisher.
ActivityDefinition.description0..1markdownA free text natural language description of the activity definition from a consumer's perspective.
ActivityDefinition.useContext0..*UsageContextThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.
ActivityDefinition.jurisdiction0..*CodeableConceptA legal or geographic region in which the activity definition is intended to be used.
ActivityDefinition.purpose0..1markdownExplanation of why this activity definition is needed and why it has been designed as it has.
ActivityDefinition.usage0..1stringA detailed description of how the activity definition is used from a clinical perspective.
ActivityDefinition.copyright0..1markdownA copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
ActivityDefinition.approvalDate0..1dateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
ActivityDefinition.lastReviewDate0..1dateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
ActivityDefinition.effectivePeriod0..1PeriodThe period during which the activity definition content was or is planned to be in active use.
ActivityDefinition.topic0..*CodeableConceptDescriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
ActivityDefinition.author0..*ContactDetailAn individiual or organization primarily involved in the creation and maintenance of the content.
ActivityDefinition.editor0..*ContactDetailAn individual or organization primarily responsible for internal coherence of the content.
ActivityDefinition.reviewer0..*ContactDetailAn individual or organization primarily responsible for review of some aspect of the content.
ActivityDefinition.endorser0..*ContactDetailAn individual or organization responsible for officially endorsing the content for use in some setting.
ActivityDefinition.relatedArtifact0..*RelatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.
ActivityDefinition.library0..*canonicalA reference to a Library resource containing any formal logic used by the activity definition.
ActivityDefinition.kind0..1codeA description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
ActivityDefinition.profile0..1canonicalA profile to which the target of the activity definition is expected to conform.
ActivityDefinition.code0..1CodeableConceptDetailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
ActivityDefinition.intent0..1codeIndicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
ActivityDefinition.priority0..1codeIndicates how quickly the activity should be addressed with respect to other requests.
ActivityDefinition.doNotPerform0..1booleanSet this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
ActivityDefinition.timing[x]0..1TimingThe period, timing or frequency upon which the described activity is to occur.
ActivityDefinition.location0..1ReferenceIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
ActivityDefinition.participant0..*BackboneElementIndicates who should participate in performing the action described.
ActivityDefinition.participant.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ActivityDefinition.participant.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ActivityDefinition.participant.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ActivityDefinition.participant.type1..1codeThe type of participant in the action.
ActivityDefinition.participant.role0..1CodeableConceptThe role the participant should play in performing the described action.
ActivityDefinition.product[x]0..1ReferenceIdentifies the food, drug or other product being consumed or supplied in the activity.
ActivityDefinition.quantity0..1QuantityIdentifies the quantity expected to be consumed at once (per dose, per meal, etc.).
ActivityDefinition.dosage0..*DosageProvides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
ActivityDefinition.bodySite0..*CodeableConceptIndicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
ActivityDefinition.specimenRequirement0..*ReferenceDefines specimen requirements for the action to be performed, such as required specimens for a lab test.
ActivityDefinition.observationRequirement0..*ReferenceDefines observation requirements for the action to be performed, such as body weight or surface area.
ActivityDefinition.observationResultRequirement0..*ReferenceDefines the observations that are expected to be produced by the action.
ActivityDefinition.transform0..1canonicalA reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
ActivityDefinition.dynamicValue0..*BackboneElementDynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.
ActivityDefinition.dynamicValue.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ActivityDefinition.dynamicValue.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
ActivityDefinition.dynamicValue.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
ActivityDefinition.dynamicValue.path1..1stringThe path to the element to be customized. This is the path on the resource that will hold the result of the calculation defined by the expression. The specified path SHALL be a FHIRPath resolveable on the specified target type of the ActivityDefinition, and SHALL consist only of identifiers, constant indexers, and a restricted subset of functions. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements (see the Simple FHIRPath Profile for full details).
ActivityDefinition.dynamicValue.expression1..1ExpressionAn expression specifying the value of the customized element.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
composed-ofreferenceWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='composed-of').resource
contexttokenA use context assigned to the activity definition(ActivityDefinition.useContext.value.ofType(CodeableConcept))
context-quantityquantityA quantity- or range-valued use context assigned to the activity definition(ActivityDefinition.useContext.value.ofType(Quantity)) / (ActivityDefinition.useContext.value.ofType(Range))
context-typetokenA type of use context assigned to the activity definitionActivityDefinition.useContext.code
datedateThe activity definition publication dateActivityDefinition.date
depends-onreferenceWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='depends-on').resource / ActivityDefinition.library
derived-fromreferenceWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='derived-from').resource
descriptionstringThe description of the activity definitionActivityDefinition.description
effectivedateThe time during which the activity definition is intended to be in useActivityDefinition.effectivePeriod
identifiertokenExternal identifier for the activity definitionActivityDefinition.identifier
jurisdictiontokenIntended jurisdiction for the activity definitionActivityDefinition.jurisdiction
namestringComputationally friendly name of the activity definitionActivityDefinition.name
predecessorreferenceWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='predecessor').resource
publisherstringName of the publisher of the activity definitionActivityDefinition.publisher
statustokenThe current status of the activity definitionActivityDefinition.status
successorreferenceWhat resource is being referencedActivityDefinition.relatedArtifact.where(type='successor').resource
titlestringThe human-friendly name of the activity definitionActivityDefinition.title
topictokenTopics associated with the moduleActivityDefinition.topic
urluriThe uri that identifies the activity definitionActivityDefinition.url
versiontokenThe business version of the activity definitionActivityDefinition.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the activity definitionActivityDefinition.useContext
context-type-valuecompositeA use context type and value assigned to the activity definitionActivityDefinition.useContext
_iguhealth-version-seqnumberThe version sequence of the resourceResource.meta.extension.where(url='https://iguhealth.app/version-sequence').value
_iguhealth-authorreferenceThe author of the resourceResource.meta.extension.where(url='https://iguhealth.app/author').value