FHIR Release 3 (STU) R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.0.2: STU 3). (v3.3.0: R4 Ballot 2). 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

5.2 Resource CapabilityStatement - Content

FHIR Infrastructure Work Group Maturity Level : 3   Trial Use Normative Compartments : Not linked to any defined compartments

Normative Candidate Note: This page is candidate normative content for R4 in the Conformance Package . Once normative, it will lose it's Maturity Level, and breaking changes will no longer be made.

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

5.2.1 Scope and Usage

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 either 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:

5.2.1.1 Describe an actual implementation

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 profile 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.

5.2.1.2 Describe software solution capabilities

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.

5.2.1.3 Describe a desired solution

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.

5.2.2 Background and Context

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 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.

This resource is referenced by testscript

5.2.3 Resource Content

Structure

profile Σ 0..* Reference ( StructureDefinition ) Profiles for use cases supported certificate 0..* BackboneElement Certificates associated with security profiles type 0..1 code Mime type for certificates MimeType ( Required ) blob 0..1 base64Binary Actual certificate SystemRestfulInteraction event Σ 0..* BackboneElement Declare support for this event code Σ 1..1 Coding Event type MessageEvent ( Example ) category 0..1 code Consequence | Currency | Notification MessageSignificanceCategory ( Required ) mode 1..1 code sender | receiver EventCapabilityMode ( Required ) focus 1..1 code Resource that's focus of message ResourceType ( Required ) request Σ 1..1 Reference ( StructureDefinition ) Profile that describes the request response Σ 1..1 Reference ( StructureDefinition ) Profile that describes the response documentation 0..1 string Endpoint-specific event documentation
Name Flags Card. Type Description & Constraints doco
. . CapabilityStatement I N DomainResource A statement of system capabilities
+ There can only be one REST declaration per mode.
+ The set of documents must be unique by the combination of profile and mode.
+ Capability Statements of kind 'instance' do not cannot have implementation elements. elements unless kind is 'instance'
+ Messaging end-point is required (and is only permitted) when a statement is for an implementation.
+ Capability Statements of kind 'requirements' do not have software or implementation elements.
+ A Capability Statement SHALL have at least one of description, software, or implementation element.
+ A Capability Statement SHALL have at least one of REST, messaging or document element.
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . url Σ 0..1 uri Logical URI to reference Canonical identifier for this capability statement statement, represented as a URI (globally unique)
. . . version Σ 0..1 string Business version of the capability statement
. . . name Σ 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 this was 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 Context The context that the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for capability statement (if applicable)
Jurisdiction ValueSet ( 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..* uri canonical Canonical URL of another capability statement this implements
. . . 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 uri url Base URL for the installation
. . . fhirVersion Σ 1..1 id FHIR Version the system uses acceptUnknown Σ 1..1 code no | extensions | elements | both
UnknownContentCode All Published FHIR versions ( Required )
. . . format Σ 1..* code formats supported (xml | json | ttl | mime type)
MimeType ( Required )
. . . patchFormat Σ 0..* code Patch formats supported
MimeType ( Required )
. . . implementationGuide Σ 0..* uri canonical Implementation guides supported
. . . rest Σ I 0..* BackboneElement If the endpoint is a RESTful one
+ A given resource can only be described once per RESTful mode.
. . . . mode Σ 1..1 code client | server
RestfulCapabilityMode ( Required )
. . . . documentation 0..1 string 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 string General description of how security works
. . . . resource Σ I 0..* BackboneElement Resource served on the REST interface
+ 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 Reference ( StructureDefinition canonical ) Base System profile for all uses of resource
. . . . . supportedProfile Σ 0..* canonical Profiles for use cases supported
..... documentation 0..1 markdown Additional information about the use of the resource type
. . . . . interaction 1..* 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 string Anything special about operation behavior
. . . . . versioning 0..1 code no-version | versioned | versioned-update
ResourceVersionPolicy ( Required )
. . . . . readHistory 0..1 boolean Whether vRead can return past versions
. . . . . updateCreate 0..1 boolean If update can commit to a new identity
. . . . . conditionalCreate 0..1 boolean If allows/uses conditional create
. . . . . conditionalRead 0..1 code not-supported | modified-since | not-match | full-support
ConditionalReadStatus ( Required )
. . . . . conditionalUpdate 0..1 boolean If allows/uses conditional update
. . . . . conditionalDelete 0..1 code not-supported | single | multiple - how conditional delete is supported
ConditionalDeleteStatus ( Required )
. . . . . referencePolicy 0..* code literal | logical | resolves | enforced | local
ReferenceHandlingPolicy ( Required )
. . . . . searchInclude 0..* string _include values supported by the server
. . . . . searchRevInclude 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 uri canonical Source of definition for parameter
. . . . . . type 1..1 code number | date | string | token | reference | composite | quantity | uri
SearchParamType ( Required )
. . . . . . documentation 0..1 string Server-specific usage
. . . . . interaction operation Σ 0..* BackboneElement What operations are supported? Definition of a resource operation
. . . . . . code name Σ 1..1 code string transaction | batch | search-system | history-system Name by which the operation/query is invoked
. . . . . . definition ( Required ) Σ 1..1 canonical The defined operation/query
. . . . . . documentation 0..1 string markdown Anything special Specific details about operation behavior
. . . searchParam . interaction 0..* see searchParam BackboneElement Search parameters for searching all resources What operations are supported?
. . . . operation . code Σ 0..* 1..1 BackboneElement code Definition of an operation or a custom query transaction | batch | search-system | history-system
SystemRestfulInteraction ( Required )
. . . . . name documentation 1..1 0..1 string Name by which the operation/query is invoked Anything special about operation behavior
. . . . searchParam 0..* see searchParam Search parameters for searching all resources
. . . definition . operation Σ 1..1 0..* Reference ( OperationDefinition see operation ) The defined operation/query Definition of a system level operation
. . . . compartment 0..* uri canonical Compartments served/used by system
. . . messaging Σ I TU 0..* BackboneElement If messaging is supported
+ A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both.
. . . . endpoint 0..* BackboneElement Where messages should be sent
. . . . . protocol 1..1 Coding http | ftp | mllp +
MessageTransport ( Extensible )
. . . . . address 1..1 uri url Network address or identifier of the end-point
. . . . reliableCache 0..1 unsignedInt Reliable Message Cache Length (min)
. . . . documentation 0..1 string Messaging interface behavior details
. . . . supportedMessage Σ 0..* BackboneElement Messages supported by this system
. . . . . mode Σ 1..1 code sender | receiver
EventCapabilityMode ( Required )
. . . . . definition Σ 1..1 Reference ( MessageDefinition canonical ) Message supported by this system
. . . document Σ I TU 0..* BackboneElement Document definition
. . . . mode Σ 1..1 code producer | consumer
DocumentMode ( Required )
. . . . documentation 0..1 string Description of document support
. . . . profile Σ 1..1 Reference ( StructureDefinition canonical ) Constraint on a resource the resources used in the document

doco Documentation for this format

UML Diagram ( Legend )

CapabilityStatement ( DomainResource ) An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. instance; also called its canonical identifier. This SHALL be a URL, SHOULD be globally unique, unique and SHOULD be an a literal address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions) published url : uri [0..1] The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence version : string [0..1] A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1] A short, descriptive, user-friendly title for the capability statement title : string [0..1] The status of this capability statement. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of a Value Set or Concept Map. an artifact. (Strength=Required) PublicationStatus ! » A boolean Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), education/evaluation/marketing) and is not intended to be used for genuine usage (this element modifies the meaning of other elements) experimental : boolean [0..1] The date (and optionally time) when the capability statement was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes date : dateTime [1..1] The name of the individual or organization or individual that published the capability statement publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP description : markdown [0..1] The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances useContext : UsageContext [0..*] A legal or geographic region in which the capability statement is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible) Jurisdiction ValueSet + » Explaination Explanation of why this capability statement is needed and why it has been designed as it has purpose : markdown [0..1] A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement copyright : markdown [0..1] The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind (kind, not instance of software) or a class of implementation (e.g. a desired purchase) kind : code [1..1] « How a capability statement is intended to be used. (Strength=Required) CapabilityStatementKind ! » Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so instantiates : uri canonical [0..*] The version of the FHIR specification on which this capability statement is based fhirVersion : id [1..1] A code that indicates whether the application accepts unknown elements or extensions when reading resources acceptUnknown : code [1..1] « A code that indicates whether an application accepts unknown elements or extensions when reading resources. All published FHIR Versions (Strength=Required) UnknownContentCode All Published FHIR versions ! » A list of the formats supported by this implementation using their content types format : code [1..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required) MimeType ! » A list of the patch formats supported by this implementation using their content types patchFormat : code [0..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required) MimeType ! » A list of implementation guides that the server does (or should) support in their entirety implementationGuide : uri canonical [0..*] A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses) profile : Reference [0..*] StructureDefinition Software Name the software is known by name : string [1..1] The version identifier for the software covered by this statement version : string [0..1] Date this version of the software was released releaseDate : dateTime [0..1] Implementation Information about the specific installation that this capability statement relates to description : string [1..1] An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces url : uri url [0..1] Rest Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations mode : code [1..1] « The mode of a RESTful capability statement. (Strength=Required) RestfulCapabilityMode ! » Information about the system's restful capabilities that apply across all applications, such as security documentation : string [0..1] An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL compartment : uri canonical [0..*] Security Server adds CORS headers when responding to requests - this enables javascript Javascript applications to use the server cors : boolean [0..1] Types of security services that are supported/required by the system service : CodeableConcept [0..*] « Types of security services used with FHIR. (Strength=Extensible) RestfulSecurityService + » General description of how security works description : string [0..1] Certificate Mime type for a certificate type : code [0..1] The mime type of an attachment. Any valid mime type is allowed. (Strength=Required) MimeType ! Actual certificate blob : base64Binary [0..1] Resource A type of resource exposed via the restful interface type : code [1..1] « One of the resource types defined as part of this version of FHIR. (Strength=Required) ResourceType ! » A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses) profile : Reference canonical [0..1] StructureDefinition A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses) supportedProfile : canonical [0..*] Additional information about the resource type used by the system documentation : markdown [0..1] This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API versioning : code [0..1] « How the system supports versioning for a resource. (Strength=Required) ResourceVersionPolicy ! » A flag for whether the server is able to return past versions as part of the vRead operation readHistory : boolean [0..1] A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server updateCreate : boolean [0..1] A flag that indicates that the server supports conditional create conditionalCreate : boolean [0..1] A code that indicates how the server supports conditional read conditionalRead : code [0..1] « A code that indicates how the server supports conditional read. (Strength=Required) ConditionalReadStatus ! » A flag that indicates that the server supports conditional update conditionalUpdate : boolean [0..1] A code that indicates how the server supports conditional delete conditionalDelete : code [0..1] « A code that indicates how the server supports conditional delete. (Strength=Required) ConditionalDeleteStatus ! » A set of flags that defines how references are supported referencePolicy : code [0..*] « A set of flags that defines how references are supported. (Strength=Required) ReferenceHandlingPolicy ! » A list of _include values supported by the server searchInclude : string [0..*] A list of _revinclude (reverse include) values supported by the server searchRevInclude : string [0..*] ResourceInteraction Coded identifier of the operation, supported by the system resource code : code [1..1] « Operations supported by REST at the type or instance level. (Strength=Required) TypeRestfulInteraction ! » Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only' documentation : string [0..1] SearchParam The name of the search parameter used in the interface name : string [1..1] An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]) definition : uri canonical [0..1] The type of value a search parameter refers to, and how the content is interpreted type : code [1..1] « Data types allowed to be used for search parameters. (Strength=Required) SearchParamType ! » This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms documentation : string [0..1] Operation The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called name : string [1..1] Where the formal definition can be found definition : canonical [1..1] Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation documentation : markdown [0..1] SystemInteraction A coded identifier of the operation, supported by the system code : code [1..1] « Operations supported by REST at the system level. (Strength=Required) SystemRestfulInteraction ! » Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented documentation : string [0..1] Operation The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called name : string [1..1] Where the formal definition can be found definition : Reference [1..1] OperationDefinition Messaging Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender) reliableCache : unsignedInt [0..1] Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner documentation : string [0..1] Endpoint A list of the messaging transport protocol(s) identifiers, supported by this endpoint protocol : Coding [1..1] « The protocol used for message transport. (Strength=Extensible) MessageTransport + » The network address of the end-point. endpoint. For solutions that do not use network addresses for routing, it can be just an identifier address : uri url [1..1] SupportedMessage The mode of this event declaration - whether application is sender or receiver mode : code [1..1] « The mode of a message capability statement. (Strength=Required) EventCapabilityMode ! » Points to a message definition that identifies the messaging event, message structure, allowed responses, etc definition : Reference [1..1] MessageDefinition Event A coded identifier of a supported messaging event code : Coding [1..1] One of the message events defined as part of FHIR. (Strength=Example) MessageEvent ?? The impact of the content of the message category : code [0..1] The impact of the content of a message. (Strength=Required) MessageSignificanceCategory ! The mode of this event declaration - whether an application is a sender or receiver mode : code [1..1] The mode of a message capability statement. (Strength=Required) EventCapabilityMode ! A resource associated with the event. This is the resource that defines the event focus : code [1..1] One of the resource types defined as part of FHIR. (Strength=Required) ResourceType ! Information about the request for this event request : Reference [1..1] StructureDefinition Information about the response for this event response : Reference canonical [1..1] StructureDefinition Guidance on how this event is handled, such as internal system trigger points, business rules, etc documentation : string [0..1] Document Mode of this document declaration - whether an application is a producer or consumer mode : code [1..1] « Whether the application produces or consumes documents. (Strength=Required) DocumentMode ! » A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc documentation : string [0..1] A constraint profile on a resource used in the document Bundle that constrains which resources are present, and their contents profile : Reference canonical [1..1] StructureDefinition Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation software [0..1] Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program implementation [0..1] Certificates associated with security profiles certificate [0..*] Information about security implementation from an interface perspective - what a client needs to know security [0..1] Identifies a restful operation supported by the solution interaction [1..*] [0..*] Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation searchParam [0..*] Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters operation [0..*] A specification of the restful capabilities of the solution for a specific resource type resource [0..*] A specification of restful operations supported by the system interaction [0..*] Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation searchParam [0..*] Definition of an operation or a named query together with its parameters and their meaning and type operation [0..*] A definition of the restful capabilities of the solution, if any rest [0..*] An endpoint (network accessible address) to which messages and/or replies are to be sent endpoint [0..*] References to message definitions for messages this system can send or receive supportedMessage [0..*] A description of the solution's support for an event at this end-point event [0..*] A description of the messaging capabilities of the solution messaging [0..*] A document definition document [0..*]

