DAF Research, Release 1 Ballot

This page is part of the Data Access Framework (v1.8.0: STU 2 Ballot 2) based on FHIR v1.8.0. . For a full list of available versions, see the Directory of published versions

D.4.1.4 StructureDefinition: - Detailed Descriptions

Definitions for the StructureDefinition-daf-capabilitystatement Profile.

CapabilityStatement(DAFCapabilityStatement)
Definition

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Control1..1
InvariantsDefined on this element
cpb-1: A Capability Statement SHALL have at least one of REST, messaging or document (xpath: exists(f:rest) or exists(f:messaging) or exists(f:document))
cpb-14: Capability Statements of kind 'requirements' do not have software or implementation elements (xpath: not(exists(f:software) or exists(f:implementation)) or (f:kind/@value != 'requirements'))
cpb-15: Capability Statements of kind 'instance' do not have implementation elements (xpath: not(exists(f:implementation)) or (f:kind/@value != 'capability'))
cpb-2: A Capability Statement SHALL have at least one of description, software, or implementation (xpath: count(f:software | f:implementation | f:description) > 0)
cpb-3: Messaging end-point is required (and is only permitted) when statement is for an implementation (xpath: not(exists(f:messaging/f:endpoint)) or f:kind/@value = 'instance')
cpb-7: The set of documents must be unique by the combination of profile & mode (xpath: count(f:document[f:mode/@value='producer'])=count(distinct-values(f:document[f:mode/@value='producer']/f:profile/f:reference/@value)) and count(f:document[f:mode/@value='consumer'])=count(distinct-values(f:document[f:mode/@value='consumer']/f:profile/f:reference/@value)))
cpb-8: There can only be one REST declaration per mode (xpath: count(f:rest)=count(distinct-values(f:rest/f:mode/@value)))
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (xpath: not(parent::f:contained and f:text))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (xpath: not(parent::f:contained and f:contained))
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (xpath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])))
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (xpath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)))
CapabilityStatement.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

CapabilityStatement.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
CapabilityStatement.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

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 as much as possible.

CapabilityStatement.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Typecode
Comments

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).

CapabilityStatement.text
Definition

A human-readable narrative that contains a summary of the resource, and may 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

CapabilityStatement.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

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.

CapabilityStatement.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.modifierExtension
Definition

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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.url
Definition

An absolute URL that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see Technical and Business Versions.

Control0..1
Typeuri
Must Supporttrue
Requirements

Allows the capability statement to be referenced by a single globally unique identifier.

Comments

Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.

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 are orderable.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Must Supporttrue
Comments

There may be multiple different instances of a capability statement that have the same identifier but different versions.

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.

Control0..1
Typestring
Must Supporttrue
Requirements

Support human navigation & code generation.

Comments

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly.

CapabilityStatement.title
Definition

A short, descriptive, user-friendly title for the capability statement.

Control0..1
Typestring
CapabilityStatement.status
Definition

The status of this capability statement. Enables tracking the life-cycle of the content.

Control1..1
BindingThe lifecycle status of a Value Set or Concept Map.
The codes SHALL be taken from PublicationStatus
Typecode
Is Modifiertrue
Must Supporttrue
Comments

Allows filtering of capability statement that are appropriate for use vs. not. This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.

CapabilityStatement.experimental
Definition

A flag 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.

Control0..1
Typeboolean
Is Modifiertrue
Requirements

Enables experimental content to be developed following the same life-cycle as a production-level capability statement would.

Comments

Allows filtering of capability statement that are appropriate for use vs. not.

CapabilityStatement.date
Definition

The date (and optionally time) when the capability statement was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.

Control1..1
TypedateTime
Must Supporttrue
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions.

CapabilityStatement.publisher
Definition

The name of the individual or organization that published the capability statement.

Control0..1
Typestring
Must Supporttrue
Requirements

Helps establish the "authority/credibility" of the capability statement. May also allow for contact.

Comments

Usually an organization, but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.

CapabilityStatement.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Control0..*
TypeContactDetail
Comments

May be a web site, an email address, a telephone number, etc.

CapabilityStatement.description
Definition

A free text natural language description of the capability statement from the 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.

Control0..1 This element is affected by the following invariants: cpb-2
Typemarkdown
Must Supporttrue
Comments

This description can be used to capture details such as why the capability statement was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context. This does not need to be populated if the description is adequately implied by the software or implementation details.

CapabilityStatement.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Comments

When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

CapabilityStatement.jurisdiction
Definition

A jurisdiction in which the capability statement is intended to be used.

Control0..*
BindingCountries and regions within which this artifact is targeted for use
The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable
TypeCodeableConcept
CapabilityStatement.purpose
Definition

