NameFlagsCard.TypeDescription & Constraintsdoco
.. CapabilityStatement IDomainResourceA statement of system Capabilities
There can only be one REST declaration per mode
The set of documents must be unique by the combination of profile & mode
Capability Statements of kind 'instance' do not have implementation elements
Messaging end-point is required (and is only permitted) when statement is for an implementation
Capability Statements of kind 'requirements' do not have software or implementation elements
A Capability Statement SHALL have at least one of description, software, or implementation
A Capability Statement SHALL have at least one of REST, messaging or document
... url Σ0..1uriLogical uri to reference this capability statement (globally unique)
... version Σ0..1stringBusiness version of the capability statement
... name Σ0..1stringName for this capability statement (Computer friendly)
... title Σ0..1stringName for this capability statement (Human friendly)
... status ?!Σ1..1codedraft | active | retired
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... date Σ1..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description I0..1markdownNatural language description of the capability statement
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for capability statement (if applicable)
Jurisdiction ValueSet (Extensible)
... purpose 0..1markdownWhy this capability statement is defined
... copyright 0..1markdownUse and/or publishing restrictions
... kind Σ1..1codeinstance | capability | requirements
CapabilityStatementKind (Required)
... instantiates Σ0..*uriCanonical URL of another capability statement this implements
... software ΣI0..1BackboneElementSoftware that is covered by this capability statement
.... name Σ1..1stringA name the software is known by
.... version Σ0..1stringVersion covered by this statement
.... releaseDate Σ0..1dateTimeDate this version released
... implementation ΣI0..1BackboneElementIf this describes a specific instance
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1uriBase URL for the installation
... fhirVersion Σ1..1idFHIR Version the system uses
... acceptUnknown Σ1..1codeno | extensions | elements | both
UnknownContentCode (Required)
... format Σ1..*codeformats supported (xml | json | ttl | mime type)
MimeType (Required)
... patchFormat Σ0..*codePatch formats supported
MimeType (Required)
... implementationGuide Σ0..*uriImplementation Guide supported
... profile Σ0..*Reference(StructureDefinition)Profiles for use cases supported
... rest ΣI0..*BackboneElementIf the endpoint is a RESTful one
A given resource can only be described once per RESTful mode
.... mode Σ1..1codeclient | server
RestfulCapabilityMode (Required)
.... documentation 0..1stringGeneral description of implementation
.... security Σ0..1BackboneElementInformation about security of implementation
..... cors Σ0..1booleanAdds CORS Headers (http://enable-cors.org/)
..... service Σ0..*CodeableConceptOAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
RestfulSecurityService (Extensible)
..... description 0..1stringGeneral description of how security works
..... certificate 0..*BackboneElementCertificates associated with security profiles
...... type 0..1codeMime type for certificate
MimeType (Required)
...... blob 0..1base64BinaryActual certificate
.... resource ΣI0..*BackboneElementResource served on the REST interface
Search parameter names must be unique in the context of a resource
..... type Σ1..1codeA resource type that is supported
ResourceType (Required)
..... profile Σ0..1Reference(StructureDefinition)Base System profile for all uses of resource
..... documentation 0..1markdownAdditional information about the use of the resource type
..... interaction 1..*BackboneElementWhat operations are supported?
...... code 1..1coderead | vread | update | patch | delete | history-instance | history-type | create | search-type
TypeRestfulInteraction (Required)
...... documentation 0..1stringAnything special about operation behavior
..... versioning 0..1codeno-version | versioned | versioned-update
ResourceVersionPolicy (Required)
..... readHistory 0..1booleanWhether vRead can return past versions
..... updateCreate 0..1booleanIf update can commit to a new identity
..... conditionalCreate 0..1booleanIf allows/uses conditional create
..... conditionalRead 0..1codenot-supported | modified-since | not-match | full-support
ConditionalReadStatus (Required)
..... conditionalUpdate 0..1booleanIf allows/uses conditional update
..... conditionalDelete 0..1codenot-supported | single | multiple - how conditional delete is supported
ConditionalDeleteStatus (Required)
..... referencePolicy 0..*codeliteral | logical | resolves | enforced | local
ReferenceHandlingPolicy (Required)
..... searchInclude 0..*string_include values supported by the server
..... searchRevInclude 0..*string_revinclude values supported by the server
..... searchParam 0..*BackboneElementSearch params supported by implementation
...... name 1..1stringName of search parameter
...... definition 0..1uriSource of definition for parameter
...... type 1..1codenumber | date | string | token | reference | composite | quantity | uri
SearchParamType (Required)
...... documentation 0..1stringServer-specific usage
.... interaction 0..*BackboneElementWhat operations are supported?
..... code 1..1codetransaction | batch | search-system | history-system
SystemRestfulInteraction (Required)
..... documentation 0..1stringAnything special about operation behavior
.... searchParam 0..*see searchParamSearch params for searching all resources
.... operation Σ0..*BackboneElementDefinition of an operation or a custom query
..... name 1..1stringName by which the operation/query is invoked
..... definition Σ1..1Reference(OperationDefinition)The defined operation/query
.... compartment 0..*uriCompartments served/used by system
... messaging ΣI0..*BackboneElementIf messaging is supported
.... endpoint 0..*BackboneElementWhere messages should be sent
..... protocol 1..1Codinghttp | ftp | mllp +
MessageTransport (Extensible)
..... address 1..1uriAddress of end-point
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation 0..1stringMessaging interface behavior details
.... event Σ1..*BackboneElementDeclare support for this event
..... code Σ1..1CodingEvent type
MessageEvent (Preferred)
..... category 0..1codeConsequence | Currency | Notification
MessageSignificanceCategory (Required)
..... mode 1..1codesender | receiver
EventCapabilityMode (Required)
..... focus 1..1codeResource that's focus of message
ResourceType (Required)
..... request Σ1..1Reference(StructureDefinition)Profile that describes the request
..... response Σ1..1Reference(StructureDefinition)Profile that describes the response
..... documentation 0..1stringEndpoint-specific event documentation
... document ΣI0..*BackboneElementDocument definition
.... mode 1..1codeproducer | consumer
DocumentMode (Required)
.... documentation 0..1stringDescription of document support
.... profile Σ1..1Reference(StructureDefinition)Constraint on a resource used in the document

doco Documentation for this format