XML Template 

<

<CapabilityStatement xmlns="http://hl7.org/fhir"> doco

 <!-- 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>
 <
 <</useContext>

 <description value="[markdown]"/><!-- ?? 0..1 Natural language description of the capability statement -->
 <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 -->
 <kind value="[code]"/><!-- ?? 1..1 instance | capability | requirements -->
 <instantiates><!-- 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this implements --></instantiates>

 <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 -->

 </implementation>
 <
 <
 <
 <
 <
 <</profile>

 <fhirVersion value="[id]"/><!-- 1..1 FHIR Version the system uses -->
 <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="[string]"/><!-- 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>
   <
   <
    <
    <
   </certificate>

   <description value="[string]"/><!-- 0..1 General description of how security works -->

  </security>
  <resource>  <!-- 0..* Resource served on the REST interface -->
   <
   <</profile>
   <
   <
    <
    <

   <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="[string]"/><!-- 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><!-- 0..1 canonical(SearchParameter) Source of definition for parameter --></definition>
    <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri -->
    <documentation value="[string]"/><!-- 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><!-- 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="[string]"/><!-- 0..1 Anything special about operation behavior -->

  </interaction>
  <searchParam><!-- 0..* Content as for CapabilityStatement.rest.resource.searchParam Search parameters for searching all resources --></searchParam>
  <
   <
   <</definition>
  </operation>
  <

  <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="[string]"/><!-- 0..1 Messaging interface behavior details -->

  <supportedMessage>  <!-- 0..* Messages supported by this system -->
   <
   <</definition>

   <mode value="[code]"/><!-- 1..1 sender | receiver -->
   <definition><!-- 1..1 canonical(MessageDefinition) Message supported by this system --></definition>

  </supportedMessage>
  <
   <</code>
   <
   <
   <
   <</request>
   <</response>
   <
  </event>

 </messaging>
 <document>  <!-- ?? 0..* Document definition -->
  <
  <
  <</profile>

  <mode value="[code]"/><!-- 1..1 producer | consumer -->
  <documentation value="[string]"/><!-- 0..1 Description of document support -->
  <profile><!-- 1..1 canonical(StructureDefinition) Constraint on the resources used in the document --></profile>

 </document>
