This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R4
R3
FHIR
Infrastructure
Work
Group
|
Maturity
Level
:
|
|
Security Category : Anonymous | Compartments : Not linked to any defined compartments |
Detailed Descriptions for the elements in the GraphDefinition resource.
| GraphDefinition | |||||||||
| Element Id | GraphDefinition | ||||||||
| Definition |
A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set. |
||||||||
|
|
| ||||||||
| Type | DomainResource | ||||||||
| Invariants |
|
||||||||
| GraphDefinition.url | |||||||||
| Element Id | GraphDefinition.url | ||||||||
| Definition |
An
absolute
URI
that
is
used
to
identify
this
graph
definition
when
it
is
referenced
in
a
specification,
model,
design
or
an
|
||||||||
|
|
0..1 | ||||||||
| Type | uri | ||||||||
| Requirements |
Allows the graph definition to be referenced by a single globally unique identifier. |
||||||||
| Summary | true | ||||||||
| Comments |
Can
be
a
urn:uuid:
or
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. |
||||||||
| GraphDefinition.version | |||||||||
| Element Id | GraphDefinition.version | ||||||||
| Definition |
The identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph 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. |
||||||||
| Note | This is a business versionId, not a resource version id (see discussion ) | ||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| Comments |
There
may
be
different
graph
definition
instances
that
have
the
same
identifier
but
different
versions.
The
version
can
be
appended
to
the
url
in
a
reference
to
allow
a
|
||||||||
| GraphDefinition.name | |||||||||
| Element Id | GraphDefinition.name | ||||||||
| Definition |
A natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. |
||||||||
|
|
1..1 | ||||||||
| Type | string | ||||||||
| Requirements |
Support human navigation and code generation. |
||||||||
| Summary | true | ||||||||
| Comments |
The
name
is
not
expected
to
be
globally
unique.
The
name
should
be
a
simple
|
||||||||
| Invariants |
| ||||||||
| GraphDefinition.status | |||||||||
| Element Id | GraphDefinition.status | ||||||||
| Definition |
The status of this graph definition. Enables tracking the life-cycle of the content. |
||||||||
|
|
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) | ||||||||
| Summary | true | ||||||||
| Comments |
Allows
filtering
of
graph
definitions
that
are
appropriate
for
use
|
||||||||
| GraphDefinition.experimental | |||||||||
| Element Id | GraphDefinition.experimental | ||||||||
| Definition |
A
|
||||||||
|
|
0..1 | ||||||||
| Type | boolean | ||||||||
|
|
Enables experimental content to be developed following the same lifecycle that would be used for a production-level graph definition. |
||||||||
| Summary | true | ||||||||
| Comments |
Allows
filtering
of
graph
|
||||||||
| GraphDefinition.date | |||||||||
| Element Id | GraphDefinition.date | ||||||||
| Definition |
The
date
(and
optionally
time)
when
the
graph
definition
was
published.
The
date
must
change
|
||||||||
|
|
0..1 | ||||||||
| Type | dateTime | ||||||||
| Alternate Names | Revision Date | ||||||||
| Summary | true | ||||||||
| Comments |
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the graph definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
||||||||
| GraphDefinition.publisher | |||||||||
| Element Id | GraphDefinition.publisher | ||||||||
| Definition |
The
name
of
the
|
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| Requirements |
Helps
establish
the
|
||||||||
| Summary | true | ||||||||
| Comments |
Usually
an
|
||||||||
| GraphDefinition.contact | |||||||||
| Element Id | GraphDefinition.contact | ||||||||
| Definition |
Contact details to assist a user in finding and communicating with the publisher. |
||||||||
|
|
0..* | ||||||||
| Type | ContactDetail | ||||||||
| Summary | true | ||||||||
| Comments |
May be a web site, an email address, a telephone number, etc. |
||||||||
| GraphDefinition.description | |||||||||
| Element Id | GraphDefinition.description | ||||||||
| Definition |
A free text natural language description of the graph definition from a consumer's perspective. |
||||||||
|
|
0..1 | ||||||||
| Type | markdown | ||||||||
| Comments |
This
description
can
be
used
to
capture
details
such
as
why
the
graph
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
graph
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
|
||||||||
| GraphDefinition.useContext | |||||||||
| Element Id | GraphDefinition.useContext | ||||||||
| Definition |
The
content
was
developed
with
a
focus
and
intent
of
supporting
the
contexts
that
are
listed.
These
|
||||||||
|
|
0..* | ||||||||
| Type | UsageContext | ||||||||
| Requirements |
Assist in searching for appropriate content. |
||||||||
| Summary | true | ||||||||
| Comments |
When
multiple
useContexts
are
specified,
there
is
no
expectation
|
||||||||
| GraphDefinition.jurisdiction | |||||||||
| Element Id | GraphDefinition.jurisdiction | ||||||||
| Definition |
A legal or geographic region in which the graph definition is intended to be used. |
||||||||
|
|
0..* | ||||||||
| Terminology Binding |
Jurisdiction
|
||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
| Comments |
It may be possible for the graph definition to be used in jurisdictions other than those for which it was originally designed or intended. |
||||||||
| GraphDefinition.purpose | |||||||||
| Element Id | GraphDefinition.purpose | ||||||||
| Definition |
|
||||||||
|
|
0..1 | ||||||||
| Type | markdown | ||||||||
| Comments |
This
element
does
not
describe
the
usage
of
the
graph
|
||||||||
| GraphDefinition.start | |||||||||
| Element Id | GraphDefinition.start | ||||||||
| Definition |
The type of FHIR resource at which instances of this graph start. |
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | Any defined Resource Type name | ||||||||
| Type | code | ||||||||
| Summary | true | ||||||||
| GraphDefinition.profile | |||||||||
| Element Id | GraphDefinition.profile | ||||||||
| Definition |
The profile that describes the use of the base resource. |
||||||||
|
|
0..1 | ||||||||
| Type |
|
||||||||
| Comments |
The code does not include the '$' prefix that is always included in the URL when the operation is invoked. |
||||||||
| GraphDefinition.link | |||||||||
| Element Id | GraphDefinition.link | ||||||||
| Definition |
Links this graph makes rules about. |
||||||||
|
|
0..* | ||||||||
| GraphDefinition.link.path | |||||||||
| Element Id | GraphDefinition.link.path | ||||||||
| Definition |
|
||||||||
|
|
|
||||||||
| Type | string | ||||||||
| Comments |
The
path
|
||||||||
| GraphDefinition.link.sliceName | |||||||||
| Element Id | GraphDefinition.link.sliceName | ||||||||
| Definition |
Which slice (if profiled). |
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| GraphDefinition.link.min | |||||||||
| Element Id | GraphDefinition.link.min | ||||||||
| Definition |
Minimum occurrences for this link. |
||||||||
|
|
0..1 | ||||||||
| Type | integer | ||||||||
| GraphDefinition.link.max | |||||||||
| Element Id | GraphDefinition.link.max | ||||||||
| Definition |
Maximum occurrences for this link. |
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| GraphDefinition.link.description | |||||||||
| Element Id | GraphDefinition.link.description | ||||||||
| Definition |
Information about why this link is of interest in this graph definition. |
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| GraphDefinition.link.target | |||||||||
| Element Id | GraphDefinition.link.target | ||||||||
| Definition |
Potential target for the link. |
||||||||
|
|
|
||||||||
| GraphDefinition.link.target.type | |||||||||
| Element Id | GraphDefinition.link.target.type | ||||||||
| Definition |
Type of resource this link refers to. |
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | Any defined Resource Type name | ||||||||
| Type | code | ||||||||
| GraphDefinition.link.target.params | |||||||||
| Element Id | GraphDefinition.link.target.params | ||||||||
| Definition | A set of parameters to look up. | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Comments | At least one of the parameters must have the value {ref} which identifies the focus resource. | ||||||||
| GraphDefinition.link.target.profile | |||||||||
| Element Id | GraphDefinition.link.target.profile | ||||||||
| Definition |
Profile for the target resource. |
||||||||
|
|
0..1 | ||||||||
| Type |
|
||||||||
| GraphDefinition.link.target.compartment | |||||||||
| Element Id | GraphDefinition.link.target.compartment | ||||||||
| Definition |
Compartment Consistency Rules. |
||||||||
|
|
0..* | ||||||||
| GraphDefinition.link.target.compartment.use | |||||||||
| Element Id | GraphDefinition.link.target.compartment.use | ||||||||
| Definition | Defines how the compartment rule is used - whether it it is used to test whether resources are subject to the rule, or whether it is a rule that must be followed. | ||||||||
| Cardinality | 1..1 | ||||||||
| Terminology Binding | GraphCompartmentUse ( Required ) | ||||||||
| Type | code | ||||||||
| Comments | All conditional rules are evaluated; if they are true, then the rules are evaluated. | ||||||||
| GraphDefinition.link.target.compartment.code | |||||||||
| Element Id | GraphDefinition.link.target.compartment.code | ||||||||
| Definition |
Identifies the compartment. |
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | CompartmentType ( Required ) | ||||||||
| Type | code | ||||||||
| GraphDefinition.link.target.compartment.rule | |||||||||
| Element Id | GraphDefinition.link.target.compartment.rule | ||||||||
| Definition |
identical | matching | different | no-rule | custom. |
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | GraphCompartmentRule ( Required ) | ||||||||
| Type | code | ||||||||
| GraphDefinition.link.target.compartment.expression | |||||||||
| Element Id | GraphDefinition.link.target.compartment.expression | ||||||||
| Definition |
Custom rule, as a FHIRPath expression. |
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| GraphDefinition.link.target.compartment.description | |||||||||
| Element Id | GraphDefinition.link.target.compartment.description | ||||||||
| Definition |
Documentation for FHIRPath expression. |
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| GraphDefinition.link.target.link | |||||||||
| Element Id | GraphDefinition.link.target.link | ||||||||
| Definition |
Additional links from target resource. |
||||||||
|
|
0..* | ||||||||
| Type | See GraphDefinition.link | ||||||||