NHS England FHIR Implementation Guide (deprecated)

NHSDigital-CapabilityStatement

Important: Experimental. This page is for illustration of a concept

Conformance url	FHIR Module	Maturity Level
https://fhir.nhs.uk/StructureDefinition/NHSDigital-CapabilityStatement	Implementation Support	draft

Conformance Rules

with CapabilityStatement

CapabilityStatement	I		CapabilityStatement	There are no (further) constraints on this element Element Id CapabilityStatement Short description A statement of system capabilities Definition 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. Comments Applications may implement multiple versions (see Managing Multiple Versions, and the $versions 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. Data Type CapabilityStatement Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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()` dom-3: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()` dom-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` cpb-7:The set of documents must be unique by the combination of profile and mode. `document.select(profile&mode).isDistinct()` cpb-16:If kind = requirements, implementation and software must be absent `(kind!='requirements') or (implementation.exists().not() and software.exists().not())` cpb-15:If kind = capability, implementation must be absent, software must be present `(kind != 'capability') or (implementation.exists().not() and software.exists())` cpb-3:Messaging end-point is required (and is only permitted) when a statement is for an implementation. `messaging.endpoint.empty() or kind = 'instance'` cpb-14:If kind = instance, implementation must be present and software may be present `(kind != 'instance') or implementation.exists()` cpb-2:A Capability Statement SHALL have at least one of description, software, or implementation element. `(description.count() + software.count() + implementation.count()) > 0` cpb-1:A Capability Statement SHALL have at least one of REST, messaging or document element. `rest.exists() or messaging.exists() or document.exists()` cpb-0:Name should be usable as an identifier for the module by machine processing applications such as code generation `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')` Mappings rim:Entity. Role, or Act rim:n/a
extension	I	0..*	Extension	Element Id CapabilityStatement.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Package	S I	0..1	Extension(Complex)	Element Id CapabilityStatement.extension:Package Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. Comments 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. Data Type Extension(Complex) Extension URL https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Package Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url	Σ	0..1	uri	There are no (further) constraints on this element Element Id CapabilityStatement.url Short description Canonical identifier for this capability statement, represented as a URI (globally unique) Definition 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. Requirements Allows the capability statement to be referenced by a single globally unique identifier. Comments 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. 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 element to indicate where the current master source of the resource can be found. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.url w5:FiveWs.identifier
version	Σ	0..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.version Short description Business version of the capability statement Definition 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. Comments 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]. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.version w5:FiveWs.version
name	Σ I	0..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.name Short description Name for this capability statement (computer friendly) Definition 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. Requirements Support human navigation and code generation. Comments 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
title	Σ	0..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.title Short description Name for this capability statement (human friendly) Definition A short, descriptive, user-friendly title for the capability statement. Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.title
status	S Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.status Short description draft \| active \| retired \| unknown Definition The status of this capability statement. Enables tracking the life-cycle of the content. Comments 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. Data Type code Binding The lifecycle status of an artifact. PublicationStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.status w5:FiveWs.status
experimental	Σ	0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.experimental Short description For testing purposes, not real usage Definition 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. Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement. Comments Allows filtering of capability statements that are appropriate for use versus not. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.experimental w5:FiveWs.class
date	Σ	1..1	dateTime	There are no (further) constraints on this element Element Id CapabilityStatement.date Short description Date last changed Alternate names Revision Date Definition 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. Comments 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. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.date w5:FiveWs.recorded
publisher	Σ	1..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.publisher Short description Name of the publisher (organization or individual) Definition The name of the organization or individual that published the capability statement. Requirements Helps establish the "authority/credibility" of the capability statement. May also allow for contact. Comments 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.publisher w5:FiveWs.witness
contact	Σ	0..*	ContactDetail	There are no (further) constraints on this element Element Id CapabilityStatement.contact Short description Contact details for the publisher Definition Contact details to assist a user in finding and communicating with the publisher. Comments May be a web site, an email address, a telephone number, etc. Data Type ContactDetail Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.contact
description	I	0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.description Short description Natural language description of the capability statement Definition 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. Comments 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. Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.description
useContext	Σ	0..*	UsageContext	There are no (further) constraints on this element Element Id CapabilityStatement.useContext Short description The context that the content is intended to support Definition 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. Requirements Assist in searching for appropriate content. Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. Data Type UsageContext Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.useContext
jurisdiction	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id CapabilityStatement.jurisdiction Short description Intended jurisdiction for capability statement (if applicable) Definition A legal or geographic region in which the capability statement is intended to be used. Comments It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended. Data Type CodeableConcept Binding Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD workflow:Definition.jurisdiction
purpose		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.purpose Short description Why this capability statement is defined Definition Explanation of why this capability statement is needed and why it has been designed as it has. Comments 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. Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.purpose w5:FiveWs.why[x] objimpl:no-gen-base
copyright		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.copyright Short description Use and/or publishing restrictions Alternate names License, Restrictions Definition 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. Requirements Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.copyright objimpl:no-gen-base
kind	S Σ I	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.kind Short description instance \| capability \| requirements Definition 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). Requirements Allow searching the 3 modes. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding How a capability statement is intended to be used. CapabilityStatementKind (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
instantiates	Σ	0..*	canonical(CapabilityStatement)	There are no (further) constraints on this element Element Id CapabilityStatement.instantiates Short description Canonical URL of another capability statement this implements Definition 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. Comments HL7 defines the following Services: Terminology Service. Many Implementation Guides define additional services. Data Type canonical(CapabilityStatement) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
imports	Σ	0..*	canonical(CapabilityStatement)	There are no (further) constraints on this element Element Id CapabilityStatement.imports Short description Canonical URL of another capability statement this adds to Definition 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. Comments 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). Data Type canonical(CapabilityStatement) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
software	S Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.software Short description Software that is covered by this capability statement Definition 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
name	Σ	1..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.software.name Short description A name the software is known by Definition Name the software is known by. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
version	Σ	0..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.software.version Short description Version covered by this statement Definition The version identifier for the software covered by this statement. Comments If possible, a version should be specified, as statements are likely to be different for different versions of software. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
releaseDate	Σ	0..1	dateTime	There are no (further) constraints on this element Element Id CapabilityStatement.software.releaseDate Short description Date this version was released Definition Date this version of the software was released. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
implementation	Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.implementation Short description If this describes a specific instance Definition 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
description	Σ	1..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.implementation.description Short description Describes this specific instance Definition Information about the specific installation that this capability statement relates to. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
url	Σ	0..1	url	There are no (further) constraints on this element Element Id CapabilityStatement.implementation.url Short description Base URL for the installation Definition An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type url Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
custodian	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id CapabilityStatement.implementation.custodian Short description Organization that manages the data Definition The organization responsible for the management of the instance and oversight of the data on the server at the specified URL. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
fhirVersion	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.fhirVersion Short description FHIR Version the system supports Definition 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. Comments Servers may implement multiple versions (see Managing Multiple Versions, and the $versions 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. Data Type code Binding All published FHIR Versions. FHIRVersion (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
format	Σ	1..*	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.format Short description formats supported (xml \| json \| ttl \| mime type) Definition A list of the formats supported by this implementation using their content types. Comments "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. Data Type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
patchFormat	Σ	0..*	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.patchFormat Short description Patch formats supported Definition A list of the patch formats supported by this implementation using their content types. Comments 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. Data Type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
implementationGuide	S Σ	0..*	canonical(ImplementationGuide)	There are no (further) constraints on this element Element Id CapabilityStatement.implementationGuide Short description Implementation guides supported Definition A list of implementation guides that the server does (or should) support in their entirety. Comments see Canonical References Data Type canonical(ImplementationGuide) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
rest	S Σ I	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest Short description If the endpoint is a RESTful one Definition A definition of the restful capabilities of the solution, if any. Comments Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements). Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpb-9:A given resource can only be described once per RESTful mode. `resource.select(type).isDistinct()` Mappings rim:n/a
mode	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.mode Short description client \| server Definition Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The mode of a RESTful capability statement. RestfulCapabilityMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.documentation Short description General description of implementation Definition Information about the system's restful capabilities that apply across all applications, such as security. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
security	S Σ	0..1	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.security Short description Information about security of implementation Definition Information about security implementation from an interface perspective - what a client needs to know. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
extension	I	0..*	Extension	Element Id CapabilityStatement.rest.security.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
oauthUris	S I	0..1	Extension(Complex)	Element Id CapabilityStatement.rest.security.extension:oauthUris Short description Automated discovery of OAuth2 endpoints Alternate names extensions, user content Definition Supports automated discovery of OAuth2 endpoints. Comments 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. Data Type Extension(Complex) Extension URL http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
cors	Σ	0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.rest.security.cors Short description Adds CORS Headers (http://enable-cors.org/) Definition Server adds CORS headers when responding to requests - this enables Javascript applications to use the server. Comments The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
service	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.security.service Short description OAuth \| SMART-on-FHIR \| NTLM \| Basic \| Kerberos \| Certificates Definition Types of security services that are supported/required by the system. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Types of security services used with FHIR. RestfulSecurityService (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
description		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.security.description Short description General description of how security works Definition General description of how security works. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
resource	S Σ I	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource Short description Resource served on the REST interface Definition A specification of the restful capabilities of the solution for a specific resource type. Comments Max of one repetition per resource type. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpb-12:Search parameter names must be unique in the context of a resource. `searchParam.select(name).isDistinct()` Mappings rim:n/a
extension	I	0..*	Extension	Element Id CapabilityStatement.rest.resource.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
searchParameterCombination	I	0..*	Extension(Complex)	Element Id CapabilityStatement.rest.resource.extension:searchParameterCombination Short description An allowable parameter combination Alternate names extensions, user content Definition This extension defines a possible search parameter combination, by listing a set of search parameters and indicating whether they are required or optional. If a search combination is specified, clients should expect that they must submit a search that meets one of the required combinations or the search will be unsuccessful. If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations. Comments For example, on the Patient Resource you could use this to state support for searching by Patient.name and Patient.gender is required. Data Type Extension(Complex) Extension URL http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A v2:N/A
type	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.type Short description A resource type that is supported Definition A type of resource exposed via the restful interface. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding One of the resource types defined as part of this version of FHIR. ResourceType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
profile	Σ	1..1	canonical(StructureDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.profile Short description Base System profile for all uses of resource Definition 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. Comments The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system. Data Type canonical(StructureDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
supportedProfile	Σ	0..*	canonical(StructureDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.supportedProfile Short description Profiles for use cases supported Definition 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. Comments 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). Data Type canonical(StructureDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.documentation Short description Additional information about the use of the resource type Definition Additional information about the resource type used by the system. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
interaction		0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.interaction Short description What operations are supported? Definition Identifies a restful operation supported by the solution. Comments 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). Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
extension	I	0..*	Extension	Element Id CapabilityStatement.rest.resource.interaction.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Examples	I	0..1	Extension(Complex)	Element Id CapabilityStatement.rest.resource.interaction.extension:Examples Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. Comments 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. Data Type Extension(Complex) Extension URL https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
code		1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.interaction.code Short description read \| vread \| update \| patch \| delete \| history-instance \| history-type \| create \| search-type Definition Coded identifier of the operation, supported by the system resource. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Operations supported by REST at the type or instance level. TypeRestfulInteraction (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.interaction.documentation Short description Anything special about operation behavior Definition 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'. Requirements REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
versioning		0..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.versioning Short description no-version \| versioned \| versioned-update Definition 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. Comments If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so. Data Type code Binding How the system supports versioning for a resource. ResourceVersionPolicy (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
readHistory		0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.readHistory Short description Whether vRead can return past versions Definition A flag for whether the server is able to return past versions as part of the vRead operation. Comments It is useful to support the vRead operation for current operations, even if past versions aren't available. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
updateCreate		0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.updateCreate Short description If update can commit to a new identity Definition 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. Comments 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. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
conditionalCreate		0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.conditionalCreate Short description If allows/uses conditional create Definition A flag that indicates that the server supports conditional create. Comments Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
conditionalRead		0..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.conditionalRead Short description not-supported \| modified-since \| not-match \| full-support Definition A code that indicates how the server supports conditional read. Comments Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2. Data Type code Binding A code that indicates how the server supports conditional read. ConditionalReadStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
conditionalUpdate		0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.conditionalUpdate Short description If allows/uses conditional update Definition A flag that indicates that the server supports conditional update. Comments Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
conditionalDelete		0..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.conditionalDelete Short description not-supported \| single \| multiple - how conditional delete is supported Definition A code that indicates how the server supports conditional delete. Comments Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2. Data Type code Binding A code that indicates how the server supports conditional delete. ConditionalDeleteStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
referencePolicy		0..*	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.referencePolicy Short description literal \| logical \| resolves \| enforced \| local Definition A set of flags that defines how references are supported. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding A set of flags that defines how references are supported. ReferenceHandlingPolicy (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
searchInclude		0..*	string	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchInclude Short description _include values supported by the server Definition A list of _include values supported by the server. Comments If this list is empty, the server does not support includes. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
searchRevInclude		0..*	string	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchRevInclude Short description _revinclude values supported by the server Definition A list of _revinclude (reverse include) values supported by the server. Comments If this list is empty, the server does not support reverse includes. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
searchParam		0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchParam Short description Search parameters supported by implementation Definition 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. Comments 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). 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 definitions. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
name		1..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchParam.name Short description Name of search parameter Definition The name of the search parameter used in the interface. Comments Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
definition		0..1	canonical(SearchParameter)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchParam.definition Short description Source of definition for parameter Definition 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). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs. Comments 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. Data Type canonical(SearchParameter) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
type		1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchParam.type Short description number \| date \| string \| token \| reference \| composite \| quantity \| uri \| special Definition The type of value a search parameter refers to, and how the content is interpreted. Comments 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 Type code Binding Data types allowed to be used for search parameters. SearchParamType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchParam.documentation Short description Server-specific usage Definition This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
operation	Σ	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.operation Short description Definition of a resource operation Definition 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. Comments 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
name	Σ	1..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.operation.name Short description Name by which the operation/query is invoked Definition 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. Comments 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
definition	Σ	1..1	canonical(OperationDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.operation.definition Short description The defined operation/query Definition 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 with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported. Comments This can be used to build an HTML form to invoke the operation, for instance. Data Type canonical(OperationDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.operation.documentation Short description Specific details about operation behavior Definition Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
interaction		0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.interaction Short description What operations are supported? Definition A specification of restful operations supported by the system. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
code		1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.interaction.code Short description transaction \| batch \| search-system \| history-system Definition A coded identifier of the operation, supported by the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Operations supported by REST at the system level. SystemRestfulInteraction (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.interaction.documentation Short description Anything special about operation behavior Definition 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. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
searchParam		0..*	see (searchParam)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.searchParam Short description Search parameters for searching all resources Definition 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. Comments 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). 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 definitions.
operation	Σ	0..*	see (operation)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.operation Short description Definition of a system level operation Definition Definition of an operation or a named query together with its parameters and their meaning and type. Comments 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.
compartment		0..*	canonical(CompartmentDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.compartment Short description Compartments served/used by system Definition 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 . Comments At present, the only defined compartments are at CompartmentDefinition. Data Type canonical(CompartmentDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
messaging	S Σ I	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.messaging Short description If messaging is supported Definition A description of the messaging capabilities of the solution. Comments Multiple repetitions allow the documentation of multiple endpoints per solution. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
endpoint		0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.endpoint Short description Where messages should be sent Alternate names 3 Definition An endpoint (network accessible address) to which messages and/or replies are to be sent. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
protocol		1..1	CodingBinding	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.endpoint.protocol Short description http \| ftp \| mllp + Definition A list of the messaging transport protocol(s) identifiers, supported by this endpoint. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data Type Coding Binding The protocol used for message transport. MessageTransport (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding
address		1..1	url	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.endpoint.address Short description Network address or identifier of the end-point Definition The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type url Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
reliableCache		0..1	unsignedInt	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.reliableCache Short description Reliable Message Cache Length (min) Definition 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). Comments If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging. Data Type unsignedInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.documentation Short description Messaging interface behavior details Definition 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. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
supportedMessage	Σ	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.supportedMessage Short description Messages supported by this system Definition References to message definitions for messages this system can send or receive. Comments This is a proposed alternative to the messaging.event structure. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
extension	I	0..*	Extension	Element Id CapabilityStatement.messaging.supportedMessage.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Examples	I	0..*	Extension(Complex)	Element Id CapabilityStatement.messaging.supportedMessage.extension:Examples Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. Comments 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. Data Type Extension(Complex) Extension URL https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
mode	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.supportedMessage.mode Short description sender \| receiver Definition The mode of this event declaration - whether application is sender or receiver. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The mode of a message capability statement. EventCapabilityMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
definition	Σ	1..1	canonical(MessageDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.supportedMessage.definition Short description Message supported by this system Definition Points to a message definition that identifies the messaging event, message structure, allowed responses, etc. Comments see Canonical References Data Type canonical(MessageDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
document	Σ I	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.document Short description Document definition Definition A document definition. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
mode	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.document.mode Short description producer \| consumer Definition Mode of this document declaration - whether an application is a producer or consumer. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Whether the application produces or consumes documents. DocumentMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.document.documentation Short description Description of document support Definition 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. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
profile	Σ	1..1	canonical(StructureDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.document.profile Short description Constraint on the resources used in the document Definition A profile on the document Bundle that constrains which resources are present, and their contents. Comments The profile is actually on the Bundle. Data Type canonical(StructureDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a

from CapabilityStatement

CapabilityStatement	I		CapabilityStatement	There are no (further) constraints on this element Element Id CapabilityStatement Short description A statement of system capabilities Definition 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. Comments Applications may implement multiple versions (see Managing Multiple Versions, and the $versions 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. Data Type CapabilityStatement Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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()` dom-3: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()` dom-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` cpb-7:The set of documents must be unique by the combination of profile and mode. `document.select(profile&mode).isDistinct()` cpb-16:If kind = requirements, implementation and software must be absent `(kind!='requirements') or (implementation.exists().not() and software.exists().not())` cpb-15:If kind = capability, implementation must be absent, software must be present `(kind != 'capability') or (implementation.exists().not() and software.exists())` cpb-3:Messaging end-point is required (and is only permitted) when a statement is for an implementation. `messaging.endpoint.empty() or kind = 'instance'` cpb-14:If kind = instance, implementation must be present and software may be present `(kind != 'instance') or implementation.exists()` cpb-2:A Capability Statement SHALL have at least one of description, software, or implementation element. `(description.count() + software.count() + implementation.count()) > 0` cpb-1:A Capability Statement SHALL have at least one of REST, messaging or document element. `rest.exists() or messaging.exists() or document.exists()` cpb-0:Name should be usable as an identifier for the module by machine processing applications such as code generation `name.matches('[A-Z]([A-Za-z0-9_]){0,254}')` Mappings rim:Entity. Role, or Act rim:n/a
extension	I	0..*	Extension	Element Id CapabilityStatement.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Package	S I	0..1	Extension(Complex)	Element Id CapabilityStatement.extension:Package Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. Comments 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. Data Type Extension(Complex) Extension URL https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Package Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
url	Σ	0..1	uri	There are no (further) constraints on this element Element Id CapabilityStatement.url Short description Canonical identifier for this capability statement, represented as a URI (globally unique) Definition 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. Requirements Allows the capability statement to be referenced by a single globally unique identifier. Comments 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. 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 element to indicate where the current master source of the resource can be found. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.url w5:FiveWs.identifier
version	Σ	0..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.version Short description Business version of the capability statement Definition 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. Comments 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]. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.version w5:FiveWs.version
name	Σ I	0..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.name Short description Name for this capability statement (computer friendly) Definition 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. Requirements Support human navigation and code generation. Comments 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
title	Σ	0..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.title Short description Name for this capability statement (human friendly) Definition A short, descriptive, user-friendly title for the capability statement. Comments This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.title
status	S Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.status Short description draft \| active \| retired \| unknown Definition The status of this capability statement. Enables tracking the life-cycle of the content. Comments 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. Data Type code Binding The lifecycle status of an artifact. PublicationStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.status w5:FiveWs.status
experimental	Σ	0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.experimental Short description For testing purposes, not real usage Definition 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. Requirements Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement. Comments Allows filtering of capability statements that are appropriate for use versus not. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.experimental w5:FiveWs.class
date	Σ	1..1	dateTime	There are no (further) constraints on this element Element Id CapabilityStatement.date Short description Date last changed Alternate names Revision Date Definition 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. Comments 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. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.date w5:FiveWs.recorded
publisher	Σ	1..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.publisher Short description Name of the publisher (organization or individual) Definition The name of the organization or individual that published the capability statement. Requirements Helps establish the "authority/credibility" of the capability statement. May also allow for contact. Comments 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.publisher w5:FiveWs.witness
contact	Σ	0..*	ContactDetail	There are no (further) constraints on this element Element Id CapabilityStatement.contact Short description Contact details for the publisher Definition Contact details to assist a user in finding and communicating with the publisher. Comments May be a web site, an email address, a telephone number, etc. Data Type ContactDetail Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.contact
description	I	0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.description Short description Natural language description of the capability statement Definition 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. Comments 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. Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.description
useContext	Σ	0..*	UsageContext	There are no (further) constraints on this element Element Id CapabilityStatement.useContext Short description The context that the content is intended to support Definition 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. Requirements Assist in searching for appropriate content. Comments When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. Data Type UsageContext Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.useContext
jurisdiction	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id CapabilityStatement.jurisdiction Short description Intended jurisdiction for capability statement (if applicable) Definition A legal or geographic region in which the capability statement is intended to be used. Comments It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended. Data Type CodeableConcept Binding Countries and regions within which this artifact is targeted for use. Jurisdiction ValueSet (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD workflow:Definition.jurisdiction
purpose		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.purpose Short description Why this capability statement is defined Definition Explanation of why this capability statement is needed and why it has been designed as it has. Comments 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. Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.purpose w5:FiveWs.why[x] objimpl:no-gen-base
copyright		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.copyright Short description Use and/or publishing restrictions Alternate names License, Restrictions Definition 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. Requirements Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a workflow:Definition.copyright objimpl:no-gen-base
kind	S Σ I	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.kind Short description instance \| capability \| requirements Definition 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). Requirements Allow searching the 3 modes. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding How a capability statement is intended to be used. CapabilityStatementKind (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
instantiates	Σ	0..*	canonical(CapabilityStatement)	There are no (further) constraints on this element Element Id CapabilityStatement.instantiates Short description Canonical URL of another capability statement this implements Definition 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. Comments HL7 defines the following Services: Terminology Service. Many Implementation Guides define additional services. Data Type canonical(CapabilityStatement) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
imports	Σ	0..*	canonical(CapabilityStatement)	There are no (further) constraints on this element Element Id CapabilityStatement.imports Short description Canonical URL of another capability statement this adds to Definition 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. Comments 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). Data Type canonical(CapabilityStatement) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
software	S Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.software Short description Software that is covered by this capability statement Definition 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
name	Σ	1..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.software.name Short description A name the software is known by Definition Name the software is known by. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
version	Σ	0..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.software.version Short description Version covered by this statement Definition The version identifier for the software covered by this statement. Comments If possible, a version should be specified, as statements are likely to be different for different versions of software. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
releaseDate	Σ	0..1	dateTime	There are no (further) constraints on this element Element Id CapabilityStatement.software.releaseDate Short description Date this version was released Definition Date this version of the software was released. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
implementation	Σ I	0..1	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.implementation Short description If this describes a specific instance Definition 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
description	Σ	1..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.implementation.description Short description Describes this specific instance Definition Information about the specific installation that this capability statement relates to. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
url	Σ	0..1	url	There are no (further) constraints on this element Element Id CapabilityStatement.implementation.url Short description Base URL for the installation Definition An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type url Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
custodian	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id CapabilityStatement.implementation.custodian Short description Organization that manages the data Definition The organization responsible for the management of the instance and oversight of the data on the server at the specified URL. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
fhirVersion	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.fhirVersion Short description FHIR Version the system supports Definition 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. Comments Servers may implement multiple versions (see Managing Multiple Versions, and the $versions 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. Data Type code Binding All published FHIR Versions. FHIRVersion (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
format	Σ	1..*	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.format Short description formats supported (xml \| json \| ttl \| mime type) Definition A list of the formats supported by this implementation using their content types. Comments "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. Data Type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
patchFormat	Σ	0..*	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.patchFormat Short description Patch formats supported Definition A list of the patch formats supported by this implementation using their content types. Comments 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. Data Type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
implementationGuide	S Σ	0..*	canonical(ImplementationGuide)	There are no (further) constraints on this element Element Id CapabilityStatement.implementationGuide Short description Implementation guides supported Definition A list of implementation guides that the server does (or should) support in their entirety. Comments see Canonical References Data Type canonical(ImplementationGuide) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
rest	S Σ I	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest Short description If the endpoint is a RESTful one Definition A definition of the restful capabilities of the solution, if any. Comments Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements). Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpb-9:A given resource can only be described once per RESTful mode. `resource.select(type).isDistinct()` Mappings rim:n/a
mode	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.mode Short description client \| server Definition Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The mode of a RESTful capability statement. RestfulCapabilityMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.documentation Short description General description of implementation Definition Information about the system's restful capabilities that apply across all applications, such as security. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
security	S Σ	0..1	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.security Short description Information about security of implementation Definition Information about security implementation from an interface perspective - what a client needs to know. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
extension	I	0..*	Extension	Element Id CapabilityStatement.rest.security.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
oauthUris	S I	0..1	Extension(Complex)	Element Id CapabilityStatement.rest.security.extension:oauthUris Short description Automated discovery of OAuth2 endpoints Alternate names extensions, user content Definition Supports automated discovery of OAuth2 endpoints. Comments 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. Data Type Extension(Complex) Extension URL http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
cors	Σ	0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.rest.security.cors Short description Adds CORS Headers (http://enable-cors.org/) Definition Server adds CORS headers when responding to requests - this enables Javascript applications to use the server. Comments The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
service	Σ	0..*	CodeableConceptBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.security.service Short description OAuth \| SMART-on-FHIR \| NTLM \| Basic \| Kerberos \| Certificates Definition Types of security services that are supported/required by the system. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Types of security services used with FHIR. RestfulSecurityService (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
description		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.security.description Short description General description of how security works Definition General description of how security works. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
resource	S Σ I	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource Short description Resource served on the REST interface Definition A specification of the restful capabilities of the solution for a specific resource type. Comments Max of one repetition per resource type. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpb-12:Search parameter names must be unique in the context of a resource. `searchParam.select(name).isDistinct()` Mappings rim:n/a
extension	I	0..*	Extension	Element Id CapabilityStatement.rest.resource.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
searchParameterCombination	I	0..*	Extension(Complex)	Element Id CapabilityStatement.rest.resource.extension:searchParameterCombination Short description An allowable parameter combination Alternate names extensions, user content Definition This extension defines a possible search parameter combination, by listing a set of search parameters and indicating whether they are required or optional. If a search combination is specified, clients should expect that they must submit a search that meets one of the required combinations or the search will be unsuccessful. If multiple search parameter combinations are specified, a client may pick between them, and supply the minimal required parameters for any of the combinations. Comments For example, on the Patient Resource you could use this to state support for searching by Patient.name and Patient.gender is required. Data Type Extension(Complex) Extension URL http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A v2:N/A
type	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.type Short description A resource type that is supported Definition A type of resource exposed via the restful interface. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding One of the resource types defined as part of this version of FHIR. ResourceType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
profile	Σ	1..1	canonical(StructureDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.profile Short description Base System profile for all uses of resource Definition 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. Comments The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system. Data Type canonical(StructureDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
supportedProfile	Σ	0..*	canonical(StructureDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.supportedProfile Short description Profiles for use cases supported Definition 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. Comments 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). Data Type canonical(StructureDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.documentation Short description Additional information about the use of the resource type Definition Additional information about the resource type used by the system. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
interaction		0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.interaction Short description What operations are supported? Definition Identifies a restful operation supported by the solution. Comments 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). Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
extension	I	0..*	Extension	Element Id CapabilityStatement.rest.resource.interaction.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Examples	I	0..1	Extension(Complex)	Element Id CapabilityStatement.rest.resource.interaction.extension:Examples Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. Comments 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. Data Type Extension(Complex) Extension URL https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
code		1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.interaction.code Short description read \| vread \| update \| patch \| delete \| history-instance \| history-type \| create \| search-type Definition Coded identifier of the operation, supported by the system resource. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Operations supported by REST at the type or instance level. TypeRestfulInteraction (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.interaction.documentation Short description Anything special about operation behavior Definition 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'. Requirements REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
versioning		0..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.versioning Short description no-version \| versioned \| versioned-update Definition 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. Comments If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so. Data Type code Binding How the system supports versioning for a resource. ResourceVersionPolicy (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
readHistory		0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.readHistory Short description Whether vRead can return past versions Definition A flag for whether the server is able to return past versions as part of the vRead operation. Comments It is useful to support the vRead operation for current operations, even if past versions aren't available. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
updateCreate		0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.updateCreate Short description If update can commit to a new identity Definition 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. Comments 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. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
conditionalCreate		0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.conditionalCreate Short description If allows/uses conditional create Definition A flag that indicates that the server supports conditional create. Comments Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
conditionalRead		0..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.conditionalRead Short description not-supported \| modified-since \| not-match \| full-support Definition A code that indicates how the server supports conditional read. Comments Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2. Data Type code Binding A code that indicates how the server supports conditional read. ConditionalReadStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
conditionalUpdate		0..1	boolean	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.conditionalUpdate Short description If allows/uses conditional update Definition A flag that indicates that the server supports conditional update. Comments Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
conditionalDelete		0..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.conditionalDelete Short description not-supported \| single \| multiple - how conditional delete is supported Definition A code that indicates how the server supports conditional delete. Comments Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2. Data Type code Binding A code that indicates how the server supports conditional delete. ConditionalDeleteStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
referencePolicy		0..*	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.referencePolicy Short description literal \| logical \| resolves \| enforced \| local Definition A set of flags that defines how references are supported. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding A set of flags that defines how references are supported. ReferenceHandlingPolicy (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
searchInclude		0..*	string	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchInclude Short description _include values supported by the server Definition A list of _include values supported by the server. Comments If this list is empty, the server does not support includes. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
searchRevInclude		0..*	string	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchRevInclude Short description _revinclude values supported by the server Definition A list of _revinclude (reverse include) values supported by the server. Comments If this list is empty, the server does not support reverse includes. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
searchParam		0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchParam Short description Search parameters supported by implementation Definition 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. Comments 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). 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 definitions. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
name		1..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchParam.name Short description Name of search parameter Definition The name of the search parameter used in the interface. Comments Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
definition		0..1	canonical(SearchParameter)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchParam.definition Short description Source of definition for parameter Definition 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). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs. Comments 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. Data Type canonical(SearchParameter) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
type		1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchParam.type Short description number \| date \| string \| token \| reference \| composite \| quantity \| uri \| special Definition The type of value a search parameter refers to, and how the content is interpreted. Comments 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 Type code Binding Data types allowed to be used for search parameters. SearchParamType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.searchParam.documentation Short description Server-specific usage Definition This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
operation	Σ	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.operation Short description Definition of a resource operation Definition 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. Comments 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. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
name	Σ	1..1	string	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.operation.name Short description Name by which the operation/query is invoked Definition 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. Comments 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
definition	Σ	1..1	canonical(OperationDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.operation.definition Short description The defined operation/query Definition 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 with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported. Comments This can be used to build an HTML form to invoke the operation, for instance. Data Type canonical(OperationDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.resource.operation.documentation Short description Specific details about operation behavior Definition Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
interaction		0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.rest.interaction Short description What operations are supported? Definition A specification of restful operations supported by the system. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
code		1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.rest.interaction.code Short description transaction \| batch \| search-system \| history-system Definition A coded identifier of the operation, supported by the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Operations supported by REST at the system level. SystemRestfulInteraction (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.rest.interaction.documentation Short description Anything special about operation behavior Definition 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. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
searchParam		0..*	see (searchParam)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.searchParam Short description Search parameters for searching all resources Definition 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. Comments 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). 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 definitions.
operation	Σ	0..*	see (operation)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.operation Short description Definition of a system level operation Definition Definition of an operation or a named query together with its parameters and their meaning and type. Comments 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.
compartment		0..*	canonical(CompartmentDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.rest.compartment Short description Compartments served/used by system Definition 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 . Comments At present, the only defined compartments are at CompartmentDefinition. Data Type canonical(CompartmentDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
messaging	S Σ I	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.messaging Short description If messaging is supported Definition A description of the messaging capabilities of the solution. Comments Multiple repetitions allow the documentation of multiple endpoints per solution. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
endpoint		0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.endpoint Short description Where messages should be sent Alternate names 3 Definition An endpoint (network accessible address) to which messages and/or replies are to be sent. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
protocol		1..1	CodingBinding	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.endpoint.protocol Short description http \| ftp \| mllp + Definition A list of the messaging transport protocol(s) identifiers, supported by this endpoint. Comments Codes may be defined very casually in enumerations or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Data Type Coding Binding The protocol used for message transport. MessageTransport (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding
address		1..1	url	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.endpoint.address Short description Network address or identifier of the end-point Definition The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier. Comments see http://en.wikipedia.org/wiki/Uniform_resource_identifier Data Type url Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
reliableCache		0..1	unsignedInt	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.reliableCache Short description Reliable Message Cache Length (min) Definition 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). Comments If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging. Data Type unsignedInt Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.documentation Short description Messaging interface behavior details Definition 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. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
supportedMessage	Σ	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.supportedMessage Short description Messages supported by this system Definition References to message definitions for messages this system can send or receive. Comments This is a proposed alternative to the messaging.event structure. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
extension	I	0..*	Extension	Element Id CapabilityStatement.messaging.supportedMessage.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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. Comments 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
Examples	I	0..*	Extension(Complex)	Element Id CapabilityStatement.messaging.supportedMessage.extension:Examples Short description Optional Extensions Element Alternate names extensions, user content Definition Optional Extension Element - found in all resources. Comments 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. Data Type Extension(Complex) Extension URL https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-CapabilityStatement-Examples Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
mode	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.supportedMessage.mode Short description sender \| receiver Definition The mode of this event declaration - whether application is sender or receiver. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The mode of a message capability statement. EventCapabilityMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
definition	Σ	1..1	canonical(MessageDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.messaging.supportedMessage.definition Short description Message supported by this system Definition Points to a message definition that identifies the messaging event, message structure, allowed responses, etc. Comments see Canonical References Data Type canonical(MessageDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
document	Σ I	0..*	BackboneElement	There are no (further) constraints on this element Element Id CapabilityStatement.document Short description Document definition Definition A document definition. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
mode	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id CapabilityStatement.document.mode Short description producer \| consumer Definition Mode of this document declaration - whether an application is a producer or consumer. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding Whether the application produces or consumes documents. DocumentMode (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
documentation		0..1	markdown	There are no (further) constraints on this element Element Id CapabilityStatement.document.documentation Short description Description of document support Definition 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. Comments Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/ Data Type markdown Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
profile	Σ	1..1	canonical(StructureDefinition)	There are no (further) constraints on this element Element Id CapabilityStatement.document.profile Short description Constraint on the resources used in the document Definition A profile on the document Bundle that constrains which resources are present, and their contents. Comments The profile is actually on the Bundle. Data Type canonical(StructureDefinition) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a

CapabilityStatement-NHSDigital-IG

apiDefinition
status
kind
software
fhirVersion
implementationGuide
rest

apiDefinition (extension)

Links to the API documentation MUST be provided.

{
    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-APIDefinition",
    "extension": [
        {
            "url": "openApi",
            "extension": [
            {
                "url": "documentation",
                "valueUri": "https://digital.nhs.uk/developer/api-catalogue/electronic-prescription-service-fhir"
            },{
                "url": "description",
                "valueString": "Access the Electronic Prescription Service (EPS) - the national service used to send electronic prescriptions from GP surgeries to pharmacies."
            },
        }
    ]
}

A list of Implementation Guide packages used with this API MUST be provided.

Although the UKCore.R4 version can be derived from the uk.nhsdigital.r4 package information, it MUST be provided. This applies to all derived or supplemental packages.

{
    "url": "https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-APIDefinition",
    "extension": [
        {
            "url": "implementationGuide",
            "extension": [
                {
                    "url": "name",
                    "valueString": "uk.nhsdigital.r4"
                },{
                    "url": "version",
                    "valueString": "2.1.34-discovery"
                }
            ]
        },
        {
            "url": "implementationGuide",
            "extension": [
                {
                    "url": "name",
                    "valueString": "UKCore.R4.02.00.00"
                },{
                    "url": "version",
                    "valueString": "2.0.0"
                }
            ]
        }
    ]
}

status

"status": "active"

kind

For APIM FHIR endpoints this MUST be instance

"kind": "instance"

software

For APIM FHIR endpoints this is the API Name and verson of the API.

"software": {
    "name": "EPS NextGen",
    "version": "1.2.4-alpha",
    "releaseDate": "2021-07-21T00:00:00+00:00"
}

fhirVersion

For APIM FHIR R4 endpoints this MUST be 4.0.1

"fhirVersion": "4.0.1"

format

MUST be provided. This is populated according to serialisation policies. Serialisation

"format":  [
    "application/fhir+json",
    "application/fhir+xml"
]

implementationGuide

List of FHIR Implementation Guides followed by the API. For NHS Digital APIM endpoints this MUST include:

"implementationGuide":  [
        "https://simplifier.net/guide/nhsdigital"
    ],

rest

This is required for all APIM FHIR endpoints.

rest.security

Only populated if the endpoint is secured using APIM Apigee security.

SHOULD include the url of the OAuth2/Apigee endpoint. Add extension http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris to profile.

"security": {
    "extension": [
        {
            "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris",
            "extension": [{
             "url": "token",
                "valueUri": "https://oauth2.nhs.uk/token"
            },{
                "url": "authorize",
                "valueUri": "https://oauth2.nhs.uk/authorize"
            },{
                "url": "manage",
                "valueUri": "https://oauth2.nhs.uk/authorizations/manage"
            }]
        }
    ]
}

For APIM FHIR endpoints this should be populated as follows:

"security": {
    "service":  [
        {
            "coding":  [
                {
                    "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                    "code": "OAuth",
                    "display": "OAuth2 Token"
                }
            ]
        }
    ]
}

rest.resource

All the resources supported by the endpoint MUST be listed together with the FHIR profile they conform to. This applies to all FHIR Exchange methods.

"resource":  [
    {
        "type": "CommunicationRequest",
        "profile": "https://fhir.nhs.uk/StructureDefinition/NHSDigital-CommunicationRequest"
    }
]

messaging

MUST be populated if FHIR Messaging is used. This MUST list all the FHIR MessageDefinitions the endpoint supports.

"messaging":  [
    {
        "supportedMessage":  [
            {
                "mode": "receiver",
                "definition": "https://fhir.nhs.uk/MessageDefinition/prescription-order"
            },
            {
                "mode": "receiver",
                "definition": "https://fhir.nhs.uk/MessageDefinition/dispense-notification"
            }
        ]
    }
]