</CapabilityStatement>

JSON Template 

{doco
  "resourceType" : "",

  "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>", // 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>"], // Canonical URL of another capability statement this implements
  "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

  },
  "
  "
  "
  "
  "
  "
  "
    "
    "
    "
      "
      "
      "
      "
        "
        "
      }]

  "fhirVersion" : "<id>", // R!  FHIR Version the system uses
  "format" : ["<code>"], // R!  formats supported (xml | json | ttl | mime type) 
  "patchFormat" : ["<code>"], // Patch formats supported 
  "implementationGuide" : ["<canonical>"], // Implementation guides supported
  "rest" : [{ // C? If the endpoint is a RESTful one
    "mode" : "<code>", // R!  client | server
    "documentation" : "<string>", // 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" : "<string>" // General description of how security works

    },
    "
      "
      "
      "
      "
        "
        "

    "resource" : [{ // Resource served on the REST interface
      "type" : "<code>", // R!  A resource type that is supported
      "profile" : "<canonical>", // Base System profile for all uses of resource
      "supportedProfile" : ["<canonical>"], // 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" : "<string>" // 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>", // Source of definition for parameter
        "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri
        "documentation" : "<string>" // Server-specific usage
      }],
      "operation" : [{ // Definition of a resource operation
        "name" : "<string>", // R!  Name by which the operation/query is invoked
        "definition" : "<canonical>", // 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" : "<string>" // 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>"] // 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" : "<string>", // Messaging interface behavior details
    "supportedMessage" : [{ // Messages supported by this system
      "mode" : "<code>", // R!  sender | receiver
      "definition" : "<canonical>" // R!  Message supported by this system

    }]
  }],
  "
    "
    "
    "

  "document" : [{ // C? Document definition
    "mode" : "<code>", // R!  producer | consumer
    "documentation" : "<string>", // Description of document support
    "profile" : "<canonical>" // R!  Constraint on the resources used in the document

  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:CapabilityStatement;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  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 | unknown
  fhir:
  fhir:
  fhir:

  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 statement
  fhir:

  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:

  fhir:CapabilityStatement.purpose [ markdown ]; # 0..1 Why this capability statement is defined

  fhir:CapabilityStatement.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:
  fhir:

  fhir:CapabilityStatement.kind [ code ]; # 1..1 instance | capability | requirements
  fhir:CapabilityStatement.instantiates [ canonical(CapabilityStatement) ], ... ; # 0..* Canonical URL of another capability statement this implements

  fhir:CapabilityStatement.software [ # 0..1 Software that is covered by this capability statement
    fhir:

    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:

    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:

    fhir:CapabilityStatement.implementation.url [ url ]; # 0..1 Base URL for the installation

  ];
  fhir:CapabilityStatement.fhirVersion [ id ]; # 1..1 FHIR Version the system uses
  fhir:

  fhir:CapabilityStatement.format [ code ], ... ; # 1..* formats supported (xml | json | ttl | mime type)
  fhir:CapabilityStatement.patchFormat [ code ], ... ; # 0..* Patch formats supported
  fhir:
  fhir:

  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 | server
    fhir:CapabilityStatement.rest.documentation [ string ]; # 0..1 General description of implementation
    fhir:CapabilityStatement.rest.security [ # 0..1 Information about security of implementation
      fhir:

      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 | Certificates
      fhir:CapabilityStatement.rest.security.description [ string ]; # 0..1 General description of how security works
      fhir:
        fhir:
        fhir:
      ], ...;

    ];
    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:

      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:

      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-type
        fhir:CapabilityStatement.rest.resource.interaction.documentation [ string ]; # 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:

      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 parameter
        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
        fhir:CapabilityStatement.rest.resource.searchParam.documentation [ string ]; # 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 invoked
        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-system
      fhir:CapabilityStatement.rest.interaction.documentation [ string ]; # 0..1 Anything special about operation behavior
    ], ...;
    fhir:CapabilityStatement.rest.searchParam [ See CapabilityStatement.rest.resource.searchParam ], ... ; # 0..* Search parameters for searching all resources
    fhir:
      fhir:
      fhir:
    ], ...;
    fhir:

    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:

      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:CapabilityStatement.messaging.documentation [ string ]; # 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:
    ], ...;
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      fhir:

      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 | consumer
    fhir:CapabilityStatement.document.documentation [ string ]; # 0..1 Description of document support
    fhir:

    fhir:CapabilityStatement.document.profile [ canonical(StructureDefinition) ]; # 1..1 Constraint on the resources used in the document

  ], ...;
]

