Name Flags Card. Type Description & Constraints CapabilityStatement 0..* CapabilityStatement This is an abstract profile. A statement of system capabilities Slices for rest 0..* BackboneElement If the endpoint is a RESTful one Slice: Unordered, Open by value:mode rest:All Slices Content/Rules for all slices Slices for resource 0..* BackboneElement Resource served on the REST interface Slice: Unordered, Open by value:type resource:LocationSlice 0..1 BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: Location resource:OrganizationSlice 0..1 BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: Organization resource:MeasureSlice 0..1 BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: Measure resource:MeasureReportSlice 0..1 BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: MeasureReport resource:QuestionnaireSlice 0..1 BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: Questionnaire resource:QuestionnaireResponseSlice 0..1 BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: QuestionnaireResponse resource:LibrarySlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: Library resource:ConceptMapSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: ConceptMap resource:ValueSetSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: ValueSet resource:CodeSystemSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: CodeSystem resource:PatientSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: Patient resource:AllergyIntoleranceSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: AllergyIntolerance resource:ConditionSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: Condition resource:DocumentReferenceSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: DocumentReference resource:DiagnosticReportSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: DiagnosticReport resource:EncounterSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: Encounter resource:FamilyMemberHistorySlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: FamilyMemberHistory resource:MedicationAdministrationSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: MedicationAdministration resource:MedicationDispenseSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: MedicationDispense resource:MedicationRequestSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: MedicationRequest resource:MedicationStatementSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: MedicationStatement resource:ObservationSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: Observation resource:ProcedureSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: Procedure resource:ServiceRequestSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: ServiceRequest resource:ParametersSlice 0..* BackboneElement Resource served on the REST interface type 1..1 code A resource type that is supported Fixed Value: Parameters rest:clientSlice 0..1 BackboneElement If the endpoint is a RESTful one mode 1..1 code client | server Fixed Value: client rest:serverSlice 0..1 BackboneElement If the endpoint is a RESTful one mode 1..1 code client | server Fixed Value: server Documentation for this format
A Capability Statement with slicing defined
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.
Applications may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement-operation-versions.html) operation). If they do, then a CapabilityStatement describes the system's support for a particular version of FHIR, and the server will have multiple statements, one for each version.
Name should be usable as an identifier for the module by machine processing applications such as code generation
not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')
A Capability Statement SHALL have at least one of REST, messaging or document element.
rest.exists() or messaging.exists() or document.exists()
exists(f:rest) or exists(f:messaging) or exists(f:document)
A Capability Statement SHALL have at least one of description, software, or implementation element.
(description.count() + software.count() + implementation.count()) > 0
count(f:software | f:implementation | f:description) > 0
Messaging end-point is required (and is only permitted) when a statement is for an implementation.
messaging.endpoint.empty() or kind = 'instance'
not(exists(f:messaging/f:endpoint)) or f:kind/@value = 'instance'
The set of documents must be unique by the combination of profile and mode.
count(f:document[f:mode/@value='producer'])=count(distinct-values(f:document[f:mode/@value='producer']/f:profile/f:reference/@value)) and count(f:document[f:mode/@value='consumer'])=count(distinct-values(f:document[f:mode/@value='consumer']/f:profile/f:reference/@value))
If kind = instance, implementation must be present and software may be present
(kind != 'instance') or implementation.exists()
not(f:kind/@value='instance') or exists(f:implementation)
If kind = capability, implementation must be absent, software must be present
(kind != 'capability') or (implementation.exists().not() and software.exists())
not(f:kind/@value='instance') or (not(exists(f:implementation)) and exists(f:software))
If kind = requirements, implementation and software must be absent
(kind!='requirements') or (implementation.exists().not() and software.exists().not())
not(f:kind/@value='instance') or (not(exists(f:implementation)) and not(exists(f:software)))
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The 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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A 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.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A 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.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These 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.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Additional content defined by implementations
May 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.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
May 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).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this capability statement, represented as a URI (globally unique)
An 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.
Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](http://hl7.org/fhir/R4/resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](http://hl7.org/fhir/R4/resource.html#meta) element to indicate where the current master source of the resource can be found.
Allows the capability statement to be referenced by a single globally unique identifier.
Business version of the capability statement
The 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.
There may be different capability statement instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the capability statement with the format [url]|[version].
Name for this capability statement (computer friendly)
A 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.
The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Support human navigation and code generation.
Name for this capability statement (human friendly)
A short, descriptive, user-friendly title for the capability statement.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
The status of this capability statement. Enables tracking the life-cycle of the content.
Allows filtering of capability statements that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
A 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.
Allows filtering of capability statements that are appropriate for use versus not.
Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement.
The 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.
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
Name of the publisher (organization or individual)
The name of the organization or individual that published the capability statement.
Usually an organization but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.
Helps establish the "authority/credibility" of the capability statement. May also allow for contact.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc.
Natural language description of the capability statement
A 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.
This description can be used to capture details such as why the capability statement was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the capability statement as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the capability statement is presumed to be the predominant language in the place the capability statement was created).This does not need to be populated if the description is adequately implied by the software or implementation details.
The context that the content is intended to support
The 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.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for capability statement (if applicable)
A legal or geographic region in which the capability statement is intended to be used.
It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended.
Countries and regions within which this artifact is targeted for use.
Why this capability statement is defined
Explanation of why this capability statement is needed and why it has been designed as it has.
This element does not describe the usage of the capability statement. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this capability statement.
A 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.
Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content.
The 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).
How a capability statement is intended to be used.
Canonical URL of another capability statement this implements
Reference 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.
HL7 defines the following Services: [Terminology Service](terminology-service.html). Many [Implementation Guides](http://fhir.org/guides/registry) define additional services.
Canonical URL of another capability statement this adds to
Reference 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.
the contents of any directly or indirectly imported CapabilityStatements SHALL NOT overlap, i.e. they cannot refer to the same rest/resource, operations/name, searchparam/name, interaction/code, messaging/endpoint, document/mode pair. A capability statement that imports another CapabilityStatement automatically instantiates it too (though this is often not a very useful statement for the kinds of CapabilityStatements that are suitable for importing).
Software that is covered by this capability statement
Software 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.
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
May 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.
Extensions that cannot be ignored even if unrecognized
May 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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The version identifier for the software covered by this statement.
If possible, a version should be specified, as statements are likely to be different for different versions of software.
Date this version of the software was released.
Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
Information about the specific installation that this capability statement relates to.
An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.
The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.
The 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.
Servers may implement multiple versions (see [Managing Multiple Versions](versioning.html), and the [$versions](capabilitystatement-operation-versions.html) operation). If they do, and the CapabilityStatement is requested from the server, then this fhirVersion will be either the version requested, or the server's default version.
formats supported (xml | json | ttl | mime type)
A list of the formats supported by this implementation using their content types.
"xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.
The mime type of an attachment. Any valid mime type is allowed.
A list of the patch formats supported by this implementation using their content types.
At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats and match the formats it supports, but this is not always possible or necessary.
A list of implementation guides that the server does (or should) support in their entirety.
A definition of the restful capabilities of the solution, if any.
Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).
A given resource can only be described once per RESTful mode.
Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
The mode of a RESTful capability statement.
Information about the system's restful capabilities that apply across all applications, such as security.
Information about security of implementation
Information about security implementation from an interface perspective - what a client needs to know.
Adds CORS Headers (http://enable-cors.org/)
Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.
The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.
OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
Types of security services that are supported/required by the system.
Types of security services used with FHIR.
General description of how security works
Slice based on the rest.resource.type pattern
A specification of the restful capabilities of the solution for a specific resource type.
Max of one repetition per resource type.
Search parameter names must be unique in the context of a resource.
A type of resource exposed via the restful interface.
One of the resource types defined as part of this version of FHIR.
Base System profile for all uses of resource
A 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](profiling.html#profile-uses).
The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.
A 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](profiling.html#profile-uses).
Supported profiles are different than the profile that applies to a particular resource in .rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports - this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that do? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile).
Additional information about the use of the resource type
Additional information about the resource type used by the system.
Identifies a restful operation supported by the solution.
In general, a Resource will only appear in a CapabilityStatement if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).
read | vread | update | patch | delete | history-instance | history-type | create | search-type
Coded identifier of the operation, supported by the system resource.
Operations supported by REST at the type or instance level.
Anything special about operation behavior
Guidance 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'.
REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.
no-version | versioned | versioned-update
This 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.
If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so.
How the system supports versioning for a resource.
A flag for whether the server is able to return past versions as part of the vRead operation.
It is useful to support the vRead operation for current operations, even if past versions aren't available.
A 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.
Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.
A flag that indicates that the server supports conditional create.
Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.
not-supported | modified-since | not-match | full-support
A code that indicates how the server supports conditional read.
Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2.
A flag that indicates that the server supports conditional update.
Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.
not-supported | single | multiple - how conditional delete is supported
A code that indicates how the server supports conditional delete.
Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.
literal | logical | resolves | enforced | local
A set of flags that defines how references are supported.
A list of _include values supported by the server.
If this list is empty, the server does not support includes.
_revinclude values supported by the server
A list of _revinclude (reverse include) values supported by the server.
If this list is empty, the server does not support reverse includes.
Search parameters supported by implementation
Search 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.
The search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement.rest.searchParam](capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.
The name of the search parameter used in the interface.
Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.
An 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](searchparameter-definitions.html#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.
This SHOULD be present, and matches refers to a SearchParameter by its canonical URL. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource. This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.
number | date | string | token | reference | composite | quantity | uri | special
The type of value a search parameter refers to, and how the content is interpreted.
While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition.
Data types allowed to be used for search parameters.
This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
Definition 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.
Operations linked from CapabilityStatement.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true. If an operation that is listed in multiple CapabilityStatement.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.
Name by which the operation/query is invoked
The 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.
The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the "$" portion that is always included in the URL.
Where 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](operationdefinition.html#) with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.
This can be used to build an HTML form to invoke the operation, for instance.
Specific details about operation behavior
Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.
A specification of restful operations supported by the system.
transaction | batch | search-system | history-system
A coded identifier of the operation, supported by the system.
Operations supported by REST at the system level.
Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.
Search parameters for searching all resources
Search 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.
Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement.rest.searchParam](capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](searchparameter.html#) definitions.
Definition of an operation or a named query together with its parameters and their meaning and type.
CapabilityStatement.rest.operation is for operations invoked at the system level, or for operations that are supported across multiple resource types. Operations linked from CapabilityStatement.rest.operation must have OperationDefinition.system = true, or more than one Operation.resource.
An 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 .
At present, the only defined compartments are at [CompartmentDefinition](compartmentdefinition.html).
A description of the messaging capabilities of the solution.
Multiple repetitions allow the documentation of multiple endpoints per solution.
An endpoint (network accessible address) to which messages and/or replies are to be sent.
A list of the messaging transport protocol(s) identifiers, supported by this endpoint.
The protocol used for message transport.
Network address or identifier of the end-point
The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.
Length 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).
If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.
Documentation 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.
References to message definitions for messages this system can send or receive.
This is a proposed alternative to the messaging.event structure.
The mode of this event declaration - whether application is sender or receiver.
The mode of a message capability statement.
Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.
Mode of this document declaration - whether an application is a producer or consumer.
Whether the application produces or consumes documents.
A 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.
Constraint on the resources used in the document
A profile on the document Bundle that constrains which resources are present, and their contents.