A compartment definition that defines how resources are accessed on a server.

In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content.

An absolute URL that is used to identify this compartment definition 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 compartment definition is (or will be) published. The URL SHOULD include the major version of the compartment definition. For more information see Technical and Business Versions.

Allows the compartment definition to be referenced by a single globally unique identifier.

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

A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Support human navigation & code generation.

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. This is often the same as the code for the parameter, but does not need to be.

A short, descriptive, user-friendly title for the compartment definition.

The status of this compartment definition. Enables tracking the life-cycle of the content.

Allows filtering of compartment definition that are appropriate for use vs. not.

A flag to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

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

Allows filtering of compartment definition that are appropriate for use vs. not.

The name of the individual or organization that published the compartment definition.

Helps establish the "authority/credibility" of the compartment definition. May also allow for contact.

Usually an organization, but may be an individual. The publisher (or steward) of the compartment definition is the organization or individual primarily responsible for the maintenance and upkeep of the compartment definition. 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 compartment definition. This item SHOULD be populated unless the information is available from context.

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

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

The date (and optionally time) when the compartment definition 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 compartment definition changes.

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

A free text natural language description of the compartment definition from the consumer's perspective.

This description can be used to capture details such as why the compartment definition 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.

Explains why this compartment definition is needed and why it has been designed as it has.

This element does not describe the usage of the compartment definition (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 compartment 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.

Assist in searching for appropriate content.

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

A jurisdiction in which the compartment definition is intended to be used.

Which compartment this definition describes.

Only the specification can define the compartments that can exist. Servers can choose to support them.

Whether the search syntax is supported.

Servers may define and use compartments to manage logical access without implementing the compoartment related syntax.

Information about how a resource it related to the compartment.

The name of a resource supported by the server.

The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment more than one way.

If no search parameters are listed, then the resource is not linked to the compartment.

Additional doco about the resource and compartment.