Changes since DSTU2 R3

CapabilityStatement
CapabilityStatement.instantiates
  • Type changed from uri to canonical
CapabilityStatement.implementation.url
  • Type changed from uri to url
CapabilityStatement.fhirVersion
  • Add Binding http://hl7.org/fhir/ValueSet/fhir-versions (required)
CapabilityStatement.implementationGuide
  • Type changed from uri to canonical
CapabilityStatement.rest.resource.profile
  • Type changed from Reference(StructureDefinition) to canonical
CapabilityStatement.rest.resource.supportedProfile
  • Added Element
CapabilityStatement.rest.resource.interaction
  • Min Cardinality changed from 1 to 0
CapabilityStatement.rest.resource.searchParam.definition
  • Type changed from uri to canonical
CapabilityStatement.rest.resource.operation
  • Added Element
CapabilityStatement.rest.resource.operation.name
  • Added Element
CapabilityStatement.rest.resource.operation.definition
  • Added Element
CapabilityStatement.rest.resource.operation.documentation
  • Added Element
CapabilityStatement.rest.operation
  • Remove BackboneElement
CapabilityStatement.rest.compartment
  • Type changed from uri to canonical
CapabilityStatement.messaging.endpoint.address
  • Type changed from uri to url
CapabilityStatement.messaging.supportedMessage.definition
  • Type changed from Reference(MessageDefinition) to canonical
CapabilityStatement.document.profile
  • Type changed from Reference(StructureDefinition) to canonical
CapabilityStatement.acceptUnknown
  • deleted
CapabilityStatement.profile
  • deleted
CapabilityStatement.rest.security.certificate
  • deleted
CapabilityStatement.rest.operation.name
  • deleted
CapabilityStatement.rest.operation.definition
  • deleted
CapabilityStatement.messaging.event
  • deleted

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

Structure

