Skip to main content

CapabilityStatement

PropertyValue
Publisher
NameCapabilityStatement
URLhttp://hl7.org/fhir/StructureDefinition/CapabilityStatement
Statusactive
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
CapabilityStatement0..*CapabilityStatementA 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.
CapabilityStatement.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CapabilityStatement.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
CapabilityStatement.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
CapabilityStatement.language0..1codeThe base language in which the resource is written.
CapabilityStatement.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
CapabilityStatement.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
CapabilityStatement.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.url0..1uriAn absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.
CapabilityStatement.version0..1stringThe identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
CapabilityStatement.name0..1stringA natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
CapabilityStatement.title0..1stringA short, descriptive, user-friendly title for the capability statement.
CapabilityStatement.status1..1codeThe status of this capability statement. Enables tracking the life-cycle of the content.
CapabilityStatement.experimental0..1booleanA Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
CapabilityStatement.date1..1dateTimeThe date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.
CapabilityStatement.publisher0..1stringThe name of the organization or individual that published the capability statement.
CapabilityStatement.contact0..*ContactDetailContact details to assist a user in finding and communicating with the publisher.
CapabilityStatement.description0..1markdownA free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
CapabilityStatement.useContext0..*UsageContextThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances.
CapabilityStatement.jurisdiction0..*CodeableConceptA legal or geographic region in which the capability statement is intended to be used.
CapabilityStatement.purpose0..1markdownExplanation of why this capability statement is needed and why it has been designed as it has.
CapabilityStatement.copyright0..1markdownA copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
CapabilityStatement.kind1..1codeThe way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).
CapabilityStatement.instantiates0..*canonicalReference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.
CapabilityStatement.imports0..*canonicalReference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.
CapabilityStatement.software0..1BackboneElementSoftware that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
CapabilityStatement.software.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.software.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.software.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.software.name1..1stringName the software is known by.
CapabilityStatement.software.version0..1stringThe version identifier for the software covered by this statement.
CapabilityStatement.software.releaseDate0..1dateTimeDate this version of the software was released.
CapabilityStatement.implementation0..1BackboneElementIdentifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
CapabilityStatement.implementation.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.implementation.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.implementation.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.implementation.description1..1stringInformation about the specific installation that this capability statement relates to.
CapabilityStatement.implementation.url0..1urlAn absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.
CapabilityStatement.implementation.custodian0..1ReferenceThe organization responsible for the management of the instance and oversight of the data on the server at the specified URL.
CapabilityStatement.fhirVersion1..1codeThe version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.
CapabilityStatement.format1..*codeA list of the formats supported by this implementation using their content types.
CapabilityStatement.patchFormat0..*codeA list of the patch formats supported by this implementation using their content types.
CapabilityStatement.implementationGuide0..*canonicalA list of implementation guides that the server does (or should) support in their entirety.
CapabilityStatement.rest0..*BackboneElementA definition of the restful capabilities of the solution, if any.
CapabilityStatement.rest.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.rest.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.rest.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.rest.mode1..1codeIdentifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
CapabilityStatement.rest.documentation0..1markdownInformation about the system's restful capabilities that apply across all applications, such as security.
CapabilityStatement.rest.security0..1BackboneElementInformation about security implementation from an interface perspective - what a client needs to know.
CapabilityStatement.rest.security.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.rest.security.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.rest.security.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.rest.security.cors0..1booleanServer adds CORS headers when responding to requests - this enables Javascript applications to use the server.
CapabilityStatement.rest.security.service0..*CodeableConceptTypes of security services that are supported/required by the system.
CapabilityStatement.rest.security.description0..1markdownGeneral description of how security works.
CapabilityStatement.rest.resource0..*BackboneElementA specification of the restful capabilities of the solution for a specific resource type.
CapabilityStatement.rest.resource.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.rest.resource.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.rest.resource.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.rest.resource.type1..1codeA type of resource exposed via the restful interface.
CapabilityStatement.rest.resource.profile0..1canonicalA specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in Using Profiles.
CapabilityStatement.rest.resource.supportedProfile0..*canonicalA list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in Using Profiles.
CapabilityStatement.rest.resource.documentation0..1markdownAdditional information about the resource type used by the system.
CapabilityStatement.rest.resource.interaction0..*BackboneElementIdentifies a restful operation supported by the solution.
CapabilityStatement.rest.resource.interaction.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.rest.resource.interaction.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.rest.resource.interaction.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.rest.resource.interaction.code1..1codeCoded identifier of the operation, supported by the system resource.
CapabilityStatement.rest.resource.interaction.documentation0..1markdownGuidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.
CapabilityStatement.rest.resource.versioning0..1codeThis field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.
CapabilityStatement.rest.resource.readHistory0..1booleanA flag for whether the server is able to return past versions as part of the vRead operation.
CapabilityStatement.rest.resource.updateCreate0..1booleanA flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.
CapabilityStatement.rest.resource.conditionalCreate0..1booleanA flag that indicates that the server supports conditional create.
CapabilityStatement.rest.resource.conditionalRead0..1codeA code that indicates how the server supports conditional read.
CapabilityStatement.rest.resource.conditionalUpdate0..1booleanA flag that indicates that the server supports conditional update.
CapabilityStatement.rest.resource.conditionalDelete0..1codeA code that indicates how the server supports conditional delete.
CapabilityStatement.rest.resource.referencePolicy0..*codeA set of flags that defines how references are supported.
CapabilityStatement.rest.resource.searchInclude0..*stringA list of _include values supported by the server.
CapabilityStatement.rest.resource.searchRevInclude0..*stringA list of _revinclude (reverse include) values supported by the server.
CapabilityStatement.rest.resource.searchParam0..*BackboneElementSearch parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
CapabilityStatement.rest.resource.searchParam.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.rest.resource.searchParam.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.rest.resource.searchParam.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.rest.resource.searchParam.name1..1stringThe name of the search parameter used in the interface.
CapabilityStatement.rest.resource.searchParam.definition0..1canonicalAn absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to SearchParameter.url). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.
CapabilityStatement.rest.resource.searchParam.type1..1codeThe type of value a search parameter refers to, and how the content is interpreted.
CapabilityStatement.rest.resource.searchParam.documentation0..1markdownThis allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
CapabilityStatement.rest.resource.operation0..*BackboneElementDefinition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.
CapabilityStatement.rest.resource.operation.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.rest.resource.operation.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.rest.resource.operation.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.rest.resource.operation.name1..1stringThe name of the operation or query. For an operation, this is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.
CapabilityStatement.rest.resource.operation.definition1..1canonicalWhere the formal definition can be found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand\`\`\`), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom OperationDefinition with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.
CapabilityStatement.rest.resource.operation.documentation0..1markdownDocumentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.
CapabilityStatement.rest.interaction0..*BackboneElementA specification of restful operations supported by the system.
CapabilityStatement.rest.interaction.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.rest.interaction.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.rest.interaction.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.rest.interaction.code1..1codeA coded identifier of the operation, supported by the system.
CapabilityStatement.rest.interaction.documentation0..1markdownGuidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.
CapabilityStatement.rest.searchParam0..*CapabilityStatementSearch parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
CapabilityStatement.rest.operation0..*CapabilityStatementDefinition of an operation or a named query together with its parameters and their meaning and type.
CapabilityStatement.rest.compartment0..*canonicalAn absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .
CapabilityStatement.messaging0..*BackboneElementA description of the messaging capabilities of the solution.
CapabilityStatement.messaging.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.messaging.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.messaging.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.messaging.endpoint0..*BackboneElementAn endpoint (network accessible address) to which messages and/or replies are to be sent.
CapabilityStatement.messaging.endpoint.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.messaging.endpoint.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.messaging.endpoint.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.messaging.endpoint.protocol1..1CodingA list of the messaging transport protocol(s) identifiers, supported by this endpoint.
CapabilityStatement.messaging.endpoint.address1..1urlThe network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.
CapabilityStatement.messaging.reliableCache0..1unsignedIntLength if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).
CapabilityStatement.messaging.documentation0..1markdownDocumentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.
CapabilityStatement.messaging.supportedMessage0..*BackboneElementReferences to message definitions for messages this system can send or receive.
CapabilityStatement.messaging.supportedMessage.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.messaging.supportedMessage.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.messaging.supportedMessage.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.messaging.supportedMessage.mode1..1codeThe mode of this event declaration - whether application is sender or receiver.
CapabilityStatement.messaging.supportedMessage.definition1..1canonicalPoints to a message definition that identifies the messaging event, message structure, allowed responses, etc.
CapabilityStatement.document0..*BackboneElementA document definition.
CapabilityStatement.document.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
CapabilityStatement.document.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
CapabilityStatement.document.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
CapabilityStatement.document.mode1..1codeMode of this document declaration - whether an application is a producer or consumer.
CapabilityStatement.document.documentation0..1markdownA description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.
CapabilityStatement.document.profile1..1canonicalA profile on the document Bundle that constrains which resources are present, and their contents.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
contexttokenMultiple Resources: * CapabilityStatement: A use context assigned to the capability statement* CodeSystem: A use context assigned to the code system* CompartmentDefinition: A use context assigned to the compartment definition* ConceptMap: A use context assigned to the concept map* GraphDefinition: A use context assigned to the graph definition* ImplementationGuide: A use context assigned to the implementation guide* MessageDefinition: A use context assigned to the message definition* NamingSystem: A use context assigned to the naming system* OperationDefinition: A use context assigned to the operation definition* SearchParameter: A use context assigned to the search parameter* StructureDefinition: A use context assigned to the structure definition* StructureMap: A use context assigned to the structure map* TerminologyCapabilities: A use context assigned to the terminology capabilities* ValueSet: A use context assigned to the value set(CapabilityStatement.useContext.value.ofType(CodeableConcept)) / (CodeSystem.useContext.value.ofType(CodeableConcept)) / (CompartmentDefinition.useContext.value.ofType(CodeableConcept)) / (ConceptMap.useContext.value.ofType(CodeableConcept)) / (GraphDefinition.useContext.value.ofType(CodeableConcept)) / (ImplementationGuide.useContext.value.ofType(CodeableConcept)) / (MessageDefinition.useContext.value.ofType(CodeableConcept)) / (NamingSystem.useContext.value.ofType(CodeableConcept)) / (OperationDefinition.useContext.value.ofType(CodeableConcept)) / (SearchParameter.useContext.value.ofType(CodeableConcept)) / (StructureDefinition.useContext.value.ofType(CodeableConcept)) / (StructureMap.useContext.value.ofType(CodeableConcept)) / (TerminologyCapabilities.useContext.value.ofType(CodeableConcept)) / (ValueSet.useContext.value.ofType(CodeableConcept))
context-quantityquantityMultiple Resources: * CapabilityStatement: A quantity- or range-valued use context assigned to the capability statement* CodeSystem: A quantity- or range-valued use context assigned to the code system* CompartmentDefinition: A quantity- or range-valued use context assigned to the compartment definition* ConceptMap: A quantity- or range-valued use context assigned to the concept map* GraphDefinition: A quantity- or range-valued use context assigned to the graph definition* ImplementationGuide: A quantity- or range-valued use context assigned to the implementation guide* MessageDefinition: A quantity- or range-valued use context assigned to the message definition* NamingSystem: A quantity- or range-valued use context assigned to the naming system* OperationDefinition: A quantity- or range-valued use context assigned to the operation definition* SearchParameter: A quantity- or range-valued use context assigned to the search parameter* StructureDefinition: A quantity- or range-valued use context assigned to the structure definition* StructureMap: A quantity- or range-valued use context assigned to the structure map* TerminologyCapabilities: A quantity- or range-valued use context assigned to the terminology capabilities* ValueSet: A quantity- or range-valued use context assigned to the value set(CapabilityStatement.useContext.value.ofType(Quantity)) / (CapabilityStatement.useContext.value.ofType(Range)) / (CodeSystem.useContext.value.ofType(Quantity)) / (CodeSystem.useContext.value.ofType(Range)) / (CompartmentDefinition.useContext.value.ofType(Quantity)) / (CompartmentDefinition.useContext.value.ofType(Range)) / (ConceptMap.useContext.value.ofType(Quantity)) / (ConceptMap.useContext.value.ofType(Range)) / (GraphDefinition.useContext.value.ofType(Quantity)) / (GraphDefinition.useContext.value.ofType(Range)) / (ImplementationGuide.useContext.value.ofType(Quantity)) / (ImplementationGuide.useContext.value.ofType(Range)) / (MessageDefinition.useContext.value.ofType(Quantity)) / (MessageDefinition.useContext.value.ofType(Range)) / (NamingSystem.useContext.value.ofType(Quantity)) / (NamingSystem.useContext.value.ofType(Range)) / (OperationDefinition.useContext.value.ofType(Quantity)) / (OperationDefinition.useContext.value.ofType(Range)) / (SearchParameter.useContext.value.ofType(Quantity)) / (SearchParameter.useContext.value.ofType(Range)) / (StructureDefinition.useContext.value.ofType(Quantity)) / (StructureDefinition.useContext.value.ofType(Range)) / (StructureMap.useContext.value.ofType(Quantity)) / (StructureMap.useContext.value.ofType(Range)) / (TerminologyCapabilities.useContext.value.ofType(Quantity)) / (TerminologyCapabilities.useContext.value.ofType(Range)) / (ValueSet.useContext.value.ofType(Quantity)) / (ValueSet.useContext.value.ofType(Range))
context-typetokenMultiple Resources: * CapabilityStatement: A type of use context assigned to the capability statement* CodeSystem: A type of use context assigned to the code system* CompartmentDefinition: A type of use context assigned to the compartment definition* ConceptMap: A type of use context assigned to the concept map* GraphDefinition: A type of use context assigned to the graph definition* ImplementationGuide: A type of use context assigned to the implementation guide* MessageDefinition: A type of use context assigned to the message definition* NamingSystem: A type of use context assigned to the naming system* OperationDefinition: A type of use context assigned to the operation definition* SearchParameter: A type of use context assigned to the search parameter* StructureDefinition: A type of use context assigned to the structure definition* StructureMap: A type of use context assigned to the structure map* TerminologyCapabilities: A type of use context assigned to the terminology capabilities* ValueSet: A type of use context assigned to the value setCapabilityStatement.useContext.code / CodeSystem.useContext.code / CompartmentDefinition.useContext.code / ConceptMap.useContext.code / GraphDefinition.useContext.code / ImplementationGuide.useContext.code / MessageDefinition.useContext.code / NamingSystem.useContext.code / OperationDefinition.useContext.code / SearchParameter.useContext.code / StructureDefinition.useContext.code / StructureMap.useContext.code / TerminologyCapabilities.useContext.code / ValueSet.useContext.code
datedateMultiple Resources: * CapabilityStatement: The capability statement publication date* CodeSystem: The code system publication date* CompartmentDefinition: The compartment definition publication date* ConceptMap: The concept map publication date* GraphDefinition: The graph definition publication date* ImplementationGuide: The implementation guide publication date* MessageDefinition: The message definition publication date* NamingSystem: The naming system publication date* OperationDefinition: The operation definition publication date* SearchParameter: The search parameter publication date* StructureDefinition: The structure definition publication date* StructureMap: The structure map publication date* TerminologyCapabilities: The terminology capabilities publication date* ValueSet: The value set publication dateCapabilityStatement.date / CodeSystem.date / CompartmentDefinition.date / ConceptMap.date / GraphDefinition.date / ImplementationGuide.date / MessageDefinition.date / NamingSystem.date / OperationDefinition.date / SearchParameter.date / StructureDefinition.date / StructureMap.date / TerminologyCapabilities.date / ValueSet.date
descriptionstringMultiple Resources: * CapabilityStatement: The description of the capability statement* CodeSystem: The description of the code system* CompartmentDefinition: The description of the compartment definition* ConceptMap: The description of the concept map* GraphDefinition: The description of the graph definition* ImplementationGuide: The description of the implementation guide* MessageDefinition: The description of the message definition* NamingSystem: The description of the naming system* OperationDefinition: The description of the operation definition* SearchParameter: The description of the search parameter* StructureDefinition: The description of the structure definition* StructureMap: The description of the structure map* TerminologyCapabilities: The description of the terminology capabilities* ValueSet: The description of the value setCapabilityStatement.description / CodeSystem.description / CompartmentDefinition.description / ConceptMap.description / GraphDefinition.description / ImplementationGuide.description / MessageDefinition.description / NamingSystem.description / OperationDefinition.description / SearchParameter.description / StructureDefinition.description / StructureMap.description / TerminologyCapabilities.description / ValueSet.description
fhirversiontokenThe version of FHIRCapabilityStatement.version
formattokenformats supported (xml / json / ttl / mime type)CapabilityStatement.format
guidereferenceImplementation guides supportedCapabilityStatement.implementationGuide
jurisdictiontokenMultiple Resources: * CapabilityStatement: Intended jurisdiction for the capability statement* CodeSystem: Intended jurisdiction for the code system* ConceptMap: Intended jurisdiction for the concept map* GraphDefinition: Intended jurisdiction for the graph definition* ImplementationGuide: Intended jurisdiction for the implementation guide* MessageDefinition: Intended jurisdiction for the message definition* NamingSystem: Intended jurisdiction for the naming system* OperationDefinition: Intended jurisdiction for the operation definition* SearchParameter: Intended jurisdiction for the search parameter* StructureDefinition: Intended jurisdiction for the structure definition* StructureMap: Intended jurisdiction for the structure map* TerminologyCapabilities: Intended jurisdiction for the terminology capabilities* ValueSet: Intended jurisdiction for the value setCapabilityStatement.jurisdiction / CodeSystem.jurisdiction / ConceptMap.jurisdiction / GraphDefinition.jurisdiction / ImplementationGuide.jurisdiction / MessageDefinition.jurisdiction / NamingSystem.jurisdiction / OperationDefinition.jurisdiction / SearchParameter.jurisdiction / StructureDefinition.jurisdiction / StructureMap.jurisdiction / TerminologyCapabilities.jurisdiction / ValueSet.jurisdiction
modetokenMode - restful (server/client) or messaging (sender/receiver)CapabilityStatement.rest.mode
namestringMultiple Resources: * CapabilityStatement: Computationally friendly name of the capability statement* CodeSystem: Computationally friendly name of the code system* CompartmentDefinition: Computationally friendly name of the compartment definition* ConceptMap: Computationally friendly name of the concept map* GraphDefinition: Computationally friendly name of the graph definition* ImplementationGuide: Computationally friendly name of the implementation guide* MessageDefinition: Computationally friendly name of the message definition* NamingSystem: Computationally friendly name of the naming system* OperationDefinition: Computationally friendly name of the operation definition* SearchParameter: Computationally friendly name of the search parameter* StructureDefinition: Computationally friendly name of the structure definition* StructureMap: Computationally friendly name of the structure map* TerminologyCapabilities: Computationally friendly name of the terminology capabilities* ValueSet: Computationally friendly name of the value setCapabilityStatement.name / CodeSystem.name / CompartmentDefinition.name / ConceptMap.name / GraphDefinition.name / ImplementationGuide.name / MessageDefinition.name / NamingSystem.name / OperationDefinition.name / SearchParameter.name / StructureDefinition.name / StructureMap.name / TerminologyCapabilities.name / ValueSet.name
publisherstringMultiple Resources: * CapabilityStatement: Name of the publisher of the capability statement* CodeSystem: Name of the publisher of the code system* CompartmentDefinition: Name of the publisher of the compartment definition* ConceptMap: Name of the publisher of the concept map* GraphDefinition: Name of the publisher of the graph definition* ImplementationGuide: Name of the publisher of the implementation guide* MessageDefinition: Name of the publisher of the message definition* NamingSystem: Name of the publisher of the naming system* OperationDefinition: Name of the publisher of the operation definition* SearchParameter: Name of the publisher of the search parameter* StructureDefinition: Name of the publisher of the structure definition* StructureMap: Name of the publisher of the structure map* TerminologyCapabilities: Name of the publisher of the terminology capabilities* ValueSet: Name of the publisher of the value setCapabilityStatement.publisher / CodeSystem.publisher / CompartmentDefinition.publisher / ConceptMap.publisher / GraphDefinition.publisher / ImplementationGuide.publisher / MessageDefinition.publisher / NamingSystem.publisher / OperationDefinition.publisher / SearchParameter.publisher / StructureDefinition.publisher / StructureMap.publisher / TerminologyCapabilities.publisher / ValueSet.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
statustokenMultiple Resources: * CapabilityStatement: The current status of the capability statement* CodeSystem: The current status of the code system* CompartmentDefinition: The current status of the compartment definition* ConceptMap: The current status of the concept map* GraphDefinition: The current status of the graph definition* ImplementationGuide: The current status of the implementation guide* MessageDefinition: The current status of the message definition* NamingSystem: The current status of the naming system* OperationDefinition: The current status of the operation definition* SearchParameter: The current status of the search parameter* StructureDefinition: The current status of the structure definition* StructureMap: The current status of the structure map* TerminologyCapabilities: The current status of the terminology capabilities* ValueSet: The current status of the value setCapabilityStatement.status / CodeSystem.status / CompartmentDefinition.status / ConceptMap.status / GraphDefinition.status / ImplementationGuide.status / MessageDefinition.status / NamingSystem.status / OperationDefinition.status / SearchParameter.status / StructureDefinition.status / StructureMap.status / TerminologyCapabilities.status / ValueSet.status
supported-profilereferenceProfiles for use cases supportedCapabilityStatement.rest.resource.supportedProfile
titlestringMultiple Resources: * CapabilityStatement: The human-friendly name of the capability statement* CodeSystem: The human-friendly name of the code system* ConceptMap: The human-friendly name of the concept map* ImplementationGuide: The human-friendly name of the implementation guide* MessageDefinition: The human-friendly name of the message definition* OperationDefinition: The human-friendly name of the operation definition* StructureDefinition: The human-friendly name of the structure definition* StructureMap: The human-friendly name of the structure map* TerminologyCapabilities: The human-friendly name of the terminology capabilities* ValueSet: The human-friendly name of the value setCapabilityStatement.title / CodeSystem.title / ConceptMap.title / ImplementationGuide.title / MessageDefinition.title / OperationDefinition.title / StructureDefinition.title / StructureMap.title / TerminologyCapabilities.title / ValueSet.title
urluriMultiple Resources: * CapabilityStatement: The uri that identifies the capability statement* CodeSystem: The uri that identifies the code system* CompartmentDefinition: The uri that identifies the compartment definition* ConceptMap: The uri that identifies the concept map* GraphDefinition: The uri that identifies the graph definition* ImplementationGuide: The uri that identifies the implementation guide* MessageDefinition: The uri that identifies the message definition* OperationDefinition: The uri that identifies the operation definition* SearchParameter: The uri that identifies the search parameter* StructureDefinition: The uri that identifies the structure definition* StructureMap: The uri that identifies the structure map* TerminologyCapabilities: The uri that identifies the terminology capabilities* ValueSet: The uri that identifies the value setCapabilityStatement.url / CodeSystem.url / CompartmentDefinition.url / ConceptMap.url / GraphDefinition.url / ImplementationGuide.url / MessageDefinition.url / OperationDefinition.url / SearchParameter.url / StructureDefinition.url / StructureMap.url / TerminologyCapabilities.url / ValueSet.url
versiontokenMultiple Resources: * CapabilityStatement: The business version of the capability statement* CodeSystem: The business version of the code system* CompartmentDefinition: The business version of the compartment definition* ConceptMap: The business version of the concept map* GraphDefinition: The business version of the graph definition* ImplementationGuide: The business version of the implementation guide* MessageDefinition: The business version of the message definition* OperationDefinition: The business version of the operation definition* SearchParameter: The business version of the search parameter* StructureDefinition: The business version of the structure definition* StructureMap: The business version of the structure map* TerminologyCapabilities: The business version of the terminology capabilities* ValueSet: The business version of the value setCapabilityStatement.version / CodeSystem.version / CompartmentDefinition.version / ConceptMap.version / GraphDefinition.version / ImplementationGuide.version / MessageDefinition.version / OperationDefinition.version / SearchParameter.version / StructureDefinition.version / StructureMap.version / TerminologyCapabilities.version / ValueSet.version
context-type-quantitycompositeMultiple Resources: * CapabilityStatement: A use context type and quantity- or range-based value assigned to the capability statement* CodeSystem: A use context type and quantity- or range-based value assigned to the code system* CompartmentDefinition: A use context type and quantity- or range-based value assigned to the compartment definition* ConceptMap: A use context type and quantity- or range-based value assigned to the concept map* GraphDefinition: A use context type and quantity- or range-based value assigned to the graph definition* ImplementationGuide: A use context type and quantity- or range-based value assigned to the implementation guide* MessageDefinition: A use context type and quantity- or range-based value assigned to the message definition* NamingSystem: A use context type and quantity- or range-based value assigned to the naming system* OperationDefinition: A use context type and quantity- or range-based value assigned to the operation definition* SearchParameter: A use context type and quantity- or range-based value assigned to the search parameter* StructureDefinition: A use context type and quantity- or range-based value assigned to the structure definition* StructureMap: A use context type and quantity- or range-based value assigned to the structure map* TerminologyCapabilities: A use context type and quantity- or range-based value assigned to the terminology capabilities* ValueSet: A use context type and quantity- or range-based value assigned to the value setCapabilityStatement.useContext / CodeSystem.useContext / CompartmentDefinition.useContext / ConceptMap.useContext / GraphDefinition.useContext / ImplementationGuide.useContext / MessageDefinition.useContext / NamingSystem.useContext / OperationDefinition.useContext / SearchParameter.useContext / StructureDefinition.useContext / StructureMap.useContext / TerminologyCapabilities.useContext / ValueSet.useContext
context-type-valuecompositeMultiple Resources: * CapabilityStatement: A use context type and value assigned to the capability statement* CodeSystem: A use context type and value assigned to the code system* CompartmentDefinition: A use context type and value assigned to the compartment definition* ConceptMap: A use context type and value assigned to the concept map* GraphDefinition: A use context type and value assigned to the graph definition* ImplementationGuide: A use context type and value assigned to the implementation guide* MessageDefinition: A use context type and value assigned to the message definition* NamingSystem: A use context type and value assigned to the naming system* OperationDefinition: A use context type and value assigned to the operation definition* SearchParameter: A use context type and value assigned to the search parameter* StructureDefinition: A use context type and value assigned to the structure definition* StructureMap: A use context type and value assigned to the structure map* TerminologyCapabilities: A use context type and value assigned to the terminology capabilities* ValueSet: A use context type and value assigned to the value setCapabilityStatement.useContext / CodeSystem.useContext / CompartmentDefinition.useContext / ConceptMap.useContext / GraphDefinition.useContext / ImplementationGuide.useContext / MessageDefinition.useContext / NamingSystem.useContext / OperationDefinition.useContext / SearchParameter.useContext / StructureDefinition.useContext / StructureMap.useContext / TerminologyCapabilities.useContext / ValueSet.useContext