This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
Responsible
Owner:
FHIR
Infrastructure
![]() | Informative |
Detailed
Descriptions
for
the
elements
in
the
definition
resource.
Definition
pattern.
| Definition | |
| Definition |
A pattern to be followed by resources that represent a specific proposal, plan and/or order for some sort of action or service. |
| Short Display | Definition Pattern |
| Cardinality | 0..* |
|
| Logical |
| Definition.url | |
| Definition |
An
absolute
|
| Short Display | Canonical identifier for this {{title}}, represented as an absolute URI (globally unique) |
| Cardinality | 0..1 |
| Type | uri |
| Requirements |
Allows the {{title}} to be referenced by a single globally unique identifier. |
| Summary | true |
| Comments |
Can
be
a
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 . 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 element to indicate where the current master source of the resource can be found. |
| Definition.identifier | |
| Definition |
|
|
|
Business identifier for {{title}} |
| Note |
This
is
a
business
|
|
|
|
| Type | Identifier |
| Requirements |
Allows
|
| Summary | true |
| Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this {{title}} outside of FHIR, where it is not possible to use the logical URI. |
| Definition.version | |
| Definition |
The
identifier
that
is
used
to
identify
this
version
of
the
{{title}}
when
it
is
referenced
in
a
specification,
model,
design
or
instance.
This
is
an
arbitrary
value
managed
by
the
{{title}}
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
|
|
|
Business version of the {{title}} |
| Note | This is a business versionId, not a resource version id (see discussion ) |
|
|
0..1 |
| Type | string |
| Summary | true |
| Comments |
There
may
be
|
| Definition.versionAlgorithm[x] | |
| Definition | Indicates the mechanism used to compare versions to determine which is more current. |
| Short Display | How to compare versions |
| Cardinality | 0..1 |
| Terminology Binding | Version Algorithm ( Extensible ) |
| Type | string | Coding |
| [x] Note | See Choice of Datatypes for further information about how to use [x] |
| Summary | true |
| Comments | If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined. |
| Definition.name | |
| Definition | A natural language name identifying the {{title}}. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
| Short Display | Name for this {{title}} (computer friendly) |
| Cardinality | 0..1 |
| Type | string |
| Requirements | Supports code generation. |
| Summary | true |
| Comments | The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly. |
| Definition.title | |
| Definition |
A short, descriptive, user-friendly title for the {{title}}. |
| Short Display | Name for this {{title}} (human friendly) |
| Cardinality | 0..1 |
| Type | string |
| Summary | true |
| Comments |
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
|
|
|
| Definition |
|
| Short Display | Based on FHIR protocol or definition |
| Cardinality | 0..* |
| Type |
|
| Requirements |
Protocols and order sets may be refinements of more generic protocols and order sets. |
| Summary | true |
|
|
|
| Definition |
|
| Short Display | Based on external protocol or definition |
|
|
0..* |
| Type |
|
| Requirements |
|
| Summary | true |
| Comments |
|
|
|
|
| Definition |
|
| Short Display | Part of referenced definition |
| Cardinality | 0..* |
| Type |
|
| Requirements |
|
| Alternate Names |
|
| Summary | true |
| Comments | [The allowed reference resources may be adjusted as appropriate for the event resource]. |
| Definition.status | |
| Definition |
The
current
state
of
|
| Short Display | draft | active | retired | unknown |
|
|
1..1 |
| Terminology Binding | PublicationStatus ( Required ) |
| Type | code |
| Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) |
| Requirements | Enables tracking the lifecycle of the content and filtering of {{title}}s that are appropriate for use versus not. |
| Summary | true |
| Comments |
A nominal state-transition diagram can be found in the [[definition.html#statemachine | Definition pattern]] documentation
Unknown
does
not
represent
|
| To Do | Should this be a common code system for all definitions? |
| Definition.experimental | |
| Definition |
A
|
|
|
|
|
|
|
|
|
|
| Requirements |
Enables
experimental
content
to
be
developed
following
the
same
|
| Summary | true |
| Comments |
Allows
filtering
of
|
|
|
|
| Definition |
A code or group definition that describes the intended subject of instantiations of this definition. |
| Short Display | Type of individual the defined service is for |
|
|
|
| Terminology Binding | DefinitionSubject : |
| Type |
|
|
|
Many
protocols,
order
sets
and
guidelines
are
|
| Alternate Names |
|
| Summary | true |
| Definition.date | |
| Definition |
|
| Short Display | Date last changed |
| Cardinality | 0..1 |
| Type | dateTime |
| Alternate Names | created |
| Summary | true |
| Comments | The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
| Definition.publisher | |
| Definition |
|
| Short Display | Name of the publisher/steward (organization or individual) |
| Cardinality | 0..1 |
| Type |
|
| Requirements |
Helps establish the "authority/credibility" of the {{title}}. May also allow for contact. |
| Alternate Names | author |
| Summary | true |
| Comments |
Usually
an
|
|
Definition.contact
|
|
| Definition |
Contact details to assist a user in finding and communicating with the publisher. |
| Short Display | Contact details for the publisher |
| Cardinality | 0..* |
| Type | ContactDetail |
| Summary | true |
| Comments |
May be a web site, an email address, a telephone number, etc. |
| Definition.description | |
| Definition | A free text natural language description of the {{title}} from a consumer's perspective. |
| Short Display | Natural language description of the {{title}} |
| Cardinality | 0..1 |
| Type | markdown |
| Summary | true |
| Comments | This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context. |
| Definition.useContext | |
| Definition |
The
content
was
developed
with
a
focus
and
intent
of
supporting
the
contexts
that
are
listed.
These
|
| Short Display | The context that the content is intended to support |
| Cardinality | 0..* |
| Type | UsageContext |
| Requirements |
Assist in searching for appropriate content. |
| Summary | true |
| Comments |
When
multiple
|
| Definition.jurisdiction | |
| Definition |
A
|
| Short Display | Intended jurisdiction for {{title}} (if applicable) |
|
|
0..* |
| Terminology Binding |
Jurisdiction
ValueSet
(
Extensible
)
|
| Type | CodeableConcept |
| Summary | true |
| Comments |
DEPRECATION
NOTE:
For
consistency,
implementations
are
encouraged
to
migrate
to
using
the
|
| Definition.purpose | |
| Definition |
|
| Short Display | Why this {{title}} is defined |
| Cardinality | 0..1 |
| Type | markdown |
| Comments |
This
element
does
not
describe
the
usage
of
the
{{title}}.
|
| Definition.copyright | |
| Definition |
A
copyright
statement
relating
to
the
{{title}}
and/or
its
contents.
Copyright
statements
are
|
| Short Display | Notice about intellectual property ownership, can include restrictions on use |
| Cardinality | 0..1 |
| Type | markdown |
| Requirements |
Consumers of the {{title}} must be able to determine any legal restrictions on the use of the artifact and/or its content. |
| Alternate Names | License; Restrictions |
| Definition.copyrightLabel | |
| Definition | A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved'). |
| Short Display | Copyright holder and year(s) |
| Cardinality | 0..1 |
| Type | string |
| Requirements | Defines the content expected to be rendered in all representations of the artifact. |
| Comments | The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element. |
| Definition.approvalDate | |
| Definition |
The
date
on
which
the
|
| Short Display | When the {{title}} was approved by publisher |
| Cardinality | 0..1 |
| Type | date |
| Comments |
The
|
| Definition.lastReviewDate | |
| Definition |
The
date
on
which
the
|
| Short Display | When the {{title}} was last reviewed |
| Cardinality | 0..1 |
| Type | 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. |
| Comments |
If
specified,
this
|
| Definition.effectivePeriod | |
| Definition |
The
period
during
which
the
{{title}}
content
was
or
is
planned
to
be
|
| Short Display | When the {{title}} is expected to be used |
| Cardinality | 0..1 |
| Type | Period |
| Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the {{title}} are or are expected to be used instead. |
| Summary | true |
| Comments |
The
effective
period
for
a
{{title}}
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
|
| Definition.topic | |
| Definition | Repositories must be able to determine how to categorize the {{title}} so that it can be found by topical and keyword searches. |
| Short Display | 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 |
| Cardinality | 0..* |
| Type | CodeableConcept |
| Requirements | This element provides topical categorization and keywords for the {{title}}, as opposed to the more structured context-of-use information provided in the useContext element. |
| Summary | true |
| Definition.performerType | |
| Definition |
The type of individual that is expected to act upon instances of this definition. |
| Short Display | Desired kind of service performer |
|
|
0..1 |
| Terminology Binding | PerformerType : |
| Type | CodeableConcept |
| Summary | true |
| To Do | Need to define who.performer. |
| Definition.code | |
| Definition | A code that identifies the specific service or action that was or is being performed. |
| Short Display | Service to be done |
| Cardinality | 0..1 |
| Type | CodeableConcept |
| Alternate Names | type |
| Summary | true |
| Definition.product | |
| Definition | Indicates the product supplied or manipulated by this {{title}}. |
| Short Display | Product to use/manipulate |
| Cardinality | 0..1 |
| Type | CodeableReference ( BiologicallyDerivedProduct | DeviceDefinition | Medication | NutritionProduct | Substance ) |
| Summary | true |