profile Σ 0..* Reference ( StructureDefinition ) Profiles for use cases supported certificate 0..* BackboneElement Certificates associated with security profiles type 0..1 code Mime type for certificates MimeType ( Required ) blob 0..1 base64Binary Actual certificate SystemRestfulInteraction event Σ 0..* BackboneElement Declare support for this event code Σ 1..1 Coding Event type MessageEvent ( Example ) category 0..1 code Consequence | Currency | Notification MessageSignificanceCategory ( Required ) mode 1..1 code sender | receiver EventCapabilityMode ( Required ) focus 1..1 code Resource that's focus of message ResourceType ( Required ) request Σ 1..1 Reference ( StructureDefinition ) Profile that describes the request response Σ 1..1 Reference ( StructureDefinition ) Profile that describes the response documentation 0..1 string Endpoint-specific event documentation
Name Flags Card. Type Description & Constraints doco
. . CapabilityStatement I N DomainResource A statement of system capabilities
+ There can only be one REST declaration per mode.
+ The set of documents must be unique by the combination of profile and mode.
+ Capability Statements of kind 'instance' do not cannot have implementation elements. elements unless kind is 'instance'
+ Messaging end-point is required (and is only permitted) when a statement is for an implementation.
+ Capability Statements of kind 'requirements' do not have software or implementation elements.
+ A Capability Statement SHALL have at least one of description, software, or implementation element.
+ A Capability Statement SHALL have at least one of REST, messaging or document element.
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
. . . url Σ 0..1 uri Logical URI to reference Canonical identifier for this capability statement statement, represented as a URI (globally unique)
. . . version Σ 0..1 string Business version of the capability statement
. . . name Σ 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 this was 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 Context The context that the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for capability statement (if applicable)
Jurisdiction ValueSet ( 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..* uri canonical Canonical URL of another capability statement this implements
. . . 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 uri url Base URL for the installation
. . . fhirVersion Σ 1..1 id FHIR Version the system uses acceptUnknown Σ 1..1 code no | extensions | elements | both
UnknownContentCode All Published FHIR versions ( Required )
. . . format Σ 1..* code formats supported (xml | json | ttl | mime type)
MimeType ( Required )
. . . patchFormat Σ 0..* code Patch formats supported
MimeType ( Required )
. . . implementationGuide Σ 0..* uri canonical Implementation guides supported
. . . rest Σ I 0..* BackboneElement If the endpoint is a RESTful one
+ A given resource can only be described once per RESTful mode.
. . . . mode Σ 1..1 code client | server
RestfulCapabilityMode ( Required )
. . . . documentation 0..1 string 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 string General description of how security works
. . . . resource Σ I 0..* BackboneElement Resource served on the REST interface
+ 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 Reference ( StructureDefinition canonical ) Base System profile for all uses of resource
. . . . . supportedProfile Σ 0..* canonical Profiles for use cases supported
..... documentation 0..1 markdown Additional information about the use of the resource type
. . . . . interaction 1..* 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 string Anything special about operation behavior
. . . . . versioning 0..1 code no-version | versioned | versioned-update
ResourceVersionPolicy ( Required )
. . . . . readHistory 0..1 boolean Whether vRead can return past versions
. . . . . updateCreate 0..1 boolean If update can commit to a new identity
. . . . . conditionalCreate 0..1 boolean If allows/uses conditional create
. . . . . conditionalRead 0..1 code not-supported | modified-since | not-match | full-support
ConditionalReadStatus ( Required )
. . . . . conditionalUpdate 0..1 boolean If allows/uses conditional update
. . . . . conditionalDelete 0..1 code not-supported | single | multiple - how conditional delete is supported
ConditionalDeleteStatus ( Required )
. . . . . referencePolicy 0..* code literal | logical | resolves | enforced | local
ReferenceHandlingPolicy ( Required )
. . . . . searchInclude 0..* string _include values supported by the server
. . . . . searchRevInclude 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 uri canonical Source of definition for parameter
. . . . . . type 1..1 code number | date | string | token | reference | composite | quantity | uri
SearchParamType ( Required )
. . . . . . documentation 0..1 string Server-specific usage
. . . . . interaction operation Σ 0..* BackboneElement What operations are supported? Definition of a resource operation
. . . . . . code name Σ 1..1 code string transaction | batch | search-system | history-system Name by which the operation/query is invoked
. . . . . . definition ( Required ) Σ 1..1 canonical The defined operation/query
. . . . . . documentation 0..1 string markdown Anything special Specific details about operation behavior
. . . searchParam . interaction 0..* see searchParam BackboneElement Search parameters for searching all resources What operations are supported?
. . . . operation . code Σ 0..* 1..1 BackboneElement code Definition of an operation or a custom query transaction | batch | search-system | history-system
SystemRestfulInteraction ( Required )
. . . . . name documentation 1..1 0..1 string Name by which the operation/query is invoked Anything special about operation behavior
. . . . searchParam 0..* see searchParam Search parameters for searching all resources
. . . definition . operation Σ 1..1 0..* Reference ( OperationDefinition see operation ) The defined operation/query Definition of a system level operation
. . . . compartment 0..* uri canonical Compartments served/used by system
. . . messaging Σ I TU 0..* BackboneElement If messaging is supported
+ A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both.
. . . . endpoint 0..* BackboneElement Where messages should be sent
. . . . . protocol 1..1 Coding http | ftp | mllp +
MessageTransport ( Extensible )
. . . . . address 1..1 uri url Network address or identifier of the end-point
. . . . reliableCache 0..1 unsignedInt Reliable Message Cache Length (min)
. . . . documentation 0..1 string Messaging interface behavior details
. . . . supportedMessage Σ 0..* BackboneElement Messages supported by this system
. . . . . mode Σ 1..1 code sender | receiver
EventCapabilityMode ( Required )
. . . . . definition Σ 1..1 Reference ( MessageDefinition canonical ) Message supported by this system
. . . document Σ I TU 0..* BackboneElement Document definition
. . . . mode Σ 1..1 code producer | consumer
DocumentMode ( Required )
. . . . documentation 0..1 string Description of document support
. . . . profile Σ 1..1 Reference ( StructureDefinition canonical ) Constraint on a resource the resources used in the document

doco Documentation for this format

UML Diagram ( Legend )

CapabilityStatement ( DomainResource ) An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. instance; also called its canonical identifier. This SHALL be a URL, SHOULD be globally unique, unique and SHOULD be an a literal address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions) published url : uri [0..1] The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence version : string [0..1] A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation name : string [0..1] A short, descriptive, user-friendly title for the capability statement title : string [0..1] The status of this capability statement. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of a Value Set or Concept Map. an artifact. (Strength=Required) PublicationStatus ! » A boolean Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), education/evaluation/marketing) and is not intended to be used for genuine usage (this element modifies the meaning of other elements) experimental : boolean [0..1] The date (and optionally time) when the capability statement was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes date : dateTime [1..1] The name of the individual or organization or individual that published the capability statement publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP description : markdown [0..1] The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate capability statement instances useContext : UsageContext [0..*] A legal or geographic region in which the capability statement is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible) Jurisdiction ValueSet + » Explaination Explanation of why this capability statement is needed and why it has been designed as it has purpose : markdown [0..1] A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement copyright : markdown [0..1] The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind (kind, not instance of software) or a class of implementation (e.g. a desired purchase) kind : code [1..1] « How a capability statement is intended to be used. (Strength=Required) CapabilityStatementKind ! » Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so instantiates : uri canonical [0..*] The version of the FHIR specification on which this capability statement is based fhirVersion : id [1..1] A code that indicates whether the application accepts unknown elements or extensions when reading resources acceptUnknown : code [1..1] « A code that indicates whether an application accepts unknown elements or extensions when reading resources. All published FHIR Versions (Strength=Required) UnknownContentCode All Published FHIR versions ! » A list of the formats supported by this implementation using their content types format : code [1..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required) MimeType ! » A list of the patch formats supported by this implementation using their content types patchFormat : code [0..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required) MimeType ! » A list of implementation guides that the server does (or should) support in their entirety implementationGuide : uri canonical [0..*] A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses) profile : Reference [0..*] StructureDefinition Software Name the software is known by name : string [1..1] The version identifier for the software covered by this statement version : string [0..1] Date this version of the software was released releaseDate : dateTime [0..1] Implementation Information about the specific installation that this capability statement relates to description : string [1..1] An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces url : uri url [0..1] Rest Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations mode : code [1..1] « The mode of a RESTful capability statement. (Strength=Required) RestfulCapabilityMode ! » Information about the system's restful capabilities that apply across all applications, such as security documentation : string [0..1] An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL compartment : uri canonical [0..*] Security Server adds CORS headers when responding to requests - this enables javascript Javascript applications to use the server cors : boolean [0..1] Types of security services that are supported/required by the system service : CodeableConcept [0..*] « Types of security services used with FHIR. (Strength=Extensible) RestfulSecurityService + » General description of how security works description : string [0..1] Certificate Mime type for a certificate type : code [0..1] The mime type of an attachment. Any valid mime type is allowed. (Strength=Required) MimeType ! Actual certificate blob : base64Binary [0..1] Resource A type of resource exposed via the restful interface type : code [1..1] « One of the resource types defined as part of this version of FHIR. (Strength=Required) ResourceType ! » A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses) profile : Reference canonical [0..1] StructureDefinition A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses) supportedProfile : canonical [0..*] Additional information about the resource type used by the system documentation : markdown [0..1] This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API versioning : code [0..1] « How the system supports versioning for a resource. (Strength=Required) ResourceVersionPolicy ! » A flag for whether the server is able to return past versions as part of the vRead operation readHistory : boolean [0..1] A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server updateCreate : boolean [0..1] A flag that indicates that the server supports conditional create conditionalCreate : boolean [0..1] A code that indicates how the server supports conditional read conditionalRead : code [0..1] « A code that indicates how the server supports conditional read. (Strength=Required) ConditionalReadStatus ! » A flag that indicates that the server supports conditional update conditionalUpdate : boolean [0..1] A code that indicates how the server supports conditional delete conditionalDelete : code [0..1] « A code that indicates how the server supports conditional delete. (Strength=Required) ConditionalDeleteStatus ! » A set of flags that defines how references are supported referencePolicy : code [0..*] « A set of flags that defines how references are supported. (Strength=Required) ReferenceHandlingPolicy ! » A list of _include values supported by the server searchInclude : string [0..*] A list of _revinclude (reverse include) values supported by the server searchRevInclude : string [0..*] ResourceInteraction Coded identifier of the operation, supported by the system resource code : code [1..1] « Operations supported by REST at the type or instance level. (Strength=Required) TypeRestfulInteraction ! » Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only' documentation : string [0..1] SearchParam The name of the search parameter used in the interface name : string [1..1] An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]]) definition : uri canonical [0..1] The type of value a search parameter refers to, and how the content is interpreted type : code [1..1] « Data types allowed to be used for search parameters. (Strength=Required) SearchParamType ! » This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms documentation : string [0..1] Operation The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called name : string [1..1] Where the formal definition can be found definition : canonical [1..1] Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation documentation : markdown [0..1] SystemInteraction A coded identifier of the operation, supported by the system code : code [1..1] « Operations supported by REST at the system level. (Strength=Required) SystemRestfulInteraction ! » Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented documentation : string [0..1] Operation The name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called name : string [1..1] Where the formal definition can be found definition : Reference [1..1] OperationDefinition Messaging Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender) reliableCache : unsignedInt [0..1] Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner documentation : string [0..1] Endpoint A list of the messaging transport protocol(s) identifiers, supported by this endpoint protocol : Coding [1..1] « The protocol used for message transport. (Strength=Extensible) MessageTransport + » The network address of the end-point. endpoint. For solutions that do not use network addresses for routing, it can be just an identifier address : uri url [1..1] SupportedMessage The mode of this event declaration - whether application is sender or receiver mode : code [1..1] « The mode of a message capability statement. (Strength=Required) EventCapabilityMode ! » Points to a message definition that identifies the messaging event, message structure, allowed responses, etc definition : Reference [1..1] MessageDefinition Event A coded identifier of a supported messaging event code : Coding [1..1] One of the message events defined as part of FHIR. (Strength=Example) MessageEvent ?? The impact of the content of the message category : code [0..1] The impact of the content of a message. (Strength=Required) MessageSignificanceCategory ! The mode of this event declaration - whether an application is a sender or receiver mode : code [1..1] The mode of a message capability statement. (Strength=Required) EventCapabilityMode ! A resource associated with the event. This is the resource that defines the event focus : code [1..1] One of the resource types defined as part of FHIR. (Strength=Required) ResourceType ! Information about the request for this event request : Reference [1..1] StructureDefinition Information about the response for this event response : Reference canonical [1..1] StructureDefinition Guidance on how this event is handled, such as internal system trigger points, business rules, etc documentation : string [0..1] Document Mode of this document declaration - whether an application is a producer or consumer mode : code [1..1] « Whether the application produces or consumes documents. (Strength=Required) DocumentMode ! » A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc documentation : string [0..1] A constraint profile on a resource used in the document Bundle that constrains which resources are present, and their contents profile : Reference canonical [1..1] StructureDefinition Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation software [0..1] Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program implementation [0..1] Certificates associated with security profiles certificate [0..*] Information about security implementation from an interface perspective - what a client needs to know security [0..1] Identifies a restful operation supported by the solution interaction [1..*] [0..*] Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation searchParam [0..*] Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters operation [0..*] A specification of the restful capabilities of the solution for a specific resource type resource [0..*] A specification of restful operations supported by the system interaction [0..*] Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation searchParam [0..*] Definition of an operation or a named query together with its parameters and their meaning and type operation [0..*] A definition of the restful capabilities of the solution, if any rest [0..*] An endpoint (network accessible address) to which messages and/or replies are to be sent endpoint [0..*] References to message definitions for messages this system can send or receive supportedMessage [0..*] A description of the solution's support for an event at this end-point event [0..*] A description of the messaging capabilities of the solution messaging [0..*] A document definition document [0..*]

