| Name | Flags | Card. | Type |
Description & Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
CapabilityStatement
|
N | DomainResource | A statement of system capabilities
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation + Rule: A Capability Statement SHALL have at least one of REST, messaging or document element. + Rule: A Capability Statement SHALL have at least one of description, software, or implementation element. + Rule: Messaging end-point is only permitted when a capability statement is for an implementation. + Rule: There should only be one CapabilityStatement.rest per mode. + Rule: The set of documents must be unique by the combination of profile and mode. + Rule: If kind = instance, implementation must be present and software may be present + Rule: If kind = capability, implementation must be absent, software must be present + Rule: If kind = requirements, implementation and software must be absent Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource |
|||||
url
|
Σ C | 0..1 | uri | Canonical identifier for this capability statement, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic |
||||
identifier
|
Σ TU | 0..* | Identifier | Additional identifier for the CapabilityStatement (business identifier)
|
||||
|
version
|
Σ | 0..1 | string | Business version of the capability statement
|
||||
versionAlgorithm[x]
|
Σ TU | 0..1 | How to compare versions
Binding: Version Algorithm ( Extensible) |
|||||
versionAlgorithmString
|
string | |||||||
versionAlgorithmCoding
|
Coding | |||||||
|
name
|
Σ C | 0..1 | string | Name for this capability statement (computer friendly)
|
||||
|
title
|
Σ T | 0..1 | string | Name for this capability statement (human friendly)
|
||||
|
status
|
?! Σ | 1..1 | code | draft | active | retired | unknown
Binding: PublicationStatus ( Required) |
||||
|
experimental
|
Σ | 0..1 | boolean | For testing purposes, not real usage
|
||||
|
date
|
Σ | 1..1 | dateTime | Date last changed
|
||||
|
publisher
|
Σ T | 0..1 | string | Name of the publisher/steward (organization or individual)
|
||||
|
contact
|
Σ | 0..* | ContactDetail | Contact details for the publisher
|
||||
|
description
|
T C | 0..1 | markdown | Natural language description of the capability statement
|
||||
|
useContext
|
Σ TU | 0..* | UsageContext | The context that the content is intended to support
|
||||
|
jurisdiction
|
Σ XD | 0..* | CodeableConcept | Intended jurisdiction for capability statement (if applicable)
Binding: Jurisdiction ValueSet ( Extensible) |
||||
|
purpose
|
T | 0..1 | markdown | Why this capability statement is defined
|
||||
|
copyright
|
T | 0..1 | markdown | Use and/or publishing restrictions
|
||||
|
copyrightLabel
|
T TU | 0..1 | string | Copyright holder and year(s)
|
||||
|
kind
|
Σ C | 1..1 | code | instance | capability | requirements
Binding: Capability Statement Kind ( Required) |
||||
instantiates
|
Σ | 0..* | canonical( CapabilityStatement) | Canonical URL of another capability statement this implements
|
||||
|
imports
|
Σ TU | 0..* | canonical( CapabilityStatement) | Canonical URL of another capability statement this adds to
|
||||
software
|
Σ C | 0..1 | BackboneElement | Software that is covered by this capability statement
|
||||
|
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
|
Σ C | 0..1 | BackboneElement | If this describes a specific instance
|
||||
|
description
|
Σ | 1..1 | markdown | Describes this specific instance
|
||||
|
url
|
Σ | 0..1 | url | Base URL for the installation
|
||||
|
custodian
|
Σ TU | 0..1 | Reference( Organization) | Organization that manages the data
|
||||
|
fhirVersion
|
Σ | 1..1 | code | FHIR Version the system supports
Binding: FHIRVersion ( Required) |
||||
|
format
|
Σ | 1..* | code | formats supported (xml | json | ttl | mime type)
Binding: Mime Types ( Required)
|
||||
|
patchFormat
|
Σ | 0..* | code | Patch formats supported
Binding: Mime Types ( Required) |
||||
|
acceptLanguage
|
Σ TU | 0..* | code | Languages supported
Binding: All Languages ( Required)
|
||||
|
implementationGuide
|
Σ | 0..* | canonical( ImplementationGuide) | Implementation guides supported
|
||||
|
rest
|
Σ C | 0..* | BackboneElement | If the endpoint is a RESTful one
+ Rule: A given resource can only be described once per RESTful mode. |
||||
|
mode
|
Σ C | 1..1 | code | client | server
Binding: Restful Capability Mode ( Required) |
||||
|
documentation
|
T | 0..1 | markdown | General description of implementation
|
||||
|
security
|
Σ TU | 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 | Certificates
Binding: Restful Security Service ( Extensible) |
||||
|
description
|
T | 0..1 | markdown | General description of how security works
|
||||
|
resource
|
Σ C | 0..* | BackboneElement | Resource served on the REST interface
+ Rule: Search parameter names must be unique in the context of a resource. |
||||
|
type
|
Σ C | 1..1 | code | A resource type that is supported
Binding: Resource Types ( Required) |
||||
|
profile
|
Σ | 0..1 | canonical( StructureDefinition) | System-wide profile
|
||||
|
supportedProfile
|
Σ TU | 0..* | canonical( StructureDefinition) | Use-case specific profiles
|
||||
|
documentation
|
T | 0..1 | markdown | Additional information about the use of the resource type
|
||||
|
interaction
|
0..* | BackboneElement | What operations are supported?
|
|||||
|
code
|
1..1 | code | read | vread | update | patch | delete | history-instance | history-type | create | search-type
Binding: Type Restful Interaction ( Required) |
|||||
|
documentation
|
T | 0..1 | markdown | Anything special about operation behavior
|
||||
|
versioning
|
TU | 0..1 | code | no-version | versioned | versioned-update
Binding: Resource Version Policy ( Required) |
||||
|
readHistory
|
TU | 0..1 | boolean | Whether vRead can return past versions
|
||||
|
updateCreate
|
TU | 0..1 | boolean | If update can commit to a new identity
|
||||
|
conditionalCreate
|
TU | 0..1 | boolean | If allows/uses conditional create
|
||||
|
conditionalRead
|
TU | 0..1 | code | not-supported | modified-since | not-match | full-support
Binding: Conditional Read Status ( Required) |
||||
|
conditionalUpdate
|
TU | 0..1 | boolean | If allows/uses conditional update
|
||||
|
conditionalPatch
|
TU | 0..1 | boolean | If allows/uses conditional patch
|
||||
|
conditionalDelete
|
TU | 0..1 | code | not-supported | single | multiple - how conditional delete is supported
Binding: Conditional Delete Status ( Required) |
||||
|
referencePolicy
|
TU | 0..* | code | literal | logical | resolves | enforced | local
Binding: Reference Handling Policy ( Required) |
||||
|
searchInclude
|
TU | 0..* | string | _include values supported by the server
|
||||
|
searchRevInclude
|
TU | 0..* | string | _revinclude values supported by the server
|
||||
|
searchParam
|
C | 0..* | BackboneElement | Search parameters supported by implementation
|
||||
|
name
|
C | 1..1 | string | Name for parameter in search url
|
||||
|
definition
|
0..1 | canonical( SearchParameter) | Source of definition for parameter
|
|||||
|
type
|
1..1 | code | number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType ( Required) |
|||||
|
documentation
|
0..1 | markdown | Server-specific usage
|
|||||
|
operation
|
Σ | 0..* | BackboneElement | Definition of a resource operation
|
||||
name
|
Σ | 1..1 | string | Name by which the operation/query is invoked
|
||||
|
definition
|
Σ | 1..1 | canonical( OperationDefinition) | The defined operation/query
|
||||
|
documentation
|
T | 0..1 | markdown | Specific details about operation behavior
|
||||
|
interaction
|
0..* | BackboneElement | What operations are supported?
|
|||||
|
code
|
1..1 | code | transaction | batch | search-system | history-system
Binding: System Restful Interaction ( Required) |
|||||
|
documentation
|
T | 0..1 | markdown | Anything special about operation behavior
|
||||
searchParam
|
0..* | see searchParam | Search parameters for searching all resources
|
|||||
|
operation
|
Σ | 0..* | see operation | Definition of a system level operation
|
||||
|
compartment
|
0..* | canonical( CompartmentDefinition) | Compartments served/used by system
|
|||||
|
messaging
|
Σ C TU | 0..* | BackboneElement | If messaging is supported
|
||||
|
endpoint
|
C | 0..* | BackboneElement | Where messages should be sent
|
||||
|
protocol
|
1..1 | Coding | http | ftp | mllp +
Binding: Message Transport ( Extensible) |
|||||
|
address
|
1..1 | url | Network address or identifier of the end-point
|
|||||
|
reliableCache
|
0..1 | unsignedInt | Reliable Message Cache Length (min)
|
|||||
|
documentation
|
T | 0..1 | markdown | Messaging interface behavior details
|
||||
|
supportedMessage
|
Σ | 0..* | BackboneElement | Messages supported by this system
|
||||
|
mode
|
Σ | 1..1 | code | sender | receiver
Binding: Event Capability Mode ( Required) |
||||
|
definition
|
Σ | 1..1 | canonical( MessageDefinition) | Message supported by this system
|
||||
|
document
|
Σ C TU | 0..* | BackboneElement | Document definition
|
||||
|
mode
|
Σ C | 1..1 | code | producer | consumer
Binding: Document Mode ( Required) |
||||
|
documentation
|
T | 0..1 | markdown | Description of document support
|
||||
|
profile
|
Σ C | 1..1 | canonical( StructureDefinition) | Constraint on the resources used in the document
|
||||
|
Documentation for this format
|
||||||||