Generated Narrative: StructureDefinition profile-Conformance-for-CapabilityStatement Name Flags Card. Type Description & Constraints CapabilityStatement 0..* CapabilityStatement(5.0.0) A statement of system capabilities #xD; meta #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:meta 0..1 Meta DSTU2: meta additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.meta #xD; text #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:text 0..1 (Complex) DSTU2: text additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.text #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:acceptUnknown 1..1 code DSTU2: no | extensions | elements | both (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.acceptUnknown Binding: R2UnknownContentCodeForR5 (0.1.0) (required): A code that indicates whether an application accepts unknown elements or extensions when reading resources. #xD; contact #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:name 0..1 string DSTU2: Name of a individual to contact additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.contact.name #xD; extension:telecom 0..* ContactPoint DSTU2: Contact details for individual or publisher additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.contact.telecom #xD; rest #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:transactionMode 0..1 code DSTU2: not-supported | batch | transaction | both (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.rest.transactionMode Binding: R2TransactionModeForR5 (0.1.0) (required): A code that indicates how transactions are supported. #xD; security #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:certificate 0..* (Complex) DSTU2: Certificates associated with security profiles (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.rest.security.certificate #xD; resource #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:profile 0..1 Reference(Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5(0.1.0) | StructureDefinition) DSTU2: Base System profile for all uses of resource additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.rest.resource.profile #xD; type #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:type 0..1 code DSTU2: type additional codes URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.rest.resource.type Binding: R2ResourceTypesForR5 (0.1.0) (required): One of the resource types defined as part of FHIR. #xD; supportedProfile #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:profile 0..* Reference(Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5(0.1.0) | StructureDefinition) DSTU2: Profiles for use cases supported additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.profile #xD; interaction #xD; code #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:code 0..1 code DSTU2: read | vread | update | delete | history-instance | validate | history-type | create | search-type URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.rest.resource.interaction.code Binding: R2TypeRestfulInteractionForR5 (0.1.0) (required): Operations supported by REST at the type or instance level. #xD; searchParam #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:target 0..* code DSTU2: Types of resource (if a resource reference) (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.rest.resource.searchParam.target Binding: R2ResourceTypesForR5 (0.1.0) (required): One of the resource types defined as part of FHIR. #xD; extension:modifier 0..* code DSTU2: missing | exact | contains | not | text | in | not-in | below | above | type (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.rest.resource.searchParam.modifier Binding: SearchModifierCode (required): A supported modifier for a search parameter. #xD; extension:chain 0..* string DSTU2: Chained names supported (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.rest.resource.searchParam.chain #xD; operation #xD; definition #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:definition 0..1 Reference(Cross-version Profile for DSTU2.OperationDefinition for use in FHIR R5(0.1.0) | OperationDefinition) DSTU2: definition additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.rest.operation.definition #xD; messaging #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:event 1..* (Complex) DSTU2: Declare support for this event (new) URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.messaging.event #xD; document #xD; profile #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:profile 0..1 Reference(Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5(0.1.0) | StructureDefinition) DSTU2: Constraint on a resource used in the document additional types URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.document.profile #xD; Documentation for this format
Cross-version Profile for DSTU2.Conformance for use in FHIR R5
This cross-version profile allows DSTU2 Conformance content to be represented via FHIR R5 CapabilityStatement resources.
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
Applications may implement multiple versions (see [Managing Multiple Versions](http://hl7.org/fhir/R5/versioning.html), and the [$versions](http://hl7.org/fhir/R5/capabilitystatement-operation-versions.html) operation). If they do, then a CapabilityStatement describes the system's support for a particular version of FHIR, and the server will have multiple statements, one for each version.
Name should be usable as an identifier for the module by machine processing applications such as code generation
name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
A Capability Statement SHALL have at least one of REST, messaging or document element.
rest.exists() or messaging.exists() or document.exists()
A Capability Statement SHALL have at least one of description, software, or implementation element.
(description.count() + software.count() + implementation.count()) > 0
Messaging end-point is only permitted when a capability statement is for an implementation.
messaging.endpoint.empty() or kind = 'instance'
There should only be one CapabilityStatement.rest per mode.
The set of documents must be unique by the combination of profile and mode.
If kind = instance, implementation must be present and software may be present
(kind != 'instance') or implementation.exists()
If kind = capability, implementation must be absent, software must be present
(kind != 'capability') or (implementation.exists().not() and software.exists())
If kind = requirements, implementation and software must be absent
(kind!='requirements') or (implementation.exists().not() and software.exists().not())
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Must have either extensions or value[x], not both
DSTU2: `Conformance.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)
Element `Conformance.meta` is mapped to FHIR R5 element `CapabilityStatement.meta` as `SourceIsBroaderThanTarget`. The mappings for `Conformance.meta` do not cover the following types: Meta. The mappings for `Conformance.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.
The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
When the resource last changed - e.g. when the version changed.
This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R5/http.html#read) interaction.
Identifies where the resource comes from
A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R5/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
Profiles this resource claims to conform to
A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R5/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R5/structuredefinition-definitions.html#StructureDefinition.url).
It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Security Labels applied to this resource
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Security Labels from the Healthcare Privacy and Security Classification System.
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
DSTU2: `Conformance.text` additional types (Narrative) additional types from child elements (div, status)
Element `Conformance.text` is mapped to FHIR R5 element `CapabilityStatement.text` as `SourceIsBroaderThanTarget`. The mappings for `Conformance.text` do not cover the following types: Narrative. The mappings for `Conformance.text` do not cover the following types based on type expansion: div, status. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.
generated | extensions | additional | empty
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
The actual narrative content, a stripped down version of XHTML.
The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.
The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, elements (either name or href), images and internally contained style attributes
The narrative SHALL have some non-whitespace content
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
DSTU2: no | extensions | elements | both (new)
DSTU2: `Conformance.acceptUnknown` (new:code)
Element `Conformance.acceptUnknown` has a context of CapabilityStatement based on following the parent source element upwards and mapping to `CapabilityStatement`. Element `Conformance.acceptUnknown` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Unknown elements in a resource can only arise as later versions of the specification are published, because this is the only place where such elements can be defined. Hence accepting unknown elements is about inter-version compatibility. Applications are recommended to accept unknown extensions and elements ('both'), but this is not always possible.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
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.
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this capability statement, represented as a URI (globally unique)
An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different servers.
Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](http://hl7.org/fhir/R5/resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](http://hl7.org/fhir/R5/resource.html#meta) element to indicate where the current master source of the resource can be found.
Allows the capability statement to be referenced by a single globally unique identifier.
URL should not contain | or # - these characters make processing canonical references problematic
Additional identifier for the CapabilityStatement (business identifier)
A formal identifier that is used to identify this CapabilityStatement when it is represented in other formats, or referenced in a specification, model, design or an instance.
Allows externally provided and/or usable business identifiers to be easily associated with the module.
Business version of the capability statement
The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
There may be different capability statement instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the capability statement with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](http://hl7.org/fhir/R5/resource.html#bv-format).
Indicates the mechanism used to compare versions to determine which is more current.
If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.
Name for this capability statement (computer friendly)
A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generation.
The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
Support human navigation and code generation.
Name for this capability statement (human friendly)
A short, descriptive, user-friendly title for the capability statement.
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
The status of this capability statement. Enables tracking the life-cycle of the content.
Allows filtering of capability statements that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Allows filtering of capability statements that are appropriate for use versus not.
Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement.
If absent, this resource is treated as though it is not experimental.
The date (and optionally time) when the capability statement was last significantly changed. 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.
The date is often not tracked until the resource is published, but may be present on draft content. 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. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
Name of the publisher/steward (organization or individual)
The name of the organization or individual responsible for the release and ongoing maintenance of the capability statement.
Usually an organization but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.
Helps establish the "authority/credibility" of the capability statement. May also allow for contact.
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
DSTU2: Name of a individual to contact additional types
DSTU2: `Conformance.contact.name` additional types (string) additional types from child elements (value)
Element `Conformance.contact.name` is mapped to FHIR R5 element `CapabilityStatement.contact` as `RelatedTo`. The mappings for `Conformance.contact.name` do not cover the following types: string. The mappings for `Conformance.contact.name` do not cover the following types based on type expansion: value. If there is no named individual, the telecom is for the organization as a whole.
DSTU2: Contact details for individual or publisher additional types
DSTU2: `Conformance.contact.telecom` additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)
Element `Conformance.contact.telecom` is mapped to FHIR R5 element `CapabilityStatement.contact` as `SourceIsBroaderThanTarget`. The mappings for `Conformance.contact.telecom` do not cover the following types: ContactPoint. The mappings for `Conformance.contact.telecom` do not cover the following types based on type expansion: period, rank, system, use, value.
If there is no named individual, the telecom information is for the organization as a whole.
Contact details for individual or organization
The contact details for the individual (if a name was provided) or the organization.
Natural language description of the capability statement
A free text natural language description of the capability statement from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.
This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the capability statement as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the capability statement is presumed to be the predominant language in the place the capability statement was created).This does not need to be populated if the description is adequately implied by the software or implementation details.
The context that the content is intended to support
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instances.
When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction for capability statement (if applicable)
A legal or geographic region in which the capability statement is intended to be used.
It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended. DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)
Countries and regions within which this artifact is targeted for use.
Why this capability statement is defined
Explanation of why this capability statement is needed and why it has been designed as it has.
This element does not describe the usage of the capability statement. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this capability statement.
A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statement.
Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content.
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.
Defines the content expected to be rendered in all representations of the artifact.
The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).
How a capability statement is intended to be used.
Canonical URL of another capability statement this implements
Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability details.
HL7 defines the following Services: [Terminology Service](http://hl7.org/fhir/R5/terminology-service.html). Many [Implementation Guides](http://fhir.org/guides/registry) define additional services.
Canonical URL of another capability statement this adds to
Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to them.
the contents of any directly or indirectly imported CapabilityStatements SHALL NOT overlap, i.e. they cannot refer to the same rest/resource, operations/name, searchparam/name, interaction/code, messaging/endpoint, document/mode pair. A capability statement that imports another CapabilityStatement automatically instantiates it too (though this is often not a very useful statement for the kinds of CapabilityStatements that are suitable for importing).
Software that is covered by this capability statement
Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installation.
Additional content defined by implementations
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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The version identifier for the software covered by this statement.
If possible, a version should be specified, as statements are likely to be different for different versions of software.
Date this version of the software was released.
Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.
Information about the specific installation that this capability statement relates to.
An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.
The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.
The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default value.
Servers may implement multiple versions (see [Managing Multiple Versions](http://hl7.org/fhir/R5/versioning.html), and the [$versions](http://hl7.org/fhir/R5/capabilitystatement-operation-versions.html) operation). If they do, and the CapabilityStatement is requested from the server, then this fhirVersion will be either the version requested, or the server's default version.
formats supported (xml | json | ttl | mime type)
A list of the formats supported by this implementation using their content types.
"xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.
The mime type of an attachment. Any valid mime type is allowed.
A list of the patch formats supported by this implementation using their content types.
At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats and match the formats it supports, but this is not always possible or necessary.
A list of the languages supported by this implementation that are usefully supported in the ```Accept-Language``` header.
In general, if a server gets a request with an Accept-Language that it doesn't support, it should still reutrn the resource, just in its default language for the resource.
A list of implementation guides that the server does (or should) support in their entirety.
Note: this is primarily only relevant in terms of ImplementationGuides that don't define specific CapabilityStatements declaring the expectation of distinct roles. (E.g. generic IGs that establish privacy policies.) In situations where an ImplementationGuide does define CapabilityStatements, asserting CapabilityStatement.implementationGuide means that the implementation adheres to any Implementation.global definitions present in that IG as well as any textual requirements around security or other general interoperability behaviors. However, it does not make any assertions as to conformance with any of the CapabilityStatements defined in the IG. To assert conformance with CapabilityStatements in a referenced IG, it is necessary to use the CapabilityStatement.instantiates element.
A definition of the restful capabilities of the solution, if any.
Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).
A given resource can only be described once per RESTful mode.
DSTU2: not-supported | batch | transaction | both (new)
DSTU2: `Conformance.rest.transactionMode` (new:code)
Element `Conformance.rest.transactionMode` has a context of CapabilityStatement.rest based on following the parent source element upwards and mapping to `CapabilityStatement`. Element `Conformance.rest.transactionMode` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
The mode of a RESTful capability statement.
Information about the system's restful capabilities that apply across all applications, such as security.
Information about security of implementation
Information about security implementation from an interface perspective - what a client needs to know.
DSTU2: Certificates associated with security profiles (new)
DSTU2: `Conformance.rest.security.certificate` (new:BackboneElement)
Element `Conformance.rest.security.certificate` has a context of CapabilityStatement.rest.security based on following the parent source element upwards and mapping to `CapabilityStatement`. Element `Conformance.rest.security.certificate` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
Adds CORS Headers (http://enable-cors.org/)
Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.
The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.
OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
Types of security services that are supported/required by the system.
Types of security services used with FHIR.
General description of how security works
General description of how security works.
A specification of the restful capabilities of the solution for a specific resource type.
Max of one repetition per resource type.
Search parameter names must be unique in the context of a resource.
DSTU2: Base System profile for all uses of resource additional types
DSTU2: `Conformance.rest.resource.profile` additional types (Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition)) additional types from child elements (display, reference)
Element `Conformance.rest.resource.profile` is mapped to FHIR R5 element `CapabilityStatement.rest.resource.profile` as `SourceIsBroaderThanTarget`. Element `Conformance.rest.resource.profile` is mapped to FHIR R5 element `CapabilityStatement.rest.resource.supportedProfile` as `RelatedTo`. The mappings for `Conformance.rest.resource.profile` do not cover the following types: Reference. The mappings for `Conformance.rest.resource.profile` do not cover the following types based on type expansion: display, reference. The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.
A type of resource exposed via the restful interface.
One of the resource types defined as part of this version of FHIR.
unique id for the element within a resource (for internal references)
DSTU2: `Conformance.rest.resource.type` additional codes
Element `Conformance.rest.resource.type` is mapped to FHIR R5 element `CapabilityStatement.rest.resource.type` as `RelatedTo`. The mappings for `Conformance.rest.resource.type` do not allow expression of the necessary codes, per the bindings on the source and target.
A system-wide profile that is applied across *all* instances of the resource supported by the system. For example, if declared on Observation, this profile is the "superset" of capabilities for laboratory *and* vitals *and* other domains. See further discussion in [Using Profiles](http://hl7.org/fhir/R5/profiling.html#profile-uses).
All other profiles for this type that are listed in `.rest.resource.supportedProfile` must conform to this profile.
A list of profiles representing different use cases the system hosts/produces. A supported profile is a statement about the functionality of the data and services provided by the server (or the client) for supported use cases. For example, a system can define and declare multiple Observation profiles for laboratory observations, vital sign observations, etc. By declaring supported profiles, systems provide a way to determine whether individual resources are conformant. See further discussion in [Using Profiles](http://hl7.org/fhir/R5/profiling.html#profile-uses).
Supported profiles must conform to the resource profile in the `.rest.resource.profile` element if it is present. The resource profile is a system-wide profile applied across *all* instances of the resource supported by the system. A supported profile is a statement about the functionality of the data and services provided by the server (or used by the client) for a particular set of use cases and will not necessarily apply to all data consumed or exposed by the server.
DSTU2: Profiles for use cases supported additional types
DSTU2: `Conformance.profile` additional types (Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition)) additional types from child elements (display, reference)
Element `Conformance.profile` is mapped to FHIR R5 element `CapabilityStatement.rest.resource.supportedProfile` as `SourceIsBroaderThanTarget`. The mappings for `Conformance.profile` do not cover the following types: Reference. The mappings for `Conformance.profile` do not cover the following types based on type expansion: display, reference. Supported profiles are different to the profiles that apply 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 does? 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). Typical supported profiles cross resource types to describe a network of related resources, so they are listed here rather than by resource. However, they do not need to describe more than one resource.
Additional information about the use of the resource type
Additional information about the resource type used by the system.
Identifies a restful operation supported by the solution.
In general, a Resource will only appear in a CapabilityStatement if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).
read | vread | update | patch | delete | history-instance | history-type | create | search-type
Coded identifier of the operation, supported by the system resource.
Operations supported by REST at the type or instance level.
DSTU2: read | vread | update | delete | history-instance | validate | history-type | create | search-type
DSTU2: `Conformance.rest.resource.interaction.code`
Element `Conformance.rest.resource.interaction.code` is mapped to FHIR R5 element `CapabilityStatement.rest.resource.interaction.code` as `SourceIsBroaderThanTarget`.
Anything special about operation behavior
Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'.
REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.
no-version | versioned | versioned-update
This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the API.
If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so.
How the system supports versioning for a resource.
A flag for whether the server is able to return past versions as part of the vRead operation.
It is useful to support the vRead operation for current operations, even if past versions aren't available.
A flag to indicate that the server allows or needs to allow the client to create new identities on the server (that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the server.
Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.
A flag that indicates that the server supports conditional create.
Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.
not-supported | modified-since | not-match | full-support
A code that indicates how the server supports conditional read.
Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2.
A flag that indicates that the server supports conditional update.
Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.
A flag that indicates that the server supports conditional patch.
Conditional Patch is mainly appropriate for interface engine scripts converting from other formats, such as v2.
not-supported | single | multiple - how conditional delete is supported
A code that indicates how the server supports conditional delete.
Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.
literal | logical | resolves | enforced | local
A set of flags that defines how references are supported.
A list of _include values supported by the server.
Documenting [`_include`](http://hl7.org/fhir/R5/search.html#revinclude) support helps set conformance expectations for the desired system. Still, it is a level of detail that might not be exposed by production servers or clients when using CapabilityStatement to describe an actual implementation. If this list is empty, the server does not support includes. Support for *iterative* (a.k.a., recursive) `_include` is communicated by listing the iterative includes values supported by the server in the `searchInclude` element of the "root" resource type. For example, to support the following search: `GET [base]/CarePlan?_include=CarePlan:activity-reference:DeviceRequest&_include:iterate=DeviceRequest:device` These values would be listed as part of capabilities for "CarePlan": "searchInclude" : ["CarePlan:activity-reference:DeviceRequest","DeviceRequest:device"],
_revinclude values supported by the server
A list of _revinclude (reverse include) values supported by the server.
See `CapabilityStatement.rest.resource.searchInclude` comments.
Search parameters supported by implementation
Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
The search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at [CapabilityStatement.rest.searchParam](http://hl7.org/fhir/R5/capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](http://hl7.org/fhir/R5/searchparameter.html#) definitions.
DSTU2: Types of resource (if a resource reference) (new)
DSTU2: `Conformance.rest.resource.searchParam.target` (new:code)
Element `Conformance.rest.resource.searchParam.target` has a context of CapabilityStatement.rest.resource.searchParam based on following the parent source element upwards and mapping to `CapabilityStatement`. Element `Conformance.rest.resource.searchParam.target` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). This SHALL be the same as or a proper subset of the resources listed in the search parameter definition.
DSTU2: missing | exact | contains | not | text | in | not-in | below | above | type (new)
DSTU2: `Conformance.rest.resource.searchParam.modifier` (new:code)
Element `Conformance.rest.resource.searchParam.modifier` has a context of CapabilityStatement.rest.resource.searchParam based on following the parent source element upwards and mapping to `CapabilityStatement`. Element `Conformance.rest.resource.searchParam.modifier` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).
DSTU2: `Conformance.rest.resource.searchParam.chain` (new:string)
Element `Conformance.rest.resource.searchParam.chain` has a context of CapabilityStatement.rest.resource.searchParam based on following the parent source element upwards and mapping to `CapabilityStatement`. Element `Conformance.rest.resource.searchParam.chain` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Systems are not required to list all the chain names they support, but if they don't list them, clients may not know to use them.
The label used for the search parameter in this particular system's API - i.e. the 'name' portion of the name-value pair that will appear as part of the search URL. This SHOULD be the same as the SearchParameter.code of the defining SearchParameter. However, it can sometimes differ if necessary to disambiguate when a server supports multiple SearchParameters that happen to share the same code.
Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined. There is no correspondence whatsoever between CapabilityStatement's searchParam.name and SearchParameter.name - the latter is used as a class name when generating code for the search parameter.
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](http://hl7.org/fhir/R5/searchparameter-definitions.html#SearchParameter.url)). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.
This SHOULD be present, and matches refers to a SearchParameter by its canonical URL. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource. This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.
number | date | string | token | reference | composite | quantity | uri | special
The type of value a search parameter refers to, and how the content is interpreted.
While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition.
Data types allowed to be used for search parameters.
This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parameters.
Operations linked from CapabilityStatement.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true. If an operation that is listed in multiple CapabilityStatement.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.
Name by which the operation/query is invoked
The name of the operation or query. For an operation, this name is prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called. This SHOULD be the same as the OperationDefinition.code of the defining OperationDefinition. However, it can sometimes differ if necessary to disambiguate when a server supports multiple OperationDefinition that happen to share the same code.
The name here SHOULD be the same as the OperationDefinition.code in the referenced OperationDefinition, unless there is a name clash and the OperationDefinition.code cannot be used. The name does not include the "$" portion that is always included in the URL. There is no correspondence whatsoever between CapabilityStatement's operation.name and OperationDefinition.name - the latter is used as a class name when generating code for the operation. HL7 will never define operations that have conflicting names.
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](http://hl7.org/fhir/R5/operationdefinition.html#) with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.
This can be used to build an HTML form to invoke the operation, for instance.
DSTU2: `Conformance.rest.operation.definition` additional types (Reference(http://hl7.org/fhir/StructureDefinition/OperationDefinition)) additional types from child elements (display, reference)
Element `Conformance.rest.operation.definition` is mapped to FHIR R5 element `CapabilityStatement.rest.resource.operation.definition` as `SourceIsBroaderThanTarget`. The mappings for `Conformance.rest.operation.definition` do not cover the following types: Reference. The mappings for `Conformance.rest.operation.definition` do not cover the following types based on type expansion: display, reference. This can be used to build an HTML form to invoke the operation, for instance.
Specific details about operation behavior
Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.
A specification of restful operations supported by the system.
transaction | batch | search-system | history-system
A coded identifier of the operation, supported by the system.
Operations supported by REST at the system level.
Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.
Search parameters for searching all resources
Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation. This is only for searches executed against the system-level endpoint.
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](http://hl7.org/fhir/R5/capabilitystatement-definitions.html#CapabilityStatement.rest.searchParam)). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked [SearchParameter](http://hl7.org/fhir/R5/searchparameter.html#) definitions.
Definition of an operation or a named query together with its parameters and their meaning and type.
CapabilityStatement.rest.operation is for operations invoked at the system level, or for operations that are supported across multiple resource types. Operations linked from CapabilityStatement.rest.operation must have OperationDefinition.system = true, or more than one Operation.resource.
An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by its canonical URL .
At present, the only defined compartments are at [CompartmentDefinition](http://hl7.org/fhir/R5/compartmentdefinition.html).
A description of the messaging capabilities of the solution.
Multiple repetitions allow the documentation of multiple endpoints per solution.
DSTU2: Declare support for this event (new)
DSTU2: `Conformance.messaging.event` (new:BackboneElement)
Element `Conformance.messaging.event` has a context of CapabilityStatement.messaging based on following the parent source element upwards and mapping to `CapabilityStatement`. Element `Conformance.messaging.event` has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). The same event may be listed up to two times - once as sender and once as receiver.
An endpoint (network accessible address) to which messages and/or replies are to be sent.
A list of the messaging transport protocol(s) identifiers, supported by this endpoint.
The protocol used for message transport.
Network address or identifier of the end-point
The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.
Length if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender).
If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.
Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, the process for becoming an authorized messaging exchange partner.
References to message definitions for messages this system can send or receive.
This is a proposed alternative to the messaging.event structure.
The mode of this event declaration - whether application is sender or receiver.
The mode of a message capability statement.
Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.
Mode of this document declaration - whether an application is a producer or consumer.
Whether the application produces or consumes documents.
A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etc.
Constraint on the resources used in the document
A profile on the document Bundle that constrains which resources are present, and their contents.
DSTU2: Constraint on a resource used in the document additional types
DSTU2: `Conformance.document.profile` additional types (Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition)) additional types from child elements (display, reference)
Element `Conformance.document.profile` is mapped to FHIR R5 element `CapabilityStatement.document.profile` as `SourceIsBroaderThanTarget`. The mappings for `Conformance.document.profile` do not cover the following types: Reference. The mappings for `Conformance.document.profile` do not cover the following types based on type expansion: display, reference. The first resource is the document resource.