Skip to main content

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.

Properties

NameCardTypeDescription
id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
url0..1uriCanonical identifier for this capability statement, represented as a URI (globally unique)
version0..1stringBusiness version of the capability statement
name0..1stringName for this capability statement (computer friendly)
title0..1stringName for this capability statement (human friendly)
status1..1codedraft | active | retired | unknown
experimental0..1booleanFor testing purposes, not real usage
date1..1dateTimeDate last changed
publisher0..1stringName of the publisher (organization or individual)
contact0..*ContactDetailContact details for the publisher
description0..1markdownNatural language description of the capability statement
useContext0..*UsageContextThe context that the content is intended to support
jurisdiction0..*CodeableConceptIntended jurisdiction for capability statement (if applicable)
purpose0..1markdownWhy this capability statement is defined
copyright0..1markdownUse and/or publishing restrictions
kind1..1codeinstance | capability | requirements
instantiates0..*canonicalCanonical URL of another capability statement this implements
imports0..*canonicalCanonical URL of another capability statement this adds to
software0..1BackboneElementSoftware that is covered by this capability statement
implementation0..1BackboneElementIf this describes a specific instance
fhirVersion1..1codeFHIR Version the system supports
format1..*codeformats supported (xml | json | ttl | mime type)
patchFormat0..*codePatch formats supported
implementationGuide0..*canonicalImplementation guides supported
rest0..*BackboneElementIf the endpoint is a RESTful one
messaging0..*BackboneElementIf messaging is supported
document0..*BackboneElementDocument definition

Search Parameters

NameTypeDescriptionExpression
contexttokenA use context assigned to the capability statementCapabilityStatement.useContext.value
context-quantityquantityA quantity- or range-valued use context assigned to the capability statementCapabilityStatement.useContext.value
context-typetokenA type of use context assigned to the capability statementCapabilityStatement.useContext.code
datedateThe capability statement publication dateCapabilityStatement.date
descriptionstringThe description of the capability statementCapabilityStatement.description
fhirversiontokenThe version of FHIRCapabilityStatement.version
formattokenformats supported (xml | json | ttl | mime type)CapabilityStatement.format
guidereferenceImplementation guides supportedCapabilityStatement.implementationGuide
jurisdictiontokenIntended jurisdiction for the capability statementCapabilityStatement.jurisdiction
modetokenMode - restful (server/client) or messaging (sender/receiver)CapabilityStatement.rest.mode
namestringComputationally friendly name of the capability statementCapabilityStatement.name
publisherstringName of the publisher of the capability statementCapabilityStatement.publisher
resourcetokenName of a resource mentioned in a capability statementCapabilityStatement.rest.resource.type
resource-profilereferenceA profile id invoked in a capability statementCapabilityStatement.rest.resource.profile
security-servicetokenOAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | CertificatesCapabilityStatement.rest.security.service
softwarestringPart of the name of a software applicationCapabilityStatement.software.name
statustokenThe current status of the capability statementCapabilityStatement.status
supported-profilereferenceProfiles for use cases supportedCapabilityStatement.rest.resource.supportedProfile
titlestringThe human-friendly name of the capability statementCapabilityStatement.title
urluriThe uri that identifies the capability statementCapabilityStatement.url
versiontokenThe business version of the capability statementCapabilityStatement.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the capability statementCapabilityStatement.useContext
context-type-valuecompositeA use context type and value assigned to the capability statementCapabilityStatement.useContext