FHIR
Infrastructure
![]() |
Maturity
Level
:
| Normative (from v4.0.0) | Security Category : Anonymous | Compartments : Not linked to any defined compartments |
![]() |
This
page
![]() |
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
The capability statement is a key part of the overall conformance framework in FHIR. It is used as a statement of the features of actual software, or of a set of rules for an application to provide. This statement connects to all the detailed statements of functionality, such as StructureDefinitions and ValueSets . This composite statement of application capability may be used for system compatibility testing, code generation, or as the basis for a conformance assessment. For further information about Conformance testing, see Conformance Rules and Profiling FHIR .
Specifically, capability statements are used in one of three ways:
Instance |
implementation
must
be
present
and
software
may
be
present
|
Capability |
implementation
must
be
absent,
software
must
be
present
|
Requirements |
implementation
and
software
must
be
absent
|
In this scenario, the capability statement describes the capabilities of a deployed and configured solution available at a particular access point or set of access points. The statement describes exactly how to interface with that deployed solution and thus provides for a degree of self-configuration of software solutions.
This is the type of statement that FHIR restful solutions are expected to make available on invocation of the capabilities operation. It is also the type of statement that forms a basis for the testing, certification or commissioning of specific software installations.
In this scenario, the capability statement describes generic capabilities of a software application or component solution. The solution might be available for purchase or other acquisition and might be deployed and configured at any number of independent sites. Because it is not dependent on any particular implementation, the profile cannot provide specific details such as endpoint addresses. It may also need to document various configurations in which the application can be set up or describe the degree of customizability associated with the solution.
This type of statement may be used as a marketing tool by software and system developers to formally describe their capabilities. It can also be used as the basis for conformance testing of software solutions independent of a particular installation.
In this scenario, the capability statement describes the capabilities of a desired system. It might be used as part of an architectural design process to document needed system capabilities, or might be used as part of an RFP process to formally document the requirements of a requested solution and to document the criteria by which proposals will be evaluated.
These three types of profiles can be used together. A requirements statement can be compared against the solution statements proffered by respondents to an RFP. A solution statement for a software package forms the starting point for the implementation statement associated with a particular installation of that software package.
CapabilityStatements of type "requirement" describe what capabilities are potentially relevant; additional documentation or extensions (see capabilitystatement-expectation ) within the CapabilityStatement are expected to make more explicit statements of degree of expectation associated with each capability.
Capability Statements provide for a degree of automatic configuration and adaptation. However, capturing absolutely every variation that could impact the interoperability of two systems, let alone keeping that detailed information up-to-date as systems evolve through maintenance and upgrades, is rarely practical. Therefore, capability statements should be seen as an interim step. They provide a degree of automation. However, they also provide a great deal of human-readable content that can minimize the need for direct communication between the operators of the systems being configured to interoperate.
Applications
may
implement
multiple
versions.
If
they
do,
then
a
CapabilityStatement
describes
the
system's
support
for
a
particular
version
of
FHIR,
and
the
system
will
have
multiple
statements,
one
for
each
version
it
supports.
For
further
information,
see
Managing
Multiple
Versions
,
and
the
$versions
operation.
While
the
core
of
the
CapabilityStatement
resource
is
Normative
,
many
of
the
flags
that
indicate
exactly
how
the
system
operates
are
marked
as
trial-use
.
Roughly,
the
portions
of
the
resource
that
correspond
to
OpenAPI
document
elements
are
normative.
Applications
looking
for
normative
stability
should
only
use
the
normative
parts
of
the
resource,
and
not
populate
or
ignore
the
portions
labelled
trial-use.
To
assist
with
this,
clients
can
ask
for
the
server
to
return
a
'Normative
content
only'
CapabilityStatement
using
the
mode
parameter
on
/metadata
.
Community discussion regarding more capable, efficient and computable representations of an applications capabilities may lead to change to the trial-use parts of this resource or the creation of new resources and/or functionality in future versions of this specification.
This
resource
is
referenced
by
testscript
itself
and
TestScript
.
This resource does not implement any patterns.
Structure
Name | Flags | Card. | Type |
Description
&
Constraints
![]() |
---|---|---|---|---|
![]() ![]() |
|
|
A
statement
of
system
capabilities
+ + + Rule: A Capability + Rule: Messaging end-point is required (and is only permitted) when a statement is for an implementation. + + Rule: If kind + + Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension , url , identifier , version , name , title , status , experimental , date , publisher , contact , description , useContext , jurisdiction , purpose , copyright | |
![]() ![]() ![]() | Σ | 0..1 | uri | Canonical identifier for this capability statement, represented as a URI (globally unique) |
![]() ![]() ![]() | Σ | 0..1 | string | Business version of the capability statement |
![]() ![]() ![]() | Σ I | 0..1 | string | Name for this capability statement (computer friendly) |
![]() ![]() ![]() | Σ | 0..1 | string | Name for this capability statement (human friendly) |
![]() ![]() ![]() | ?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
PublicationStatus ( Required ) |
![]() ![]() ![]() |
| 0..1 | boolean | For testing purposes, not real usage |
![]() ![]() ![]() | Σ | 1..1 | dateTime | Date last changed |
![]() ![]() ![]() | Σ | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() ![]() | Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
![]() ![]() ![]() | I | 0..1 | markdown | Natural language description of the capability statement |
![]() ![]() ![]() | Σ TU | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
![]() ![]() ![]() | Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
capability
statement
(if
applicable)
Jurisdiction |
![]() ![]() ![]() | 0..1 | markdown | Why this capability statement is defined | |
![]() ![]() ![]() | 0..1 | markdown | Use and/or publishing restrictions | |
![]() ![]() ![]() | Σ I | 1..1 | code |
instance
|
capability
|
requirements
CapabilityStatementKind ( Required ) |
![]() ![]() ![]() | Σ | 0..* | canonical ( CapabilityStatement ) |
Canonical
URL
of
another
capability
statement
this
implements
|
![]() ![]() ![]() | Σ TU | 0..* | canonical ( CapabilityStatement ) |
Canonical
URL
of
another
capability
statement
this
adds
to
|
![]() ![]() ![]() | Σ I | 0..1 | BackboneElement | Software that is covered by this capability statement |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | A name the software is known by |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version covered by this statement |
![]() ![]() ![]() ![]() | Σ | 0..1 | dateTime | Date this version was released |
![]() ![]() ![]() | Σ I | 0..1 | BackboneElement | If this describes a specific instance |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Describes this specific instance |
![]() ![]() ![]() ![]() | Σ | 0..1 | url | Base URL for the installation |
![]() ![]() ![]() ![]() | Σ TU | 0..1 | Reference ( Organization ) | Organization that manages the data |
![]() ![]() ![]() | Σ | 1..1 |
|
FHIR
Version
the
system
|
![]() ![]() ![]() | Σ | 1..* | code |
formats
supported
(xml
|
json
|
ttl
|
mime
type)
MimeType ( Required ) |
![]() ![]() ![]() | Σ | 0..* | code |
Patch
formats
supported
MimeType ( Required ) |
![]() ![]() ![]() | Σ | 0..* | canonical ( ImplementationGuide ) |
Implementation
guides
supported
|
![]() ![]() ![]() | Σ I | 0..* | BackboneElement |
If
the
endpoint
is
a
RESTful
one
+ Rule: A given resource can only be described once per RESTful mode. |
![]() ![]() ![]() ![]() | Σ | 1..1 | code |
client
|
server
RestfulCapabilityMode ( Required ) |
![]() ![]() ![]() ![]() | 0..1 |
| General description of implementation | |
![]() ![]() ![]() ![]() | Σ TU | 0..1 | BackboneElement | Information about security of implementation |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | Adds CORS Headers (http://enable-cors.org/) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | CodeableConcept |
OAuth
|
SMART-on-FHIR
|
NTLM
|
Basic
|
Kerberos
|
Certificates
RestfulSecurityService ( Extensible ) |
![]() ![]() ![]() ![]() ![]() | 0..1 |
| General description of how security works | |
![]() ![]() ![]() ![]() | Σ I | 0..* | BackboneElement |
Resource
served
on
the
REST
interface
+ Rule: Search parameter names must be unique in the context of a resource. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code |
A
resource
type
that
is
supported
ResourceType ( Required ) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | canonical ( StructureDefinition ) | Base System profile for all uses of resource |
![]() ![]() ![]() ![]() ![]() | Σ TU | 0..* | canonical ( StructureDefinition ) |
Profiles
for
use
cases
supported
|
![]() ![]() ![]() ![]() ![]() | 0..1 | markdown | Additional information about the use of the resource type | |
![]() ![]() ![]() ![]() ![]() | 0..* | BackboneElement |
What
operations
are
supported?
| |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code |
read
|
vread
|
update
|
patch
|
delete
|
history-instance
|
history-type
|
create
|
search-type
TypeRestfulInteraction ( Required ) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 |
| Anything special about operation behavior | |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | code |
no-version
|
versioned
|
versioned-update
ResourceVersionPolicy ( Required ) |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | boolean | Whether vRead can return past versions |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | boolean | If update can commit to a new identity |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | boolean | If allows/uses conditional create |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | code |
not-supported
|
modified-since
|
not-match
|
full-support
ConditionalReadStatus ( Required ) |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | boolean | If allows/uses conditional update |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | code |
not-supported
|
single
|
multiple
-
how
conditional
delete
is
supported
ConditionalDeleteStatus ( Required ) |
![]() ![]() ![]() ![]() ![]() | TU | 0..* | code |
literal
|
logical
|
resolves
|
enforced
|
local
ReferenceHandlingPolicy ( Required ) |
![]() ![]() ![]() ![]() ![]() | TU | 0..* | string |
_include
values
supported
by
the
server
|
![]() ![]() ![]() ![]() ![]() | TU | 0..* | string |
_revinclude
values
supported
by
the
server
|
![]() ![]() ![]() ![]() ![]() | 0..* | BackboneElement |
Search
parameters
supported
by
implementation
| |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Name of search parameter | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | canonical ( SearchParameter ) | Source of definition for parameter | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code |
number
|
date
|
string
|
token
|
reference
|
composite
|
quantity
|
uri
|
special
SearchParamType ( Required ) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 |
| Server-specific usage | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | BackboneElement |
Definition
of
a
resource
operation
|
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Name by which the operation/query is invoked |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | canonical ( OperationDefinition ) | The defined operation/query |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | markdown | Specific details about operation behavior | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement |
What
operations
are
supported?
| |
![]() ![]() ![]() ![]() ![]() | 1..1 | code |
transaction
|
batch
|
search-system
|
history-system
SystemRestfulInteraction ( Required ) | |
![]() ![]() ![]() ![]() ![]() | 0..1 |
| Anything special about operation behavior | |
![]() ![]() ![]() ![]() | 0..* | see searchParam |
Search
parameters
for
searching
all
resources
| |
![]() ![]() ![]() ![]() | Σ | 0..* | see operation |
Definition
of
a
system
level
operation
|
![]() ![]() ![]() ![]() | 0..* | canonical ( CompartmentDefinition ) |
Compartments
served/used
by
system
| |
![]() ![]() ![]() | Σ I TU | 0..* | BackboneElement |
If
messaging
is
supported
|
![]() ![]() ![]() ![]() | 0..* | BackboneElement |
Where
messages
should
be
sent
| |
![]() ![]() ![]() ![]() ![]() | 1..1 | Coding |
http
|
ftp
|
mllp
+
MessageTransport ( Extensible ) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | url | Network address or identifier of the end-point | |
![]() ![]() ![]() ![]() | 0..1 | unsignedInt | Reliable Message Cache Length (min) | |
![]() ![]() ![]() ![]() | 0..1 |
| Messaging interface behavior details | |
![]() ![]() ![]() ![]() | Σ | 0..* | BackboneElement |
Messages
supported
by
this
system
|
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code |
sender
|
receiver
EventCapabilityMode ( Required ) |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | canonical ( MessageDefinition ) | Message supported by this system |
![]() ![]() ![]() | Σ I TU | 0..* | BackboneElement |
Document
definition
|
![]() ![]() ![]() ![]() | Σ | 1..1 | code |
producer
|
consumer
DocumentMode ( Required ) |
![]() ![]() ![]() ![]() | 0..1 |
| Description of document support | |
![]() ![]() ![]() ![]() | Σ | 1..1 | canonical ( StructureDefinition ) | Constraint on the resources used in the document |
![]() |
UML Diagram ( Legend )
XML Template
<CapabilityStatement xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language -->
<!-- from --> <<url value="[uri]"/><!-- 0..1 Canonical identifier for this capability statement, represented as a URI (globally unique) --> <version value="[string]"/><!-- 0..1 Business version of the capability statement --><<name value="[string]"/><!--0..1 Name for this capability statement (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this capability statement (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
<<experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 1..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!--0..1 Natural language description of the capability statement -->
<</useContext><useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for capability statement (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this capability statement is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->< <</instantiates><kind value="[code]"/><!--1..1 instance | capability | requirements --> <instantiates><!-- 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this implements --></instantiates> <imports><!-- 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this adds to --></imports> <software> <!--
0..1 Software that is covered by this capability statement --> <name value="[string]"/><!-- 1..1 A name the software is known by --> <version value="[string]"/><!-- 0..1 Version covered by this statement --> <releaseDate value="[dateTime]"/><!-- 0..1 Date this version was released --> </software>
<<implementation> <!--0..1 If this describes a specific instance --> <description value="[string]"/><!-- 1..1 Describes this specific instance --> <url value="[url]"/><!-- 0..1 Base URL for the installation --> <custodian><!-- 0..1 Reference(Organization) Organization that manages the data --></custodian> </implementation>
< < <<fhirVersion value="[code]"/><!-- 1..1 FHIR Version the system supports --> <format value="[code]"/><!-- 1..* formats supported (xml | json | ttl | mime type) --> <patchFormat value="[code]"/><!-- 0..* Patch formats supported --> <implementationGuide><!-- 0..* canonical(ImplementationGuide) Implementation guides supported --></implementationGuide> <rest> <!--0..* If the endpoint is a RESTful one --> <mode value="[code]"/><!-- 1..1 client | server -->
<<documentation value="[markdown]"/><!-- 0..1 General description of implementation --> <security> <!-- 0..1 Information about security of implementation --> <cors value="[boolean]"/><!-- 0..1 Adds CORS Headers (http://enable-cors.org/) --> <service><!-- 0..* CodeableConcept OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates --></service><<description value="[markdown]"/><!-- 0..1 General description of how security works --> </security> <resource> <!-- 0..* Resource served on the REST interface --> <type value="[code]"/><!-- 1..1 A resource type that is supported --> <profile><!-- 0..1 canonical(StructureDefinition) Base System profile for all uses of resource --></profile> <supportedProfile><!-- 0..* canonical(StructureDefinition) Profiles for use cases supported --></supportedProfile> <documentation value="[markdown]"/><!-- 0..1 Additional information about the use of the resource type --> <interaction> <!-- 0..* What operations are supported? --> <code value="[code]"/><!-- 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-type --><<documentation value="[markdown]"/><!-- 0..1 Anything special about operation behavior --> </interaction> <versioning value="[code]"/><!-- 0..1 no-version | versioned | versioned-update --> <readHistory value="[boolean]"/><!-- 0..1 Whether vRead can return past versions --> <updateCreate value="[boolean]"/><!-- 0..1 If update can commit to a new identity --> <conditionalCreate value="[boolean]"/><!-- 0..1 If allows/uses conditional create --> <conditionalRead value="[code]"/><!-- 0..1 not-supported | modified-since | not-match | full-support --> <conditionalUpdate value="[boolean]"/><!-- 0..1 If allows/uses conditional update --> <conditionalDelete value="[code]"/><!-- 0..1 not-supported | single | multiple - how conditional delete is supported --> <referencePolicy value="[code]"/><!-- 0..* literal | logical | resolves | enforced | local --> <searchInclude value="[string]"/><!-- 0..* _include values supported by the server --> <searchRevInclude value="[string]"/><!-- 0..* _revinclude values supported by the server --> <searchParam> <!-- 0..* Search parameters supported by implementation --> <name value="[string]"/><!-- 1..1 Name of search parameter --><</definition> < <<definition><!-- 0..1 canonical(SearchParameter) Source of definition for parameter --></definition> <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri | special --> <documentation value="[markdown]"/><!-- 0..1 Server-specific usage --> </searchParam> <operation> <!-- 0..* Definition of a resource operation --> <name value="[string]"/><!-- 1..1 Name by which the operation/query is invoked --><</definition><definition><!-- 1..1 canonical(OperationDefinition) The defined operation/query --></definition> <documentation value="[markdown]"/><!-- 0..1 Specific details about operation behavior --> </operation> </resource> <interaction> <!-- 0..* What operations are supported? --> <code value="[code]"/><!-- 1..1 transaction | batch | search-system | history-system --><<documentation value="[markdown]"/><!-- 0..1 Anything special about operation behavior --> </interaction> <searchParam><!-- 0..* Content as for CapabilityStatement.rest.resource.searchParam Search parameters for searching all resources --></searchParam> <operation><!-- 0..* Content as for CapabilityStatement.rest.resource.operation Definition of a system level operation --></operation> <compartment><!-- 0..* canonical(CompartmentDefinition) Compartments served/used by system --></compartment> </rest> <messaging> <!--0..* If messaging is supported --> <endpoint> <!-- 0..* Where messages should be sent --> <protocol><!-- 1..1 Coding http | ftp | mllp + --></protocol> <address value="[url]"/><!-- 1..1 Network address or identifier of the end-point --> </endpoint> <reliableCache value="[unsignedInt]"/><!-- 0..1 Reliable Message Cache Length (min) -->
<<documentation value="[markdown]"/><!-- 0..1 Messaging interface behavior details --> <supportedMessage> <!-- 0..* Messages supported by this system --> <mode value="[code]"/><!-- 1..1 sender | receiver --> <definition><!-- 1..1 canonical(MessageDefinition) Message supported by this system --></definition> </supportedMessage> </messaging> <document> <!--0..* Document definition --> <mode value="[code]"/><!-- 1..1 producer | consumer -->
<<documentation value="[markdown]"/><!-- 0..1 Description of document support --> <profile><!-- 1..1 canonical(StructureDefinition) Constraint on the resources used in the document --></profile> </document> </CapabilityStatement>
JSON Template
{![]()
"resourceType" : "","resourceType" : "CapabilityStatement", // from Resource: id, meta, implicitRules, and language// from ""url" : "<uri>", // Canonical identifier for this capability statement, represented as a URI (globally unique) "version" : "<string>", // Business version of the capability statement""name" : "<string>", // C? Name for this capability statement (computer friendly) "title" : "<string>", // Name for this capability statement (human friendly) "status" : "<code>", // R! draft | active | retired | unknown""experimental" : <boolean>, // For testing purposes, not real usage "date" : "<dateTime>", // R! Date last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // C? Natural language description of the capability statement""useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for capability statement (if applicable) "purpose" : "<markdown>", // Why this capability statement is defined "copyright" : "<markdown>", // Use and/or publishing restrictions" ""kind" : "<code>", // C? R! instance | capability | requirements "instantiates" : [{ canonical(CapabilityStatement) }], // Canonical URL of another capability statement this implements "imports" : [{ canonical(CapabilityStatement) }], // Canonical URL of another capability statement this adds to "software" : { // C? Software that is covered by this capability statement "name" : "<string>", // R! A name the software is known by "version" : "<string>", // Version covered by this statement "releaseDate" : "<dateTime>" // Date this version was released },""implementation" : { // C? If this describes a specific instance "description" : "<string>", // R! Describes this specific instance""url" : "<url>", // Base URL for the installation "custodian" : { Reference(Organization) } // Organization that manages the data }," " " ""fhirVersion" : "<code>", // R! FHIR Version the system supports "format" : ["<code>"], // R! formats supported (xml | json | ttl | mime type) "patchFormat" : ["<code>"], // Patch formats supported "implementationGuide" : [{ canonical(ImplementationGuide) }], // Implementation guides supported "rest" : [{ // C? If the endpoint is a RESTful one "mode" : "<code>", // R! client | server""documentation" : "<markdown>", // General description of implementation "security" : { // Information about security of implementation "cors" : <boolean>, // Adds CORS Headers (http://enable-cors.org/) "service" : [{ CodeableConcept }], // OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates""description" : "<markdown>" // General description of how security works }, "resource" : [{ // Resource served on the REST interface "type" : "<code>", // R! A resource type that is supported" ""profile" : { canonical(StructureDefinition) }, // Base System profile for all uses of resource "supportedProfile" : [{ canonical(StructureDefinition) }], // Profiles for use cases supported "documentation" : "<markdown>", // Additional information about the use of the resource type "interaction" : [{ // What operations are supported? "code" : "<code>", // R! read | vread | update | patch | delete | history-instance | history-type | create | search-type""documentation" : "<markdown>" // Anything special about operation behavior }], "versioning" : "<code>", // no-version | versioned | versioned-update "readHistory" : <boolean>, // Whether vRead can return past versions "updateCreate" : <boolean>, // If update can commit to a new identity "conditionalCreate" : <boolean>, // If allows/uses conditional create "conditionalRead" : "<code>", // not-supported | modified-since | not-match | full-support "conditionalUpdate" : <boolean>, // If allows/uses conditional update "conditionalDelete" : "<code>", // not-supported | single | multiple - how conditional delete is supported "referencePolicy" : ["<code>"], // literal | logical | resolves | enforced | local "searchInclude" : ["<string>"], // _include values supported by the server "searchRevInclude" : ["<string>"], // _revinclude values supported by the server "searchParam" : [{ // Search parameters supported by implementation "name" : "<string>", // R! Name of search parameter" " ""definition" : { canonical(SearchParameter) }, // Source of definition for parameter "type" : "<code>", // R! number | date | string | token | reference | composite | quantity | uri | special "documentation" : "<markdown>" // Server-specific usage }], "operation" : [{ // Definition of a resource operation "name" : "<string>", // R! Name by which the operation/query is invoked""definition" : { canonical(OperationDefinition) }, // R! The defined operation/query "documentation" : "<markdown>" // Specific details about operation behavior }] }], "interaction" : [{ // What operations are supported? "code" : "<code>", // R! transaction | batch | search-system | history-system""documentation" : "<markdown>" // Anything special about operation behavior }], "searchParam" : [{ Content as for CapabilityStatement.rest.resource.searchParam }], // Search parameters for searching all resources "operation" : [{ Content as for CapabilityStatement.rest.resource.operation }], // Definition of a system level operation""compartment" : [{ canonical(CompartmentDefinition) }] // Compartments served/used by system }], "messaging" : [{ // C? If messaging is supported "endpoint" : [{ // Where messages should be sent "protocol" : { Coding }, // R! http | ftp | mllp + "address" : "<url>" // R! Network address or identifier of the end-point }], "reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)""documentation" : "<markdown>", // Messaging interface behavior details "supportedMessage" : [{ // Messages supported by this system "mode" : "<code>", // R! sender | receiver""definition" : { canonical(MessageDefinition) } // R! Message supported by this system }] }], "document" : [{ // C? Document definition "mode" : "<code>", // R! producer | consumer" ""documentation" : "<markdown>", // Description of document support "profile" : { canonical(StructureDefinition) } // R! Constraint on the resources used in the document }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:;[ a fhir:CapabilityStatement; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language# from fhir:fhir:CapabilityStatement.url [ uri ]; # 0..1 Canonical identifier for this capability statement, represented as a URI (globally unique) fhir:CapabilityStatement.version [ string ]; # 0..1 Business version of the capability statement fhir:CapabilityStatement.name [ string ]; # 0..1 Name for this capability statement (computer friendly) fhir:CapabilityStatement.title [ string ]; # 0..1 Name for this capability statement (human friendly) fhir:CapabilityStatement.status [ code ]; # 1..1 draft | active | retired | unknownfhir:fhir:CapabilityStatement.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:CapabilityStatement.date [ dateTime ]; # 1..1 Date last changed fhir:CapabilityStatement.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:CapabilityStatement.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:CapabilityStatement.description [ markdown ]; # 0..1 Natural language description of the capability statementfhir:fhir:CapabilityStatement.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:CapabilityStatement.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for capability statement (if applicable) fhir:CapabilityStatement.purpose [ markdown ]; # 0..1 Why this capability statement is defined fhir:CapabilityStatement.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:CapabilityStatement.kind [ code ]; # 1..1 instance | capability | requirementsfhir:fhir:CapabilityStatement.instantiates [ canonical(CapabilityStatement) ], ... ; # 0..* Canonical URL of another capability statement this implements fhir:CapabilityStatement.imports [ canonical(CapabilityStatement) ], ... ; # 0..* Canonical URL of another capability statement this adds to fhir:CapabilityStatement.software [ # 0..1 Software that is covered by this capability statement fhir:CapabilityStatement.software.name [ string ]; # 1..1 A name the software is known by fhir:CapabilityStatement.software.version [ string ]; # 0..1 Version covered by this statement fhir:CapabilityStatement.software.releaseDate [ dateTime ]; # 0..1 Date this version was released ]; fhir:CapabilityStatement.implementation [ # 0..1 If this describes a specific instance fhir:CapabilityStatement.implementation.description [ string ]; # 1..1 Describes this specific instance fhir:CapabilityStatement.implementation.url [ url ]; # 0..1 Base URL for the installation fhir:CapabilityStatement.implementation.custodian [ Reference(Organization) ]; # 0..1 Organization that manages the data ];fhir:fhir:CapabilityStatement.fhirVersion [ code ]; # 1..1 FHIR Version the system supports fhir:CapabilityStatement.format [ code ], ... ; # 1..* formats supported (xml | json | ttl | mime type) fhir:CapabilityStatement.patchFormat [ code ], ... ; # 0..* Patch formats supported fhir:CapabilityStatement.implementationGuide [ canonical(ImplementationGuide) ], ... ; # 0..* Implementation guides supported fhir:CapabilityStatement.rest [ # 0..* If the endpoint is a RESTful one fhir:CapabilityStatement.rest.mode [ code ]; # 1..1 client | serverfhir:fhir:CapabilityStatement.rest.documentation [ markdown ]; # 0..1 General description of implementation fhir:CapabilityStatement.rest.security [ # 0..1 Information about security of implementation fhir:CapabilityStatement.rest.security.cors [ boolean ]; # 0..1 Adds CORS Headers (http://enable-cors.org/) fhir:CapabilityStatement.rest.security.service [ CodeableConcept ], ... ; # 0..* OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificatesfhir:fhir:CapabilityStatement.rest.security.description [ markdown ]; # 0..1 General description of how security works ]; fhir:CapabilityStatement.rest.resource [ # 0..* Resource served on the REST interface fhir:CapabilityStatement.rest.resource.type [ code ]; # 1..1 A resource type that is supported fhir:CapabilityStatement.rest.resource.profile [ canonical(StructureDefinition) ]; # 0..1 Base System profile for all uses of resource fhir:CapabilityStatement.rest.resource.supportedProfile [ canonical(StructureDefinition) ], ... ; # 0..* Profiles for use cases supported fhir:CapabilityStatement.rest.resource.documentation [ markdown ]; # 0..1 Additional information about the use of the resource type fhir:CapabilityStatement.rest.resource.interaction [ # 0..* What operations are supported? fhir:CapabilityStatement.rest.resource.interaction.code [ code ]; # 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-typefhir:fhir:CapabilityStatement.rest.resource.interaction.documentation [ markdown ]; # 0..1 Anything special about operation behavior ], ...; fhir:CapabilityStatement.rest.resource.versioning [ code ]; # 0..1 no-version | versioned | versioned-update fhir:CapabilityStatement.rest.resource.readHistory [ boolean ]; # 0..1 Whether vRead can return past versions fhir:CapabilityStatement.rest.resource.updateCreate [ boolean ]; # 0..1 If update can commit to a new identity fhir:CapabilityStatement.rest.resource.conditionalCreate [ boolean ]; # 0..1 If allows/uses conditional create fhir:CapabilityStatement.rest.resource.conditionalRead [ code ]; # 0..1 not-supported | modified-since | not-match | full-support fhir:CapabilityStatement.rest.resource.conditionalUpdate [ boolean ]; # 0..1 If allows/uses conditional update fhir:CapabilityStatement.rest.resource.conditionalDelete [ code ]; # 0..1 not-supported | single | multiple - how conditional delete is supported fhir:CapabilityStatement.rest.resource.referencePolicy [ code ], ... ; # 0..* literal | logical | resolves | enforced | local fhir:CapabilityStatement.rest.resource.searchInclude [ string ], ... ; # 0..* _include values supported by the server fhir:CapabilityStatement.rest.resource.searchRevInclude [ string ], ... ; # 0..* _revinclude values supported by the server fhir:CapabilityStatement.rest.resource.searchParam [ # 0..* Search parameters supported by implementation fhir:CapabilityStatement.rest.resource.searchParam.name [ string ]; # 1..1 Name of search parameterfhir: fhir: fhir:fhir:CapabilityStatement.rest.resource.searchParam.definition [ canonical(SearchParameter) ]; # 0..1 Source of definition for parameter fhir:CapabilityStatement.rest.resource.searchParam.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri | special fhir:CapabilityStatement.rest.resource.searchParam.documentation [ markdown ]; # 0..1 Server-specific usage ], ...; fhir:CapabilityStatement.rest.resource.operation [ # 0..* Definition of a resource operation fhir:CapabilityStatement.rest.resource.operation.name [ string ]; # 1..1 Name by which the operation/query is invokedfhir:fhir:CapabilityStatement.rest.resource.operation.definition [ canonical(OperationDefinition) ]; # 1..1 The defined operation/query fhir:CapabilityStatement.rest.resource.operation.documentation [ markdown ]; # 0..1 Specific details about operation behavior ], ...; ], ...; fhir:CapabilityStatement.rest.interaction [ # 0..* What operations are supported? fhir:CapabilityStatement.rest.interaction.code [ code ]; # 1..1 transaction | batch | search-system | history-systemfhir:fhir:CapabilityStatement.rest.interaction.documentation [ markdown ]; # 0..1 Anything special about operation behavior ], ...; fhir:CapabilityStatement.rest.searchParam [ See CapabilityStatement.rest.resource.searchParam ], ... ; # 0..* Search parameters for searching all resources fhir:CapabilityStatement.rest.operation [ See CapabilityStatement.rest.resource.operation ], ... ; # 0..* Definition of a system level operation fhir:CapabilityStatement.rest.compartment [ canonical(CompartmentDefinition) ], ... ; # 0..* Compartments served/used by system ], ...; fhir:CapabilityStatement.messaging [ # 0..* If messaging is supported fhir:CapabilityStatement.messaging.endpoint [ # 0..* Where messages should be sent fhir:CapabilityStatement.messaging.endpoint.protocol [ Coding ]; # 1..1 http | ftp | mllp + fhir:CapabilityStatement.messaging.endpoint.address [ url ]; # 1..1 Network address or identifier of the end-point ], ...; fhir:CapabilityStatement.messaging.reliableCache [ unsignedInt ]; # 0..1 Reliable Message Cache Length (min)fhir:fhir:CapabilityStatement.messaging.documentation [ markdown ]; # 0..1 Messaging interface behavior details fhir:CapabilityStatement.messaging.supportedMessage [ # 0..* Messages supported by this system fhir:CapabilityStatement.messaging.supportedMessage.mode [ code ]; # 1..1 sender | receiver fhir:CapabilityStatement.messaging.supportedMessage.definition [ canonical(MessageDefinition) ]; # 1..1 Message supported by this system ], ...; ], ...; fhir:CapabilityStatement.document [ # 0..* Document definition fhir:CapabilityStatement.document.mode [ code ]; # 1..1 producer | consumerfhir:fhir:CapabilityStatement.document.documentation [ markdown ]; # 0..1 Description of document support fhir:CapabilityStatement.document.profile [ canonical(StructureDefinition) ]; # 1..1 Constraint on the resources used in the document ], ...; ]
Changes since R3
CapabilityStatement | |
|
|
|
|
CapabilityStatement.fhirVersion |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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). )
Structure
Name | Flags | Card. | Type |
Description
&
Constraints
![]() |
---|---|---|---|---|
![]() ![]() |
|
|
A
statement
of
system
capabilities
+ + + Rule: A Capability + Rule: Messaging end-point is required (and is only permitted) when a statement is for an implementation. + + Rule: If kind + + Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension , url , identifier , version , name , title , status , experimental , date , publisher , contact , description , useContext , jurisdiction , purpose , copyright | |
![]() ![]() ![]() | Σ | 0..1 | uri | Canonical identifier for this capability statement, represented as a URI (globally unique) |
![]() ![]() ![]() | Σ | 0..1 | string | Business version of the capability statement |
![]() ![]() ![]() | Σ I | 0..1 | string | Name for this capability statement (computer friendly) |
![]() ![]() ![]() | Σ | 0..1 | string | Name for this capability statement (human friendly) |
![]() ![]() ![]() | ?! Σ | 1..1 | code |
draft
|
active
|
retired
|
unknown
PublicationStatus ( Required ) |
![]() ![]() ![]() |
| 0..1 | boolean | For testing purposes, not real usage |
![]() ![]() ![]() | Σ | 1..1 | dateTime | Date last changed |
![]() ![]() ![]() | Σ | 0..1 | string | Name of the publisher (organization or individual) |
![]() ![]() ![]() | Σ | 0..* | ContactDetail |
Contact
details
for
the
publisher
|
![]() ![]() ![]() | I | 0..1 | markdown | Natural language description of the capability statement |
![]() ![]() ![]() | Σ TU | 0..* | UsageContext |
The
context
that
the
content
is
intended
to
support
|
![]() ![]() ![]() | Σ | 0..* | CodeableConcept |
Intended
jurisdiction
for
capability
statement
(if
applicable)
Jurisdiction |
![]() ![]() ![]() | 0..1 | markdown | Why this capability statement is defined | |
![]() ![]() ![]() | 0..1 | markdown | Use and/or publishing restrictions | |
![]() ![]() ![]() | Σ I | 1..1 | code |
instance
|
capability
|
requirements
CapabilityStatementKind ( Required ) |
![]() ![]() ![]() | Σ | 0..* | canonical ( CapabilityStatement ) |
Canonical
URL
of
another
capability
statement
this
implements
|
![]() ![]() ![]() | Σ TU | 0..* | canonical ( CapabilityStatement ) |
Canonical
URL
of
another
capability
statement
this
adds
to
|
![]() ![]() ![]() | Σ I | 0..1 | BackboneElement | Software that is covered by this capability statement |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | A name the software is known by |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | Version covered by this statement |
![]() ![]() ![]() ![]() | Σ | 0..1 | dateTime | Date this version was released |
![]() ![]() ![]() | Σ I | 0..1 | BackboneElement | If this describes a specific instance |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | Describes this specific instance |
![]() ![]() ![]() ![]() | Σ | 0..1 | url | Base URL for the installation |
![]() ![]() ![]() ![]() | Σ TU | 0..1 | Reference ( Organization ) | Organization that manages the data |
![]() ![]() ![]() | Σ | 1..1 |
|
FHIR
Version
the
system
|
![]() ![]() ![]() | Σ | 1..* | code |
formats
supported
(xml
|
json
|
ttl
|
mime
type)
MimeType ( Required ) |
![]() ![]() ![]() | Σ | 0..* | code |
Patch
formats
supported
MimeType ( Required ) |
![]() ![]() ![]() | Σ | 0..* | canonical ( ImplementationGuide ) |
Implementation
guides
supported
|
![]() ![]() ![]() | Σ I | 0..* | BackboneElement |
If
the
endpoint
is
a
RESTful
one
+ Rule: A given resource can only be described once per RESTful mode. |
![]() ![]() ![]() ![]() | Σ | 1..1 | code |
client
|
server
RestfulCapabilityMode ( Required ) |
![]() ![]() ![]() ![]() | 0..1 |
| General description of implementation | |
![]() ![]() ![]() ![]() | Σ TU | 0..1 | BackboneElement | Information about security of implementation |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | boolean | Adds CORS Headers (http://enable-cors.org/) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | CodeableConcept |
OAuth
|
SMART-on-FHIR
|
NTLM
|
Basic
|
Kerberos
|
Certificates
RestfulSecurityService ( Extensible ) |
![]() ![]() ![]() ![]() ![]() | 0..1 |
| General description of how security works | |
![]() ![]() ![]() ![]() | Σ I | 0..* | BackboneElement |
Resource
served
on
the
REST
interface
+ Rule: Search parameter names must be unique in the context of a resource. |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code |
A
resource
type
that
is
supported
ResourceType ( Required ) |
![]() ![]() ![]() ![]() ![]() | Σ | 0..1 | canonical ( StructureDefinition ) | Base System profile for all uses of resource |
![]() ![]() ![]() ![]() ![]() | Σ TU | 0..* | canonical ( StructureDefinition ) |
Profiles
for
use
cases
supported
|
![]() ![]() ![]() ![]() ![]() | 0..1 | markdown | Additional information about the use of the resource type | |
![]() ![]() ![]() ![]() ![]() | 0..* | BackboneElement |
What
operations
are
supported?
| |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code |
read
|
vread
|
update
|
patch
|
delete
|
history-instance
|
history-type
|
create
|
search-type
TypeRestfulInteraction ( Required ) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 |
| Anything special about operation behavior | |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | code |
no-version
|
versioned
|
versioned-update
ResourceVersionPolicy ( Required ) |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | boolean | Whether vRead can return past versions |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | boolean | If update can commit to a new identity |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | boolean | If allows/uses conditional create |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | code |
not-supported
|
modified-since
|
not-match
|
full-support
ConditionalReadStatus ( Required ) |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | boolean | If allows/uses conditional update |
![]() ![]() ![]() ![]() ![]() | TU | 0..1 | code |
not-supported
|
single
|
multiple
-
how
conditional
delete
is
supported
ConditionalDeleteStatus ( Required ) |
![]() ![]() ![]() ![]() ![]() | TU | 0..* | code |
literal
|
logical
|
resolves
|
enforced
|
local
ReferenceHandlingPolicy ( Required ) |
![]() ![]() ![]() ![]() ![]() | TU | 0..* | string |
_include
values
supported
by
the
server
|
![]() ![]() ![]() ![]() ![]() | TU | 0..* | string |
_revinclude
values
supported
by
the
server
|
![]() ![]() ![]() ![]() ![]() | 0..* | BackboneElement |
Search
parameters
supported
by
implementation
| |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | string | Name of search parameter | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | canonical ( SearchParameter ) | Source of definition for parameter | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code |
number
|
date
|
string
|
token
|
reference
|
composite
|
quantity
|
uri
|
special
SearchParamType ( Required ) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 |
| Server-specific usage | |
![]() ![]() ![]() ![]() ![]() | Σ | 0..* | BackboneElement |
Definition
of
a
resource
operation
|
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | string | Name by which the operation/query is invoked |
![]() ![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | canonical ( OperationDefinition ) | The defined operation/query |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | markdown | Specific details about operation behavior | |
![]() ![]() ![]() ![]() | 0..* | BackboneElement |
What
operations
are
supported?
| |
![]() ![]() ![]() ![]() ![]() | 1..1 | code |
transaction
|
batch
|
search-system
|
history-system
SystemRestfulInteraction ( Required ) | |
![]() ![]() ![]() ![]() ![]() | 0..1 |
| Anything special about operation behavior | |
![]() ![]() ![]() ![]() | 0..* | see searchParam |
Search
parameters
for
searching
all
resources
| |
![]() ![]() ![]() ![]() | Σ | 0..* | see operation |
Definition
of
a
system
level
operation
|
![]() ![]() ![]() ![]() | 0..* | canonical ( CompartmentDefinition ) |
Compartments
served/used
by
system
| |
![]() ![]() ![]() | Σ I TU | 0..* | BackboneElement |
If
messaging
is
supported
|
![]() ![]() ![]() ![]() | 0..* | BackboneElement |
Where
messages
should
be
sent
| |
![]() ![]() ![]() ![]() ![]() | 1..1 | Coding |
http
|
ftp
|
mllp
+
MessageTransport ( Extensible ) | |
![]() ![]() ![]() ![]() ![]() | 1..1 | url | Network address or identifier of the end-point | |
![]() ![]() ![]() ![]() | 0..1 | unsignedInt | Reliable Message Cache Length (min) | |
![]() ![]() ![]() ![]() | 0..1 |
| Messaging interface behavior details | |
![]() ![]() ![]() ![]() | Σ | 0..* | BackboneElement |
Messages
supported
by
this
system
|
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | code |
sender
|
receiver
EventCapabilityMode ( Required ) |
![]() ![]() ![]() ![]() ![]() | Σ | 1..1 | canonical ( MessageDefinition ) | Message supported by this system |
![]() ![]() ![]() | Σ I TU | 0..* | BackboneElement |
Document
definition
|
![]() ![]() ![]() ![]() | Σ | 1..1 | code |
producer
|
consumer
DocumentMode ( Required ) |
![]() ![]() ![]() ![]() | 0..1 |
| Description of document support | |
![]() ![]() ![]() ![]() | Σ | 1..1 | canonical ( StructureDefinition ) | Constraint on the resources used in the document |
![]() |
XML Template
<CapabilityStatement xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language -->
<!-- from --> <<url value="[uri]"/><!-- 0..1 Canonical identifier for this capability statement, represented as a URI (globally unique) --> <version value="[string]"/><!-- 0..1 Business version of the capability statement --><<name value="[string]"/><!--0..1 Name for this capability statement (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this capability statement (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
<<experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 1..1 Date last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!--0..1 Natural language description of the capability statement -->
<</useContext><useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for capability statement (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this capability statement is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->< <</instantiates><kind value="[code]"/><!--1..1 instance | capability | requirements --> <instantiates><!-- 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this implements --></instantiates> <imports><!-- 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this adds to --></imports> <software> <!--
0..1 Software that is covered by this capability statement --> <name value="[string]"/><!-- 1..1 A name the software is known by --> <version value="[string]"/><!-- 0..1 Version covered by this statement --> <releaseDate value="[dateTime]"/><!-- 0..1 Date this version was released --> </software>
<<implementation> <!--0..1 If this describes a specific instance --> <description value="[string]"/><!-- 1..1 Describes this specific instance --> <url value="[url]"/><!-- 0..1 Base URL for the installation --> <custodian><!-- 0..1 Reference(Organization) Organization that manages the data --></custodian> </implementation>
< < <<fhirVersion value="[code]"/><!-- 1..1 FHIR Version the system supports --> <format value="[code]"/><!-- 1..* formats supported (xml | json | ttl | mime type) --> <patchFormat value="[code]"/><!-- 0..* Patch formats supported --> <implementationGuide><!-- 0..* canonical(ImplementationGuide) Implementation guides supported --></implementationGuide> <rest> <!--0..* If the endpoint is a RESTful one --> <mode value="[code]"/><!-- 1..1 client | server -->
<<documentation value="[markdown]"/><!-- 0..1 General description of implementation --> <security> <!-- 0..1 Information about security of implementation --> <cors value="[boolean]"/><!-- 0..1 Adds CORS Headers (http://enable-cors.org/) --> <service><!-- 0..* CodeableConcept OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates --></service><<description value="[markdown]"/><!-- 0..1 General description of how security works --> </security> <resource> <!-- 0..* Resource served on the REST interface --> <type value="[code]"/><!-- 1..1 A resource type that is supported --> <profile><!-- 0..1 canonical(StructureDefinition) Base System profile for all uses of resource --></profile> <supportedProfile><!-- 0..* canonical(StructureDefinition) Profiles for use cases supported --></supportedProfile> <documentation value="[markdown]"/><!-- 0..1 Additional information about the use of the resource type --> <interaction> <!-- 0..* What operations are supported? --> <code value="[code]"/><!-- 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-type --><<documentation value="[markdown]"/><!-- 0..1 Anything special about operation behavior --> </interaction> <versioning value="[code]"/><!-- 0..1 no-version | versioned | versioned-update --> <readHistory value="[boolean]"/><!-- 0..1 Whether vRead can return past versions --> <updateCreate value="[boolean]"/><!-- 0..1 If update can commit to a new identity --> <conditionalCreate value="[boolean]"/><!-- 0..1 If allows/uses conditional create --> <conditionalRead value="[code]"/><!-- 0..1 not-supported | modified-since | not-match | full-support --> <conditionalUpdate value="[boolean]"/><!-- 0..1 If allows/uses conditional update --> <conditionalDelete value="[code]"/><!-- 0..1 not-supported | single | multiple - how conditional delete is supported --> <referencePolicy value="[code]"/><!-- 0..* literal | logical | resolves | enforced | local --> <searchInclude value="[string]"/><!-- 0..* _include values supported by the server --> <searchRevInclude value="[string]"/><!-- 0..* _revinclude values supported by the server --> <searchParam> <!-- 0..* Search parameters supported by implementation --> <name value="[string]"/><!-- 1..1 Name of search parameter --><</definition> < <<definition><!-- 0..1 canonical(SearchParameter) Source of definition for parameter --></definition> <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri | special --> <documentation value="[markdown]"/><!-- 0..1 Server-specific usage --> </searchParam> <operation> <!-- 0..* Definition of a resource operation --> <name value="[string]"/><!-- 1..1 Name by which the operation/query is invoked --><</definition><definition><!-- 1..1 canonical(OperationDefinition) The defined operation/query --></definition> <documentation value="[markdown]"/><!-- 0..1 Specific details about operation behavior --> </operation> </resource> <interaction> <!-- 0..* What operations are supported? --> <code value="[code]"/><!-- 1..1 transaction | batch | search-system | history-system --><<documentation value="[markdown]"/><!-- 0..1 Anything special about operation behavior --> </interaction> <searchParam><!-- 0..* Content as for CapabilityStatement.rest.resource.searchParam Search parameters for searching all resources --></searchParam> <operation><!-- 0..* Content as for CapabilityStatement.rest.resource.operation Definition of a system level operation --></operation> <compartment><!-- 0..* canonical(CompartmentDefinition) Compartments served/used by system --></compartment> </rest> <messaging> <!--0..* If messaging is supported --> <endpoint> <!-- 0..* Where messages should be sent --> <protocol><!-- 1..1 Coding http | ftp | mllp + --></protocol> <address value="[url]"/><!-- 1..1 Network address or identifier of the end-point --> </endpoint> <reliableCache value="[unsignedInt]"/><!-- 0..1 Reliable Message Cache Length (min) -->
<<documentation value="[markdown]"/><!-- 0..1 Messaging interface behavior details --> <supportedMessage> <!-- 0..* Messages supported by this system --> <mode value="[code]"/><!-- 1..1 sender | receiver --> <definition><!-- 1..1 canonical(MessageDefinition) Message supported by this system --></definition> </supportedMessage> </messaging> <document> <!--0..* Document definition --> <mode value="[code]"/><!-- 1..1 producer | consumer -->
<<documentation value="[markdown]"/><!-- 0..1 Description of document support --> <profile><!-- 1..1 canonical(StructureDefinition) Constraint on the resources used in the document --></profile> </document> </CapabilityStatement>
JSON Template
{![]()
"resourceType" : "","resourceType" : "CapabilityStatement", // from Resource: id, meta, implicitRules, and language// from ""url" : "<uri>", // Canonical identifier for this capability statement, represented as a URI (globally unique) "version" : "<string>", // Business version of the capability statement""name" : "<string>", // C? Name for this capability statement (computer friendly) "title" : "<string>", // Name for this capability statement (human friendly) "status" : "<code>", // R! draft | active | retired | unknown""experimental" : <boolean>, // For testing purposes, not real usage "date" : "<dateTime>", // R! Date last changed "publisher" : "<string>", // Name of the publisher (organization or individual) "contact" : [{ ContactDetail }], // Contact details for the publisher "description" : "<markdown>", // C? Natural language description of the capability statement""useContext" : [{ UsageContext }], // The context that the content is intended to support "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for capability statement (if applicable) "purpose" : "<markdown>", // Why this capability statement is defined "copyright" : "<markdown>", // Use and/or publishing restrictions" ""kind" : "<code>", // C? R! instance | capability | requirements "instantiates" : [{ canonical(CapabilityStatement) }], // Canonical URL of another capability statement this implements "imports" : [{ canonical(CapabilityStatement) }], // Canonical URL of another capability statement this adds to "software" : { // C? Software that is covered by this capability statement "name" : "<string>", // R! A name the software is known by "version" : "<string>", // Version covered by this statement "releaseDate" : "<dateTime>" // Date this version was released },""implementation" : { // C? If this describes a specific instance "description" : "<string>", // R! Describes this specific instance""url" : "<url>", // Base URL for the installation "custodian" : { Reference(Organization) } // Organization that manages the data }," " " ""fhirVersion" : "<code>", // R! FHIR Version the system supports "format" : ["<code>"], // R! formats supported (xml | json | ttl | mime type) "patchFormat" : ["<code>"], // Patch formats supported "implementationGuide" : [{ canonical(ImplementationGuide) }], // Implementation guides supported "rest" : [{ // C? If the endpoint is a RESTful one "mode" : "<code>", // R! client | server""documentation" : "<markdown>", // General description of implementation "security" : { // Information about security of implementation "cors" : <boolean>, // Adds CORS Headers (http://enable-cors.org/) "service" : [{ CodeableConcept }], // OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates""description" : "<markdown>" // General description of how security works }, "resource" : [{ // Resource served on the REST interface "type" : "<code>", // R! A resource type that is supported" ""profile" : { canonical(StructureDefinition) }, // Base System profile for all uses of resource "supportedProfile" : [{ canonical(StructureDefinition) }], // Profiles for use cases supported "documentation" : "<markdown>", // Additional information about the use of the resource type "interaction" : [{ // What operations are supported? "code" : "<code>", // R! read | vread | update | patch | delete | history-instance | history-type | create | search-type""documentation" : "<markdown>" // Anything special about operation behavior }], "versioning" : "<code>", // no-version | versioned | versioned-update "readHistory" : <boolean>, // Whether vRead can return past versions "updateCreate" : <boolean>, // If update can commit to a new identity "conditionalCreate" : <boolean>, // If allows/uses conditional create "conditionalRead" : "<code>", // not-supported | modified-since | not-match | full-support "conditionalUpdate" : <boolean>, // If allows/uses conditional update "conditionalDelete" : "<code>", // not-supported | single | multiple - how conditional delete is supported "referencePolicy" : ["<code>"], // literal | logical | resolves | enforced | local "searchInclude" : ["<string>"], // _include values supported by the server "searchRevInclude" : ["<string>"], // _revinclude values supported by the server "searchParam" : [{ // Search parameters supported by implementation "name" : "<string>", // R! Name of search parameter" " ""definition" : { canonical(SearchParameter) }, // Source of definition for parameter "type" : "<code>", // R! number | date | string | token | reference | composite | quantity | uri | special "documentation" : "<markdown>" // Server-specific usage }], "operation" : [{ // Definition of a resource operation "name" : "<string>", // R! Name by which the operation/query is invoked""definition" : { canonical(OperationDefinition) }, // R! The defined operation/query "documentation" : "<markdown>" // Specific details about operation behavior }] }], "interaction" : [{ // What operations are supported? "code" : "<code>", // R! transaction | batch | search-system | history-system""documentation" : "<markdown>" // Anything special about operation behavior }], "searchParam" : [{ Content as for CapabilityStatement.rest.resource.searchParam }], // Search parameters for searching all resources "operation" : [{ Content as for CapabilityStatement.rest.resource.operation }], // Definition of a system level operation""compartment" : [{ canonical(CompartmentDefinition) }] // Compartments served/used by system }], "messaging" : [{ // C? If messaging is supported "endpoint" : [{ // Where messages should be sent "protocol" : { Coding }, // R! http | ftp | mllp + "address" : "<url>" // R! Network address or identifier of the end-point }], "reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)""documentation" : "<markdown>", // Messaging interface behavior details "supportedMessage" : [{ // Messages supported by this system "mode" : "<code>", // R! sender | receiver""definition" : { canonical(MessageDefinition) } // R! Message supported by this system }] }], "document" : [{ // C? Document definition "mode" : "<code>", // R! producer | consumer" ""documentation" : "<markdown>", // Description of document support "profile" : { canonical(StructureDefinition) } // R! Constraint on the resources used in the document }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .![]()
[ a fhir:;[ a fhir:CapabilityStatement; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language# from fhir:fhir:CapabilityStatement.url [ uri ]; # 0..1 Canonical identifier for this capability statement, represented as a URI (globally unique) fhir:CapabilityStatement.version [ string ]; # 0..1 Business version of the capability statement fhir:CapabilityStatement.name [ string ]; # 0..1 Name for this capability statement (computer friendly) fhir:CapabilityStatement.title [ string ]; # 0..1 Name for this capability statement (human friendly) fhir:CapabilityStatement.status [ code ]; # 1..1 draft | active | retired | unknownfhir:fhir:CapabilityStatement.experimental [ boolean ]; # 0..1 For testing purposes, not real usage fhir:CapabilityStatement.date [ dateTime ]; # 1..1 Date last changed fhir:CapabilityStatement.publisher [ string ]; # 0..1 Name of the publisher (organization or individual) fhir:CapabilityStatement.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher fhir:CapabilityStatement.description [ markdown ]; # 0..1 Natural language description of the capability statementfhir:fhir:CapabilityStatement.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support fhir:CapabilityStatement.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for capability statement (if applicable) fhir:CapabilityStatement.purpose [ markdown ]; # 0..1 Why this capability statement is defined fhir:CapabilityStatement.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions fhir:CapabilityStatement.kind [ code ]; # 1..1 instance | capability | requirementsfhir:fhir:CapabilityStatement.instantiates [ canonical(CapabilityStatement) ], ... ; # 0..* Canonical URL of another capability statement this implements fhir:CapabilityStatement.imports [ canonical(CapabilityStatement) ], ... ; # 0..* Canonical URL of another capability statement this adds to fhir:CapabilityStatement.software [ # 0..1 Software that is covered by this capability statement fhir:CapabilityStatement.software.name [ string ]; # 1..1 A name the software is known by fhir:CapabilityStatement.software.version [ string ]; # 0..1 Version covered by this statement fhir:CapabilityStatement.software.releaseDate [ dateTime ]; # 0..1 Date this version was released ]; fhir:CapabilityStatement.implementation [ # 0..1 If this describes a specific instance fhir:CapabilityStatement.implementation.description [ string ]; # 1..1 Describes this specific instance fhir:CapabilityStatement.implementation.url [ url ]; # 0..1 Base URL for the installation fhir:CapabilityStatement.implementation.custodian [ Reference(Organization) ]; # 0..1 Organization that manages the data ];fhir:fhir:CapabilityStatement.fhirVersion [ code ]; # 1..1 FHIR Version the system supports fhir:CapabilityStatement.format [ code ], ... ; # 1..* formats supported (xml | json | ttl | mime type) fhir:CapabilityStatement.patchFormat [ code ], ... ; # 0..* Patch formats supported fhir:CapabilityStatement.implementationGuide [ canonical(ImplementationGuide) ], ... ; # 0..* Implementation guides supported fhir:CapabilityStatement.rest [ # 0..* If the endpoint is a RESTful one fhir:CapabilityStatement.rest.mode [ code ]; # 1..1 client | serverfhir:fhir:CapabilityStatement.rest.documentation [ markdown ]; # 0..1 General description of implementation fhir:CapabilityStatement.rest.security [ # 0..1 Information about security of implementation fhir:CapabilityStatement.rest.security.cors [ boolean ]; # 0..1 Adds CORS Headers (http://enable-cors.org/) fhir:CapabilityStatement.rest.security.service [ CodeableConcept ], ... ; # 0..* OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificatesfhir:fhir:CapabilityStatement.rest.security.description [ markdown ]; # 0..1 General description of how security works ]; fhir:CapabilityStatement.rest.resource [ # 0..* Resource served on the REST interface fhir:CapabilityStatement.rest.resource.type [ code ]; # 1..1 A resource type that is supported fhir:CapabilityStatement.rest.resource.profile [ canonical(StructureDefinition) ]; # 0..1 Base System profile for all uses of resource fhir:CapabilityStatement.rest.resource.supportedProfile [ canonical(StructureDefinition) ], ... ; # 0..* Profiles for use cases supported fhir:CapabilityStatement.rest.resource.documentation [ markdown ]; # 0..1 Additional information about the use of the resource type fhir:CapabilityStatement.rest.resource.interaction [ # 0..* What operations are supported? fhir:CapabilityStatement.rest.resource.interaction.code [ code ]; # 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-typefhir:fhir:CapabilityStatement.rest.resource.interaction.documentation [ markdown ]; # 0..1 Anything special about operation behavior ], ...; fhir:CapabilityStatement.rest.resource.versioning [ code ]; # 0..1 no-version | versioned | versioned-update fhir:CapabilityStatement.rest.resource.readHistory [ boolean ]; # 0..1 Whether vRead can return past versions fhir:CapabilityStatement.rest.resource.updateCreate [ boolean ]; # 0..1 If update can commit to a new identity fhir:CapabilityStatement.rest.resource.conditionalCreate [ boolean ]; # 0..1 If allows/uses conditional create fhir:CapabilityStatement.rest.resource.conditionalRead [ code ]; # 0..1 not-supported | modified-since | not-match | full-support fhir:CapabilityStatement.rest.resource.conditionalUpdate [ boolean ]; # 0..1 If allows/uses conditional update fhir:CapabilityStatement.rest.resource.conditionalDelete [ code ]; # 0..1 not-supported | single | multiple - how conditional delete is supported fhir:CapabilityStatement.rest.resource.referencePolicy [ code ], ... ; # 0..* literal | logical | resolves | enforced | local fhir:CapabilityStatement.rest.resource.searchInclude [ string ], ... ; # 0..* _include values supported by the server fhir:CapabilityStatement.rest.resource.searchRevInclude [ string ], ... ; # 0..* _revinclude values supported by the server fhir:CapabilityStatement.rest.resource.searchParam [ # 0..* Search parameters supported by implementation fhir:CapabilityStatement.rest.resource.searchParam.name [ string ]; # 1..1 Name of search parameterfhir: fhir: fhir:fhir:CapabilityStatement.rest.resource.searchParam.definition [ canonical(SearchParameter) ]; # 0..1 Source of definition for parameter fhir:CapabilityStatement.rest.resource.searchParam.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri | special fhir:CapabilityStatement.rest.resource.searchParam.documentation [ markdown ]; # 0..1 Server-specific usage ], ...; fhir:CapabilityStatement.rest.resource.operation [ # 0..* Definition of a resource operation fhir:CapabilityStatement.rest.resource.operation.name [ string ]; # 1..1 Name by which the operation/query is invokedfhir:fhir:CapabilityStatement.rest.resource.operation.definition [ canonical(OperationDefinition) ]; # 1..1 The defined operation/query fhir:CapabilityStatement.rest.resource.operation.documentation [ markdown ]; # 0..1 Specific details about operation behavior ], ...; ], ...; fhir:CapabilityStatement.rest.interaction [ # 0..* What operations are supported? fhir:CapabilityStatement.rest.interaction.code [ code ]; # 1..1 transaction | batch | search-system | history-systemfhir:fhir:CapabilityStatement.rest.interaction.documentation [ markdown ]; # 0..1 Anything special about operation behavior ], ...; fhir:CapabilityStatement.rest.searchParam [ See CapabilityStatement.rest.resource.searchParam ], ... ; # 0..* Search parameters for searching all resources fhir:CapabilityStatement.rest.operation [ See CapabilityStatement.rest.resource.operation ], ... ; # 0..* Definition of a system level operation fhir:CapabilityStatement.rest.compartment [ canonical(CompartmentDefinition) ], ... ; # 0..* Compartments served/used by system ], ...; fhir:CapabilityStatement.messaging [ # 0..* If messaging is supported fhir:CapabilityStatement.messaging.endpoint [ # 0..* Where messages should be sent fhir:CapabilityStatement.messaging.endpoint.protocol [ Coding ]; # 1..1 http | ftp | mllp + fhir:CapabilityStatement.messaging.endpoint.address [ url ]; # 1..1 Network address or identifier of the end-point ], ...; fhir:CapabilityStatement.messaging.reliableCache [ unsignedInt ]; # 0..1 Reliable Message Cache Length (min)fhir:fhir:CapabilityStatement.messaging.documentation [ markdown ]; # 0..1 Messaging interface behavior details fhir:CapabilityStatement.messaging.supportedMessage [ # 0..* Messages supported by this system fhir:CapabilityStatement.messaging.supportedMessage.mode [ code ]; # 1..1 sender | receiver fhir:CapabilityStatement.messaging.supportedMessage.definition [ canonical(MessageDefinition) ]; # 1..1 Message supported by this system ], ...; ], ...; fhir:CapabilityStatement.document [ # 0..* Document definition fhir:CapabilityStatement.document.mode [ code ]; # 1..1 producer | consumerfhir:fhir:CapabilityStatement.document.documentation [ markdown ]; # 0..1 Description of document support fhir:CapabilityStatement.document.profile [ canonical(StructureDefinition) ]; # 1..1 Constraint on the resources used in the document ], ...; ]
Changes
since
DSTU2
Release
3
CapabilityStatement | |
|
|
|
|
CapabilityStatement.fhirVersion |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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). )
Alternate
See
the
Profiles
&
Extensions
and
the
alternate
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
,
the
extensions
spreadsheet
version
&
the
dependency
analysis
a
Path | Definition | Type | Reference |
---|---|---|---|
CapabilityStatement.status | The lifecycle status of an artifact. | Required | PublicationStatus |
CapabilityStatement.jurisdiction |
Countries
and
regions
within
which
this
artifact
is
targeted
for
| Extensible | Jurisdiction ValueSet |
CapabilityStatement.kind | How a capability statement is intended to be used. | Required | CapabilityStatementKind |
CapabilityStatement.fhirVersion |
All
published
FHIR
| Required |
|
CapabilityStatement.format
| The mime type of an attachment. Any valid mime type is allowed. | Required |
|
CapabilityStatement.patchFormat | The mime type of an attachment. Any valid mime type is allowed. | Required | Mime Types |
CapabilityStatement.rest.mode | The mode of a RESTful capability statement. | Required | RestfulCapabilityMode |
CapabilityStatement.rest.security.service | Types of security services used with FHIR. | Extensible | RestfulSecurityService |
CapabilityStatement.rest.resource.type | One of the resource types defined as part of this version of FHIR. | Required |
|
CapabilityStatement.rest.resource.interaction.code | Operations supported by REST at the type or instance level. | Required | TypeRestfulInteraction |
CapabilityStatement.rest.resource.versioning | How the system supports versioning for a resource. | Required | ResourceVersionPolicy |
CapabilityStatement.rest.resource.conditionalRead | A code that indicates how the server supports conditional read. | Required | ConditionalReadStatus |
CapabilityStatement.rest.resource.conditionalDelete | A code that indicates how the server supports conditional delete. | Required | ConditionalDeleteStatus |
CapabilityStatement.rest.resource.referencePolicy | A set of flags that defines how references are supported. | Required | ReferenceHandlingPolicy |
CapabilityStatement.rest.resource.searchParam.type | Data types allowed to be used for search parameters. | Required | SearchParamType |
CapabilityStatement.rest.interaction.code | Operations supported by REST at the system level. | Required | SystemRestfulInteraction |
CapabilityStatement.messaging.endpoint.protocol | The protocol used for message transport. | Extensible | MessageTransport |
CapabilityStatement.messaging.supportedMessage.mode | The mode of a message capability statement. | Required | EventCapabilityMode |
CapabilityStatement.document.mode | Whether the application produces or consumes documents. | Required | DocumentMode |
id | Level | Location | Description | Expression |
cnl-0 | Warning | (base) | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
cpb-1
| Rule | (base) |
A
Capability
Statement
SHALL
have
at
least
one
of
REST,
messaging
or
document
element.
|
|
|
| (base) |
A
Capability
Statement
SHALL
have
at
least
one
of
description,
software,
or
implementation
element.
|
|
cpb-3
| Rule | (base) |
Messaging
end-point
is
required
(and
is
only
permitted)
when
a
statement
is
for
an
implementation.
|
|
cpb-7
| Rule | (base) |
The
set
of
documents
must
be
unique
by
the
combination
of
profile
and
mode.
|
|
cpb-9
| Rule | CapabilityStatement.rest |
A
given
resource
can
only
be
described
once
per
RESTful
mode.
|
|
cpb-12 | Rule | CapabilityStatement.rest.resource | Search parameter names must be unique in the context of a resource. | searchParam.select(name).isDistinct() |
cpb-14 | Rule | (base) | If kind = instance, implementation must be present and software may be present | (kind != 'instance') or implementation.exists() |
cpb-15 | Rule | (base) | If kind = capability, implementation must be absent, software must be present | (kind != 'capability') or (implementation.exists().not() and software.exists()) |
cpb-16 | Rule | (base) | If kind = requirements, implementation and software must be absent | (kind!='requirements') or (implementation.exists().not() and software.exists().not()) |
supportedMessage
element
can
be
used
in
place
of
the
event
and
the
work
group
believes
it
may
meet
implementer
needs
better,
however
because
the
new
mechanism
has
not
yet
been
reviewed
by
ballot,
the
older
'event'
mechanism
has
been
retained.
Implementers
may
use
one
or
the
other
to
define
their
capabilities.
Feedback
is
welcome.
CapabilityStatement
resource
does
not
attempt
to
describe
service-based
use
of
resources.
The
various
service
specifications
will
need
to
describe
this
usage
in
their
own
way.
A CapabilityStatement declares two different kinds of profiles for the functionality it describes. For a discussion of the use of these two types of resources, see two uses for profiles .
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
context TU | token | A use context assigned to the capability statement | (CapabilityStatement.useContext.value as CodeableConcept) | |
context-quantity TU | quantity | A quantity- or range-valued use context assigned to the capability statement | (CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range) | |
context-type TU | token | A type of use context assigned to the capability statement | CapabilityStatement.useContext.code | |
context-type-quantity TU | composite | A use context type and quantity- or range-based value assigned to the capability statement |
On
CapabilityStatement.useContext:
context-type: code context-quantity: value.as(Quantity) | value.as(Range) | |
context-type-value TU | composite | A use context type and value assigned to the capability statement |
On
CapabilityStatement.useContext:
context-type: code context: value.as(CodeableConcept) | |
date | date | The capability statement publication date | CapabilityStatement.date | |
description | string | The description of the capability statement | CapabilityStatement.description | |
fhirversion | token | The version of FHIR | CapabilityStatement.version | |
format | token | formats supported (xml | json | ttl | mime type) | CapabilityStatement.format | |
guide | reference | Implementation guides supported |
CapabilityStatement.implementationGuide
( ImplementationGuide ) | |
jurisdiction TU | token | Intended jurisdiction for the capability statement | CapabilityStatement.jurisdiction | |
mode | token | Mode - restful (server/client) or messaging (sender/receiver) | CapabilityStatement.rest.mode | |
name | string | Computationally friendly name of the capability statement | CapabilityStatement.name | |
publisher | string | Name of the publisher of the capability statement | CapabilityStatement.publisher | |
resource | token | Name of a resource mentioned in a capability statement | CapabilityStatement.rest.resource.type | |
resource-profile | reference | A profile id invoked in a capability statement |
CapabilityStatement.rest.resource.profile
( StructureDefinition ) | |
security-service TU | token | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates | CapabilityStatement.rest.security.service | |
software | string |
Part
of
| CapabilityStatement.software.name | |
status | token | The current status of the capability statement | CapabilityStatement.status | |
supported-profile | reference | Profiles for use cases supported |
CapabilityStatement.rest.resource.supportedProfile
( StructureDefinition ) | |
title | string | The human-friendly name of the capability statement | CapabilityStatement.title | |
url | uri | The uri that identifies the capability statement | CapabilityStatement.url | |
version | token | The business version of the capability statement | CapabilityStatement.version |