Release 4
ConformanceThis page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU) 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
| FHIR Infrastructure Work Group | Maturity Level: N | Normative (from v4.0.0) | Security Category: Anonymous | Compartments: Not linked to any defined compartments |
|
This page has been approved as part of an ANSI standard.
See the Conformance Package for further details.
|
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 itself and TestScript
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CapabilityStatement | IN | 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 | ΣITU | 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 | ΣITU | 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)
XML Template
<CapabilityStatement xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <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]"/><!--
JSON Template
{
"resourceType" : "CapabilityStatement",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"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/> .
Changes since R3
| CapabilityStatement | |
| CapabilityStatement |
|
| CapabilityStatement.status |
|
| CapabilityStatement.experimental |
|
| CapabilityStatement.kind |
|
| CapabilityStatement.instantiates |
|
| CapabilityStatement.imports |
|
| CapabilityStatement.implementation.url |
|
| CapabilityStatement.implementation.custodian |
|
| CapabilityStatement.fhirVersion |
|
| CapabilityStatement.format |
|
| CapabilityStatement.patchFormat |
|
| CapabilityStatement.implementationGuide |
|
| CapabilityStatement.rest.mode |
|
| CapabilityStatement.rest.documentation |
|
| CapabilityStatement.rest.security.service |
|
| CapabilityStatement.rest.security.description |
|
| CapabilityStatement.rest.resource.type |
|
| CapabilityStatement.rest.resource.profile |
|
| CapabilityStatement.rest.resource.supportedProfile |
|
| CapabilityStatement.rest.resource.interaction |
|
| CapabilityStatement.rest.resource.interaction.code |
|
| CapabilityStatement.rest.resource.interaction.documentation |
|
| CapabilityStatement.rest.resource.versioning |
|
| CapabilityStatement.rest.resource.conditionalRead |
|
| CapabilityStatement.rest.resource.conditionalDelete |
|
| CapabilityStatement.rest.resource.referencePolicy |
|
| CapabilityStatement.rest.resource.searchParam.definition |
|
| CapabilityStatement.rest.resource.searchParam.type |
|
| CapabilityStatement.rest.resource.searchParam.documentation |
|
| CapabilityStatement.rest.resource.operation |
|
| CapabilityStatement.rest.resource.operation.name |
|
| CapabilityStatement.rest.resource.operation.definition |
|
| CapabilityStatement.rest.resource.operation.documentation |
|
| CapabilityStatement.rest.interaction.code |
|
| CapabilityStatement.rest.interaction.documentation |
|
| CapabilityStatement.rest.operation |
|
| CapabilityStatement.rest.compartment |
|
| CapabilityStatement.messaging.endpoint.protocol |
|
| CapabilityStatement.messaging.endpoint.address |
|
| CapabilityStatement.messaging.documentation |
|
| CapabilityStatement.messaging.supportedMessage.mode |
|
| CapabilityStatement.messaging.supportedMessage.definition |
|
| CapabilityStatement.document.mode |
|
| CapabilityStatement.document.documentation |
|
| CapabilityStatement.document.profile |
|
| CapabilityStatement.acceptUnknown |
|
| CapabilityStatement.rest.security.certificate |
|
| CapabilityStatement.rest.operation.name |
|
| CapabilityStatement.rest.operation.definition |
|
| CapabilityStatement.messaging.event |
|
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 |
|---|---|---|---|---|
| CapabilityStatement | IN | 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 | ΣITU | 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 | ΣITU | 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 | ||||
XML Template
<CapabilityStatement xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "CapabilityStatement",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"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/> .
Changes since Release 3
| CapabilityStatement | |
| CapabilityStatement |
|
| CapabilityStatement.status |
|
| CapabilityStatement.experimental |
|
| CapabilityStatement.kind |
|
| CapabilityStatement.instantiates |
|
| CapabilityStatement.imports |
|
| CapabilityStatement.implementation.url |
|
| CapabilityStatement.implementation.custodian |
|
| CapabilityStatement.fhirVersion |
|
| CapabilityStatement.format |
|
| CapabilityStatement.patchFormat |
|
| CapabilityStatement.implementationGuide |
|
| CapabilityStatement.rest.mode |
|
| CapabilityStatement.rest.documentation |
|
| CapabilityStatement.rest.security.service |
|
| CapabilityStatement.rest.security.description |
|
| CapabilityStatement.rest.resource.type |
|
| CapabilityStatement.rest.resource.profile |
|
| CapabilityStatement.rest.resource.supportedProfile |
|
| CapabilityStatement.rest.resource.interaction |
|
| CapabilityStatement.rest.resource.interaction.code |
|
| CapabilityStatement.rest.resource.interaction.documentation |
|
| CapabilityStatement.rest.resource.versioning |
|
| CapabilityStatement.rest.resource.conditionalRead |
|
| CapabilityStatement.rest.resource.conditionalDelete |
|
| CapabilityStatement.rest.resource.referencePolicy |
|
| CapabilityStatement.rest.resource.searchParam.definition |
|
| CapabilityStatement.rest.resource.searchParam.type |
|
| CapabilityStatement.rest.resource.searchParam.documentation |
|
| CapabilityStatement.rest.resource.operation |
|
| CapabilityStatement.rest.resource.operation.name |
|
| CapabilityStatement.rest.resource.operation.definition |
|
| CapabilityStatement.rest.resource.operation.documentation |
|
| CapabilityStatement.rest.interaction.code |
|
| CapabilityStatement.rest.interaction.documentation |
|
| CapabilityStatement.rest.operation |
|
| CapabilityStatement.rest.compartment |
|
| CapabilityStatement.messaging.endpoint.protocol |
|
| CapabilityStatement.messaging.endpoint.address |
|
| CapabilityStatement.messaging.documentation |
|
| CapabilityStatement.messaging.supportedMessage.mode |
|
| CapabilityStatement.messaging.supportedMessage.definition |
|
| CapabilityStatement.document.mode |
|
| CapabilityStatement.document.documentation |
|
| CapabilityStatement.document.profile |
|
| CapabilityStatement.acceptUnknown |
|
| CapabilityStatement.rest.security.certificate |
|
| CapabilityStatement.rest.operation.name |
|
| CapabilityStatement.rest.operation.definition |
|
| CapabilityStatement.messaging.event |
|
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
| 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 use. | Extensible | Jurisdiction ValueSet |
| CapabilityStatement.kind | How a capability statement is intended to be used. | Required | CapabilityStatementKind |
| CapabilityStatement.fhirVersion | All published FHIR Versions. | Required | FHIRVersion |
| CapabilityStatement.format 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 | Resource Types |
| 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 |
| cpb-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. | rest.exists() or messaging.exists() or document.exists() |
| cpb-2 | Rule | (base) | A Capability Statement SHALL have at least one of description, software, or implementation element. | (description.count() + software.count() + implementation.count()) > 0 |
| cpb-3 | Rule | (base) | Messaging end-point is required (and is only permitted) when a statement is for an implementation. | messaging.endpoint.empty() or kind = 'instance' |
| cpb-7 | Rule | (base) | The set of documents must be unique by the combination of profile and mode. | document.select(profile&mode).isDistinct() |
| cpb-9 | Rule | CapabilityStatement.rest | A given resource can only be described once per RESTful mode. | resource.select(type).isDistinct() |
| 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 TU | date | The capability statement publication date | CapabilityStatement.date | |
| description TU | string | The description of the capability statement | CapabilityStatement.description | |
| fhirversion TU | token | The version of FHIR | CapabilityStatement.version | |
| format TU | token | formats supported (xml | json | ttl | mime type) | CapabilityStatement.format | |
| guide TU | reference | Implementation guides supported | CapabilityStatement.implementationGuide (ImplementationGuide) | |
| jurisdiction TU | token | Intended jurisdiction for the capability statement | CapabilityStatement.jurisdiction | |
| mode TU | token | Mode - restful (server/client) or messaging (sender/receiver) | CapabilityStatement.rest.mode | |
| name TU | string | Computationally friendly name of the capability statement | CapabilityStatement.name | |
| publisher TU | string | Name of the publisher of the capability statement | CapabilityStatement.publisher | |
| resource TU | token | Name of a resource mentioned in a capability statement | CapabilityStatement.rest.resource.type | |
| resource-profile TU | 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 TU | string | Part of the name of a software application | CapabilityStatement.software.name | |
| status TU | token | The current status of the capability statement | CapabilityStatement.status | |
| supported-profile TU | reference | Profiles for use cases supported | CapabilityStatement.rest.resource.supportedProfile (StructureDefinition) | |
| title TU | string | The human-friendly name of the capability statement | CapabilityStatement.title | |
| url TU | uri | The uri that identifies the capability statement | CapabilityStatement.url | |
| version TU | token | The business version of the capability statement | CapabilityStatement.version |
®© HL7.org 2011+. FHIR Release 4 (Technical Correction #1) (v4.0.1) generated on Fri, Nov 1, 2019 09:34+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to R3 |
|
Propose a change