This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v5.0.0-draft-final:
Final
QA
Preview
for
R5
-
Mixed
Normative
and
STU
see
ballot
notes
)
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
|
|
Maturity
Level
:
|
|
Compartments
:
|
Structure
Name
Flags
Card.
Type
Description
&
Constraints
CapabilityStatement
I
N
DomainResource
A
statement
of
system
capabilities
+
Warning:
Name
should
be
usable
as
an
identifier
for
the
module
by
machine
processing
applications
such
as
code
generation
+
Rule:
A
Capability
Statement
SHALL
have
at
least
one
of
REST,
messaging
or
document
element.
+
Rule:
A
Capability
Statement
SHALL
have
at
least
one
of
description,
software,
or
implementation
element.
+
Rule:
Messaging
end-point
is
required
(and
is
only
permitted)
when
a
statement
is
for
an
implementation.
+
Rule:
The
set
of
documents
must
be
unique
by
the
combination
of
profile
and
mode.
+
Rule:
If
kind
=
instance,
implementation
must
be
present
and
software
may
be
present
+
Rule:
If
kind
=
capability,
implementation
must
be
absent,
software
must
be
present
+
Rule:
If
kind
=
requirements,
implementation
and
software
must
be
absent
Elements
defined
in
Ancestors:
id
,
meta
,
implicitRules
,
language
,
text
,
contained
,
extension
,
modifierExtension
url
Σ
0..1
uri
Canonical
identifier
for
this
capability
statement,
represented
as
a
URI
(globally
unique)
version
Σ
0..1
string
Business
version
of
the
capability
statement
name
Σ
I
0..1
string
Name
for
this
capability
statement
(computer
friendly)
title
Σ
0..1
string
Name
for
this
capability
statement
(human
friendly)
status
?!
Σ
1..1
code
draft
|
active
|
retired
|
unknown
PublicationStatus
(
Required
)
experimental
Σ
0..1
boolean
For
testing
purposes,
not
real
usage
date
Σ
1..1
dateTime
Date
last
changed
publisher
Σ
0..1
string
Name
of
the
publisher
(organization
or
individual)
contact
Σ
0..*
ContactDetail
Contact
details
for
the
publisher
description
I
0..1
markdown
Natural
language
description
of
the
capability
statement
useContext
Σ
TU
0..*
UsageContext
The
context
that
the
content
is
intended
to
support
jurisdiction
Σ
0..*
CodeableConcept
Intended
jurisdiction
for
capability
statement
(if
applicable)
Jurisdiction
(
Extensible
)
purpose
0..1
markdown
Why
this
capability
statement
is
defined
copyright
0..1
markdown
Use
and/or
publishing
restrictions
kind
Σ
I
1..1
code
instance
|
capability
|
requirements
CapabilityStatementKind
(
Required
)
instantiates
Σ
0..*
canonical
(
CapabilityStatement
)
Canonical
URL
of
another
capability
statement
this
implements
imports
Σ
TU
0..*
canonical
(
CapabilityStatement
)
Canonical
URL
of
another
capability
statement
this
adds
to
software
Σ
I
0..1
BackboneElement
Software
that
is
covered
by
this
capability
statement
name
Σ
1..1
string
A
name
the
software
is
known
by
version
Σ
0..1
string
Version
covered
by
this
statement
releaseDate
Σ
0..1
dateTime
Date
this
version
was
released
implementation
Σ
I
0..1
BackboneElement
If
this
describes
a
specific
instance
description
Σ
1..1
string
Describes
this
specific
instance
url
Σ
0..1
url
Base
URL
for
the
installation
custodian
Σ
TU
0..1
Reference
(
Organization
)
Organization
that
manages
the
data
fhirVersion
Σ
1..1
code
FHIR
Version
the
system
supports
FHIRVersion
(
Required
)
format
Σ
1..*
code
formats
supported
(xml
|
json
|
ttl
|
mime
type)
MimeType
(
Required
)
patchFormat
Σ
0..*
code
Patch
formats
supported
MimeType
(
Required
)
implementationGuide
Σ
0..*
canonical
(
ImplementationGuide
)
Implementation
guides
supported
rest
Σ
I
0..*
BackboneElement
If
the
endpoint
is
a
RESTful
one
+
Rule:
A
given
resource
can
only
be
described
once
per
RESTful
mode.
mode
Σ
1..1
code
client
|
server
RestfulCapabilityMode
(
Required
)
documentation
0..1
markdown
General
description
of
implementation
security
Σ
TU
0..1
BackboneElement
Information
about
security
of
implementation
cors
Σ
0..1
boolean
Adds
CORS
Headers
(http://enable-cors.org/)
service
Σ
0..*
CodeableConcept
OAuth
|
SMART-on-FHIR
|
NTLM
|
Basic
|
Kerberos
|
Certificates
RestfulSecurityService
(
Extensible
)
description
0..1
markdown
General
description
of
how
security
works
resource
Σ
I
0..*
BackboneElement
Resource
served
on
the
REST
interface
+
Rule:
Search
parameter
names
must
be
unique
in
the
context
of
a
resource.
type
Σ
1..1
code
A
resource
type
that
is
supported
ResourceType
(
Required
)
profile
Σ
0..1
canonical
(
StructureDefinition
)
Base
System
profile
for
all
uses
of
resource
supportedProfile
Σ
TU
0..*
canonical
(
StructureDefinition
)
Profiles
for
use
cases
supported
documentation
0..1
markdown
Additional
information
about
the
use
of
the
resource
type
interaction
0..*
BackboneElement
What
operations
are
supported?
code
1..1
code
read
|
vread
|
update
|
patch
|
delete
|
history-instance
|
history-type
|
create
|
search-type
TypeRestfulInteraction
(
Required
)
documentation
0..1
markdown
Anything
special
about
operation
behavior
versioning
TU
0..1
code
no-version
|
versioned
|
versioned-update
ResourceVersionPolicy
(
Required
)
readHistory
TU
0..1
boolean
Whether
vRead
can
return
past
versions
updateCreate
TU
0..1
boolean
If
update
can
commit
to
a
new
identity
conditionalCreate
TU
0..1
boolean
If
allows/uses
conditional
create
conditionalRead
TU
0..1
code
not-supported
|
modified-since
|
not-match
|
full-support
ConditionalReadStatus
(
Required
)
conditionalUpdate
TU
0..1
boolean
If
allows/uses
conditional
update
conditionalDelete
TU
0..1
code
not-supported
|
single
|
multiple
-
how
conditional
delete
is
supported
ConditionalDeleteStatus
(
Required
)
referencePolicy
TU
0..*
code
literal
|
logical
|
resolves
|
enforced
|
local
ReferenceHandlingPolicy
(
Required
)
searchInclude
TU
0..*
string
_include
values
supported
by
the
server
searchRevInclude
TU
0..*
string
_revinclude
values
supported
by
the
server
searchParam
0..*
BackboneElement
Search
parameters
supported
by
implementation
name
1..1
string
Name
of
search
parameter
definition
0..1
canonical
(
SearchParameter
)
Source
of
definition
for
parameter
type
1..1
code
number
|
date
|
string
|
token
|
reference
|
composite
|
quantity
|
uri
|
special
SearchParamType
(
Required
)
documentation
0..1
markdown
Server-specific
usage
operation
Σ
0..*
BackboneElement
Definition
of
a
resource
operation
name
Σ
1..1
string
Name
by
which
the
operation/query
is
invoked
definition
Σ
1..1
canonical
(
OperationDefinition
)
The
defined
operation/query
documentation
0..1
markdown
Specific
details
about
operation
behavior
interaction
0..*
BackboneElement
What
operations
are
supported?
code
1..1
code
transaction
|
batch
|
search-system
|
history-system
SystemRestfulInteraction
(
Required
)
documentation
0..1
markdown
Anything
special
about
operation
behavior
searchParam
0..*
see
searchParam
Search
parameters
for
searching
all
resources
operation
Σ
0..*
see
operation
Definition
of
a
system
level
operation
compartment
0..*
canonical
(
CompartmentDefinition
)
Compartments
served/used
by
system
messaging
Σ
I
TU
0..*
BackboneElement
If
messaging
is
supported
endpoint
0..*
BackboneElement
Where
messages
should
be
sent
protocol
1..1
Coding
http
|
ftp
|
mllp
+
MessageTransport
(
Extensible
)
address
1..1
url
Network
address
or
identifier
of
the
end-point
reliableCache
0..1
unsignedInt
Reliable
Message
Cache
Length
(min)
documentation
0..1
markdown
Messaging
interface
behavior
details
supportedMessage
Σ
0..*
BackboneElement
Messages
supported
by
this
system
mode
Σ
1..1
code
sender
|
receiver
EventCapabilityMode
(
Required
)
definition
Σ
1..1
canonical
(
MessageDefinition
)
Message
supported
by
this
system
document
Σ
I
TU
0..*
BackboneElement
Document
definition
mode
Σ
1..1
code
producer
|
consumer
DocumentMode
(
Required
)
documentation
0..1
markdown
Description
of
document
support
profile
Σ
1..1
canonical
(
StructureDefinition
)
Constraint
on
the
resources
used
in
the
document
Documentation
for
this
format
UML
Diagram
(
Legend
)
CapabilityStatement
(
DomainResource
)
An
absolute
URI
that
is
used
to
identify
this
capability
statement
when
it
is
referenced
in
a
specification,
model,
design
or
an
instance;
also
called
its
canonical
identifier.
This
SHOULD
be
globally
unique
and
SHOULD
be
a
literal
address
at
which
at
which
an
authoritative
instance
of
this
capability
statement
is
(or
will
be)
published.
This
URL
can
be
the
target
of
a
canonical
reference.
It
SHALL
remain
the
same
when
the
capability
statement
is
stored
on
different
servers
url
:
uri
[0..1]
The
identifier
that
is
used
to
identify
this
version
of
the
capability
statement
when
it
is
referenced
in
a
specification,
model,
design
or
instance.
This
is
an
arbitrary
value
managed
by
the
capability
statement
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
version
:
string
[0..1]
A
natural
language
name
identifying
the
capability
statement.
This
name
should
be
usable
as
an
identifier
for
the
module
by
machine
processing
applications
such
as
code
generation
name
:
string
[0..1]
A
short,
descriptive,
user-friendly
title
for
the
capability
statement
title
:
string
[0..1]
The
status
of
this
capability
statement.
Enables
tracking
the
life-cycle
of
the
content
(this
element
modifies
the
meaning
of
other
elements)
status
:
code
[1..1]
«
The
lifecycle
status
of
an
artifact.
(Strength=Required)
PublicationStatus
!
»
A
Boolean
value
to
indicate
that
this
capability
statement
is
authored
for
testing
purposes
(or
education/evaluation/marketing)
and
is
not
intended
to
be
used
for
genuine
usage
experimental
:
boolean
[0..1]
The
date
(and
optionally
time)
when
the
capability
statement
was
published.
The
date
must
change
when
the
business
version
changes
and
it
must
change
if
the
status
code
changes.
In
addition,
it
should
change
when
the
substantive
content
of
the
capability
statement
changes
date
:
dateTime
[1..1]
The
name
of
the
organization
or
individual
that
published
the
capability
statement
publisher
:
string
[0..1]
Contact
details
to
assist
a
user
in
finding
and
communicating
with
the
publisher
contact
:
ContactDetail
[0..*]
A
free
text
natural
language
description
of
the
capability
statement
from
a
consumer's
perspective.
Typically,
this
is
used
when
the
capability
statement
describes
a
desired
rather
than
an
actual
solution,
for
example
as
a
formal
expression
of
requirements
as
part
of
an
RFP
description
:
markdown
[0..1]
The
content
was
developed
with
a
focus
and
intent
of
supporting
the
contexts
that
are
listed.
These
contexts
may
be
general
categories
(gender,
age,
...)
or
may
be
references
to
specific
programs
(insurance
plans,
studies,
...)
and
may
be
used
to
assist
with
indexing
and
searching
for
appropriate
capability
statement
instances
useContext
:
UsageContext
[0..*]
A
legal
or
geographic
region
in
which
the
capability
statement
is
intended
to
be
used
jurisdiction
:
CodeableConcept
[0..*]
«
Countries
and
regions
within
which
this
artifact
is
targeted
for
use.
(Strength=Extensible)
Jurisdiction
ValueSet
+
»
Explanation
of
why
this
capability
statement
is
needed
and
why
it
has
been
designed
as
it
has
purpose
:
markdown
[0..1]
A
copyright
statement
relating
to
the
capability
statement
and/or
its
contents.
Copyright
statements
are
generally
legal
restrictions
on
the
use
and
publishing
of
the
capability
statement
copyright
:
markdown
[0..1]
The
way
that
this
statement
is
intended
to
be
used,
to
describe
an
actual
running
instance
of
software,
a
particular
product
(kind,
not
instance
of
software)
or
a
class
of
implementation
(e.g.
a
desired
purchase)
kind
:
code
[1..1]
«
How
a
capability
statement
is
intended
to
be
used.
(Strength=Required)
CapabilityStatementKind
!
»
Reference
to
a
canonical
URL
of
another
CapabilityStatement
that
this
software
implements.
This
capability
statement
is
a
published
API
description
that
corresponds
to
a
business
service.
The
server
may
actually
implement
a
subset
of
the
capability
statement
it
claims
to
implement,
so
the
capability
statement
must
specify
the
full
capability
details
instantiates
:
canonical
[0..*]
«
CapabilityStatement
»
Reference
to
a
canonical
URL
of
another
CapabilityStatement
that
this
software
adds
to.
The
capability
statement
automatically
includes
everything
in
the
other
statement,
and
it
is
not
duplicated,
though
the
server
may
repeat
the
same
resources,
interactions
and
operations
to
add
additional
details
to
them
imports
:
canonical
[0..*]
«
CapabilityStatement
»
The
version
of
the
FHIR
specification
that
this
CapabilityStatement
describes
(which
SHALL
be
the
same
as
the
FHIR
version
of
the
CapabilityStatement
itself).
There
is
no
default
value
fhirVersion
:
code
[1..1]
«
All
published
FHIR
Versions.
(Strength=Required)
FHIRVersion
!
»
A
list
of
the
formats
supported
by
this
implementation
using
their
content
types
format
:
code
[1..*]
«
The
mime
type
of
an
attachment.
Any
valid
mime
type
is
allowed.
(Strength=Required)
Mime
Types
!
»
A
list
of
the
patch
formats
supported
by
this
implementation
using
their
content
types
patchFormat
:
code
[0..*]
«
The
mime
type
of
an
attachment.
Any
valid
mime
type
is
allowed.
(Strength=Required)
Mime
Types
!
»
A
list
of
implementation
guides
that
the
server
does
(or
should)
support
in
their
entirety
implementationGuide
:
canonical
[0..*]
«
ImplementationGuide
»
Software
Name
the
software
is
known
by
name
:
string
[1..1]
The
version
identifier
for
the
software
covered
by
this
statement
version
:
string
[0..1]
Date
this
version
of
the
software
was
released
releaseDate
:
dateTime
[0..1]
Implementation
Information
about
the
specific
installation
that
this
capability
statement
relates
to
description
:
string
[1..1]
An
absolute
base
URL
for
the
implementation.
This
forms
the
base
for
REST
interfaces
as
well
as
the
mailbox
and
document
interfaces
url
:
url
[0..1]
The
organization
responsible
for
the
management
of
the
instance
and
oversight
of
the
data
on
the
server
at
the
specified
URL
custodian
:
Reference
[0..1]
«
Organization
»
Rest
Identifies
whether
this
portion
of
the
statement
is
describing
the
ability
to
initiate
or
receive
restful
operations
mode
:
code
[1..1]
«
The
mode
of
a
RESTful
capability
statement.
(Strength=Required)
RestfulCapabilityMode
!
»
Information
about
the
system's
restful
capabilities
that
apply
across
all
applications,
such
as
security
documentation
:
markdown
[0..1]
An
absolute
URI
which
is
a
reference
to
the
definition
of
a
compartment
that
the
system
supports.
The
reference
is
to
a
CompartmentDefinition
resource
by
its
canonical
URL
compartment
:
canonical
[0..*]
«
CompartmentDefinition
»
Security
Server
adds
CORS
headers
when
responding
to
requests
-
this
enables
Javascript
applications
to
use
the
server
cors
:
boolean
[0..1]
Types
of
security
services
that
are
supported/required
by
the
system
service
:
CodeableConcept
[0..*]
«
Types
of
security
services
used
with
FHIR.
(Strength=Extensible)
RestfulSecurityService
+
»
General
description
of
how
security
works
description
:
markdown
[0..1]
Resource
A
type
of
resource
exposed
via
the
restful
interface
type
:
code
[1..1]
«
One
of
the
resource
types
defined
as
part
of
this
version
of
FHIR.
(Strength=Required)
ResourceType
!
»
A
specification
of
the
profile
that
describes
the
solution's
overall
support
for
the
resource,
including
any
constraints
on
cardinality,
bindings,
lengths
or
other
limitations.
See
further
discussion
in
[Using
Profiles](profiling.html#profile-uses)
profile
:
canonical
[0..1]
«
StructureDefinition
»
A
list
of
profiles
that
represent
different
use
cases
supported
by
the
system.
For
a
server,
"supported
by
the
system"
means
the
system
hosts/produces
a
set
of
resources
that
are
conformant
to
a
particular
profile,
and
allows
clients
that
use
its
services
to
search
using
this
profile
and
to
find
appropriate
data.
For
a
client,
it
means
the
system
will
search
by
this
profile
and
process
data
according
to
the
guidance
implicit
in
the
profile.
See
further
discussion
in
[Using
Profiles](profiling.html#profile-uses)
supportedProfile
:
canonical
[0..*]
«
StructureDefinition
»
Additional
information
about
the
resource
type
used
by
the
system
documentation
:
markdown
[0..1]
This
field
is
set
to
no-version
to
specify
that
the
system
does
not
support
(server)
or
use
(client)
versioning
for
this
resource
type.
If
this
has
some
other
value,
the
server
must
at
least
correctly
track
and
populate
the
versionId
meta-property
on
resources.
If
the
value
is
'versioned-update',
then
the
server
supports
all
the
versioning
features,
including
using
e-tags
narrative
for
version
integrity
in
the
API
versioning
:
code
[0..1]
«
How
the
system
supports
versioning
for
a
resource.
(Strength=Required)
ResourceVersionPolicy
!
»
A
flag
for
whether
the
server
is
able
to
return
past
versions
as
part
of
the
vRead
operation
readHistory
:
boolean
[0..1]
A
flag
to
indicate
that
the
server
allows
or
needs
to
allow
the
client
to
create
new
identities
on
the
server
(that
is,
the
client
PUTs
to
a
location
where
there
is
no
existing
resource).
Allowing
this
operation
means
that
the
server
allows
the
client
to
create
new
identities
on
the
server
updateCreate
:
boolean
[0..1]
A
flag
that
indicates
that
the
server
supports
conditional
create
conditionalCreate
:
boolean
[0..1]
A
code
that
indicates
how
the
server
supports
conditional
read
conditionalRead
:
code
[0..1]
«
A
code
that
indicates
how
the
server
supports
conditional
read.
(Strength=Required)
ConditionalReadStatus
!
»
A
flag
that
indicates
that
the
server
supports
conditional
update
conditionalUpdate
:
boolean
[0..1]
A
code
that
indicates
how
the
server
supports
conditional
delete
conditionalDelete
:
code
[0..1]
«
A
code
that
indicates
how
the
server
supports
conditional
delete.
(Strength=Required)
ConditionalDeleteStatus
!
»
A
set
of
flags
that
defines
how
references
are
supported
referencePolicy
:
code
[0..*]
«
A
set
of
flags
that
defines
how
references
are
supported.
(Strength=Required)
ReferenceHandlingPolicy
!
»
A
list
of
_include
values
supported
by
the
server
searchInclude
:
string
[0..*]
A
list
of
_revinclude
(reverse
include)
values
supported
by
the
server
searchRevInclude
:
string
[0..*]
ResourceInteraction
Coded
identifier
of
the
operation,
supported
by
the
system
resource
code
:
code
[1..1]
«
Operations
supported
by
REST
at
the
type
or
instance
level.
(Strength=Required)
TypeRestfulInteraction
!
»
Guidance
specific
to
the
implementation
of
this
operation,
such
as
'delete
is
a
logical
delete'
or
'updates
are
only
allowed
with
version
id'
or
'creates
permitted
from
pre-authorized
certificates
only'
documentation
:
markdown
[0..1]
SearchParam
The
name
of
the
search
parameter
used
in
the
interface
name
:
string
[1..1]
An
absolute
URI
that
is
a
formal
reference
to
where
this
parameter
was
first
defined,
so
that
a
client
can
be
confident
of
the
meaning
of
the
search
parameter
(a
reference
to
[[[SearchParameter.url]]]).
This
element
SHALL
be
populated
if
the
search
parameter
refers
to
a
SearchParameter
defined
by
the
FHIR
core
specification
or
externally
defined
IGs
definition
:
canonical
[0..1]
«
SearchParameter
»
The
type
of
value
a
search
parameter
refers
to,
and
how
the
content
is
interpreted
type
:
code
[1..1]
«
Data
types
allowed
to
be
used
for
search
parameters.
(Strength=Required)
SearchParamType
!
»
This
allows
documentation
of
any
distinct
behaviors
about
how
the
search
parameter
is
used.
For
example,
text
matching
algorithms
documentation
:
markdown
[0..1]
Operation
The
name
of
the
operation
or
query.
For
an
operation,
this
is
the
name
prefixed
with
$
and
used
in
the
URL.
For
a
query,
this
is
the
name
used
in
the
_query
parameter
when
the
query
is
called
name
:
string
[1..1]
Where
the
formal
definition
can
be
found.
If
a
server
references
the
base
definition
of
an
Operation
(i.e.
from
the
specification
itself
such
as
```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```),
that
means
it
supports
the
full
capabilities
of
the
operation
-
e.g.
both
GET
and
POST
invocation.
If
it
only
supports
a
subset,
it
must
define
its
own
custom
[[[OperationDefinition]]]
with
a
'base'
of
the
original
OperationDefinition.
The
custom
definition
would
describe
the
specific
subset
of
functionality
supported
definition
:
canonical
[1..1]
«
OperationDefinition
»
Documentation
that
describes
anything
special
about
the
operation
behavior,
possibly
detailing
different
behavior
for
system,
type
and
instance-level
invocation
of
the
operation
documentation
:
markdown
[0..1]
SystemInteraction
A
coded
identifier
of
the
operation,
supported
by
the
system
code
:
code
[1..1]
«
Operations
supported
by
REST
at
the
system
level.
(Strength=Required)
SystemRestfulInteraction
!
»
Guidance
specific
to
the
implementation
of
this
operation,
such
as
limitations
on
the
kind
of
transactions
allowed,
or
information
about
system
wide
search
is
implemented
documentation
:
markdown
[0..1]
Messaging
Length
if
the
receiver's
reliable
messaging
cache
in
minutes
(if
a
receiver)
or
how
long
the
cache
length
on
the
receiver
should
be
(if
a
sender)
reliableCache
:
unsignedInt
[0..1]
Documentation
about
the
system's
messaging
capabilities
for
this
endpoint
not
otherwise
documented
by
the
capability
statement.
For
example,
the
process
for
becoming
an
authorized
messaging
exchange
partner
documentation
:
markdown
[0..1]
Endpoint
A
list
of
the
messaging
transport
protocol(s)
identifiers,
supported
by
this
endpoint
protocol
:
Coding
[1..1]
«
The
protocol
used
for
message
transport.
(Strength=Extensible)
MessageTransport
+
»
The
network
address
of
the
endpoint.
For
solutions
that
do
not
use
network
addresses
for
routing,
it
can
be
just
an
identifier
address
:
url
[1..1]
SupportedMessage
The
mode
of
this
event
declaration
-
whether
application
is
sender
or
receiver
mode
:
code
[1..1]
«
The
mode
of
a
message
capability
statement.
(Strength=Required)
EventCapabilityMode
!
»
Points
to
a
message
definition
that
identifies
the
messaging
event,
message
structure,
allowed
responses,
etc
definition
:
canonical
[1..1]
«
MessageDefinition
»
Document
Mode
of
this
document
declaration
-
whether
an
application
is
a
producer
or
consumer
mode
:
code
[1..1]
«
Whether
the
application
produces
or
consumes
documents.
(Strength=Required)
DocumentMode
!
»
A
description
of
how
the
application
supports
or
uses
the
specified
document
profile.
For
example,
when
documents
are
created,
what
action
is
taken
with
consumed
documents,
etc
documentation
:
markdown
[0..1]
A
profile
on
the
document
Bundle
that
constrains
which
resources
are
present,
and
their
contents
profile
:
canonical
[1..1]
«
StructureDefinition
»
Software
that
is
covered
by
this
capability
statement.
It
is
used
when
the
capability
statement
describes
the
capabilities
of
a
particular
software
version,
independent
of
an
installation
software
[0..1]
Identifies
a
specific
implementation
instance
that
is
described
by
the
capability
statement
-
i.e.
a
particular
installation,
rather
than
the
capabilities
of
a
software
program
implementation
[0..1]
Information
about
security
implementation
from
an
interface
perspective
-
what
a
client
needs
to
know
security
[0..1]
Identifies
a
restful
operation
supported
by
the
solution
interaction
[0..*]
Search
parameters
for
implementations
to
support
and/or
make
use
of
-
either
references
to
ones
defined
in
the
specification,
or
additional
ones
defined
for/by
the
implementation
searchParam
[0..*]
Definition
of
an
operation
or
a
named
query
together
with
its
parameters
and
their
meaning
and
type.
Consult
the
definition
of
the
operation
for
details
about
how
to
invoke
the
operation,
and
the
parameters
operation
[0..*]
A
specification
of
the
restful
capabilities
of
the
solution
for
a
specific
resource
type
resource
[0..*]
A
specification
of
restful
operations
supported
by
the
system
interaction
[0..*]
Search
parameters
that
are
supported
for
searching
all
resources
for
implementations
to
support
and/or
make
use
of
-
either
references
to
ones
defined
in
the
specification,
or
additional
ones
defined
for/by
the
implementation
searchParam
[0..*]
Definition
of
an
operation
or
a
named
query
together
with
its
parameters
and
their
meaning
and
type
operation
[0..*]
A
definition
of
the
restful
capabilities
of
the
solution,
if
any
rest
[0..*]
An
endpoint
(network
accessible
address)
to
which
messages
and/or
replies
are
to
be
sent
endpoint
[0..*]
References
to
message
definitions
for
messages
this
system
can
send
or
receive
supportedMessage
[0..*]
A
description
of
the
messaging
capabilities
of
the
solution
messaging
[0..*]
A
document
definition
document
[0..*]
XML
Template
<
<!-- from -->
<!-- from -->
<
<
<
<
<
<
<
<
<</contact>
<
<</useContext>
<</jurisdiction>
<
<
<
<</instantiates>
<</imports>
<
<
<
<
</software>
<
<
<
<</custodian>
</implementation>
<
<
<
<</implementationGuide>
<
<
<
<
<
<</service>
<
</security>
<
<
<</profile>
<</supportedProfile>
<
<
<
<
</interaction>
<
<
<
<
<
<
<
<
<
<
<
<
<</definition>
<
<
</searchParam>
<
<
<</definition>
<
</operation>
</resource>
<
<
<
</interaction>
<</searchParam>
<</operation>
<</compartment>
</rest>
<
<
<</protocol>
<
</endpoint>
<
<
<
<
<</definition>
</supportedMessage>
</messaging>
<
<
<
<</profile>
</document>
</CapabilityStatement>
JSON
Template
{
"resourceType" : "",
// from
// from
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
},
"
"
"
"
},
"
"
"
"
"
"
"
"
"
"
"
},
"
"
"
"
"
"
"
"
}],
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
}],
"
"
"
"
}]
}],
"
"
"
}],
"
"
"
}],
"
"
"
"
}],
"
"
"
"
"
}]
}],
"
"
"
"
}]
}
Turtle
Template
@prefix fhir: <http://hl7.org/fhir/> .
[ a fhir:;
fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from
# from
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
];
fhir:
fhir:
fhir:
fhir:
];
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
];
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
], ...;
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
], ...;
fhir:
fhir:
fhir:
fhir:
], ...;
], ...;
fhir:
fhir:
fhir:
], ...;
fhir:
fhir:
fhir:
], ...;
fhir:
fhir:
fhir:
fhir:
], ...;
fhir:
fhir:
fhir:
fhir:
fhir:
], ...;
], ...;
fhir:
fhir:
fhir:
fhir:
], ...;
]
Changes
since
R3
CapabilityStatement
CapabilityStatement
Min
Cardinality
changed
from
1
to
0
Max
Cardinality
changed
from
1
to
*
CapabilityStatement.status
Change
value
set
from
http://hl7.org/fhir/ValueSet/publication-status
to
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
CapabilityStatement.experimental
No
longer
marked
as
Modifier
CapabilityStatement.kind
Change
value
set
from
http://hl7.org/fhir/ValueSet/capability-statement-kind
to
http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1
CapabilityStatement.instantiates
Type
changed
from
uri
to
canonical(CapabilityStatement)
CapabilityStatement.imports
Added
Element
CapabilityStatement.implementation.url
Type
changed
from
uri
to
url
CapabilityStatement.implementation.custodian
Added
Element
CapabilityStatement.fhirVersion
Type
changed
from
id
to
code
Add
Binding
http://hl7.org/fhir/ValueSet/FHIR-version|4.0.1
(required)
CapabilityStatement.format
Change
value
set
from
http://hl7.org/fhir/ValueSet/mimetypes
to
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
CapabilityStatement.patchFormat
Change
value
set
from
http://hl7.org/fhir/ValueSet/mimetypes
to
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
CapabilityStatement.implementationGuide
Type
changed
from
uri
to
canonical(ImplementationGuide)
CapabilityStatement.rest.mode
Change
value
set
from
http://hl7.org/fhir/ValueSet/restful-capability-mode
to
http://hl7.org/fhir/ValueSet/restful-capability-mode|4.0.1
CapabilityStatement.rest.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.rest.security.service
Change
code
system
for
extensibly
bound
codes
from
"http://hl7.org/fhir/restful-security-service"
to
"http://terminology.hl7.org/CodeSystem/restful-security-service"
CapabilityStatement.rest.security.description
Type
changed
from
string
to
markdown
CapabilityStatement.rest.resource.type
Change
value
set
from
http://hl7.org/fhir/ValueSet/resource-types
to
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
CapabilityStatement.rest.resource.profile
Type
changed
from
Reference(StructureDefinition)
to
canonical(StructureDefinition)
CapabilityStatement.rest.resource.supportedProfile
Moved
from
CapabilityStatement.profile
to
supportedProfile
Type
changed
from
Reference(StructureDefinition)
to
canonical(StructureDefinition)
CapabilityStatement.rest.resource.interaction
Min
Cardinality
changed
from
1
to
0
CapabilityStatement.rest.resource.interaction.code
Change
value
set
from
http://hl7.org/fhir/ValueSet/type-restful-interaction
to
http://hl7.org/fhir/ValueSet/type-restful-interaction|4.0.1
CapabilityStatement.rest.resource.interaction.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.rest.resource.versioning
Change
value
set
from
http://hl7.org/fhir/ValueSet/versioning-policy
to
http://hl7.org/fhir/ValueSet/versioning-policy|4.0.1
CapabilityStatement.rest.resource.conditionalRead
Change
value
set
from
http://hl7.org/fhir/ValueSet/conditional-read-status
to
http://hl7.org/fhir/ValueSet/conditional-read-status|4.0.1
CapabilityStatement.rest.resource.conditionalDelete
Change
value
set
from
http://hl7.org/fhir/ValueSet/conditional-delete-status
to
http://hl7.org/fhir/ValueSet/conditional-delete-status|4.0.1
CapabilityStatement.rest.resource.referencePolicy
Change
value
set
from
http://hl7.org/fhir/ValueSet/reference-handling-policy
to
http://hl7.org/fhir/ValueSet/reference-handling-policy|4.0.1
CapabilityStatement.rest.resource.searchParam.definition
Type
changed
from
uri
to
canonical(SearchParameter)
CapabilityStatement.rest.resource.searchParam.type
Change
value
set
from
http://hl7.org/fhir/ValueSet/search-param-type
to
http://hl7.org/fhir/ValueSet/search-param-type|4.0.1
CapabilityStatement.rest.resource.searchParam.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.rest.resource.operation
Added
Element
CapabilityStatement.rest.resource.operation.name
Added
Mandatory
Element
CapabilityStatement.rest.resource.operation.definition
Added
Mandatory
Element
CapabilityStatement.rest.resource.operation.documentation
Added
Element
CapabilityStatement.rest.interaction.code
Change
value
set
from
http://hl7.org/fhir/ValueSet/system-restful-interaction
to
http://hl7.org/fhir/ValueSet/system-restful-interaction|4.0.1
CapabilityStatement.rest.interaction.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.rest.operation
Remove
Type
BackboneElement
CapabilityStatement.rest.compartment
Type
changed
from
uri
to
canonical(CompartmentDefinition)
CapabilityStatement.messaging.endpoint.protocol
Change
code
system
for
extensibly
bound
codes
from
"http://hl7.org/fhir/message-transport"
to
"http://terminology.hl7.org/CodeSystem/message-transport"
CapabilityStatement.messaging.endpoint.address
Type
changed
from
uri
to
url
CapabilityStatement.messaging.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.messaging.supportedMessage.mode
Change
value
set
from
http://hl7.org/fhir/ValueSet/event-capability-mode
to
http://hl7.org/fhir/ValueSet/event-capability-mode|4.0.1
CapabilityStatement.messaging.supportedMessage.definition
Type
changed
from
Reference(MessageDefinition)
to
canonical(MessageDefinition)
CapabilityStatement.document.mode
Change
value
set
from
http://hl7.org/fhir/ValueSet/document-mode
to
http://hl7.org/fhir/ValueSet/document-mode|4.0.1
CapabilityStatement.document.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.document.profile
Type
changed
from
Reference(StructureDefinition)
to
canonical(StructureDefinition)
CapabilityStatement.acceptUnknown
deleted
CapabilityStatement.rest.security.certificate
deleted
CapabilityStatement.rest.operation.name
deleted
CapabilityStatement.rest.operation.definition
deleted
CapabilityStatement.messaging.event
deleted
See
also
the
Full
Difference
for
further
information
This
analysis
is
available
as
XML
or
JSON
.
See
R3
<-->
R4
Conversion
Maps
(status
=
9
tests
that
all
execute
ok.
1
fail
round-trip
testing
and
9
r3
resources
are
invalid
(0
errors).
)
Structure
Name
Flags
Card.
Type
Description
&
Constraints
CapabilityStatement
I
N
DomainResource
A
statement
of
system
capabilities
+
Warning:
Name
should
be
usable
as
an
identifier
for
the
module
by
machine
processing
applications
such
as
code
generation
+
Rule:
A
Capability
Statement
SHALL
have
at
least
one
of
REST,
messaging
or
document
element.
+
Rule:
A
Capability
Statement
SHALL
have
at
least
one
of
description,
software,
or
implementation
element.
+
Rule:
Messaging
end-point
is
required
(and
is
only
permitted)
when
a
statement
is
for
an
implementation.
+
Rule:
The
set
of
documents
must
be
unique
by
the
combination
of
profile
and
mode.
+
Rule:
If
kind
=
instance,
implementation
must
be
present
and
software
may
be
present
+
Rule:
If
kind
=
capability,
implementation
must
be
absent,
software
must
be
present
+
Rule:
If
kind
=
requirements,
implementation
and
software
must
be
absent
Elements
defined
in
Ancestors:
id
,
meta
,
implicitRules
,
language
,
text
,
contained
,
extension
,
modifierExtension
url
Σ
0..1
uri
Canonical
identifier
for
this
capability
statement,
represented
as
a
URI
(globally
unique)
version
Σ
0..1
string
Business
version
of
the
capability
statement
name
Σ
I
0..1
string
Name
for
this
capability
statement
(computer
friendly)
title
Σ
0..1
string
Name
for
this
capability
statement
(human
friendly)
status
?!
Σ
1..1
code
draft
|
active
|
retired
|
unknown
PublicationStatus
(
Required
)
experimental
Σ
0..1
boolean
For
testing
purposes,
not
real
usage
date
Σ
1..1
dateTime
Date
last
changed
publisher
Σ
0..1
string
Name
of
the
publisher
(organization
or
individual)
contact
Σ
0..*
ContactDetail
Contact
details
for
the
publisher
description
I
0..1
markdown
Natural
language
description
of
the
capability
statement
useContext
Σ
TU
0..*
UsageContext
The
context
that
the
content
is
intended
to
support
jurisdiction
Σ
0..*
CodeableConcept
Intended
jurisdiction
for
capability
statement
(if
applicable)
Jurisdiction
(
Extensible
)
purpose
0..1
markdown
Why
this
capability
statement
is
defined
copyright
0..1
markdown
Use
and/or
publishing
restrictions
kind
Σ
I
1..1
code
instance
|
capability
|
requirements
CapabilityStatementKind
(
Required
)
instantiates
Σ
0..*
canonical
(
CapabilityStatement
)
Canonical
URL
of
another
capability
statement
this
implements
imports
Σ
TU
0..*
canonical
(
CapabilityStatement
)
Canonical
URL
of
another
capability
statement
this
adds
to
software
Σ
I
0..1
BackboneElement
Software
that
is
covered
by
this
capability
statement
name
Σ
1..1
string
A
name
the
software
is
known
by
version
Σ
0..1
string
Version
covered
by
this
statement
releaseDate
Σ
0..1
dateTime
Date
this
version
was
released
implementation
Σ
I
0..1
BackboneElement
If
this
describes
a
specific
instance
description
Σ
1..1
string
Describes
this
specific
instance
url
Σ
0..1
url
Base
URL
for
the
installation
custodian
Σ
TU
0..1
Reference
(
Organization
)
Organization
that
manages
the
data
fhirVersion
Σ
1..1
code
FHIR
Version
the
system
supports
FHIRVersion
(
Required
)
format
Σ
1..*
code
formats
supported
(xml
|
json
|
ttl
|
mime
type)
MimeType
(
Required
)
patchFormat
Σ
0..*
code
Patch
formats
supported
MimeType
(
Required
)
implementationGuide
Σ
0..*
canonical
(
ImplementationGuide
)
Implementation
guides
supported
rest
Σ
I
0..*
BackboneElement
If
the
endpoint
is
a
RESTful
one
+
Rule:
A
given
resource
can
only
be
described
once
per
RESTful
mode.
mode
Σ
1..1
code
client
|
server
RestfulCapabilityMode
(
Required
)
documentation
0..1
markdown
General
description
of
implementation
security
Σ
TU
0..1
BackboneElement
Information
about
security
of
implementation
cors
Σ
0..1
boolean
Adds
CORS
Headers
(http://enable-cors.org/)
service
Σ
0..*
CodeableConcept
OAuth
|
SMART-on-FHIR
|
NTLM
|
Basic
|
Kerberos
|
Certificates
RestfulSecurityService
(
Extensible
)
description
0..1
markdown
General
description
of
how
security
works
resource
Σ
I
0..*
BackboneElement
Resource
served
on
the
REST
interface
+
Rule:
Search
parameter
names
must
be
unique
in
the
context
of
a
resource.
type
Σ
1..1
code
A
resource
type
that
is
supported
ResourceType
(
Required
)
profile
Σ
0..1
canonical
(
StructureDefinition
)
Base
System
profile
for
all
uses
of
resource
supportedProfile
Σ
TU
0..*
canonical
(
StructureDefinition
)
Profiles
for
use
cases
supported
documentation
0..1
markdown
Additional
information
about
the
use
of
the
resource
type
interaction
0..*
BackboneElement
What
operations
are
supported?
code
1..1
code
read
|
vread
|
update
|
patch
|
delete
|
history-instance
|
history-type
|
create
|
search-type
TypeRestfulInteraction
(
Required
)
documentation
0..1
markdown
Anything
special
about
operation
behavior
versioning
TU
0..1
code
no-version
|
versioned
|
versioned-update
ResourceVersionPolicy
(
Required
)
readHistory
TU
0..1
boolean
Whether
vRead
can
return
past
versions
updateCreate
TU
0..1
boolean
If
update
can
commit
to
a
new
identity
conditionalCreate
TU
0..1
boolean
If
allows/uses
conditional
create
conditionalRead
TU
0..1
code
not-supported
|
modified-since
|
not-match
|
full-support
ConditionalReadStatus
(
Required
)
conditionalUpdate
TU
0..1
boolean
If
allows/uses
conditional
update
conditionalDelete
TU
0..1
code
not-supported
|
single
|
multiple
-
how
conditional
delete
is
supported
ConditionalDeleteStatus
(
Required
)
referencePolicy
TU
0..*
code
literal
|
logical
|
resolves
|
enforced
|
local
ReferenceHandlingPolicy
(
Required
)
searchInclude
TU
0..*
string
_include
values
supported
by
the
server
searchRevInclude
TU
0..*
string
_revinclude
values
supported
by
the
server
searchParam
0..*
BackboneElement
Search
parameters
supported
by
implementation
name
1..1
string
Name
of
search
parameter
definition
0..1
canonical
(
SearchParameter
)
Source
of
definition
for
parameter
type
1..1
code
number
|
date
|
string
|
token
|
reference
|
composite
|
quantity
|
uri
|
special
SearchParamType
(
Required
)
documentation
0..1
markdown
Server-specific
usage
operation
Σ
0..*
BackboneElement
Definition
of
a
resource
operation
name
Σ
1..1
string
Name
by
which
the
operation/query
is
invoked
definition
Σ
1..1
canonical
(
OperationDefinition
)
The
defined
operation/query
documentation
0..1
markdown
Specific
details
about
operation
behavior
interaction
0..*
BackboneElement
What
operations
are
supported?
code
1..1
code
transaction
|
batch
|
search-system
|
history-system
SystemRestfulInteraction
(
Required
)
documentation
0..1
markdown
Anything
special
about
operation
behavior
searchParam
0..*
see
searchParam
Search
parameters
for
searching
all
resources
operation
Σ
0..*
see
operation
Definition
of
a
system
level
operation
compartment
0..*
canonical
(
CompartmentDefinition
)
Compartments
served/used
by
system
messaging
Σ
I
TU
0..*
BackboneElement
If
messaging
is
supported
endpoint
0..*
BackboneElement
Where
messages
should
be
sent
protocol
1..1
Coding
http
|
ftp
|
mllp
+
MessageTransport
(
Extensible
)
address
1..1
url
JSON
Network
address
or
identifier
of
the
end-point
reliableCache
0..1
unsignedInt
Reliable
Message
Cache
Length
(min)
documentation
0..1
markdown
Messaging
interface
behavior
details
supportedMessage
Σ
0..*
BackboneElement
Messages
supported
by
this
system
mode
Σ
1..1
code
sender
|
receiver
EventCapabilityMode
(
Required
)
definition
Σ
1..1
canonical
(
MessageDefinition
)
Message
supported
by
this
system
document
Σ
I
TU
0..*
BackboneElement
Document
definition
mode
Σ
1..1
code
producer
|
consumer
DocumentMode
(
Required
)
documentation
0..1
markdown
Description
of
document
support
profile
Σ
1..1
canonical
(
StructureDefinition
)
Constraint
on
the
resources
used
in
the
document
Documentation
for
this
format
UML
Diagram
(
Legend
Turtle
)
format.
Note
that
published
the
capability
statement
publisher
:
string
[0..1]
Contact
details
to
assist
a
user
in
finding
and
communicating
with
the
publisher
contact
:
ContactDetail
[0..*]
A
free
text
natural
language
description
of
the
capability
statement
from
a
consumer's
perspective.
Typically,
this
is
used
when
the
capability
statement
describes
a
desired
rather
than
an
actual
solution,
for
example
as
a
formal
expression
of
requirements
as
part
of
an
RFP
description
:
markdown
[0..1]
The
content
was
developed
with
a
focus
and
intent
of
supporting
the
contexts
that
are
listed.
These
contexts
may
be
general
categories
(gender,
age,
...)
or
may
be
references
to
specific
programs
(insurance
plans,
studies,
...)
and
may
be
used
to
assist
with
indexing
and
searching
for
appropriate
capability
statement
instances
useContext
:
UsageContext
[0..*]
A
legal
or
geographic
region
in
which
the
capability
statement
is
intended
to
be
used
jurisdiction
:
CodeableConcept
[0..*]
«
Countries
and
regions
within
which
this
artifact
is
targeted
for
use.
(Strength=Extensible)
Jurisdiction
ValueSet
+
»
Explanation
of
why
this
capability
statement
is
needed
and
why
it
has
been
designed
as
it
has
purpose
:
markdown
[0..1]
A
copyright
statement
relating
to
the
capability
statement
and/or
its
contents.
Copyright
statements
are
generally
legal
restrictions
on
the
use
and
publishing
of
the
capability
statement
copyright
:
markdown
[0..1]
The
way
that
this
statement
is
intended
to
be
used,
to
describe
an
actual
running
instance
of
software,
a
particular
product
(kind,
not
instance
of
software)
or
a
class
of
implementation
(e.g.
a
desired
purchase)
kind
:
code
[1..1]
«
How
a
capability
statement
is
intended
to
be
used.
(Strength=Required)
CapabilityStatementKind
!
»
Reference
to
a
canonical
URL
of
another
CapabilityStatement
that
this
software
implements.
This
capability
statement
is
a
published
API
description
that
corresponds
to
a
business
service.
The
server
may
actually
implement
a
subset
of
the
capability
statement
it
claims
to
implement,
so
the
capability
statement
must
specify
the
full
capability
details
instantiates
:
canonical
[0..*]
«
CapabilityStatement
»
Reference
to
a
canonical
URL
of
another
CapabilityStatement
that
this
software
adds
to.
The
capability
statement
automatically
includes
everything
in
the
other
statement,
and
it
is
not
duplicated,
though
the
server
may
repeat
the
same
resources,
interactions
and
operations
to
add
additional
details
to
them
imports
:
canonical
[0..*]
«
CapabilityStatement
»
The
version
of
the
FHIR
specification
that
this
CapabilityStatement
describes
(which
SHALL
be
the
same
as
the
FHIR
version
of
the
CapabilityStatement
itself).
There
is
no
default
value
fhirVersion
:
code
[1..1]
«
All
published
FHIR
Versions.
(Strength=Required)
FHIRVersion
!
»
A
list
of
the
formats
supported
by
this
implementation
using
their
content
types
format
:
code
[1..*]
«
The
mime
type
of
an
attachment.
Any
valid
mime
type
is
allowed.
(Strength=Required)
Mime
Types
!
»
A
list
of
the
patch
formats
supported
by
this
implementation
using
their
content
types
patchFormat
:
code
[0..*]
«
The
mime
type
of
an
attachment.
Any
valid
mime
type
is
allowed.
(Strength=Required)
Mime
Types
!
»
A
list
of
implementation
guides
that
the
server
does
(or
should)
support
in
their
entirety
implementationGuide
:
canonical
[0..*]
«
ImplementationGuide
»
Software
Name
the
software
is
known
by
name
:
string
[1..1]
The
version
identifier
for
the
software
covered
by
this
statement
version
:
string
[0..1]
Date
this
version
of
the
software
was
released
releaseDate
:
dateTime
[0..1]
Implementation
Information
about
the
specific
installation
that
this
capability
statement
relates
to
description
:
string
[1..1]
An
absolute
base
URL
for
the
implementation.
This
forms
the
base
for
REST
interfaces
as
well
as
the
mailbox
and
document
interfaces
url
:
url
[0..1]
The
organization
responsible
for
the
management
of
the
instance
and
oversight
of
the
data
on
the
server
at
the
specified
URL
custodian
:
Reference
[0..1]
«
Organization
»
Rest
Identifies
whether
this
portion
of
the
statement
is
describing
the
ability
to
initiate
or
receive
restful
operations
mode
:
code
[1..1]
«
The
mode
of
a
RESTful
capability
statement.
(Strength=Required)
RestfulCapabilityMode
!
»
Information
about
the
system's
restful
capabilities
that
apply
across
all
applications,
such
as
security
documentation
:
markdown
[0..1]
An
absolute
URI
which
is
a
reference
to
the
definition
of
a
compartment
that
the
system
supports.
The
reference
is
to
a
CompartmentDefinition
resource
by
its
canonical
URL
compartment
:
canonical
[0..*]
«
CompartmentDefinition
»
Security
Server
adds
CORS
headers
when
responding
to
requests
-
this
enables
Javascript
applications
to
use
the
server
cors
:
boolean
[0..1]
Types
of
security
services
that
are
supported/required
by
the
system
service
:
CodeableConcept
[0..*]
«
Types
of
security
services
used
with
FHIR.
(Strength=Extensible)
RestfulSecurityService
+
»
General
description
of
how
security
works
description
:
markdown
[0..1]
Resource
A
type
of
resource
exposed
via
the
restful
interface
type
:
code
[1..1]
«
One
of
the
resource
types
defined
as
part
of
this
version
of
FHIR.
(Strength=Required)
ResourceType
!
»
A
specification
of
the
profile
that
describes
the
solution's
overall
support
for
the
resource,
including
any
constraints
on
cardinality,
bindings,
lengths
or
other
limitations.
See
further
discussion
in
[Using
Profiles](profiling.html#profile-uses)
profile
:
canonical
[0..1]
«
StructureDefinition
»
A
list
of
profiles
that
represent
different
use
cases
supported
by
the
system.
For
a
server,
"supported
by
the
system"
means
the
system
hosts/produces
a
set
of
resources
that
are
conformant
to
a
particular
profile,
and
allows
clients
that
use
its
services
to
search
using
this
profile
and
to
find
appropriate
data.
For
a
client,
it
means
the
system
will
search
by
this
profile
and
process
data
according
to
the
guidance
implicit
in
the
profile.
See
further
discussion
in
[Using
Profiles](profiling.html#profile-uses)
supportedProfile
:
canonical
[0..*]
«
StructureDefinition
»
Additional
information
about
the
resource
type
used
by
the
system
documentation
:
markdown
[0..1]
This
field
is
set
to
no-version
to
specify
that
the
system
does
not
support
(server)
or
use
(client)
versioning
for
this
resource
type.
If
this
has
some
other
value,
the
server
must
at
least
correctly
track
and
populate
the
versionId
meta-property
on
resources.
If
the
value
is
'versioned-update',
then
the
server
supports
all
the
versioning
features,
including
using
e-tags
for
version
integrity
in
the
API
versioning
:
code
[0..1]
«
How
the
system
supports
versioning
for
a
resource.
(Strength=Required)
ResourceVersionPolicy
!
»
A
flag
for
whether
the
server
is
able
to
return
past
versions
as
part
of
the
vRead
operation
readHistory
:
boolean
[0..1]
A
flag
to
indicate
that
the
server
allows
or
needs
to
allow
the
client
to
create
new
identities
on
the
server
(that
is,
the
client
PUTs
to
a
location
where
there
is
no
existing
resource).
Allowing
this
submit
operation
means
that
the
server
allows
the
client
to
create
new
identities
on
the
server
updateCreate
:
boolean
[0..1]
A
flag
that
indicates
that
the
server
supports
conditional
create
conditionalCreate
:
boolean
[0..1]
A
code
that
indicates
how
the
server
supports
conditional
read
conditionalRead
:
code
[0..1]
«
A
code
that
indicates
how
the
server
supports
conditional
read.
(Strength=Required)
ConditionalReadStatus
!
»
A
flag
that
indicates
that
the
server
supports
conditional
update
conditionalUpdate
:
boolean
[0..1]
A
code
that
indicates
how
the
server
supports
conditional
delete
conditionalDelete
:
code
[0..1]
«
A
code
that
indicates
how
the
server
supports
conditional
delete.
(Strength=Required)
ConditionalDeleteStatus
!
»
A
set
of
flags
that
defines
how
references
are
supported
referencePolicy
:
code
[0..*]
«
A
set
of
flags
that
defines
how
references
are
supported.
(Strength=Required)
ReferenceHandlingPolicy
!
»
A
list
of
_include
values
supported
by
the
server
searchInclude
:
string
[0..*]
A
list
of
_revinclude
(reverse
include)
values
supported
by
the
server
searchRevInclude
:
string
[0..*]
ResourceInteraction
Coded
identifier
of
the
operation,
supported
by
the
system
resource
code
:
code
[1..1]
«
Operations
supported
by
REST
at
the
type
or
instance
level.
(Strength=Required)
TypeRestfulInteraction
!
»
Guidance
specific
to
the
implementation
of
this
operation,
such
as
'delete
is
a
logical
delete'
or
'updates
are
only
allowed
with
version
id'
or
'creates
permitted
from
pre-authorized
certificates
only'
documentation
:
markdown
[0..1]
SearchParam
The
name
of
the
search
parameter
used
in
the
interface
name
:
string
[1..1]
An
absolute
URI
that
is
a
formal
reference
to
where
this
parameter
was
first
defined,
so
that
a
client
can
be
confident
of
the
meaning
of
the
search
parameter
(a
reference
to
[[[SearchParameter.url]]]).
This
element
SHALL
be
populated
if
the
search
parameter
refers
to
a
SearchParameter
defined
by
the
FHIR
core
specification
or
externally
defined
IGs
definition
:
canonical
[0..1]
«
SearchParameter
»
The
type
of
value
a
search
parameter
refers
to,
and
how
the
content
is
interpreted
type
:
code
[1..1]
«
Data
types
allowed
to
be
used
for
search
parameters.
(Strength=Required)
SearchParamType
!
»
This
allows
documentation
of
any
distinct
behaviors
about
how
the
search
parameter
is
used.
For
example,
text
matching
algorithms
documentation
:
markdown
[0..1]
Operation
The
name
of
the
operation
or
query.
For
an
operation,
this
is
the
name
prefixed
with
$
and
used
in
the
URL.
For
a
query,
this
is
the
name
used
in
the
_query
parameter
when
the
query
is
called
name
:
string
[1..1]
Where
the
formal
definition
can
be
found.
If
a
server
references
the
base
definition
of
an
Operation
(i.e.
from
the
specification
itself
such
as
```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```),
that
means
it
supports
the
full
capabilities
of
the
operation
-
e.g.
both
GET
and
POST
invocation.
If
it
only
supports
a
subset,
it
must
define
its
own
custom
[[[OperationDefinition]]]
with
a
'base'
of
the
original
OperationDefinition.
The
custom
definition
would
describe
the
specific
subset
of
functionality
supported
definition
:
canonical
[1..1]
«
OperationDefinition
»
Documentation
that
describes
anything
special
about
the
operation
behavior,
possibly
detailing
different
behavior
for
system,
type
and
instance-level
invocation
of
the
operation
documentation
:
markdown
[0..1]
SystemInteraction
A
coded
identifier
of
the
operation,
supported
by
the
system
code
:
code
[1..1]
«
Operations
supported
by
REST
at
the
system
level.
(Strength=Required)
SystemRestfulInteraction
!
»
Guidance
specific
to
the
implementation
of
this
operation,
such
as
limitations
on
the
kind
of
transactions
allowed,
or
information
about
system
wide
search
is
implemented
documentation
:
markdown
[0..1]
Messaging
Length
if
the
receiver's
reliable
messaging
cache
in
minutes
(if
a
receiver)
or
how
long
the
cache
length
on
Claim.
See
the
receiver
should
be
(if
a
sender)
reliableCache
:
unsignedInt
[0..1]
Documentation
about
the
system's
messaging
capabilities
for
this
endpoint
not
otherwise
documented
by
the
capability
statement.
For
example,
the
process
for
becoming
an
authorized
messaging
exchange
partner
documentation
:
markdown
[0..1]
Endpoint
A
list
of
the
messaging
transport
protocol(s)
identifiers,
supported
by
this
endpoint
protocol
:
Coding
[1..1]
«
The
protocol
used
for
message
transport.
(Strength=Extensible)
MessageTransport
+
»
The
network
address
of
the
endpoint.
For
solutions
that
do
not
use
network
addresses
for
routing,
it
can
be
just
an
identifier
address
:
url
[1..1]
SupportedMessage
The
mode
of
this
event
declaration
-
whether
application
is
sender
or
receiver
mode
:
code
[1..1]
«
The
mode
of
a
message
capability
statement.
(Strength=Required)
EventCapabilityMode
!
»
Points
to
a
message
definition
that
identifies
the
messaging
event,
message
structure,
allowed
responses,
etc
definition
:
canonical
[1..1]
«
MessageDefinition
»
Document
Mode
of
this
document
declaration
-
whether
an
application
is
a
producer
or
consumer
mode
:
code
[1..1]
«
Whether
the
application
produces
or
consumes
documents.
(Strength=Required)
DocumentMode
!
»
A
description
of
how
the
application
supports
or
uses
the
specified
document
profile.
For
example,
when
documents
are
created,
what
action
is
taken
with
consumed
documents,
etc
Operation
documentation
:
markdown
[0..1]
A
profile
on
the
document
Bundle
that
constrains
which
resources
are
present,
and
their
contents
profile
:
canonical
[1..1]
«
StructureDefinition
»
Software
that
is
covered
by
this
capability
statement.
It
is
used
when
the
capability
statement
describes
the
capabilities
of
a
particular
software
version,
independent
of
an
installation
software
[0..1]
Identifies
a
specific
implementation
instance
that
is
described
by
the
capability
statement
-
i.e.
a
particular
installation,
rather
than
the
capabilities
of
a
software
program
implementation
[0..1]
Information
about
security
implementation
from
an
interface
perspective
-
what
a
client
needs
to
know
security
[0..1]
Identifies
a
restful
operation
supported
by
the
solution
interaction
[0..*]
Search
parameters
for
implementations
to
support
and/or
make
use
of
-
either
references
to
ones
defined
in
the
specification,
or
additional
ones
defined
for/by
the
implementation
searchParam
[0..*]
Definition
of
an
operation
or
a
named
query
together
with
its
parameters
and
their
meaning
and
type.
Consult
the
definition
of
the
operation
for
details
about
how
to
invoke
the
operation,
and
the
parameters
operation
[0..*]
A
specification
of
the
restful
capabilities
of
the
solution
for
a
specific
resource
type
resource
[0..*]
A
specification
of
restful
operations
supported
by
the
system
interaction
[0..*]
Search
parameters
that
are
supported
for
searching
all
resources
for
implementations
to
support
and/or
make
use
of
-
either
references
to
ones
defined
in
the
specification,
or
additional
ones
defined
for/by
the
implementation
searchParam
[0..*]
Definition
of
an
operation
or
a
named
query
together
with
its
parameters
and
their
meaning
and
type
operation
[0..*]
A
definition
of
the
restful
capabilities
of
the
solution,
if
any
rest
[0..*]
An
endpoint
(network
accessible
address)
to
which
messages
and/or
replies
are
to
be
sent
endpoint
[0..*]
References
to
message
definitions
for
messages
this
system
can
send
or
receive
supportedMessage
[0..*]
A
description
of
the
messaging
capabilities
of
the
solution
messaging
[0..*]
A
document
definition
document
[0..*]
XML
Template
JSON
Template
URL:
[base]/Claim/$submit
Turtle
Template
@prefix fhir: <http://hl7.org/fhir/> .
[ a fhir:;
fhir:nodeRole fhir:treeRoot; # if this is the parser root
# from
# from
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
];
fhir:
fhir:
fhir:
fhir:
];
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
];
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
], ...;
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
fhir:
], ...;
fhir:
fhir:
fhir:
fhir:
], ...;
], ...;
fhir:
fhir:
fhir:
], ...;
fhir:
fhir:
fhir:
], ...;
fhir:
fhir:
fhir:
fhir:
], ...;
fhir:
fhir:
fhir:
fhir:
fhir:
], ...;
], ...;
fhir:
fhir:
fhir:
fhir:
], ...;
]
Changes
since
Release
3
CapabilityStatement
CapabilityStatement
Min
Cardinality
changed
from
1
to
0
Max
Cardinality
changed
from
1
to
*
CapabilityStatement.status
Change
value
set
from
http://hl7.org/fhir/ValueSet/publication-status
to
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
CapabilityStatement.experimental
No
longer
marked
as
Modifier
CapabilityStatement.kind
Change
value
set
from
http://hl7.org/fhir/ValueSet/capability-statement-kind
to
http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1
CapabilityStatement.instantiates
Type
changed
from
uri
to
canonical(CapabilityStatement)
CapabilityStatement.imports
Added
Element
CapabilityStatement.implementation.url
Type
changed
from
uri
to
url
CapabilityStatement.implementation.custodian
Added
Element
CapabilityStatement.fhirVersion
Type
changed
from
id
to
code
Add
Binding
http://hl7.org/fhir/ValueSet/FHIR-version|4.0.1
(required)
CapabilityStatement.format
Change
value
set
from
http://hl7.org/fhir/ValueSet/mimetypes
to
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
CapabilityStatement.patchFormat
Change
value
set
from
http://hl7.org/fhir/ValueSet/mimetypes
to
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
CapabilityStatement.implementationGuide
Type
changed
from
uri
to
canonical(ImplementationGuide)
CapabilityStatement.rest.mode
Change
value
set
from
http://hl7.org/fhir/ValueSet/restful-capability-mode
to
http://hl7.org/fhir/ValueSet/restful-capability-mode|4.0.1
CapabilityStatement.rest.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.rest.security.service
Change
code
system
for
extensibly
bound
codes
from
"http://hl7.org/fhir/restful-security-service"
to
"http://terminology.hl7.org/CodeSystem/restful-security-service"
CapabilityStatement.rest.security.description
Type
changed
from
string
to
markdown
CapabilityStatement.rest.resource.type
Change
value
set
from
http://hl7.org/fhir/ValueSet/resource-types
to
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
CapabilityStatement.rest.resource.profile
Type
changed
from
Reference(StructureDefinition)
to
canonical(StructureDefinition)
CapabilityStatement.rest.resource.supportedProfile
Moved
from
CapabilityStatement.profile
to
supportedProfile
Type
changed
from
Reference(StructureDefinition)
to
canonical(StructureDefinition)
CapabilityStatement.rest.resource.interaction
Min
Cardinality
changed
from
1
to
0
CapabilityStatement.rest.resource.interaction.code
Change
value
set
from
http://hl7.org/fhir/ValueSet/type-restful-interaction
to
http://hl7.org/fhir/ValueSet/type-restful-interaction|4.0.1
CapabilityStatement.rest.resource.interaction.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.rest.resource.versioning
Change
value
set
from
http://hl7.org/fhir/ValueSet/versioning-policy
to
http://hl7.org/fhir/ValueSet/versioning-policy|4.0.1
CapabilityStatement.rest.resource.conditionalRead
Change
value
set
from
http://hl7.org/fhir/ValueSet/conditional-read-status
to
http://hl7.org/fhir/ValueSet/conditional-read-status|4.0.1
CapabilityStatement.rest.resource.conditionalDelete
Change
value
set
from
http://hl7.org/fhir/ValueSet/conditional-delete-status
to
http://hl7.org/fhir/ValueSet/conditional-delete-status|4.0.1
CapabilityStatement.rest.resource.referencePolicy
Change
value
set
from
http://hl7.org/fhir/ValueSet/reference-handling-policy
to
http://hl7.org/fhir/ValueSet/reference-handling-policy|4.0.1
CapabilityStatement.rest.resource.searchParam.definition
Type
changed
from
uri
to
canonical(SearchParameter)
CapabilityStatement.rest.resource.searchParam.type
Change
value
set
from
http://hl7.org/fhir/ValueSet/search-param-type
to
http://hl7.org/fhir/ValueSet/search-param-type|4.0.1
CapabilityStatement.rest.resource.searchParam.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.rest.resource.operation
Added
Element
CapabilityStatement.rest.resource.operation.name
Added
Mandatory
Element
CapabilityStatement.rest.resource.operation.definition
Added
Mandatory
Element
CapabilityStatement.rest.resource.operation.documentation
Added
Element
CapabilityStatement.rest.interaction.code
Change
value
set
from
http://hl7.org/fhir/ValueSet/system-restful-interaction
to
http://hl7.org/fhir/ValueSet/system-restful-interaction|4.0.1
CapabilityStatement.rest.interaction.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.rest.operation
Remove
Type
BackboneElement
CapabilityStatement.rest.compartment
Type
changed
from
uri
to
canonical(CompartmentDefinition)
CapabilityStatement.messaging.endpoint.protocol
Change
code
system
for
extensibly
bound
codes
from
"http://hl7.org/fhir/message-transport"
to
"http://terminology.hl7.org/CodeSystem/message-transport"
CapabilityStatement.messaging.endpoint.address
Type
changed
from
uri
to
url
CapabilityStatement.messaging.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.messaging.supportedMessage.mode
Change
value
set
from
http://hl7.org/fhir/ValueSet/event-capability-mode
to
http://hl7.org/fhir/ValueSet/event-capability-mode|4.0.1
CapabilityStatement.messaging.supportedMessage.definition
Type
changed
from
Reference(MessageDefinition)
to
canonical(MessageDefinition)
CapabilityStatement.document.mode
Change
value
set
from
http://hl7.org/fhir/ValueSet/document-mode
to
http://hl7.org/fhir/ValueSet/document-mode|4.0.1
CapabilityStatement.document.documentation
Type
changed
from
string
to
markdown
CapabilityStatement.document.profile
Type
changed
from
Reference(StructureDefinition)
to
canonical(StructureDefinition)
CapabilityStatement.acceptUnknown
deleted
CapabilityStatement.rest.security.certificate
deleted
CapabilityStatement.rest.operation.name
deleted
CapabilityStatement.rest.operation.definition
deleted
CapabilityStatement.messaging.event
deleted
See
the
Full
Difference
for
further
information
This
analysis
is
available
as
XML
or
JSON
.
See
R3
<-->
R4
Conversion
Maps
(status
=
9
tests
that
all
execute
ok.
1
fail
round-trip
testing
and
9
r3
resources
are
invalid
(0
errors).
)
See
the
Profiles
&
Extensions
and
the
alternate
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
&
the
dependency
analysis
Parameters
|
|
|
|
|
|
|
|
|
|
|
|
|
A
|
||
|
|
return |
|
|
A
|
Usage
note:
every
effort
has
been
made
to
ensure
that
identifies
the
capability
statement
CapabilityStatement.url
version
TU
token
The
business
version
examples
are
correct
and
useful,
but
they
are
not
a
normative
part
of
the
capability
statement
CapabilityStatement.version
specification.