XML Template 

<

<CapabilityStatement xmlns="http://hl7.org/fhir"> doco

 <!-- 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>
 <
 <</useContext>

 <description value="[markdown]"/><!-- ?? 0..1 Natural language description of the capability statement -->
 <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 -->
 <kind value="[code]"/><!-- ?? 1..1 instance | capability | requirements -->
 <instantiates><!-- 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this implements --></instantiates>

 <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 -->

 </implementation>
 <
 <
 <
 <
 <
 <</profile>

 <fhirVersion value="[id]"/><!-- 1..1 FHIR Version the system uses -->
 <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="[string]"/><!-- 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>
   <
   <
    <
    <
   </certificate>

   <description value="[string]"/><!-- 0..1 General description of how security works -->

  </security>
  <resource>  <!-- 0..* Resource served on the REST interface -->
   <
   <</profile>
   <
   <
    <
    <

   <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="[string]"/><!-- 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><!-- 0..1 canonical(SearchParameter) Source of definition for parameter --></definition>
    <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri -->
    <documentation value="[string]"/><!-- 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><!-- 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="[string]"/><!-- 0..1 Anything special about operation behavior -->

  </interaction>
  <searchParam><!-- 0..* Content as for CapabilityStatement.rest.resource.searchParam Search parameters for searching all resources --></searchParam>
  <
   <
   <</definition>
  </operation>
  <

  <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="[string]"/><!-- 0..1 Messaging interface behavior details -->

  <supportedMessage>  <!-- 0..* Messages supported by this system -->
   <
   <</definition>

   <mode value="[code]"/><!-- 1..1 sender | receiver -->
   <definition><!-- 1..1 canonical(MessageDefinition) Message supported by this system --></definition>

  </supportedMessage>
  <
   <</code>
   <
   <
   <
   <</request>
   <</response>
   <
  </event>

 </messaging>
 <document>  <!-- ?? 0..* Document definition -->
  <
  <
  <</profile>

  <mode value="[code]"/><!-- 1..1 producer | consumer -->
  <documentation value="[string]"/><!-- 0..1 Description of document support -->
  <profile><!-- 1..1 canonical(StructureDefinition) Constraint on the resources used in the document --></profile>

 </document>
