A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.
12.3.1 Scope and Usage
This is NOT a resource. It is not part of the FHIR schema and cannot appear directly in FHIR instances. It is a logical model that defines a pattern adhered to by
other resources. This pattern serves two purposes:
It offers guidance to work groups designing resources and helps ensure consistency of content created by different work groups
It provides a standard "view" that might be useful for implementers in processing and manipulating all resources that adhere to the same pattern. (Tooling that supports
this may become available in a future release.)
This pattern describes common properties typically found on "definition" resources. "Definition" resources are resources that describe clinical, administrative or other events
that can potentially occur. They do so in a manner that is independent of a particular patient or subject and independent of any particular timeframe. Examples include
protocols, order sets, questionnaires, etc. Definitions are intended to be instantiated by Requests (orders, plans and proposals) and
Events. For example a
PlanDefinition might represent an order set that is subsequently instantiated by a combination of MedicationRequests
and ServiceRequests and results in the execution of various MedicationAdministration,
Procedure and Observation events. This pattern only applies to definitions of activities, not of objects or roles.
12.3.2 Boundaries and Relationships
This logical model is one of three common workflow patterns. The other two patterns are Event and
Request. This pattern is followed by (or is intended to be followed by a number of other FHIR resources/
Both definitions and requests deal with activities that "can" occur, but requests represent a specific intention for something to occur and are bound to
a specific context of subject and time, while definitions represent mere "possibility" rather than intention and are independent of a specific subject or timeframe.
12.3.3 Background and Context
This model represents a pattern. It provides a standard list of data elements with cardinalities, data types, definitions, rationale and usage notes that will ideally be
adhered to by resources that fall into the "definition" workflow category. However, adherence to this pattern is not mandatory. Not all healthcare domains are the same.
Concepts that may be generally applicable (and thus are included in this standard pattern) might still not be relevant everywhere or may be sufficiently uncommon that they
are more appropriate to include as extensions than as core properties of the resource. Work groups are encouraged to adjust descriptions, usage notes and rationale to be
specific to their resource (e.g. use the term "protocol" or "questionnaire" rather than "definition"). As well, design notes in the comments column marked with [square
brackets] identifies areas where domain variation is expected and encouraged. Other variation, including differences in names, cardinalities, data types and the decision to
omit an element outright are also possible, but should be discussed with the FHIR Infrastructure work group's Workflow project to ensure the rationale for non-alignment is
understood, to confirm that the deviation is necessary and to identify whether any adjustments to the pattern are appropriate.
This pattern provides a linkage to the W5 list of standard data elements. Resources that adhere to this pattern should ensure their w5 mappings are
consistent, as is their data element ordering.
Descriptive topics related to the content of the {{title}}. Topics provide a high-level categorization as well as keywords for the {{title}} that can be useful for filtering and searching
Descriptive topics related to the content of the {{title}}. Topics provide a high-level categorization as well as keywords for the {{title}} that can be useful for filtering and searching
Codes identifying the type of subject intended to be the recpient or focus of the defined action. These should ideally be consistent across definition resources.
Identifies types of practitioners, devices or other agents that are intended to perform a defined action. While the detailed constraints of relevant agents will vary by resource, some degree of consistency around recommended codes across request and definition resources would be desirable.
12.3.6 Definition extensions
Not all resources that adhere to the Definition pattern will necessarily include all pattern elements as 'core' elements. This guide defines
extensions for certain pattern elements that may be relevant but are not supported widely enough for direct inclusion in some resources.
The extensions relevant for 'definition' resources can be found in the Workflow pattern extensions section
of this specification.
12.3.7 State Machine
The following diagram shows the "typical" state machine diagram for resources following the Definition
pattern. Note that not all resources will support all states, some resources may choose different names
for certain states and some resources may introduce sub-states to the listed states. As well, additional
transitions may be supported, including from terminal nodes (e.g. from "withdrawn" back to "active").
That said, most resources should align with this state machine fairly well.
Each non-grey cell contains a number, the number of elements and extensions (if > 0) mapped in the resource
that are mapped to the pattern element in the column. If there are 0 elements and extensions, the
number is not shown. In addition, the cell has a color and some character flags.
Colors:
Grey: the resource has no element or extension for the pattern element
White: the resource has an element that implements the pattern element with the same name
Yellow: the resource has a documented extension that implements the pattern element with the same name
Blue: the resource has an element that implements the pattern element with a different name
Red: the resource has an element that implements that pattern element, but the type or cardinality does not match
Flags:
E: pattern element implemented by an extension
N: pattern element implemented by an element with a different name
T: pattern element implemented by an element with a different type
C: pattern element implemented by an element with a different cardinality