This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
FHIR Infrastructure Work Group | Maturity Level: N | Normative (from v4.0.0) | Security Category: Anonymous | Compartments: No defined compartments |
Detailed Descriptions for the elements in the CapabilityStatement resource.
CapabilityStatement | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement | ||||||||||||||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | A statement of system capabilities | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | CanonicalResource | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.url | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.url | ||||||||||||||||||||||||||||||||||||||||
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 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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Canonical identifier for this capability statement, represented as a URI (globally unique) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||||||||||||||
Requirements | Allows the capability statement to be referenced by a single globally unique identifier. | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.identifier | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.identifier | ||||||||||||||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Additional identifier for the CapabilityStatement (business identifier) | ||||||||||||||||||||||||||||||||||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||||||||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.version | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.version | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Business version of the capability statement | ||||||||||||||||||||||||||||||||||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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]. The version SHOULD NOT contain a '#' - see Business Version. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.versionAlgorithm[x] | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.versionAlgorithm[x] | ||||||||||||||||||||||||||||||||||||||||
Definition | Indicates the mechanism used to compare versions to determine which is more current. | ||||||||||||||||||||||||||||||||||||||||
Short Display | How to compare versions | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Version Algorithm (Extensible) | ||||||||||||||||||||||||||||||||||||||||
Type | string|Coding | ||||||||||||||||||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.name | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.name | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Name for this capability statement (computer friendly) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.title | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.title | ||||||||||||||||||||||||||||||||||||||||
Definition | A short, descriptive, user-friendly title for the capability statement. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Name for this capability statement (human friendly) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.status | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.status | ||||||||||||||||||||||||||||||||||||||||
Definition | The status of this capability statement. Enables tracking the life-cycle of the content. | ||||||||||||||||||||||||||||||||||||||||
Short Display | draft | active | retired | unknown | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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. See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.experimental | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.experimental | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | For testing purposes, not real usage | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||
Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||||||||||||||||||||||||||||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement. | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | Allows filtering of capability statements that are appropriate for use versus not. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.date | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.date | ||||||||||||||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Date last changed | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Type | dateTime | ||||||||||||||||||||||||||||||||||||||||
Alternate Names | Revision Date | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.publisher | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.publisher | ||||||||||||||||||||||||||||||||||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the capability statement. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||
Requirements | Helps establish the "authority/credibility" of the capability statement. May also allow for contact. | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.contact | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.contact | ||||||||||||||||||||||||||||||||||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Contact details for the publisher | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.description | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.description | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Natural language description of the capability statement | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.useContext | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.useContext | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | The context that the content is intended to support | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | UsageContext | ||||||||||||||||||||||||||||||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.jurisdiction | |||||||||||||||||||||||||||||||||||||||||
Standards Status | This element has a standards status of "Deprecated" which is different from the status of the whole resource | ||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.jurisdiction | ||||||||||||||||||||||||||||||||||||||||
Definition | A legal or geographic region in which the capability statement is intended to be used. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Intended jurisdiction for capability statement (if applicable) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Jurisdiction ValueSet (Extensible) | ||||||||||||||||||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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. 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.) | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.purpose | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.purpose | ||||||||||||||||||||||||||||||||||||||||
Definition | Explanation of why this capability statement is needed and why it has been designed as it has. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Why this capability statement is defined | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.copyright | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.copyright | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Use and/or publishing restrictions | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content. | ||||||||||||||||||||||||||||||||||||||||
Alternate Names | License; Restrictions | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | ... | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.copyrightLabel | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.copyrightLabel | ||||||||||||||||||||||||||||||||||||||||
Definition | 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'). | ||||||||||||||||||||||||||||||||||||||||
Short Display | Copyright holder and year(s) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||
Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.kind | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.kind | ||||||||||||||||||||||||||||||||||||||||
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). | ||||||||||||||||||||||||||||||||||||||||
Short Display | instance | capability | requirements | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Capability Statement Kind (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Requirements | Allow searching the 3 modes. | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.instantiates | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.instantiates | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Canonical URL of another capability statement this implements | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | canonical(CapabilityStatement) | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | HL7 defines the following Services: Terminology Service. Many Implementation Guides define additional services. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.imports | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.imports | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Canonical URL of another capability statement this adds to | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | canonical(CapabilityStatement) | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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). | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.software | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.software | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Software that is covered by this capability statement | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.software.name | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.software.name | ||||||||||||||||||||||||||||||||||||||||
Definition | Name the software is known by. | ||||||||||||||||||||||||||||||||||||||||
Short Display | A name the software is known by | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.software.version | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.software.version | ||||||||||||||||||||||||||||||||||||||||
Definition | The version identifier for the software covered by this statement. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Version covered by this statement | ||||||||||||||||||||||||||||||||||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | If possible, a version should be specified, as statements are likely to be different for different versions of software. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.software.releaseDate | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.software.releaseDate | ||||||||||||||||||||||||||||||||||||||||
Definition | Date this version of the software was released. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Date this version was released | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | dateTime | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.implementation | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.implementation | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | If this describes a specific instance | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.implementation.description | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.implementation.description | ||||||||||||||||||||||||||||||||||||||||
Definition | Information about the specific installation that this capability statement relates to. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Describes this specific instance | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.implementation.url | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.implementation.url | ||||||||||||||||||||||||||||||||||||||||
Definition | An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Base URL for the installation | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | url | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.implementation.custodian | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.implementation.custodian | ||||||||||||||||||||||||||||||||||||||||
Definition | The organization responsible for the management of the instance and oversight of the data on the server at the specified URL. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Organization that manages the data | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | Reference(Organization) | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.fhirVersion | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.fhirVersion | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | FHIR Version the system supports | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | FHIRVersion (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.format | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.format | ||||||||||||||||||||||||||||||||||||||||
Definition | A list of the formats supported by this implementation using their content types. | ||||||||||||||||||||||||||||||||||||||||
Short Display | formats supported (xml | json | ttl | mime type) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..* | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Mime Types (Required)
| ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.patchFormat | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.patchFormat | ||||||||||||||||||||||||||||||||||||||||
Definition | A list of the patch formats supported by this implementation using their content types. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Patch formats supported | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Mime Types (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.acceptLanguage | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.acceptLanguage | ||||||||||||||||||||||||||||||||||||||||
Definition | A list of the languages supported by this implementation that are usefully supported in the | ||||||||||||||||||||||||||||||||||||||||
Short Display | Languages supported | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | All Languages (Required)
| ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.implementationGuide | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.implementationGuide | ||||||||||||||||||||||||||||||||||||||||
Definition | A list of implementation guides that the server does (or should) support in their entirety. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Implementation guides supported | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | canonical(ImplementationGuide) | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest | ||||||||||||||||||||||||||||||||||||||||
Definition | A definition of the restful capabilities of the solution, if any. | ||||||||||||||||||||||||||||||||||||||||
Short Display | If the endpoint is a RESTful one | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements). | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.mode | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.mode | ||||||||||||||||||||||||||||||||||||||||
Definition | Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations. | ||||||||||||||||||||||||||||||||||||||||
Short Display | client | server | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Restful Capability Mode (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.documentation | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.documentation | ||||||||||||||||||||||||||||||||||||||||
Definition | Information about the system's restful capabilities that apply across all applications, such as security. | ||||||||||||||||||||||||||||||||||||||||
Short Display | General description of implementation | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.security | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.security | ||||||||||||||||||||||||||||||||||||||||
Definition | Information about security implementation from an interface perspective - what a client needs to know. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Information about security of implementation | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.security.cors | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.security.cors | ||||||||||||||||||||||||||||||||||||||||
Definition | Server adds CORS headers when responding to requests - this enables Javascript applications to use the server. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Adds CORS Headers (http://enable-cors.org/) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.security.service | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.security.service | ||||||||||||||||||||||||||||||||||||||||
Definition | Types of security services that are supported/required by the system. | ||||||||||||||||||||||||||||||||||||||||
Short Display | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Restful Security Service (Extensible) | ||||||||||||||||||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.security.description | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.security.description | ||||||||||||||||||||||||||||||||||||||||
Definition | General description of how security works. | ||||||||||||||||||||||||||||||||||||||||
Short Display | General description of how security works | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource | ||||||||||||||||||||||||||||||||||||||||
Definition | A specification of the restful capabilities of the solution for a specific resource type. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Resource served on the REST interface | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | Max of one repetition per resource type. | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.type | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.type | ||||||||||||||||||||||||||||||||||||||||
Definition | A type of resource exposed via the restful interface. | ||||||||||||||||||||||||||||||||||||||||
Short Display | A resource type that is supported | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Resource Types (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.profile | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.profile | ||||||||||||||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | System-wide profile | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | canonical(StructureDefinition) | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | All other profiles for this type that are listed in | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.supportedProfile | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.supportedProfile | ||||||||||||||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Use-case specific profiles | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | canonical(StructureDefinition) | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | Supported profiles must conform to the resource profile in the | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.documentation | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.documentation | ||||||||||||||||||||||||||||||||||||||||
Definition | Additional information about the resource type used by the system. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Additional information about the use of the resource type | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.interaction | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.interaction | ||||||||||||||||||||||||||||||||||||||||
Definition | Identifies a restful operation supported by the solution. | ||||||||||||||||||||||||||||||||||||||||
Short Display | What operations are supported? | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
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). | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.interaction.code | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.interaction.code | ||||||||||||||||||||||||||||||||||||||||
Definition | Coded identifier of the operation, supported by the system resource. | ||||||||||||||||||||||||||||||||||||||||
Short Display | read | vread | update | update-conditional | patch | patch-conditional | delete | delete-conditional-single | delete-conditional-multiple | delete-history | delete-history-version | history-instance | history-type | create | create-conditional | search-type | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Type Restful Interaction (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.interaction.documentation | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.interaction.documentation | ||||||||||||||||||||||||||||||||||||||||
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'. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Anything special about operation behavior | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Requirements | REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of. | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.versioning | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.versioning | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | no-version | versioned | versioned-update | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Resource Version Policy (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.readHistory | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.readHistory | ||||||||||||||||||||||||||||||||||||||||
Definition | A flag for whether the server is able to return past versions as part of the vRead operation. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Whether vRead can return past versions | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | It is useful to support the vRead operation for current operations, even if past versions aren't available. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.updateCreate | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.updateCreate | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | If update can commit to a new identity | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.conditionalCreate | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.conditionalCreate | ||||||||||||||||||||||||||||||||||||||||
Definition | A flag that indicates that the server supports conditional create. | ||||||||||||||||||||||||||||||||||||||||
Short Display | If allows/uses conditional create | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.conditionalRead | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.conditionalRead | ||||||||||||||||||||||||||||||||||||||||
Definition | A code that indicates how the server supports conditional read. | ||||||||||||||||||||||||||||||||||||||||
Short Display | not-supported | modified-since | not-match | full-support | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Conditional Read Status (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.conditionalUpdate | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.conditionalUpdate | ||||||||||||||||||||||||||||||||||||||||
Definition | A flag that indicates that the server supports conditional update. | ||||||||||||||||||||||||||||||||||||||||
Short Display | If allows/uses conditional update | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.conditionalPatch | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.conditionalPatch | ||||||||||||||||||||||||||||||||||||||||
Definition | A flag that indicates that the server supports conditional patch. | ||||||||||||||||||||||||||||||||||||||||
Short Display | If allows/uses conditional patch | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | Conditional Patch is mainly appropriate for interface engine scripts converting from other formats, such as v2. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.conditionalDelete | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.conditionalDelete | ||||||||||||||||||||||||||||||||||||||||
Definition | A code that indicates how the server supports conditional delete. | ||||||||||||||||||||||||||||||||||||||||
Short Display | not-supported | single | multiple - how conditional delete is supported | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Conditional Delete Status (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.referencePolicy | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.referencePolicy | ||||||||||||||||||||||||||||||||||||||||
Definition | A set of flags that defines how references are supported. | ||||||||||||||||||||||||||||||||||||||||
Short Display | literal | logical | resolves | enforced | local | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Reference Handling Policy (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.searchInclude | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.searchInclude | ||||||||||||||||||||||||||||||||||||||||
Definition | A list of _include values supported by the server. | ||||||||||||||||||||||||||||||||||||||||
Short Display | _include values supported by the server | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | Documenting
These values would be listed as part of capabilities for "CarePlan": "searchInclude" : ["CarePlan:activity-reference:DeviceRequest","DeviceRequest:device"], | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.searchRevInclude | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.searchRevInclude | ||||||||||||||||||||||||||||||||||||||||
Definition | A list of _revinclude (reverse include) values supported by the server. | ||||||||||||||||||||||||||||||||||||||||
Short Display | _revinclude values supported by the server | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | See | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.searchParam | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.searchParam | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Search parameters supported by implementation | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.searchParam.name | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.searchParam.name | ||||||||||||||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Name for parameter in search url | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.searchParam.definition | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.searchParam.definition | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Source of definition for parameter | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | canonical(SearchParameter) | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.searchParam.type | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.searchParam.type | ||||||||||||||||||||||||||||||||||||||||
Definition | The type of value a search parameter refers to, and how the content is interpreted. | ||||||||||||||||||||||||||||||||||||||||
Short Display | number | date | string | token | reference | composite | quantity | uri | special | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | SearchParamType (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.searchParam.documentation | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.searchParam.documentation | ||||||||||||||||||||||||||||||||||||||||
Definition | This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Server-specific usage | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.operation | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Definition of a resource operation | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.operation.name | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.operation.name | ||||||||||||||||||||||||||||||||||||||||
Definition | 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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Name by which the operation/query is invoked | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | 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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.operation.definition | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.operation.definition | ||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||
Short Display | The defined operation/query | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Type | canonical(OperationDefinition) | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | This can be used to build an HTML form to invoke the operation, for instance. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.resource.operation.documentation | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.resource.operation.documentation | ||||||||||||||||||||||||||||||||||||||||
Definition | Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Specific details about operation behavior | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.interaction | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.interaction | ||||||||||||||||||||||||||||||||||||||||
Definition | A specification of restful operations supported by the system. | ||||||||||||||||||||||||||||||||||||||||
Short Display | What operations are supported? | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.interaction.code | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.interaction.code | ||||||||||||||||||||||||||||||||||||||||
Definition | A coded identifier of the operation, supported by the system. | ||||||||||||||||||||||||||||||||||||||||
Short Display | transaction | batch | search-system | history-system | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | System Restful Interaction (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.interaction.documentation | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.interaction.documentation | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Anything special about operation behavior | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.searchParam | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.searchParam | ||||||||||||||||||||||||||||||||||||||||
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. This is only for searches executed against the system-level endpoint. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Search parameters for searching all resources | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | See CapabilityStatement.rest.resource.searchParam | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.operation | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.operation | ||||||||||||||||||||||||||||||||||||||||
Definition | Definition of an operation or a named query together with its parameters and their meaning and type. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Definition of a system level operation | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | See CapabilityStatement.rest.resource.operation | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.rest.compartment | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.rest.compartment | ||||||||||||||||||||||||||||||||||||||||
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 . | ||||||||||||||||||||||||||||||||||||||||
Short Display | Compartments served/used by system | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Type | canonical(CompartmentDefinition) | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | At present, the only defined compartments are at CompartmentDefinition. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.messaging | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.messaging | ||||||||||||||||||||||||||||||||||||||||
Definition | A description of the messaging capabilities of the solution. | ||||||||||||||||||||||||||||||||||||||||
Short Display | If messaging is supported | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | Multiple repetitions allow the documentation of multiple endpoints per solution. | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.messaging.endpoint | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.messaging.endpoint | ||||||||||||||||||||||||||||||||||||||||
Definition | An endpoint (network accessible address) to which messages and/or replies are to be sent. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Where messages should be sent | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Alternate Names | 3 | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.messaging.endpoint.protocol | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.messaging.endpoint.protocol | ||||||||||||||||||||||||||||||||||||||||
Definition | A list of the messaging transport protocol(s) identifiers, supported by this endpoint. | ||||||||||||||||||||||||||||||||||||||||
Short Display | http | ftp | mllp + | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Message Transport (Extensible) | ||||||||||||||||||||||||||||||||||||||||
Type | Coding | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.messaging.endpoint.address | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.messaging.endpoint.address | ||||||||||||||||||||||||||||||||||||||||
Definition | The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Network address or identifier of the end-point | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Type | url | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.messaging.reliableCache | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.messaging.reliableCache | ||||||||||||||||||||||||||||||||||||||||
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). | ||||||||||||||||||||||||||||||||||||||||
Short Display | Reliable Message Cache Length (min) | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | unsignedInt | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
Comments | If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.messaging.documentation | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.messaging.documentation | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Messaging interface behavior details | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.messaging.supportedMessage | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.messaging.supportedMessage | ||||||||||||||||||||||||||||||||||||||||
Definition | References to message definitions for messages this system can send or receive. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Messages supported by this system | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | This is a proposed alternative to the messaging.event structure. | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.messaging.supportedMessage.mode | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.messaging.supportedMessage.mode | ||||||||||||||||||||||||||||||||||||||||
Definition | The mode of this event declaration - whether application is sender or receiver. | ||||||||||||||||||||||||||||||||||||||||
Short Display | sender | receiver | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Event Capability Mode (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.messaging.supportedMessage.definition | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.messaging.supportedMessage.definition | ||||||||||||||||||||||||||||||||||||||||
Definition | Points to a message definition that identifies the messaging event, message structure, allowed responses, etc. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Message supported by this system | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Type | canonical(MessageDefinition) | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.document | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.document | ||||||||||||||||||||||||||||||||||||||||
Definition | A document definition. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Document definition | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.document.mode | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.document.mode | ||||||||||||||||||||||||||||||||||||||||
Definition | Mode of this document declaration - whether an application is a producer or consumer. | ||||||||||||||||||||||||||||||||||||||||
Short Display | producer | consumer | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Terminology Binding | Document Mode (Required) | ||||||||||||||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.document.documentation | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.document.documentation | ||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Description of document support | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||||||||||||||
CapabilityStatement.document.profile | |||||||||||||||||||||||||||||||||||||||||
Element Id | CapabilityStatement.document.profile | ||||||||||||||||||||||||||||||||||||||||
Definition | A profile on the document Bundle that constrains which resources are present, and their contents. | ||||||||||||||||||||||||||||||||||||||||
Short Display | Constraint on the resources used in the document | ||||||||||||||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||||||||||||||
Type | canonical(StructureDefinition) | ||||||||||||||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||||||||||||||
Comments | The profile is actually on the Bundle. | ||||||||||||||||||||||||||||||||||||||||
Invariants |
|