| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
| I | 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 & mode Capability Statements of kind 'instance' do not have implementation elements Messaging end-point is required (and is only permitted) when 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 A Capability Statement SHALL have at least one of REST, messaging or document | ||
| Σ | 0..1 | uri | Logical uri to reference this capability statement (globally unique) | |
| Σ | 0..1 | string | Business version of the capability statement | |
| Σ | 0..1 | string | Name for this capability statement (Computer friendly) | |
| Σ | 0..1 | string | Name for this capability statement (Human friendly) | |
| ?!Σ | 1..1 | code | draft | active | retired PublicationStatus (Required) | |
| ?!Σ | 0..1 | boolean | If for testing purposes, not real usage | |
| Σ | 1..1 | dateTime | Date this was last changed | |
| Σ | 0..1 | string | Name of the publisher (Organization or individual) | |
| Σ | 0..* | ContactDetail | Contact details for the publisher | |
| I | 0..1 | markdown | Natural language description of the capability statement | |
| Σ | 0..* | UsageContext | Content intends to support these contexts | |
| Σ | 0..* | CodeableConcept | Intended jurisdiction for capability statement (if applicable) Jurisdiction ValueSet (Extensible) | |
| 0..1 | markdown | Why this capability statement is defined | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| Σ | 1..1 | code | instance | capability | requirements CapabilityStatementKind (Required) | |
| Σ | 0..* | uri | Canonical URL of another capability statement this implements | |
| ΣI | 0..1 | BackboneElement | Software that is covered by this capability statement | |
| Σ | 1..1 | string | A name the software is known by | |
| Σ | 0..1 | string | Version covered by this statement | |
| Σ | 0..1 | dateTime | Date this version released | |
| ΣI | 0..1 | BackboneElement | If this describes a specific instance | |
| Σ | 1..1 | string | Describes this specific instance | |
| Σ | 0..1 | uri | Base URL for the installation | |
| Σ | 1..1 | id | FHIR Version the system uses | |
| Σ | 1..1 | code | no | extensions | elements | both UnknownContentCode (Required) | |
| Σ | 1..* | code | formats supported (xml | json | ttl | mime type) MimeType (Required) | |
| Σ | 0..* | code | Patch formats supported MimeType (Required) | |
| Σ | 0..* | uri | Implementation Guide supported | |
| Σ | 0..* | Reference(StructureDefinition) | Profiles for use cases supported | |
| ΣI | 0..* | BackboneElement | If the endpoint is a RESTful one A given resource can only be described once per RESTful mode | |
| Σ | 1..1 | code | client | server RestfulCapabilityMode (Required) | |
| 0..1 | string | General description of implementation | ||
| Σ | 0..1 | BackboneElement | Information about security of implementation | |
| Σ | 0..1 | boolean | Adds CORS Headers (http://enable-cors.org/) | |
| Σ | 0..* | CodeableConcept | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates RestfulSecurityService (Extensible) | |
| 0..1 | string | General description of how security works | ||
| 0..* | BackboneElement | Certificates associated with security profiles | ||
| 0..1 | code | Mime type for certificate MimeType (Required) | ||
| 0..1 | base64Binary | Actual certificate | ||
| ΣI | 0..* | BackboneElement | Resource served on the REST interface Search parameter names must be unique in the context of a resource | |
| Σ | 1..1 | code | A resource type that is supported ResourceType (Required) | |
| Σ | 0..1 | Reference(StructureDefinition) | Base System profile for all uses of resource | |
| 0..1 | markdown | Additional information about the use of the resource type | ||
| 1..* | BackboneElement | What operations are supported? | ||
| 1..1 | code | read | vread | update | patch | delete | history-instance | history-type | create | search-type TypeRestfulInteraction (Required) | ||
| 0..1 | string | Anything special about operation behavior | ||
| 0..1 | code | no-version | versioned | versioned-update ResourceVersionPolicy (Required) | ||
| 0..1 | boolean | Whether vRead can return past versions | ||
| 0..1 | boolean | If update can commit to a new identity | ||
| 0..1 | boolean | If allows/uses conditional create | ||
| 0..1 | code | not-supported | modified-since | not-match | full-support ConditionalReadStatus (Required) | ||
| 0..1 | boolean | If allows/uses conditional update | ||
| 0..1 | code | not-supported | single | multiple - how conditional delete is supported ConditionalDeleteStatus (Required) | ||
| 0..* | code | literal | logical | resolves | enforced | local ReferenceHandlingPolicy (Required) | ||
| 0..* | string | _include values supported by the server | ||
| 0..* | string | _revinclude values supported by the server | ||
| 0..* | BackboneElement | Search params supported by implementation | ||
| 1..1 | string | Name of search parameter | ||
| 0..1 | uri | Source of definition for parameter | ||
| 1..1 | code | number | date | string | token | reference | composite | quantity | uri SearchParamType (Required) | ||
| 0..1 | string | Server-specific usage | ||
| 0..* | BackboneElement | What operations are supported? | ||
| 1..1 | code | transaction | batch | search-system | history-system SystemRestfulInteraction (Required) | ||
| 0..1 | string | Anything special about operation behavior | ||
| 0..* | see searchParam | Search params for searching all resources | ||
| Σ | 0..* | BackboneElement | Definition of an operation or a custom query | |
| 1..1 | string | Name by which the operation/query is invoked | ||
| Σ | 1..1 | Reference(OperationDefinition) | The defined operation/query | |
| 0..* | uri | Compartments served/used by system | ||
| ΣI | 0..* | BackboneElement | If messaging is supported | |
| 0..* | BackboneElement | Where messages should be sent | ||
| 1..1 | Coding | http | ftp | mllp + MessageTransport (Extensible) | ||
| 1..1 | uri | Address of end-point | ||
| 0..1 | unsignedInt | Reliable Message Cache Length (min) | ||
| 0..1 | string | Messaging interface behavior details | ||
| Σ | 1..* | BackboneElement | Declare support for this event | |
| Σ | 1..1 | Coding | Event type MessageEvent (Preferred) | |
| 0..1 | code | Consequence | Currency | Notification MessageSignificanceCategory (Required) | ||
| 1..1 | code | sender | receiver EventCapabilityMode (Required) | ||
| 1..1 | code | Resource that's focus of message ResourceType (Required) | ||
| Σ | 1..1 | Reference(StructureDefinition) | Profile that describes the request | |
| Σ | 1..1 | Reference(StructureDefinition) | Profile that describes the response | |
| 0..1 | string | Endpoint-specific event documentation | ||
| ΣI | 0..* | BackboneElement | Document definition | |
| 1..1 | code | producer | consumer DocumentMode (Required) | ||
| 0..1 | string | Description of document support | ||
| Σ | 1..1 | Reference(StructureDefinition) | Constraint on a resource used in the document | |
Documentation for this format | ||||