Workflow
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
|
Responsible
Owner:
FHIR
Infrastructure
|
Informative |
A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service.
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:
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.
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
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.
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.
Note
that
not
all
resources
that
contain
Definition
in
their
name
are
considered
to
be
definition
resources
from
a
workflow
perspective.
For
example,
ActorDefinition
,
SpecimenDefinition
,
etc.
are
defining
entities,
not
activities.
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.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
Definition
|
I | Logical |
Definition
Pattern
|
|
url
|
Σ | 0..1 | uri |
Canonical
identifier
for
this
|
identifier
|
Σ | 0..* | Identifier |
Business
|
|
version
|
Σ | 0..1 | string |
Business
version
of
the
{{title}}
|
versionAlgorithm[x]
| Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) | |
versionAlgorithmString
| string | |||
versionAlgorithmCoding
| Coding | |||
|
name
|
Σ | 0..1 | string |
Name
for
this
{{title}}
(computer
friendly)
|
|
title
| Σ | 0..1 | string |
Name
for
this
{{title}}
|
derivedFromCanonical
|
Σ | 0..* | canonical ( Definition ) |
Based
on
FHIR
protocol
or
definition
|
|
derivedFromUri
|
Σ | 0..* | uri |
Based
on
external
protocol
or
definition
|
|
partOf
|
Σ | 0..* | canonical ( Definition ) |
Part
of
referenced
definition
|
|
status
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( Required ) |
|
experimental
|
|
0..1 | boolean |
For
testing
|
|
subject
|
Σ | 0..* | CodeableReference ( Group ) |
Type
of
individual
the
defined
service
is
for
|
|
date
|
Σ | 0..1 | dateTime |
Date
|
|
publisher
|
Σ | 0..1 |
|
Name
of
the
|
|
contact
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
description
|
Σ | 0..1 | markdown |
Natural
language
description
of
the
{{title}}
|
|
useContext
|
Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
jurisdiction
|
Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
{{title}}
(if
applicable)
Binding: Jurisdiction ValueSet
(
Extensible
)
|
|
purpose
|
0..1 | markdown |
Why
this
{{title}}
is
defined
|
|
|
copyright
|
0..1 | markdown |
Notice
about
intellectual
property
ownership,
can
include
restrictions
on
use
|
|
|
copyrightLabel
|
0..1 | string |
Copyright
holder
and
year(s)
|
|
|
approvalDate
| 0..1 | date |
When
the
{{title}}
was
approved
by
publisher
|
|
|
lastReviewDate
|
0..1 | date |
When
the
{{title}}
was
last
reviewed
|
|
|
effectivePeriod
|
Σ | 0..1 | Period |
When
the
{{title}}
is
expected
to
be
used
|
|
topic
| Σ | 0..* | CodeableConcept |
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
|
|
performerType
|
Σ | 0..1 | CodeableConcept |
Desired
kind
of
service
performer
|
|
code
| Σ | 0..1 | CodeableConcept |
Service
to
be
done
|
|
product
| Σ | 0..1 | CodeableReference ( BiologicallyDerivedProduct | DeviceDefinition | Medication | NutritionProduct | Substance ) |
Product
to
use/manipulate
|
|
Documentation
for
this
format
|
||||
UML Diagram ( Legend )
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
Filter:
|
|---|---|---|---|---|
|
Definition
|
I | Logical |
Definition
Pattern
|
|
|
url
|
Σ | 0..1 | uri |
Canonical
identifier
for
this
|
|
identifier
|
Σ | 0..* | Identifier |
Business
|
|
version
|
Σ | 0..1 | string |
Business
version
of
the
{{title}}
|
|
versionAlgorithm[x]
| Σ | 0..1 |
How
to
compare
versions
Binding: Version Algorithm ( Extensible ) | |
|
versionAlgorithmString
| string | |||
|
versionAlgorithmCoding
| Coding | |||
|
name
|
Σ | 0..1 | string |
Name
for
this
{{title}}
(computer
friendly)
|
|
title
| Σ | 0..1 | string |
Name
for
this
{{title}}
|
|
derivedFromCanonical
|
Σ | 0..* | canonical ( Definition ) |
Based
on
FHIR
protocol
or
definition
|
|
derivedFromUri
|
Σ | 0..* | uri |
Based
on
external
protocol
or
definition
|
|
partOf
|
Σ | 0..* | canonical ( Definition ) |
Part
of
referenced
definition
|
|
status
|
?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
Binding: PublicationStatus ( Required ) |
|
experimental
|
|
0..1 | boolean |
For
testing
|
|
subject
|
Σ | 0..* | CodeableReference ( Group ) |
Type
of
individual
the
defined
service
is
for
|
|
date
|
Σ | 0..1 | dateTime |
Date
|
|
publisher
|
Σ | 0..1 |
|
Name
of
the
|
|
contact
|
Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
|
description
|
Σ | 0..1 | markdown |
Natural
language
description
of
the
{{title}}
|
|
useContext
|
Σ | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
|
jurisdiction
|
Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
{{title}}
(if
applicable)
Binding: Jurisdiction ValueSet
(
Extensible
)
|
|
purpose
|
0..1 | markdown |
Why
this
{{title}}
is
defined
|
|
|
copyright
|
0..1 | markdown |
Notice
about
intellectual
property
ownership,
can
include
restrictions
on
use
|
|
|
copyrightLabel
|
0..1 | string |
Copyright
holder
and
year(s)
|
|
|
approvalDate
| 0..1 | date |
When
the
{{title}}
was
approved
by
publisher
|
|
|
lastReviewDate
|
0..1 | date |
When
the
{{title}}
was
last
reviewed
|
|
|
effectivePeriod
|
Σ | 0..1 | Period |
When
the
{{title}}
is
expected
to
be
used
|
|
topic
| Σ | 0..* | CodeableConcept |
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
|
|
performerType
|
Σ | 0..1 | CodeableConcept |
Desired
kind
of
service
performer
|
|
code
| Σ | 0..1 | CodeableConcept |
Service
to
be
done
|
|
product
| Σ | 0..1 | CodeableReference ( BiologicallyDerivedProduct | DeviceDefinition | Medication | NutritionProduct | Substance ) |
Product
to
use/manipulate
|
|
Documentation
for
this
format
|
||||
alternate
Alternate
definitions:
Master
Definition
XML
+
JSON
.
| Path |
|
Type |
|
|
|---|---|---|---|---|
| Definition.versionAlgorithm[x] |
|
|
Indicates the mechanism used to compare versions to determine which is more current. | |
| Definition.status | PublicationStatus | Required | The lifecycle status of an artifact. |
|
|
|
Unknown | No details provided yet | Example | 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. |
| Definition.jurisdiction |
|
Extensible |
This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.
Note:
The
codes
for
countries
and
country
subdivisions
are
taken
from
ISO
3166
|
|
| Definition.performerType | Unknown | No details provided yet | Example | 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. |
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.
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.
| url | identifier | version |
|
|
|
|
|
partOf | status | experimental |
|
date | publisher | contact | description | useContext | jurisdiction | purpose | copyright | copyrightLabel | approvalDate | lastReviewDate | effectivePeriod |
|
|
|
product | |
|
|
1 |
1
|
1 | 1 | 1 | 1 | 1 |
1
|
1 NTC | 1 | 1 | 1 | 1 | 1 |
1
|
1 | 1 | 1 | 1 | 1 | 1 | |||||||
|
|
1 | 1 TC | 1 C | |||||||||||||||||||||||||
| EventDefinition | 1 |
1
|
1 | 1 | 1 | 1 | 1 | 1 | 1 NTC | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
1
|
1 | 1 | 1 | |||||||
|
|
1 |
1
|
1 | 1 | 1 | 1 | 1 | 1 | 1 |
1
|
1 | 1 | 1 | 1 |
1
|
1 | 1 | 1 | 1 | 1 | ||||||||
|
|
1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 C | 1 |
1
|
1 | 1 | 1 | 1 | 1 | |||||||||||||
|
|
1 | 1 C | 1 | 1 | 1 | 1 | 1 T | 1 | 1 | 1 | 1 T | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 |
1
|
1 | 1 | 1 C | ||||
| OperationDefinition | 1 | 1 | 1 | 1 C | 1 | 1 NTC |
1
|
1 |
1
|
1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 TC | ||||||||||
|
|
1 |
1
|
1 | 1 | 1 | 2 | 1 |
1
|
3 NTC | 1 | 1 | 1 | 3 N | 1 | 1 | 1 | 1 | 1 |
1
|
1 | 1 | |||||||
|
|
1 | 1 | 1 |
1
|
1 | 1 | 1 NT | 1 | 1 | 1 NT | 1 | 1 | 1 | 1 | 1 | 1 |
1
|
1 | 1 | 1 | 1 | 1 | 1 TC | |||||
|
|
1 | 1 | 1 | 1 |
1
|
1 | 1 NT | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | ||||||||||
|
|
1
|
1 | 1 | 1 | 1 | 1 | 1 NT | 1 | 1 | 1 | 1 | 1 | 1 |
1
|
1 | 1 | 1 | 1 | 1 | 1 |
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:
Flags:
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Fri,
Wed,
Nov
1,
2019
09:32+1100.
QA
Page
12,
2025
19:15+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change