CapabilityStatement
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client 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.
Endpoints
dev
https://api.sandbox.ovok.com/fhir/R5/CapabilityStatement| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/CapabilityStatement/[id] |
| Vread | GET | /fhir/R5/CapabilityStatement/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/CapabilityStatement/[id] |
| Patch | PATCH | /fhir/R5/CapabilityStatement/[id] |
| Delete | DELETE | /fhir/R5/CapabilityStatement/[id] |
| Create | POST | /fhir/R5/CapabilityStatement |
| Search | GET | /fhir/R5/CapabilityStatement?... |
| History | GET | /fhir/R5/CapabilityStatement/[id]/_history |
| Type-history | GET | /fhir/R5/CapabilityStatement/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 0..1 | Canonical identifier for this capability statement, represented as a URI (globally unique) |
identifier | Identifier | 0..* | Additional identifier for the CapabilityStatement (business identifier) |
version | string | 0..1 | Business version of the capability statement |
versionAlgorithm[x] | string / Coding | 0..1 | How to compare versions |
name | string | 0..1 | Name for this capability statement (computer friendly) |
title | string | 0..1 | Name for this capability statement (human friendly) |
status | code | 1..1 | draft |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 1..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher/steward (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the capability statement |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for capability statement (if applicable) |
purpose | markdown | 0..1 | Why this capability statement is defined |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
copyrightLabel | string | 0..1 | Copyright holder and year(s) |
kind | code | 1..1 | instance |
instantiates | canonical | 0..* | Canonical URL of another capability statement this implements |
imports | canonical | 0..* | Canonical URL of another capability statement this adds to |
software | BackboneElement | 0..1 | Software that is covered by this capability statement |
implementation | BackboneElement | 0..1 | If this describes a specific instance |
fhirVersion | code | 1..1 | FHIR Version the system supports |
format | code | 1..* | formats supported (xml |
patchFormat | code | 0..* | Patch formats supported |
acceptLanguage | code | 0..* | Languages supported |
implementationGuide | canonical | 0..* | Implementation guides supported |
rest | BackboneElement | 0..* | If the endpoint is a RESTful one |
messaging | BackboneElement | 0..* | If messaging is supported |
document | BackboneElement | 0..* | Document definition |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
context | token | A use context assigned to the activity definition |
context-quantity | quantity | A quantity- or range-valued use context assigned to the activity definition |
context-type | token | A type of use context assigned to the activity definition |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the activity definition |
context-type-value | composite | A use context type and value assigned to the activity definition |
date | date | The activity definition publication date |
description | string | The description of the activity definition |
fhirversion | token | The version of FHIR |
format | token | formats supported (xml |
guide | reference | Implementation guides supported |
identifier | token | External identifier for the activity definition |
jurisdiction | token | Intended jurisdiction for the activity definition |
mode | token | Mode - restful (server/client) or messaging (sender/receiver) |
name | string | Computationally friendly name of the activity definition |
publisher | string | Name of the publisher of the activity definition |
resource | token | Name of a resource mentioned in a capability statement |
resource-profile | reference | A profile id invoked in a capability statement |
security-service | token | OAuth |
software | string | Part of the name of a software application |
status | token | The current status of the activity definition |
supported-profile | reference | Profiles for use cases supported |
title | string | The human-friendly name of the activity definition |
url | uri | The uri that identifies the activity definition |
version | token | The business version of the activity definition |
Reference
- Official FHIR R5 spec:
CapabilityStatement - Maturity: Normative (FMM 5).