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 : 1 | Trial Use | Security Category : Anonymous | Compartments : Not linked to any defined compartments |
Detailed Descriptions for the elements in the CompartmentDefinition resource.
| CompartmentDefinition | |||||||||
| Element Id | CompartmentDefinition | ||||||||
| Definition |
A compartment definition that defines how resources are accessed on a server. |
||||||||
|
|
| ||||||||
| Type | DomainResource | ||||||||
| Comments |
In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content. |
||||||||
| Invariants |
| ||||||||
| CompartmentDefinition.url | |||||||||
| Element Id | CompartmentDefinition.url | ||||||||
| Definition |
An
absolute
URI
that
is
used
to
identify
this
compartment
definition
when
it
is
referenced
in
a
specification,
model,
design
or
an
|
||||||||
|
|
1..1 | ||||||||
| Type | uri | ||||||||
| Requirements |
Allows the compartment 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. | ||||||||
| CompartmentDefinition.version | |||||||||
| Element Id | CompartmentDefinition.version | ||||||||
| Definition | The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment 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 ) | ||||||||
| Cardinality | 0..1 | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| Comments | There may be different compartment 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 compartment definition with the format [url]|[version]. |
||||||||
| CompartmentDefinition.name | |||||||||
| Element Id | CompartmentDefinition.name | ||||||||
| Definition |
A natural language name identifying the compartment 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 |
|
||||||||
|
|
|||||||||
|
|
|
||||||||
| Definition |
The status of this compartment 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
compartment
definitions
that
are
appropriate
for
use
|
||||||||
| CompartmentDefinition.experimental | |||||||||
| Element Id | CompartmentDefinition.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 compartment definition. |
||||||||
| Summary | true | ||||||||
| Comments |
Allows
filtering
of
compartment
|
||||||||
| CompartmentDefinition.date | |||||||||
| Element Id | CompartmentDefinition.date | ||||||||
| Definition |
The
date
(and
optionally
time)
when
the
compartment
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 compartment definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
||||||||
| CompartmentDefinition.publisher | |||||||||
| Element Id | CompartmentDefinition.publisher | ||||||||
| Definition |
The
name
of
the
|
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||
| Requirements |
Helps
establish
the
|
||||||||
| Summary | true | ||||||||
| Comments |
Usually
an
|
||||||||
| CompartmentDefinition.contact | |||||||||
| Element Id | CompartmentDefinition.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. |
||||||||
| CompartmentDefinition.description | |||||||||
| Element Id | CompartmentDefinition.description | ||||||||
| Definition |
A free text natural language description of the compartment definition from a consumer's perspective. |
||||||||
|
|
0..1 | ||||||||
| Type | markdown | ||||||||
| Comments |
This
description
can
be
used
to
capture
details
such
as
why
the
compartment
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
compartment
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
|
||||||||
|
|
|||||||||
|
|
|
||||||||
| 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
|
||||||||
|
|
|||||||||
|
|
|
||||||||
|
|
Explanation of why this compartment definition is needed and why it has been designed as it has. |
||||||||
|
|
|
||||||||
| Type |
|
||||||||
| Comments |
|
||||||||
| CompartmentDefinition.code | |||||||||
| Element Id | CompartmentDefinition.code | ||||||||
| Definition |
Which compartment this definition describes. |
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | CompartmentType ( Required ) | ||||||||
| Type | code | ||||||||
| Summary | true | ||||||||
| Comments |
Only the specification can define the compartments that can exist. Servers can choose to support them. |
||||||||
| CompartmentDefinition.search | |||||||||
| Element Id | CompartmentDefinition.search | ||||||||
| Definition |
Whether the search syntax is supported,. |
||||||||
|
|
1..1 | ||||||||
| Type | boolean | ||||||||
| Summary | true | ||||||||
| Comments |
Servers may define and use compartments to manage logical access without implementing the compartment related syntax. |
||||||||
| CompartmentDefinition.resource | |||||||||
| Element Id | CompartmentDefinition.resource | ||||||||
| Definition |
Information about how a resource is related to the compartment. |
||||||||
|
|
0..* | ||||||||
| Summary | true | ||||||||
| CompartmentDefinition.resource.code | |||||||||
| Element Id | CompartmentDefinition.resource.code | ||||||||
| Definition |
The name of a resource supported by the server. |
||||||||
|
|
1..1 | ||||||||
| Terminology Binding | Any defined Resource Type name | ||||||||
| Type | code | ||||||||
| Summary | true | ||||||||
| CompartmentDefinition.resource.param | |||||||||
| Element Id | CompartmentDefinition.resource.param | ||||||||
| Definition |
The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment in more than one way,. |
||||||||
|
|
0..* | ||||||||
| Type | string | ||||||||
| Summary | true | ||||||||
| Comments |
If no search parameters are listed, then the resource is not linked to the compartment. |
||||||||
| CompartmentDefinition.resource.documentation | |||||||||
| Element Id | CompartmentDefinition.resource.documentation | ||||||||
| Definition |
Additional documentation about the resource and compartment. |
||||||||
|
|
0..1 | ||||||||
| Type | string | ||||||||