Explains why this capability statement is needed and why it has been designed as it has.

Control0..1
Typemarkdown
Comments

This element does not describe the usage of the capability statement (See, e.g, the comments element, or relatedArtifacts), rather it's for 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
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.

Control0..1
Typemarkdown
Requirements

Consumers of the library must be able to determine any legal restrictions on the use of the capability statement and/or its content.

Alternate NamesLicense, Restrictions
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).

Control1..1
BindingHow a capability statement is intended to be used.
The codes SHALL be taken from CapabilityStatementKind
Typecode
Must Supporttrue
Requirements

Allow searching the 3 modes.

CapabilityStatement.instantiates
Definition

Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do so.

Control0..*
Typeuri
Comments

HL7 defines the following Services: Terminology Service Many Implementation Guides define additional services.

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.

Control0..1 This element is affected by the following invariants: cpb-2
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.software.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.software.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.software.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.software.name
Definition

Name software is known by.

Control1..1
Typestring
CapabilityStatement.software.version
Definition

The version identifier for the software covered by this statement.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

If possible, version should be specified, as statements are likely to be different for different versions of software.

CapabilityStatement.software.releaseDate
Definition

Date this version of the software released.

Control0..1
TypedateTime
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.

Control0..1 This element is affected by the following invariants: cpb-2
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.implementation.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.implementation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.implementation.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.implementation.description
Definition

Information about the specific installation that this capability statement relates to.

Control1..1
Typestring
Must Supporttrue
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.

Control0..1
Typeuri
Must Supporttrue
CapabilityStatement.fhirVersion
Definition

The version of the FHIR specification on which this capability statement is based.

Control1..1
Typeid
Must Supporttrue
CapabilityStatement.acceptUnknown
Definition

A code that indicates whether the application accepts unknown elements or extensions when reading resources.

Control1..1
BindingA code that indicates whether an application accepts unknown elements or extensions when reading resources.
The codes SHALL be taken from UnknownContentCode
Typecode
Comments

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.

CapabilityStatement.format
Definition

A list of the formats supported by this implementation using their content types.

Control1..*
BindingThe mime type of an attachment. Any valid mime type is allowed.
The codes SHALL be taken from http://www.rfc-editor.org/bcp/bcp13.txt
Typecode
Must Supporttrue
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
Definition

A list of the patch formats supported by this implementation using their content types.

Control0..*
BindingThe mime type of an attachment. Any valid mime type is allowed.
The codes SHALL be taken from http://www.rfc-editor.org/bcp/bcp13.txt
Typecode
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 matching the formats it supports, but this is not always possible or necessary.

CapabilityStatement.implementationGuide
Definition

A list of implementation guides that the server does (or should) support in their entirety.

Control0..*
Typeuri
CapabilityStatement.profile
Definition

A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in Using Profiles.

Control0..*
TypeReference(StructureDefinition)
Must Supporttrue
Comments

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.

CapabilityStatement.rest
Definition

A definition of the restful capabilities of the solution, if any.

Control0..* This element is affected by the following invariants: cpb-1
TypeBackboneElement
Must Supporttrue
Comments

Multiple repetitions allow definition of both client and / or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).

InvariantsDefined on this element
cpb-9: A given resource can only be described once per RESTful mode (xpath: count(f:resource)=count(distinct-values(f:resource/f:type/@value)))
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.rest.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.rest.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.mode
Definition

Identifies whether this portion of the statement is describing ability to initiate or receive restful operations.

Control1..1
BindingThe mode of a RESTful capability statement.
The codes SHALL be taken from RestfulCapabilityMode
Typecode
Must Supporttrue
CapabilityStatement.rest.documentation
Definition

Information about the system's restful capabilities that apply across all applications, such as security.

Control0..1
Typestring
CapabilityStatement.rest.security
Definition

Information about security implementation from an interface perspective - what a client needs to know.

Control0..1
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.rest.security.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.rest.security.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.security.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.security.cors
Definition

Server adds CORS headers when responding to requests - this enables javascript applications to use the server.

Control0..1
Typeboolean
Must Supporttrue
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
Definition

Types of security services are supported/required by the system.

Control0..*
BindingTypes of security services used with FHIR.
The codes SHALL be taken from RestfulSecurityService; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
CapabilityStatement.rest.security.description
Definition

General description of how security works.

Control0..1
Typestring
CapabilityStatement.rest.security.certificate
Definition

Certificates associated with security profiles.

Control0..*
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.rest.security.certificate.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.rest.security.certificate.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.security.certificate.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.security.certificate.type
Definition

Mime type for certificate.

Control0..1
BindingThe mime type of an attachment. Any valid mime type is allowed.
The codes SHALL be taken from http://www.rfc-editor.org/bcp/bcp13.txt
Typecode
CapabilityStatement.rest.security.certificate.blob
Definition

