Generated Narrative: StructureDefinition pt-ActivityDefinition Name Flags Card. Type Description & Constraints <a href="StructureDefinition-pt-ActivityDefinition-definitions.html#ActivityDefinition" title="Definition of a launchable digital (eHealth) activity that can be used as a template for patient-specific workflow requests. The definition may describe different activity types (e.g., launching a third-party module, presenting information, completing a questionnaire, or performing a measurement) and includes the technical launch details needed to invoke the activity in the correct context.">ActivityDefinition 0..* ActivityDefinition The definition of a specific activity to be taken, independent of any particular patient or context #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:resource-origin 0..* Reference(KT2_Device) Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/resource-origin #xD; extension:endpoint 1..* Reference(KT2_Endpoint) Endpoint for launching the activity URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2EndpointExtension #xD; extension:publisherId 0..* id Extension URL: http://koppeltaal.nl/fhir/StructureDefinition/KT2PublisherId #xD; title 1..1 string Name for this activity definition (human friendly) #xD; useContext 0..* UsageContext The context that the content is intended to support #xD; usage 0..1 string Describes the clinical usage of the activity definition #xD; topic 0..* CodeableConcept E.g. Self-Treatment and Self-Assessment, etc. Binding: Koppeltaal Definition Topic (extensible): High-level categorization of the definition, used for indicating special patient initialised activities #xD; Documentation for this format
This (FHIR) ActivityDefinition profile describes a reusable definition of a launchable digital (eHealth) activity that can be requested for a patient in MedMij and/or Koppeltaal workflows. It captures the clinical intent and the technical launch information (e.g., endpoint) so that systems can consistently create patient-specific Tasks that reference this definition.
Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.
The definition of a specific activity to be taken, independent of any particular patient or context
Definition of a launchable digital (eHealth) activity that can be used as a template for patient-specific workflow requests. The definition may describe different activity types (e.g., launching a third-party module, presenting information, completing a questionnaire, or performing a measurement) and includes the technical launch details needed to invoke the activity in the correct context.
Name should be usable as an identifier for the module by machine processing applications such as code generation
not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The 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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A 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.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A 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.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These 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.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Part of the authorisation model. Upon creation of the resource this extension is set to the device that created it.
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Mandatory reference to the service application (endpoint) that provides the launchable eHealth activity. Can be more than one endpoint.
This extension allows every module vendor to search for tasks with linked to their module.
May 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).
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this activity definition, represented as a URI (globally unique)
An 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.
Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](http://hl7.org/fhir/R4/resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](http://hl7.org/fhir/R4/resource.html#meta) element to indicate where the current master source of the resource can be found.
Allows the activity definition to be referenced by a single globally unique identifier.
Additional identifier for the activity definition
A 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.
Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this activity definition outside of FHIR, where it is not possible to use the logical URI.
Allows externally provided and/or usable business identifiers to be easily associated with the module.
Business version of the activity definition
The 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.
There may be different activity definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the activity definition with the format [url]|[version].
Name for this activity definition (computer friendly)
A 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.
The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Support human navigation and code generation.
Name for this activity definition (human friendly)
A short, descriptive, user-friendly title for the activity definition.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Subordinate title of the activity definition
An explanatory or alternate title for the activity definition giving additional information about its content.
The status of this activity definition. Enables tracking the life-cycle of the content.
Allows filtering of activity definitions that are appropriate for use versus not.
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
A 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.
Enables experimental content to be developed following the same lifecycle that would be used for a production-level activity definition.
Type of individual the activity definition is intended for
A code or group definition that describes the intended subject of the activity being defined.
The possible types of subjects for an activity (E.g. Patient, Practitioner, Organization, Location, etc.).
The 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.
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the activity definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Name of the publisher (organization or individual)
The name of the organization or individual that published the activity definition.
Usually an organization but may be an individual. The publisher (or steward) of the activity definition is the organization or individual primarily responsible for the maintenance and upkeep of the activity definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the activity definition. This item SHOULD be populated unless the information is available from context.
Helps establish the "authority/credibility" of the activity definition. May also allow for contact.
Definition.publisher {as string instead of CodeableConcept}
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc.
Natural language description of the activity definition
A free text natural language description of the activity definition from a consumer's perspective.
This description can be used to capture details such as why the activity definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the activity definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the activity definition is presumed to be the predominant language in the place the activity definition was created).
The context that the content is intended to support
The context for the content of the eHealth activity.
E.g. the activity is targeted to a certain age group.
Assist in searching for appropriate content.
Intended jurisdiction for activity definition (if applicable)
A legal or geographic region in which the activity definition is intended to be used.
It may be possible for the activity definition to be used in jurisdictions other than those for which it was originally designed or intended.
Countries and regions within which this artifact is targeted for use.
Explanation of why this activity definition is needed and why it has been designed as it has.
This element does not describe the usage of the activity definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this activity definition.
Describes the clinical usage of the activity definition
A detailed description of how the activity definition is used from a clinical perspective. In the MedMij use case, this text is intended for the healthcare professional who is selecting and assigning the activity to the patient.
A 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.
Consumers must be able to determine any legal restrictions on the use of the activity definition and/or its content.
When the activity definition was approved by publisher
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
When the activity definition was last reviewed
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
If specified, this date follows the original approval date.
Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
.outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime
When the activity definition is expected to be used
The period during which the activity definition content was or is planned to be in active use.
The effective period for a activity definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the activity definition are or are expected to be used instead.
E.g. Self-Treatment and Self-Assessment, etc.
Descriptive topics related to the content of the activity. The topic is used to indicate that the activity is intended or suitable for initialization by patients.
Repositories must be able to determine how to categorize the activity definition so that it can be found by topical searches.
High-level categorization of the definition, used for indicating special patient initialised activities
An individiual or organization primarily involved in the creation and maintenance of the content.
An individual or organization primarily responsible for internal coherence of the content.
An individual or organization primarily responsible for review of some aspect of the content.
.participation[typeCode=VRF] {not clear whether VRF best corresponds to reviewer or endorser}
An individual or organization responsible for officially endorsing the content for use in some setting.
Additional documentation, citations, etc.
Related artifacts such as additional documentation, justification, or bibliographic references.
Each related artifact is either an attachment, or a reference to another resource, but not both.
Activity definitions must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.
.outboundRelationship[typeCode=DOC,RSON,PREV, DRIV, USE, COMP] {successor would be PREV w/ inversionInd=true; No support for citation}
A reference to a Library resource containing any formal logic used by the activity definition.
A 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.
May determine what types of extensions are permitted.
The kind of activity the definition is describing.
What profile the resource needs to conform to
A profile to which the target of the activity definition is expected to conform.
Allows profiles to be used to describe the types of activities that can be performed within a workflow, protocol, or order set.
Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
Tends to be less relevant for activities involving particular products.
Allows matching performed to planned as well as validation against protocols.
Detailed type of the activity; e.g. CBC.
proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
Codes indicating the degree of authority/intentionality associated with a request.
Indicates how quickly the activity should be addressed with respect to other requests.
Identifies the level of importance to be assigned to actioning the request.
True if the activity should not be performed
Set 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.
This element is not intended to be used to communicate a decision support response to cancel an order in progress. That should be done with the "remove" type of a PlanDefinition or RequestGroup.
If true this element negates the specified action. For Example, instead of a request for a procedure, it is a request for the procedure to not occur.
The period, timing or frequency upon which the described activity is to occur.
Allows prompting for activities and detection of missed planned activities.
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
May reference a specific clinical location or may just identify a type of location.
Indicates who should participate in performing the action described.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Additional content defined by implementations
May 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.
Extensions that cannot be ignored even if unrecognized
May 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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
patient | practitioner | related-person | device
The type of participant in the activity.
The role the participant should play in performing the described action.
Defines roles played by participants for the action.
Identifies the food, drug or other product being consumed or supplied in the activity.
Code describing the type of substance or medication.
How much is administered/consumed/supplied
Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
If a dosage instruction is used, the definition should not specify timing or quantity.
.outboundRelationship[typeCode=COMP].target[classCode=SBADM; moodCode=DEFN]
Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
Only used if not implicit in the code found in ServiceRequest.type.
Knowing where the procedure is made is important for tracking if multiple sites are possible.
A code that identifies the anatomical location.
.targetSiteCode {for classCode=PROC, SBADM}
What specimens are required to perform this action
Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
Needed to represent lab order definitions.
What observations are required to perform this action
Defines observation requirements for the action to be performed, such as body weight or surface area.
Needed to represent observation definitions.
What observations must be produced by this action
Defines the observations that are expected to be produced by the action.
A 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.
Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.
Dynamic 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.
Dynamic values are applied in the order in which they are defined in the ActivityDefinition. Note that if both a transform and dynamic values are specified, the dynamic values will be applied to the result of the transform.
The path to the element to be set dynamically
The 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](http://hl7.org/fhir/R4/fhirpath.html#simple) for full details).
The path attribute contains a [Simple FHIRPath Subset](http://hl7.org/fhir/R4/fhirpath.html#simple) that allows path traversal, but not calculation.
An expression that provides the dynamic value for the customization
An expression specifying the value of the customized element.
The expression may be inlined, or may be a reference to a named expression within a logic library referenced by the library element.