CapabilityStatement
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.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 18 of 23 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
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) |
statusRequired?!Σ | 1..1 | code | draft | active | retired | unknownBinding (required): publication-status |
experimentalΣ | 0..1 | boolean | For testing purposes, not real usage |
dateRequiredΣ | 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)Binding (extensible): jurisdiction |
purpose | 0..1 | markdown | Why this capability statement is defined |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
kindRequiredΣ | 1..1 | code | instance | capability | requirementsBinding (required): capability-statement-kind |
instantiatesΣ | 0..* | canonical(CapabilityStatement) | Canonical URL of another capability statement this implements |
importsΣ | 0..* | canonical(CapabilityStatement) | Canonical URL of another capability statement this adds to |
softwareΣ | 0..1 | BackboneElement | Software that is covered by this capability statement |
nameRequiredΣ | 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 |
descriptionRequiredΣ | 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 |
fhirVersionRequiredΣ | 1..1 | code | FHIR Version the system supportsBinding (required): FHIR-version |
formatRequiredΣ | 1..* | code | formats supported (xml | json | ttl | mime type)Binding (required): mimetypes |
patchFormatΣ | 0..* | code | Patch formats supportedBinding (required): mimetypes |
implementationGuideΣ | 0..* | canonical(ImplementationGuide) | Implementation guides supported |
restΣ | 0..* | BackboneElement | If the endpoint is a RESTful one |
modeRequiredΣ | 1..1 | code | client | serverBinding (required): restful-capability-mode |
documentation | 0..1 | markdown | General description of implementation |
securityΣ | 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 | CertificatesBinding (extensible): restful-security-service |
description | 0..1 | markdown | General description of how security works |
resourceΣ | 0..* | BackboneElement | Resource served on the REST interface |
typeRequiredΣ | 1..1 | code | A resource type that is supportedBinding (required): resource-types |
profileΣ | 0..1 | canonical(StructureDefinition) | Base System profile for all uses of resource |
supportedProfileΣ | 0..* | canonical(StructureDefinition) | Profiles for use cases supported |
documentation | 0..1 | markdown | Additional information about the use of the resource type |
interaction | 0..* | BackboneElement | What operations are supported? |
codeRequired | 1..1 | code | read | vread | update | patch | delete | history-instance | history-type | create | search-typeBinding (required): type-restful-interaction |
documentation | 0..1 | markdown | Anything special about operation behavior |
versioning | 0..1 | code | no-version | versioned | versioned-updateBinding (required): versioning-policy |
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-supportBinding (required): conditional-read-status |
conditionalUpdate | 0..1 | boolean | If allows/uses conditional update |
conditionalDelete | 0..1 | code | not-supported | single | multiple - how conditional delete is supportedBinding (required): conditional-delete-status |
referencePolicy | 0..* | code | literal | logical | resolves | enforced | localBinding (required): reference-handling-policy |
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 |
nameRequired | 1..1 | string | Name of search parameter |
definition | 0..1 | canonical(SearchParameter) | Source of definition for parameter |
typeRequired | 1..1 | code | number | date | string | token | reference | composite | quantity | uri | specialBinding (required): search-param-type |
documentation | 0..1 | markdown | Server-specific usage |
operationΣ | 0..* | BackboneElement | Definition of a resource operation |
nameRequiredΣ | 1..1 | string | Name by which the operation/query is invoked |
definitionRequiredΣ | 1..1 | canonical(OperationDefinition) | The defined operation/query |
documentation | 0..1 | markdown | Specific details about operation behavior |
interaction | 0..* | BackboneElement | What operations are supported? |
codeRequired | 1..1 | code | transaction | batch | search-system | history-systemBinding (required): system-restful-interaction |
documentation | 0..1 | markdown | Anything special about operation behavior |
searchParam | 0..* | Same as CapabilityStatement.rest.resource.searchParam | Search parameters for searching all resources |
operationΣ | 0..* | Same as CapabilityStatement.rest.resource.operation | Definition of a system level operation |
compartment | 0..* | canonical(CompartmentDefinition) | Compartments served/used by system |
messagingΣ | 0..* | BackboneElement | If messaging is supported |
endpoint | 0..* | BackboneElement | Where messages should be sent |
protocolRequired | 1..1 | Coding | http | ftp | mllp +Binding (extensible): message-transport |
addressRequired | 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 |
modeRequiredΣ | 1..1 | code | sender | receiverBinding (required): event-capability-mode |
definitionRequiredΣ | 1..1 | canonical(MessageDefinition) | Message supported by this system |
documentΣ | 0..* | BackboneElement | Document definition |
modeRequiredΣ | 1..1 | code | producer | consumerBinding (required): document-mode |
documentation | 0..1 | markdown | Description of document support |
profileRequiredΣ | 1..1 | canonical(StructureDefinition) | Constraint on the resources used in the document |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/CapabilityStatement?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
context | token | A use context assigned to the capability statement (CapabilityStatement.useContext.value.ofType(CodeableConcept)) | ||
context-quantity | quantity | A quantity- or range-valued use context assigned to the capability statement (CapabilityStatement.useContext.value.ofType(Quantity)) | (CapabilityStatement.useContext.value.ofType(Range)) | ||
context-type | token | A type of use context assigned to the capability statement CapabilityStatement.useContext.code | ||
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the capability statement CapabilityStatement.useContext | ||
context-type-value | composite | A use context type and value assigned to the capability statement CapabilityStatement.useContext | ||
date | date | The capability statement publication date CapabilityStatement.date | ||
description | string | The description of the capability statement CapabilityStatement.description | ||
fhirversion | token | The version of FHIR CapabilityStatement.version | ||
format | token | formats supported (xml | json | ttl | mime type) CapabilityStatement.format | ||
guide | reference | Implementation guides supported CapabilityStatement.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 | ||
security-service | token | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates CapabilityStatement.rest.security.service | ||
software | string | Part of 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.rest.resource.supportedProfile | ||
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 |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken