Generated Narrative: StructureDefinition hcs-plandefinition Name Flags Card. Type Description & Constraints PlanDefinition 1..1 USPublicHealthPlanDefinition Health Care Surveys Knowledge Artifact #xD; Slices for action 5..* BackboneElement All constraints on action are intended to apply to any nested constraints. Slice: Ordered, Open by value:id #xD; action:All Slices Content/Rules for all slices #xD; code 0..1 CodeableConcept Code representing the meaning of the action or sub-actions Binding: US Public Health VaueSet - PlanDefinition Action (extensible) #xD; action:startWorkflow 1..1 BackboneElement All constraints on action are intended to apply to any nested constraints. #xD; id 1..1 string Unique id for inter-element referencing Required Pattern: start-workflow #xD; description 0..1 string Brief description of the action Required Pattern: Start the workflow action. #xD; textEquivalent S 1..1 string Text equivalent of the start workflow action. Fixed Value: Start the reporting workflow in response to an encounter-end event #xD; code 1..1 CodeableConcept Code for the start action. Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: initiate-reporting-workflow #xD; trigger 1..* TriggerDefinition When the start action should be triggered. #xD; Slices for extension Content/Rules for all slices #xD; extension:namedEventType 0..1 USPublicHealthNamedEventTypeExtension Indicates the types of named events to subscribe to from the EHR. #xD; name 0..1 string Name or URI that identifies the event Fixed Value: encounter-end #xD; relatedAction 1..1 BackboneElement Relationship to another action #xD; actionId 1..1 id What action is this related to Fixed Value: check-reportability #xD; relationship 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start #xD; Slices for offset[x] Content/Rules for all slices #xD; offset[x]:offsetDuration 0..1 Duration Time offset for the relationship Example Wait 72 hour before next action.: {"value":72,"unit":"h"} #xD; action:executeReportingWorkflow 1..1 BackboneElement All constraints on action are intended to apply to any nested constraints. #xD; id 1..1 string Unique id for inter-element referencing Required Pattern: check-reportability #xD; description 0..1 string Brief description of the action Required Pattern: Execute reporting workflow action. #xD; code 1..1 CodeableConcept Code for the execute-reporting-workflow action. Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: execute-reporting-workflow #xD; trigger #xD; Slices for extension Content/Rules for all slices #xD; extension:namedEventType 0..1 USPublicHealthNamedEventTypeExtension US Public Health Named Event Type Extension #xD; Slices for action 2..* A sub-action Slice: Unordered, Open by value:id #xD; action:isAmbulatoryEncounterReportable S 1..1 BackboneElement A sub-action #xD; id S 1..1 string Unique id for inter-element referencing Fixed Value: is-ambulatory-encounter-reportable #xD; code 1..1 CodeableConcept Code representing the meaning of the action or sub-actions Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: evaluate-condition #xD; condition #xD; kind 1..1 code applicability | start | stop Fixed Value: applicability #xD; expression S 1..1 Expression Boolean-valued expression #xD; language 1..1 code text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath #xD; input S 0..* DataRequirement Input data requirements #xD; id S 1..1 string Unique id for inter-element referencing #xD; relatedAction #xD; actionId 1..1 id What action is this related to Fixed Value: create-hcs-report #xD; relationship 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start #xD; action:isInpatientEncounterReportable S 1..1 BackboneElement A sub-action #xD; id S 1..1 string Unique id for inter-element referencing Fixed Value: is-inpatient-encounter-reportable #xD; code 1..1 CodeableConcept Code representing the meaning of the action or sub-actions Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: evaluate-condition #xD; condition #xD; kind 1..1 code applicability | start | stop Fixed Value: applicability #xD; expression S 1..1 Expression Boolean-valued expression #xD; language 1..1 code text/cql | text/fhirpath | application/x-fhir-query | etc. Fixed Value: text/fhirpath #xD; input S 0..* DataRequirement Input data requirements #xD; id S 1..1 string Unique id for inter-element referencing #xD; relatedAction #xD; actionId 1..1 id What action is this related to Fixed Value: create-hcs-report #xD; relationship 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start #xD; action:createReport 1..1 BackboneElement All constraints on action are intended to apply to any nested constraints. #xD; id 1..1 string Unique id for inter-element referencing Required Pattern: create-hcs-report #xD; description 0..1 string Brief description of the action Required Pattern: Create HCS report action. #xD; code 1..1 CodeableConcept Code representing the meaning of the action or sub-actions Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: create-report #xD; trigger #xD; Slices for extension Content/Rules for all slices #xD; extension:namedEventType 0..1 USPublicHealthNamedEventTypeExtension US Public Health Named Event Type Extension #xD; input 0..* DataRequirement Input data requirements #xD; id S 1..1 string Unique id for inter-element referencing #xD; output 0..* DataRequirement Output data definition #xD; id S 1..1 string Unique id for inter-element referencing #xD; relatedAction #xD; actionId 1..1 id What action is this related to Fixed Value: validate-hcs-report #xD; relationship 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start #xD; action:validateReport 1..1 BackboneElement All constraints on action are intended to apply to any nested constraints. #xD; id 1..1 string Unique id for inter-element referencing Required Pattern: validate-hcs-report #xD; description 0..1 string Brief description of the action Required Pattern: Validate HCS report action. #xD; code 0..1 CodeableConcept Code representing the meaning of the action or sub-actions Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: validate-report #xD; trigger #xD; Slices for extension Content/Rules for all slices #xD; extension:namedEventType 0..1 USPublicHealthNamedEventTypeExtension US Public Health Named Event Type Extension #xD; input 0..* DataRequirement Input data requirements #xD; id S 1..1 string Unique id for inter-element referencing #xD; output 0..* DataRequirement Output data definition #xD; id S 1..1 string Unique id for inter-element referencing #xD; relatedAction #xD; actionId 1..1 id What action is this related to Fixed Value: submit-hcs-report #xD; relationship 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Fixed Value: before-start #xD; action:submitHcsReport 1..1 BackboneElement All constraints on action are intended to apply to any nested constraints. #xD; id 1..1 string Unique id for inter-element referencing Required Pattern: submit-hcs-report #xD; description 0..1 string Brief description of the action Required Pattern: Submit HCS report action. #xD; textEquivalent S 1..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system Fixed Value: Route and send HCS Report #xD; code 0..1 CodeableConcept Code representing the meaning of the action or sub-actions Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/ph-library/CodeSystem/us-ph-codesystem-plandefinition-actions #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: submit-report #xD; trigger #xD; Slices for extension Content/Rules for all slices #xD; extension:namedEventType 0..1 USPublicHealthNamedEventTypeExtension US Public Health Named Event Type Extension #xD; input 0..* DataRequirement Input data requirements #xD; id S 1..1 string Unique id for inter-element referencing #xD; Documentation for this format
This PlanDefinition profile defines the logic and rules around determining whether or not data from an encounter is reportable to National Center for Health Statistics (NCHS).
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
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}')
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")])
Indicates the address where the report has to be sent.
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
US Public Health Async Indicator Extension
US Public Health Data Encrypted Extension
Indicates whether the data in the content bundle is encrypted or not.
US Public Health Data Encryption Algorithm
US Public Health Expected Response Time Extension
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/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this plan definition, represented as a URI (globally unique)
An absolute URI that is used to identify this plan 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 plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan 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/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/resource.html#meta) element to indicate where the current master source of the resource can be found.
Allows the plan definition to be referenced by a single globally unique identifier.
Additional identifier for the plan definition
A formal identifier that is used to identify this plan 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 plan 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.
There may be different plan 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 plan definition with the format [url]|[version].
Name for this PlanDefinition (computer friendly)
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.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
Subordinate title of the plan definition
An explanatory or alternate title for the plan definition giving additional information about its content.
The status of this plan definition. Enables tracking the life-cycle of the content.
Allows filtering of plan 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 plan 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 plan definition.
Type of individual the plan definition is focused on
A code or group definition that describes the intended subject of the plan definition.
The possible types of subjects for a plan definition (E.g. Patient, Practitioner, Organization, Location, etc.).
Date the PlanDefinition was last changed
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the plan 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 agency that published this PlanDefinition
Usually an organization but may be an individual. The publisher (or steward) of the plan definition is the organization or individual primarily responsible for the maintenance and upkeep of the plan 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 plan definition. This item SHOULD be populated unless the information is available from context.
Helps establish the "authority/credibility" of the plan definition. May also allow for contact.
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 plan definition
A free text natural language description of the plan definition from a consumer's perspective.
This description can be used to capture details such as why the plan 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 plan 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 plan definition is presumed to be the predominant language in the place the plan definition was created).
The context that the content is intended to support
The 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 plan definition instances.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for plan definition (if applicable)
A legal or geographic region in which the plan definition is intended to be used.
It may be possible for the plan 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 plan definition is needed and why it has been designed as it has.
This element does not describe the usage of the plan 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 plan definition.
Describes the clinical usage of the plan
A detailed description of how the plan definition is used from a clinical perspective.
A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
Consumers must be able to determine any legal restrictions on the use of the plan definition and/or its content.
When the plan 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 plan 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.
The period during which the PlanDefinition is valid
The effective period for a plan 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 plan definition are or are expected to be used instead.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
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.
The start of the time period when this PlanDefinition goes into effect
If the low element is missing, the meaning is that the low boundary is not known.
End time with inclusive boundary, if not ongoing
The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.
If the end of the period is missing, it means that the period is ongoing
Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.
Repositories must be able to determine how to categorize the plan definition so that it can be found by topical searches.
High-level categorization of the definition, used for searching, sorting, and filtering.
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.
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.
Plan 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.
A reference to a Library resource containing any formal logic used by the plan definition.
Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
Goal information needs to be captured for order sets, protocols, and care plan definitions to better describe the objectives of the protocol activities and to guide the creation of specific goals within the derived care plans and orders.
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
Indicates a category the goal falls within.
Example codes for grouping goals for filtering or presentation.
Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
If no code is available, use CodeableConcept.text.
high-priority | medium-priority | low-priority
Identifies the expected level of importance associated with reaching/sustaining the defined goal.
Indicates the level of importance associated with reaching or sustaining a goal.
The event after which the goal should begin being pursued.
Identifies the types of events that might trigger the start of a goal.
Identifies problems, conditions, issues, or concerns the goal is intended to address.
Identifies problems, conditions, issues, or concerns that goals may address.
Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.
Indicates what should be done and within what timeframe.
The parameter whose value is to be tracked
The parameter whose value is to be tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.
Identifies types of parameters that can be tracked to determine goal achievement.
The target value of the measure to be achieved to signify fulfillment of the goal, e.g. 150 pounds or 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any value at or above the low value.
Indicates the timeframe after the start of the goal in which the goal should be met.
All constraints on action are intended to apply to any nested constraints.
An action or group of actions to be taken as part of the plan.
Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.
User-visible prefix for the action (e.g. 1. or A.)
The title of the action displayed to a user.
A brief description of the action used to provide a summary to display to the user.
Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
A text equivalent of the action to be performed. This provides a human-interpretable description of the action when the definition is consumed by a system that might not be capable of interpreting it dynamically.
Indicates how quickly the action should be addressed with respect to other actions.
Identifies the level of importance to be assigned to actioning the request.
Code representing the meaning of the action or sub-actions
A code that provides meaning for the action or action group. For example, a section may have a LOINC code for the section of a documentation template.
A description of why this action is necessary or appropriate.
This is different than the clinical evidence documentation, it's an actual business description of the reason for performing the action.
Supporting documentation for the intended performer of the action
Didactic or other informational resources associated with the action that can be provided to the CDS recipient. Information resources can include inline text commentary and links to web resources.
Identifies goals that this action supports. The reference must be to a goal element defined within this plan definition.
Type of individual the action is focused on
A code or group definition that describes the intended subject of the action and its children, if any.
The subject of an action overrides the subject at a parent action or on the root of the PlanDefinition if specified. In addition, because the subject needs to be resolved during realization, use of subjects in actions (or in the ActivityDefinition referenced by the action) resolves based on the set of subjects supplied in context and by type (i.e. the patient subject would resolve to a resource of type Patient).
Multiple steps in a protocol often have different groups of steps that are focused on testing different things. The subject of an action specifies the focus of the action and any child actions.
A description of when the action should be triggered.
US Public Health Named Event Type Extension
Indicates the types of named events to subscribe to from the EHR.
named-event | periodic | data-changed | data-added | data-modified | data-removed | data-accessed | data-access-ended
A formal name for the event. This may be an absolute URI that identifies the event formally (e.g. from a trigger registry), or a simple relative URI that identifies the event in a local context.
An event name can be provided for all event types, but is required for named events. If a name is provided for a type other than named events, it is considered to be a shorthand for the semantics described by the formal description of the event.
The timing of the event (if this is a periodic trigger).
Triggering data of the event (multiple = 'and')
The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
This element shall be present for any data type trigger.
Whether the event triggers (boolean expression)
A boolean-valued expression that is evaluated in the context of the container of the trigger definition and returns whether or not the trigger fires.
This element can be only be specified for data type triggers and provides additional semantics for the trigger. The context available within the condition is based on the type of data event. For all events, the current resource will be available as context. In addition, for modification events, the previous resource will also be available. The expression may be inlined, or may be a simple absolute URI, which is a reference to a named expression within a logic library referenced by a library element or extension within the containing resource. If the expression is a FHIR Path expression, it evaluates in the context of a resource of one of the type identified in the data requirement, and may also refer to the variable %previous for delta comparisons on events of type data-changed, data-modified, and data-deleted which will always have the same type.
Need to be able to formally describe the triggering criteria.
An expression that describes applicability criteria or start/stop conditions for the action.
When multiple conditions of the same kind are present, the effects are combined using AND semantics, so the overall condition is true only if all the conditions are true.
Applicability criteria are used to determine immediate applicability when a plan definition is applied to a given context. Start and stop criteria are carried through application and used to describe enter/exit criteria for an action.
Defines the kinds of conditions that can appear on actions.
An expression that returns true or false, indicating whether the condition is satisfied.
The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
Defines input data requirements for the action.
The type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
The profile of the required data, specified as the uri of the profile definition.
E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device
The intended subjects of the data requirement. If this element is not provided, a Patient subject is assumed.
The subject of a data requirement is critical, as the data being specified is determined with respect to a particular subject. This corresponds roughly to the notion of a Compartment in that it limits what data is available based on its relationship to the subject. In CQL, this corresponds to the context declaration.
The possible types of subjects for a data requirement (E.g., Patient, Practitioner, Organization, Location, etc.).
Indicates specific structure elements that are referenced by the knowledge module
Indicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available. The value of mustSupport SHALL be a FHIRPath resolveable on the type of the DataRequirement. The path SHALL consist only of identifiers, constant indexers, and .resolve() (see the [Simple FHIRPath Profile](http://hl7.org/fhir/R4/fhirpath.html#simple) for full details).
Code filters specify additional constraints on the data, specifying the value set of interest for a particular element of the data. Each code filter defines an additional constraint on the data, i.e. code filters are AND'ed, not OR'ed.
Either a path or a searchParam must be provided, but not both
(exists(f:path) and not(exists(f:searchParam))) or (not(exists(f:path)) and exists(f:searchParam))
The code-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type code, Coding, or CodeableConcept.
The path attribute contains a [Simple FHIRPath Subset](http://hl7.org/fhir/R4/fhirpath.html#simple) that allows path traversal, but not calculation.
A token parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type code, Coding, or CodeableConcept.
The valueset for the code filter. The valueSet and code elements are additive. If valueSet is specified, the filter will return only those data items for which the value of the code-valued element specified in the path is a member of the specified valueset.
The codes for the code filter. If values are given, the filter will return only those data items for which the code-valued attribute specified by the path has a value that is one of the specified codes. If codes are specified in addition to a value set, the filter returns items matching a code in the value set or one of the specified codes.
Date filters specify additional constraints on the data in terms of the applicable date range for specific elements. Each date filter specifies an additional constraint on the data, i.e. date filters are AND'ed, not OR'ed.
The date-valued attribute of the filter. The specified path SHALL be a FHIRPath resolveable on the specified type of the DataRequirement, and SHALL consist only of identifiers, constant indexers, and .resolve(). 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). Note that the index must be an integer constant. The path must resolve to an element of type date, dateTime, Period, Schedule, or Timing.
The path attribute contains a [Simple FHIR Subset](http://hl7.org/fhir/R4/fhirpath.html#simple) that allows path traversal, but not calculation.
A date parameter that refers to a search parameter defined on the specified type of the DataRequirement, and which searches on elements of type date, dateTime, Period, Schedule, or Timing.
The value of the filter, as a Period, DateTime, or Duration value
The value of the filter. If period is specified, the filter will return only those data items that fall within the bounds determined by the Period, inclusive of the period boundaries. If dateTime is specified, the filter will return only those data items that are equal to the specified dateTime. If a Duration is specified, the filter will return only those data items that fall within Duration before now.
Specifies a maximum number of results that are required (uses the _count search parameter).
This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5".
Enables the requirement "most recent 5 results" to be expressed.
Specifies the order of the results to be returned.
This element can be used in combination with the sort element to specify quota requirements such as "the most recent 5" or "the highest 5". When multiple sorts are specified, they are applied in the order they appear in the resource.
The name of the attribute to perform the sort
The attribute of the sort. The specified path must be resolvable from the type of the required data. The path is allowed to contain qualifiers (.) to traverse sub-elements, as well as indexers ([x]) to traverse multiple-cardinality sub-elements. Note that the index must be an integer constant.
The direction of the sort, ascending or descending.
The possible sort directions, ascending or descending.
Defines the outputs of the action, if any.
A relationship to another action such as "before" or "30-60 minutes after start of".
When an action depends on multiple actions, the meaning is that all actions are dependencies, rather than that any of the actions are a dependency.
before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
The relationship of this action to the related action.
Defines the types of relationships between actions.
A duration or range of durations to apply to the relationship. For example, 30-60 minutes before.
An optional value describing when the action should be performed.
Indicates who should participate in performing the action described.
patient | practitioner | related-person | device
The role the participant should play in performing the described action.
Defines roles played by participants for the action.
The type of action to perform (create, update, remove).
visual-group | logical-group | sentence-group
Defines the grouping behavior for the action and its children.
Defines organization behavior of a group.
any | all | all-or-none | exactly-one | at-most-one | one-or-more
Defines the selection behavior for the action and its children.
Defines the required behavior for the action.
Defines expectations around whether an action or action group is required.
Defines whether the action should usually be preselected.
Defines selection frequency behavior for an action or group.
Defines whether the action can be selected multiple times.
Defines behavior for an action or a group for how many times that item may be repeated.
Description of the activity to be performed
A reference to an ActivityDefinition that describes the action to be taken in detail, or a PlanDefinition that describes a series of actions to be taken.
Note that the definition is optional, and if no definition is specified, a dynamicValue with a root ($this) path can be used to define the entire resource dynamically.
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 when a referenced ActivityDefinition also defines a transform, the transform specified here generally takes precedence. In addition, if both a transform and dynamic values are specific, the dynamic values are applied to the result of the transform.
Customizations that should be applied to the statically defined resource. For example, if the dosage of a medication must be computed based on the patient's weight, a customization would be used to specify an expression that calculated the weight, and the path on the resource that would contain the result.
Dynamic values are applied in the order in which they are defined in the PlanDefinition resource. Note that when dynamic values are also specified by a referenced ActivityDefinition, the dynamicValues from the ActivityDefinition are applied first, followed by the dynamicValues specified here. In addition, if both a transform and dynamic values are specific, the dynamic values are 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/fhirpath.html#simple) for full details).
To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](http://hl7.org/fhir/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.
Sub actions that are contained within the action. The behavior of this action determines the functionality of the sub-actions. For example, a selection behavior of at-most-one indicates that of the sub-actions, at most one may be chosen as part of realizing the action definition.
{InverseRelationship of Definition.partOf}
Text equivalent of the start workflow action.
Start the reporting workflow in response to an encounter-end event
The US-PH-PlanDefinition-Action code for the start action.
When the start action should be triggered.
The name of the event, encounter-end in this case. For any action invoked as a result of this trigger, the triggering encounter is accessible via the context variable `%encounter`
Code for the execute-reporting-workflow action.
The US-PH-PlanDefinition-Action code for the execute-reporting-workflow action.
The set of actions that can be used to create plan definition
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).
Natural language description of the condition
A brief, natural language description of the condition that effectively communicates the intended semantics.
Short name assigned to expression for reuse
A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.
text/cql | text/fhirpath | application/x-fhir-query | etc.
The media type of the language for the expression.
The media type of the expression language.
An expression in the specified language that returns a value.
A URI that defines where the expression is found.
If both a reference and an expression is found, the reference SHALL point to the same expression.
Defines input data requirements for the action. Required data is accessible via a context variable named `%[id]` using the `id` of the input data requirement
The id of the input requirement, allowing the data to be referenced via a context variable named `%[id]`
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).
To specify the path to the current action being realized, the %action environment variable is available in this path. For example, to specify the description element of the target action, the path would be %action.description. The path attribute contains a [Simple FHIRPath Subset](http://hl7.org/fhir/R4/fhirpath.html#simple) that allows path traversal, but not calculation.
Defines output produced by the action. Required data is accessible via a context variable named `%[id]` using the `id` of the output data requirement
The id of the output produced, allowing the data to be referenced via a context variable named `%[id]`