</CapabilityStatement>

JSON Template 

{doco
  "resourceType" : "",

  "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>", // 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>"], // Canonical URL of another capability statement this implements
  "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

  },
  "
  "
  "
  "
  "
  "
  "
    "
    "
    "
      "
      "
      "
      "
        "
        "
      }]

  "fhirVersion" : "<id>", // R!  FHIR Version the system uses
  "format" : ["<code>"], // R!  formats supported (xml | json | ttl | mime type) 
  "patchFormat" : ["<code>"], // Patch formats supported 
  "implementationGuide" : ["<canonical>"], // Implementation guides supported
  "rest" : [{ // C? If the endpoint is a RESTful one
    "mode" : "<code>", // R!  client | server
    "documentation" : "<string>", // 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" : "<string>" // General description of how security works

    },
    "
      "
      "
      "
      "
        "
        "

    "resource" : [{ // Resource served on the REST interface
      "type" : "<code>", // R!  A resource type that is supported
      "profile" : "<canonical>", // Base System profile for all uses of resource
      "supportedProfile" : ["<canonical>"], // 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" : "<string>" // 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>", // Source of definition for parameter
        "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri
        "documentation" : "<string>" // Server-specific usage
      }],
      "operation" : [{ // Definition of a resource operation
        "name" : "<string>", // R!  Name by which the operation/query is invoked
        "definition" : "<canonical>", // 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" : "<string>" // 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>"] // 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" : "<string>", // Messaging interface behavior details
    "supportedMessage" : [{ // Messages supported by this system
      "mode" : "<code>", // R!  sender | receiver
      "definition" : "<canonical>" // R!  Message supported by this system

    }]
  }],
  "
    "
    "
    "

  "document" : [{ // C? Document definition
    "mode" : "<code>", // R!  producer | consumer
    "documentation" : "<string>", // Description of document support
    "profile" : "<canonical>" // R!  Constraint on the resources used in the document

  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:CapabilityStatement;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  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 | unknown
  fhir:
  fhir:
  fhir:

  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 statement
  fhir:

  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:

  fhir:CapabilityStatement.purpose [ markdown ]; # 0..1 Why this capability statement is defined

  fhir:CapabilityStatement.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:
  fhir:

  fhir:CapabilityStatement.kind [ code ]; # 1..1 instance | capability | requirements
  fhir:CapabilityStatement.instantiates [ canonical(CapabilityStatement) ], ... ; # 0..* Canonical URL of another capability statement this implements

  fhir:CapabilityStatement.software [ # 0..1 Software that is covered by this capability statement
    fhir:

    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:

    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:

    fhir:CapabilityStatement.implementation.url [ url ]; # 0..1 Base URL for the installation

  ];
  fhir:CapabilityStatement.fhirVersion [ id ]; # 1..1 FHIR Version the system uses
  fhir:

  fhir:CapabilityStatement.format [ code ], ... ; # 1..* formats supported (xml | json | ttl | mime type)
  fhir:CapabilityStatement.patchFormat [ code ], ... ; # 0..* Patch formats supported
  fhir:
  fhir:

  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 | server
    fhir:CapabilityStatement.rest.documentation [ string ]; # 0..1 General description of implementation
    fhir:CapabilityStatement.rest.security [ # 0..1 Information about security of implementation
      fhir:

      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 | Certificates
      fhir:CapabilityStatement.rest.security.description [ string ]; # 0..1 General description of how security works
      fhir:
        fhir:
        fhir:
      ], ...;

    ];
    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:

      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:

      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-type
        fhir:CapabilityStatement.rest.resource.interaction.documentation [ string ]; # 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:

      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 parameter
        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
        fhir:CapabilityStatement.rest.resource.searchParam.documentation [ string ]; # 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 invoked
        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-system
      fhir:CapabilityStatement.rest.interaction.documentation [ string ]; # 0..1 Anything special about operation behavior
    ], ...;
    fhir:CapabilityStatement.rest.searchParam [ See CapabilityStatement.rest.resource.searchParam ], ... ; # 0..* Search parameters for searching all resources
    fhir:
      fhir:
      fhir:
    ], ...;
    fhir:

    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:

      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:CapabilityStatement.messaging.documentation [ string ]; # 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:
    ], ...;
    fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      fhir:
      fhir:

      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 | consumer
    fhir:CapabilityStatement.document.documentation [ string ]; # 0..1 Description of document support
    fhir:

    fhir:CapabilityStatement.document.profile [ canonical(StructureDefinition) ]; # 1..1 Constraint on the resources used in the document

  ], ...;
]

Changes since DSTU2

CapabilityStatement
CapabilityStatement.instantiates
  • Type changed from uri to canonical
CapabilityStatement.implementation.url
  • Type changed from uri to url
CapabilityStatement.fhirVersion
  • Add Binding http://hl7.org/fhir/ValueSet/fhir-versions (required)
