http://hl7.org/fhir/StructureDefinition/CapabilityStatement|4.0.1
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
| Name | Flags | Card | Type | Description & Constraints |
|---|---|---|---|---|
CapabilityStatement | 0..* | A statement of system capabilities | ||
Σ | 0..1 | uri | Canonical identifier for this capability statement, represented as a URI (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 | unknown PublicationStatus (required) | |
Σ | 0..1 | boolean | For testing purposes, not real usage | |
Σ | 1..1 | dateTime | Date last changed | |
Σ | 0..1 | string | Name of the publisher (organization or individual) | |
Σ | 0..* | ContactDetail | Contact details for the publisher | |
| 0..1 | markdown | Natural language description of the capability statement | ||
Σ | 0..* | UsageContext | The context that the content is intended to support | |
Σ | 0..* | CodeableConcept | Intended jurisdiction for capability statement (if applicable) Jurisdiction (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..* | canonical | Canonical URL of another capability statement this implements | |
Σ | 0..* | canonical | Canonical URL of another capability statement this adds to | |
Σ | 0..1 | BackboneElement | Software that is covered by this capability statement | |
Σ | 1..1 | string | A name the software is known by | |
Σ | 0..1 | string | Version covered by this statement | |
Σ | 0..1 | dateTime | Date this version was released | |
Σ | 0..1 | BackboneElement | If this describes a specific instance | |
Σ | 1..1 | string | Describes this specific instance | |
Σ | 0..1 | url | Base URL for the installation | |
Σ | 0..1 | Reference | Organization that manages the data | |
Σ | 1..1 | code | FHIR Version the system supports FHIRVersion (required) | |
Σ | 1..* | code | formats supported (xml | json | ttl | mime type) MimeType (required) | |
Σ | 0..* | code | Patch formats supported MimeType (required) | |
Σ | 0..* | canonical | Implementation guides supported | |
Σ | 0..* | BackboneElement | If the endpoint is a RESTful one | |
Σ | 1..1 | code | client | server RestfulCapabilityMode (required) | |
| 0..1 | markdown | 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 | markdown | General description of how security works | ||
Σ | 0..* | BackboneElement | Resource served on the REST interface | |
Σ | 1..1 | code | A resource type that is supported ResourceType (required) | |
Σ | 0..1 | canonical | Base System profile for all uses of resource | |
Σ | 0..* | canonical | Profiles for use cases supported | |
| 0..1 | markdown | Additional information about the use of the resource type | ||
| 0..* | BackboneElement | What operations are supported? | ||
| 1..1 | code | read | vread | update | patch | delete | history-instance | history-type | create | search-type TypeRestfulInteraction (required) | ||
| 0..1 | markdown | 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 parameters supported by implementation | ||
| 1..1 | string | Name of search parameter | ||
| 0..1 | canonical | Source of definition for parameter | ||
| 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special SearchParamType (required) | ||
| 0..1 | markdown | Server-specific usage | ||
Σ | 0..* | BackboneElement | Definition of a resource operation | |
Σ | 1..1 | string | Name by which the operation/query is invoked | |
Σ | 1..1 | canonical | The defined operation/query | |
| 0..1 | markdown | Specific details about operation behavior | ||
| 0..* | BackboneElement | What operations are supported? | ||
| 1..1 | code | transaction | batch | search-system | history-system SystemRestfulInteraction (required) | ||
| 0..1 | markdown | Anything special about operation behavior | ||
| 0..* | Search parameters for searching all resources | |||
Σ | 0..* | Definition of a system level operation | ||
| 0..* | canonical | Compartments served/used by system | ||
Σ | 0..* | BackboneElement | If messaging is supported | |
| 0..* | BackboneElement | Where messages should be sent | ||
| 1..1 | Coding | http | ftp | mllp + MessageTransport (extensible) | ||
| 1..1 | url | Network address or identifier of the end-point | ||
| 0..1 | unsignedInt | Reliable Message Cache Length (min) | ||
| 0..1 | markdown | Messaging interface behavior details | ||
Σ | 0..* | BackboneElement | Messages supported by this system | |
Σ | 1..1 | code | sender | receiver EventCapabilityMode (required) | |
Σ | 1..1 | canonical | Message supported by this system | |
Σ | 0..* | BackboneElement | Document definition | |
Σ | 1..1 | code | producer | consumer DocumentMode (required) | |
| 0..1 | markdown | Description of document support | ||
Σ | 1..1 | canonical | Constraint on the resources used in the document |