CapabilityStatement
activeFoundationA 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.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| CapabilityStatement | 0..* | — | A statement of system capabilities |
| .idΣ | 0..1 | String | Logical id of this artifact |
| .metaΣ | 0..1 | Meta | Metadata about the resource |
| .implicitRules?!Σ | 0..1 | uri | A set of rules under which this content was created |
| .language | 0..1 | code | Language of the resource content Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .urlΣ | 0..1 | uri | Canonical identifier for this capability statement, represented as a URI (globally unique) |
| .versionΣ | 0..1 | string | Business version of the capability statement |
| .nameΣ | 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 Bindingpublication-status(required) |
| .experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
| .dateΣ | 1..1 | dateTime | Date last changed |
| .publisherΣ | 0..1 | string | Name of the publisher (organization or individual) |
| .contactΣ | 0..* | ContactDetail | Contact details for the publisher |
| .description | 0..1 | markdown | Natural language description of the capability statement |
| .useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
| .jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for capability statement (if applicable) Bindingjurisdiction(extensible) |
| .purpose | 0..1 | markdown | Why this capability statement is defined |
| .copyright | 0..1 | markdown | Use and/or publishing restrictions |
| .kindΣ | 1..1 | code | instance | capability | requirements Bindingcapability-statement-kind(required) |
| .instantiatesΣ | 0..* | canonical | Canonical URL of another capability statement this implements |
| .importsΣ | 0..* | canonical | Canonical URL of another capability statement this adds to |
| .softwareΣ | 0..1 | BackboneElement | Software that is covered by this capability statement |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .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Σ | 0..1 | BackboneElement | If this describes a specific instance |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .descriptionΣ | 1..1 | string | Describes this specific instance |
| .urlΣ | 0..1 | url | Base URL for the installation |
| .custodianΣ | 0..1 | Reference(Organization) | Organization that manages the data |
| .fhirVersionΣ | 1..1 | code | FHIR Version the system supports BindingFHIR-version(required) |
| .formatΣ | 1..* | code | formats supported (xml | json | ttl | mime type) Bindingmimetypes(required) |
| .patchFormatΣ | 0..* | code | Patch formats supported Bindingmimetypes(required) |
| .implementationGuideΣ | 0..* | canonical | Implementation guides supported |
| .restΣ | 0..* | BackboneElement | If the endpoint is a RESTful one |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .modeΣ | 1..1 | code | client | server Bindingrestful-capability-mode(required) |
| .documentation | 0..1 | markdown | General description of implementation |
| .securityΣ | 0..1 | BackboneElement | Information about security of implementation |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .corsΣ | 0..1 | boolean | Adds CORS Headers (http://enable-cors.org/) |
| .serviceΣ | 0..* | CodeableConcept | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates Bindingrestful-security-service(extensible) |
| .description | 0..1 | markdown | General description of how security works |
| .resourceΣ | 0..* | BackboneElement | Resource served on the REST interface |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .typeΣ | 1..1 | code | A resource type that is supported Bindingresource-types(required) |
| .profileΣ | 0..1 | 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 | 0..* | BackboneElement | What operations are supported? |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .code | 1..1 | code | read | vread | update | patch | delete | history-instance | history-type | create | search-type Bindingtype-restful-interaction(required) |
| .documentation | 0..1 | markdown | Anything special about operation behavior |
| .versioning | 0..1 | code | no-version | versioned | versioned-update Bindingversioning-policy(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 Bindingconditional-read-status(required) |
| .conditionalUpdate | 0..1 | boolean | If allows/uses conditional update |
| .conditionalDelete | 0..1 | code | not-supported | single | multiple - how conditional delete is supported Bindingconditional-delete-status(required) |
| .referencePolicy | 0..* | code | literal | logical | resolves | enforced | local Bindingreference-handling-policy(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 |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .name | 1..1 | string | Name of search parameter |
| .definition | 0..1 | canonical | Source of definition for parameter |
| .type | 1..1 | code | number | date | string | token | reference | composite | quantity | uri | special Bindingsearch-param-type(required) |
| .documentation | 0..1 | markdown | Server-specific usage |
| .operationΣ | 0..* | BackboneElement | Definition of a resource operation |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .nameΣ | 1..1 | string | Name by which the operation/query is invoked |
| .definitionΣ | 1..1 | canonical | The defined operation/query |
| .documentation | 0..1 | markdown | Specific details about operation behavior |
| .interaction | 0..* | BackboneElement | What operations are supported? |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .code | 1..1 | code | transaction | batch | search-system | history-system Bindingsystem-restful-interaction(required) |
| .documentation | 0..1 | markdown | Anything special about operation behavior |
| .searchParam | 0..* | — | Search parameters for searching all resources |
| .operationΣ | 0..* | — | Definition of a system level operation |
| .compartment | 0..* | canonical | Compartments served/used by system |
| .messagingΣ | 0..* | BackboneElement | If messaging is supported |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .endpoint | 0..* | BackboneElement | Where messages should be sent |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .protocol | 1..1 | Coding | http | ftp | mllp + Bindingmessage-transport(extensible) |
| .address | 1..1 | url | Network address or identifier of the end-point |
| .reliableCache | 0..1 | unsignedInt | Reliable Message Cache Length (min) |
| .documentation | 0..1 | markdown | Messaging interface behavior details |
| .supportedMessageΣ | 0..* | BackboneElement | Messages supported by this system |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .modeΣ | 1..1 | code | sender | receiver Bindingevent-capability-mode(required) |
| .definitionΣ | 1..1 | canonical | Message supported by this system |
| .documentΣ | 0..* | BackboneElement | Document definition |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .modeΣ | 1..1 | code | producer | consumer Bindingdocument-mode(required) |
| .documentation | 0..1 | markdown | Description of document support |
| .profileΣ | 1..1 | canonical | Constraint on the resources used in the document |