CapabilityStatement.implementationGuide
  • Type changed from uri to canonical
CapabilityStatement.rest.resource.profile
  • Type changed from Reference(StructureDefinition) to canonical
CapabilityStatement.rest.resource.supportedProfile
  • Added Element
CapabilityStatement.rest.resource.interaction
  • Min Cardinality changed from 1 to 0
CapabilityStatement.rest.resource.searchParam.definition
  • Type changed from uri to canonical
CapabilityStatement.rest.resource.operation
  • Added Element
CapabilityStatement.rest.resource.operation.name
  • Added Element
CapabilityStatement.rest.resource.operation.definition
  • Added Element
CapabilityStatement.rest.resource.operation.documentation
  • Added Element
CapabilityStatement.rest.operation
  • Remove BackboneElement
CapabilityStatement.rest.compartment
  • Type changed from uri to canonical
CapabilityStatement.messaging.endpoint.address
  • Type changed from uri to url
CapabilityStatement.messaging.supportedMessage.definition
  • Type changed from Reference(MessageDefinition) to canonical
CapabilityStatement.document.profile
  • Type changed from Reference(StructureDefinition) to canonical
CapabilityStatement.acceptUnknown
  • deleted
CapabilityStatement.profile
  • deleted
CapabilityStatement.rest.security.certificate
  • deleted
CapabilityStatement.rest.operation.name
  • deleted
CapabilityStatement.rest.operation.definition
  • deleted
CapabilityStatement.messaging.event
  • deleted

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

 

Alternate definitions: Master Definition ( XML , + JSON ), , XML Schema / Schematron (for ) + JSON Schema , ShEx (for Turtle ) + see the extensions & the dependency analysis

5.2.3.1 Terminology Bindings

CapabilityStatement.acceptUnknown CapabilityStatement.messaging.event.code One of the message events defined as part of FHIR. Example Message Events CapabilityStatement.messaging.event.category The impact of the content of a message. Required MessageSignificanceCategory
Path Definition Type Reference
CapabilityStatement.status The lifecycle status of a Value Set or Concept Map. 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 A code that indicates whether an application accepts unknown elements or extensions when reading resources. All published FHIR Versions Required UnknownContentCode All Published FHIR versions
CapabilityStatement.format
CapabilityStatement.patchFormat CapabilityStatement.rest.security.certificate.type 		The mime type of an attachment. Any valid mime type is allowed. Required BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
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 CapabilityStatement.messaging.event.focus 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 CapabilityStatement.messaging.event.mode The mode of a message capability statement. Required EventCapabilityMode
CapabilityStatement.document.mode Whether the application produces or consumes documents. Required DocumentMode

5.2.3.2 Constraints

  • cpb-1 : A Capability Statement SHALL have at least one of REST, messaging or document element. ( expression : rest.exists() or messaging.exists() or document.exists() )
  • cpb-12 : On CapabilityStatement.rest.resource: Search parameter names must be unique in the context of a resource. ( expression on CapabilityStatement.rest.resource: searchParam.select(name).isDistinct() )
  • cpb-14 : Capability Statements of kind 'requirements' do not have software or implementation elements. ( expression : (software.empty() and implementation.empty()) or kind != 'requirements' )
  • cpb-15 : Capability Statements of kind 'instance' do not cannot have implementation elements. elements unless kind is 'instance' ( expression : implementation.empty() or kind != 'capability' ) cpb-16 : On CapabilityStatement.messaging: A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both. ( expression on CapabilityStatement.messaging: supportedMessage.empty() != event.empty() = 'instance' )
  • cpb-2 : A Capability Statement SHALL have at least one of description, software, or implementation element. ( expression : (description.count() + software.count() + implementation.count()) > 0 )
  • cpb-3 : Messaging end-point is required (and is only permitted) when a statement is for an implementation. ( expression : messaging.endpoint.empty() or kind = 'instance' )
  • cpb-7 : The set of documents must be unique by the combination of profile and mode. ( expression : document.select(profile.reference&mode).isDistinct() document.select(profile&mode).isDistinct() )
  • cpb-8 : There can only be one REST declaration per mode. ( expression : rest.select(mode).isDistinct() )
  • cpb-9 : On CapabilityStatement.rest: A given resource can only be described once per RESTful mode. ( expression on CapabilityStatement.rest: resource.select(type).isDistinct() )

5.2.4 Notes:

  • The CapabilityStatement resource provides for an application to describe its use of the RESTful paradigm messaging events, or FHIR documents. Usually, an application would only describe one, but more than one may be described
  • RESTful CapabilityStatement rules:
    • RESTful servers are required to provide this resource on demand . Servers SHALL specify what resource types and operations are supported, and SHOULD also specify profiles for each resource type.
    • RESTful clients SHOULD publish a capability statement
    • The search parameters that a server supports (or a client makes use of) are specified in the resource profile that the capability statement references
    • Resource Types or operations that are not listed are not supported
  • Messaging CapabilityStatement rules:
    • The interpretation of request and response depends on the mode. If the mode is sender, then request specifies what the application sends, and response specifies what it accepts. If the mode is "receiver", "receiver", then this is reversed
    • If a request or response is not specified for an event, then no rules are made for it
    • Events that are not listed are not supported
    • The MessageDefinition resource is newly proposed and is still considered 'draft'. The 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.
  • Document CapabilityStatement rules:
    • Document profiles should directly constrain the Document.information.class & type elements so that there is no ambiguity concerning which profile any given document conforms to.
  • Other service based service-based use of resources: Due to the variability of these services, the CapabilityStatement resource does not attempt to describe service based service-based use of resources. The various service specifications will need to describe this usage in their own way.

5.2.4.1 Supporting Profiles

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 .

5.2.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Event code in a capability statement CapabilityStatement.messaging.event.code
Name Type Description Expression In Common
date date The capability statement publication date CapabilityStatement.date
description string The description of the capability statement CapabilityStatement.description event token
fhirversion token The version of FHIR CapabilityStatement.version
format token formats supported (xml | json | ttl | mime type) CapabilityStatement.format
guide uri reference Implementation guides supported CapabilityStatement.implementationGuide
( ImplementationGuide )
jurisdiction 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 token OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates CapabilityStatement.rest.security.service
software string Part of a the name of a software application CapabilityStatement.software.name
status token The current status of the capability statement CapabilityStatement.status
supported-profile reference Profiles for use cases supported CapabilityStatement.profile 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