Actual certificate.

Control0..1
Typebase64Binary
CapabilityStatement.rest.resource
Definition

A specification of the restful capabilities of the solution for a specific resource type.

Control0..*
TypeBackboneElement
Must Supporttrue
Comments

Max of one repetition per resource type.

InvariantsDefined on this element
cpb-12: Search parameter names must be unique in the context of a resource (xpath: count(f:searchParam)=count(distinct-values(f:searchParam/f:name/@value)))
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.rest.resource.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.rest.resource.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.resource.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.resource.type
Definition

A type of resource exposed via the restful interface.

Control1..1
BindingOne of the resource types defined as part of FHIR.
The codes SHALL be taken from ResourceType
Typecode
Must Supporttrue
CapabilityStatement.rest.resource.profile
Definition

A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles]{profiling.html#profile-uses}.

Control0..1
TypeReference(StructureDefinition)
Must Supporttrue
Comments

The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.

CapabilityStatement.rest.resource.documentation
Definition

Additional information about the resource type is used by the system.

Control0..1
Typemarkdown
Must Supporttrue
CapabilityStatement.rest.resource.interaction
Definition

Identifies a restful operation supported by the solution.

Control1..*
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.rest.resource.interaction.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.rest.resource.interaction.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.resource.interaction.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.resource.interaction.code
Definition

Coded identifier of the operation, supported by the system resource.

Control1..1
BindingOperations supported by REST at the type or instance level.
The codes SHALL be taken from TypeRestfulInteraction
Typecode
Must Supporttrue
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'.

Control0..1
Typestring
Must Supporttrue
Requirements

REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.

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.

Control0..1
BindingHow the system supports versioning for a resource.
The codes SHALL be taken from ResourceVersionPolicy
Typecode
Must Supporttrue
Comments

If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so.

CapabilityStatement.rest.resource.readHistory
Definition

A flag for whether the server is able to return past versions as part of the vRead operation.

Control0..1
Typeboolean
Must Supporttrue
Comments

It is useful to support the vRead operation for current operations, even if past versions aren't available.

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 (e.g. 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.

Control0..1
Typeboolean
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
Definition

A flag that indicates that the server supports conditional create.

Control0..1
Typeboolean
Comments

Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.

CapabilityStatement.rest.resource.conditionalRead
Definition

A code that indicates how the server supports conditional read.

Control0..1
BindingA code that indicates how the server supports conditional read.
The codes SHALL be taken from ConditionalReadStatus
Typecode
Comments

Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2.

CapabilityStatement.rest.resource.conditionalUpdate
Definition

A flag that indicates that the server supports conditional update.

Control0..1
Typeboolean
Comments

Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.

CapabilityStatement.rest.resource.conditionalDelete
Definition

A code that indicates how the server supports conditional delete.

Control0..1
BindingA code that indicates how the server supports conditional delete.
The codes SHALL be taken from ConditionalDeleteStatus
Typecode
Comments

Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.

CapabilityStatement.rest.resource.referencePolicy
Definition

A set of flags that defines how references are supported.

Control0..*
BindingA set of flags that defines how references are supported
The codes SHALL be taken from ReferenceHandlingPolicy
Typecode
CapabilityStatement.rest.resource.searchInclude
Definition

A list of _include values supported by the server.

Control0..*
Typestring
Comments

If this list is empty, the server does not support includes.

CapabilityStatement.rest.resource.searchRevInclude
Definition

A list of _revinclude (reverse include) values supported by the server.

Control0..*
Typestring
Comments

If this list is empty, the server does not support includes.

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.

Control0..*
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.rest.resource.searchParam.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.rest.resource.searchParam.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.resource.searchParam.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.resource.searchParam.name
Definition

The name of the search parameter used in the interface.

Control1..1
Typestring
Must Supporttrue
Comments

Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.

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).

Control0..1
Typeuri
Must Supporttrue
Comments

This SHOULD be present, and matches refers to a SearchParameter by it's 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.

CapabilityStatement.rest.resource.searchParam.type
Definition

The type of value a search parameter refers to, and how the content is interpreted.

Control1..1
BindingData types allowed to be used for search parameters.
The codes SHALL be taken from SearchParamType
Typecode
Must Supporttrue
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
Definition

This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

Control0..1
Typestring
CapabilityStatement.rest.interaction
Definition

A specification of restful operations supported by the system.

Control0..*
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.rest.interaction.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.rest.interaction.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.interaction.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.interaction.code
Definition

A coded identifier of the operation, supported by the system.

Control1..1
BindingOperations supported by REST at the system level.
The codes SHALL be taken from SystemRestfulInteraction
Typecode
Must Supporttrue
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.

Control0..1
Typestring
Must Supporttrue
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.

Control0..*
TypeSee CapabilityStatement:dafcapabilitystatement.rest.resource.searchParam
Must Supporttrue
Comments

Typically, the only search parameters supported for all parameters are search parameters that apply to all resources - tags, profiles, text search etc.

CapabilityStatement.rest.operation
Definition

Definition of an operation or a named query and with its parameters and their meaning and type.

Control0..*
TypeBackboneElement
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.rest.operation.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.rest.operation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.operation.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.rest.operation.name
Definition

The name of the operation or query. For an operation, this is the name prefixed with $ and used in the url. For a query, this is the name used in the _query parameter when the query is called.

Control1..1
Typestring
Must Supporttrue
Comments

The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the "$" portion that is always included in the URL.

CapabilityStatement.rest.operation.definition
Definition

Where the formal definition can be found.

Control1..1
TypeReference(OperationDefinition)
Must Supporttrue
Comments

This can be used to build an HTML form to invoke the operation, for instance.

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 it's canonical URL.

Control0..*
Typeuri
Comments

At present, the only defined compartments are at CompartmentDefinition.

CapabilityStatement.messaging
Definition

A description of the messaging capabilities of the solution.

Control0..* This element is affected by the following invariants: cpb-1
TypeBackboneElement
Comments

Multiple repetitions allow the documentation of multiple endpoints per solution.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.messaging.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.messaging.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.messaging.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.messaging.endpoint
Definition

An endpoint (network accessible address) to which messages and/or replies are to be sent.

Control0..*
TypeBackboneElement
Alternate Names3
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.messaging.endpoint.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.messaging.endpoint.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.messaging.endpoint.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.messaging.endpoint.protocol
Definition

A list of the messaging transport protocol(s) identifiers, supported by this endpoint.

Control1..1
BindingThe protocol used for message transport.
The codes SHALL be taken from MessageTransport; other codes may be used where these codes are not suitable
TypeCoding
CapabilityStatement.messaging.endpoint.address
Definition

The network address of the end-point. For solutions that do not use network addresses for routing, it can be just an identifier.

Control1..1
Typeuri
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).

