type: resource-definitionsresource: CompartmentDefinition

CompartmentDefinition Definitions

CompartmentDefinition

Compartment Definition for a resource

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

Comments: 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.

Cardinality: 0..*

Constraints: cnl-0 | warning | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.exists() implies name.matches('^A-Z{1,254}$')

Mappings: v2=n/a; rim=n/a; w5=conformance.behavior

CompartmentDefinition.url

Canonical identifier for this compartment definition, represented as a URI (globally unique)

Definition: An absolute URI that is used to identify this compartment definition 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 compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.

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.

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

Cardinality: 1..1

Type: uri

Summary: true

Mappings: w5=FiveWs.identifier

CompartmentDefinition.version

Business version of the compartment definition

Definition: The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

Comments: There may be different compartment definition 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 compartment definition with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

Cardinality: 0..1

Type: string

Summary: true

Mappings: w5=FiveWs.version

CompartmentDefinition.versionAlgorithm[x]

How to compare versions

Definition: Indicates the mechanism used to compare versions to determine which is more current.

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.

Cardinality: 0..1

Type: string, Coding

Binding: extensible:version-algorithm

Summary: true

CompartmentDefinition.name

Name for this compartment definition (computer friendly)

Definition: 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.

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

Requirements: Support human navigation and code generation.

Conditions: cnl-0

Cardinality: 1..1

Type: string

Summary: true

CompartmentDefinition.title

Name for this compartment definition (human friendly)

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

Comments: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Cardinality: 0..1

Type: string

Summary: true

CompartmentDefinition.status

draft | active | retired | unknown

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

Comments: Allows filtering of compartment definitions that are appropriate for use versus not.

See guidance around (not) making local changes to elements here.

Cardinality: 1..1

Type: code

Binding: required:publication-status

Summary: true

Is Modifier: true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)

Mappings: w5=FiveWs.status

CompartmentDefinition.experimental

For testing only - never for real usage

Definition: A Boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

Comments: Allows filtering of compartment definitions that are appropriate for use versus not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level compartment definition.

Meaning if Missing: If absent, this resource is treated as though it is not experimental.

Cardinality: 0..1

Type: boolean

Summary: true

Mappings: w5=FiveWs.class

CompartmentDefinition.date

Date last changed

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

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 compartment definition. 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.

Aliases: Revision Date

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: w5=FiveWs.recorded

CompartmentDefinition.publisher

Name of the publisher/steward (organization or individual)

Definition: The name of the organization or individual responsible for the release and ongoing maintenance of the compartment definition.

Comments: 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.

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

Cardinality: 0..1

Type: string

Summary: true

Mappings: w5=FiveWs.witness

CompartmentDefinition.contact

Contact details for the publisher

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

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

See guidance around (not) making local changes to elements here.

Cardinality: 0..*

Type: ContactDetail

Summary: true

CompartmentDefinition.description

Natural language description of the compartment definition

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

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 compartment definition 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 compartment definition is presumed to be the predominant language in the place the compartment definition was created).

Cardinality: 0..1

Type: markdown

CompartmentDefinition.useContext

The context that the content is intended to support

Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances.

Comments: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Requirements: Assist in searching for appropriate content.

Cardinality: 0..*

Type: UsageContext

Summary: true

CompartmentDefinition.purpose

Why this compartment definition is defined

Definition: Explanation of why this compartment definition is needed and why it has been designed as it has.

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

Cardinality: 0..1

Type: markdown

Mappings: w5=FiveWs.why[x]; objimpl=no-gen-base

CompartmentDefinition.code

Definition: Which compartment this definition describes.

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

Cardinality: 1..1

Type: code

Binding: required:compartment-type

Summary: true

CompartmentDefinition.search

Whether the search syntax is supported

Definition: Whether the search syntax is supported,.

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

Cardinality: 1..1

Type: boolean

Summary: true

CompartmentDefinition.resource

How a resource is related to the compartment

Definition: Information about how a resource is related to the compartment.

Cardinality: 0..*

Type: BackboneElement

Summary: true

CompartmentDefinition.resource.code

Name of resource type

Definition: The name of a resource supported by the server.

Cardinality: 1..1

Type: code

Binding: required:resource-types

Summary: true

CompartmentDefinition.resource.param

Search Parameter Name, or chained parameters

Definition: The search parameter 'code' as defined in the core specification that represents the link to the compartment.

Comments: More than one may be listed because a resource may be linked to a compartment in more than one way. Note that a given server might use a different 'code' for the SearchParameter in their CapabilityStatement. The inclusion rules are based on the 'base' HL7 search parameter code value, not the server-specific code value. E.g. if a server uses code 'doc' instead of 'performer' for their Procedure performer search performer, the 'doc' search would still apply when determining membership in the Practitioner compartment. If no search parameters are listed, then the resource is not linked to the compartment.

Cardinality: 0..*

Type: string

Summary: true

CompartmentDefinition.resource.startParam

Search Param for interpreting $everything.start

Definition: Search Parameter for mapping requests made with $everything.start (e.g. on Patient.$everything).

Cardinality: 0..1

Type: uri

CompartmentDefinition.resource.endParam

Search Param for interpreting $everything.end

Definition: Search Parameter for mapping requests made with $everything.end (e.g. on Patient.$everything).

Cardinality: 0..1

Type: uri