FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R4 R3

FHIR Infrastructure Work Group Maturity Level : 1   Trial Use Security Category : Anonymous Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the CompartmentDefinition resource.

true
CompartmentDefinition
Element Id CompartmentDefinition
Definition

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

Control Cardinality 1..1 0..*
Type DomainResource
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.

Invariants
Defined on this element
cpd-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
CompartmentDefinition.url
Element Id CompartmentDefinition.url
Definition

An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. instance; also called its canonical identifier. This SHALL be a URL, SHOULD be globally unique, unique and SHOULD be an a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. The This URL SHOULD include can be the major version target of a canonical reference. It SHALL remain the same when the compartment definition. For more information see Technical and Business Versions . definition is stored on different servers.

Control Cardinality 1..1
Type uri
Requirements

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

Summary true
Comments

Can be a urn:uuid: or a urn:oid:, urn:oid: but real http: addresses are preferred. Multiple instances may share the same url 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.

CompartmentDefinition.version
Element Id CompartmentDefinition.version
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.

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

CompartmentDefinition.name
Element Id CompartmentDefinition.name
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.

Control Cardinality 1..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 alpha-numeric alphanumeric type name to ensure that it is computable friendly. This machine-processing friendly.This is often the same as the code for the parameter, but does not need to be.

Invariants Definition string
CompartmentDefinition.title Affect this element
inv-0 A short, descriptive, user-friendly title for the compartment definition. Control Warning 0..1 Name should be usable as an identifier for the module by machine processing applications such as code generation Type name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
Summary CompartmentDefinition.status true
Comments Element Id This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. CompartmentDefinition.status
Definition

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

Control 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 compartment definitions that are appropriate for use vs. versus not. This is labeled as "Is Modifier" because applications should not use a retired compartment definition without due consideration.

CompartmentDefinition.experimental
Element Id CompartmentDefinition.experimental
Definition

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

Control Cardinality 0..1
Type boolean
Is Modifier true Requirements

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

Summary true
Comments

Allows filtering of compartment definition definitions that are appropriate for use vs. versus not. This is labeled as "Is Modifier" because applications should not use an experimental compartment definition in production.

CompartmentDefinition.date
Element Id CompartmentDefinition.date
Definition

The date (and optionally time) when the compartment definition was published. The date must change if and 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.

Control Cardinality 0..1
Type dateTime
Alternate Names Revision Date
Summary true
Comments

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.

CompartmentDefinition.publisher
Element Id CompartmentDefinition.publisher
Definition

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

Control Cardinality 0..1
Type string
Requirements

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

Summary true
Comments

Usually an organization, 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.

CompartmentDefinition.contact
Element Id CompartmentDefinition.contact
Definition

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

Control Cardinality 0..*
Type ContactDetail
Summary true
Comments

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

CompartmentDefinition.description
Element Id CompartmentDefinition.description
Definition

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

Control Cardinality 0..1
Type markdown
Comments

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

CompartmentDefinition.purpose CompartmentDefinition.useContext
Definition Explaination of why this compartment definition is needed and why it has been designed as it has. Control 0..1 Type markdown Comments Element Id 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. CompartmentDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These terms 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.

Control Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary true
Comments

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

CompartmentDefinition.jurisdiction CompartmentDefinition.purpose
Definition Element Id A legal or geographic region in which the compartment definition is intended to be used. CompartmentDefinition.purpose
Control Definition 0..*

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

Terminology Binding Cardinality Jurisdiction ValueSet ( Extensible ) 0..1
Type CodeableConcept Summary markdown
Comments

It may be possible for This element does not describe the usage of the compartment definition to definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used in jurisdictions other than those for which it was originally designed to point to source materials or intended. specifications that drove the structure of this compartment definition.

CompartmentDefinition.code
Element Id CompartmentDefinition.code
Definition

Which compartment this definition describes.

Control Cardinality 1..1
Terminology Binding CompartmentType ( Required )
Type code
Summary true
Comments

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

CompartmentDefinition.search
Element Id CompartmentDefinition.search
Definition

Whether the search syntax is supported,.

Control Cardinality 1..1
Type boolean
Summary true
Comments

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

CompartmentDefinition.resource
Element Id CompartmentDefinition.resource
Definition

Information about how a resource is related to the compartment.

Control Cardinality 0..*
Summary true
CompartmentDefinition.resource.code
Element Id CompartmentDefinition.resource.code
Definition

The name of a resource supported by the server.

Control Cardinality 1..1
Terminology Binding Any defined Resource Type name
Type code
Summary true
CompartmentDefinition.resource.param
Element Id CompartmentDefinition.resource.param
Definition

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 in more than one way,.

Control Cardinality 0..*
Type string
Summary true
Comments

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

CompartmentDefinition.resource.documentation
Element Id CompartmentDefinition.resource.documentation
Definition

Additional documentation about the resource and compartment.

Control Cardinality 0..1
Type string