Control0..1
TypeunsignedInt
Comments

If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.

CapabilityStatement.messaging.documentation
Definition

Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, process for becoming an authorized messaging exchange partner.

Control0..1
Typestring
CapabilityStatement.messaging.event
Definition

A description of the solution's support for an event at this end-point.

Control1..*
TypeBackboneElement
Comments

The same event may be listed up to two times - once as sender and once as receiver.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.messaging.event.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.messaging.event.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.messaging.event.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.messaging.event.code
Definition

A coded identifier of a supported messaging event.

Control1..1
BindingOne of the message events defined as part of FHIR.
The codes SHOULD be taken from MessageEvent
TypeCoding
CapabilityStatement.messaging.event.category
Definition

The impact of the content of the message.

Control0..1
BindingThe impact of the content of a message.
The codes SHALL be taken from MessageSignificanceCategory
Typecode
CapabilityStatement.messaging.event.mode
Definition

The mode of this event declaration - whether application is sender or receiver.

Control1..1
BindingThe mode of a message capability statement.
The codes SHALL be taken from EventCapabilityMode
Typecode
CapabilityStatement.messaging.event.focus
Definition

A resource associated with the event. This is the resource that defines the event.

Control1..1
BindingOne of the resource types defined as part of FHIR.
The codes SHALL be taken from ResourceType
Typecode
Comments

This SHALL be provided if the event type supports multiple different resource types.

CapabilityStatement.messaging.event.request
Definition

Information about the request for this event.

Control1..1
TypeReference(StructureDefinition)
CapabilityStatement.messaging.event.response
Definition

Information about the response for this event.

Control1..1
TypeReference(StructureDefinition)
CapabilityStatement.messaging.event.documentation
Definition

Guidance on how this event is handled, such as internal system trigger points, business rules, etc.

Control0..1
Typestring
CapabilityStatement.document
Definition

A document definition.

Control0..* This element is affected by the following invariants: cpb-1
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
CapabilityStatement.document.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
CapabilityStatement.document.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.document.modifierExtension
Definition

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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

CapabilityStatement.document.mode
Definition

Mode of this document declaration - whether application is producer or consumer.

Control1..1
BindingWhether the application produces or consumes documents.
The codes SHALL be taken from DocumentMode
Typecode
CapabilityStatement.document.documentation
Definition

A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etc.

Control0..1
Typestring
CapabilityStatement.document.profile
Definition

A constraint on a resource used in the document.

Control1..1
TypeReference(StructureDefinition)
Comments

The first resource is the document resource.