FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the CompartmentDefinition resource.

CompartmentDefinition
Element IdCompartmentDefinition
Definition

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

Short DisplayCompartment Definition for a resource
Cardinality0..*
TypeCanonicalResource
Summaryfalse
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
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
CompartmentDefinition.url
Element IdCompartmentDefinition.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; 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.

Short DisplayCanonical identifier for this compartment definition, represented as a URI (globally unique)
Cardinality1..1
Typeuri
Requirements

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

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
CompartmentDefinition.version
Element IdCompartmentDefinition.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.

Short DisplayBusiness version of the compartment definition
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
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.

CompartmentDefinition.versionAlgorithm[x]
Element IdCompartmentDefinition.versionAlgorithm[x]
Definition

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

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
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.

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

Short DisplayName for this compartment definition (computer friendly)
Cardinality1..1
Typestring
Requirements

Support human navigation and code generation.

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

Invariants
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
CompartmentDefinition.title
Element IdCompartmentDefinition.title
Definition

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

Short DisplayName for this compartment definition (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

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

CompartmentDefinition.status
Element IdCompartmentDefinition.status
Definition

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

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

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

CompartmentDefinition.experimental
Element IdCompartmentDefinition.experimental
Definition

A Boolean value 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.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

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

Summarytrue
Comments

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

CompartmentDefinition.date
Element IdCompartmentDefinition.date
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.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
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.

CompartmentDefinition.publisher
Element IdCompartmentDefinition.publisher
Definition

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

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

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

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

CompartmentDefinition.contact
Element IdCompartmentDefinition.contact
Definition

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

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

CompartmentDefinition.description
Element IdCompartmentDefinition.description
Definition

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

Short DisplayNatural language description of the compartment definition
Cardinality0..1
Typemarkdown
Summaryfalse
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).

CompartmentDefinition.useContext
Element IdCompartmentDefinition.useContext
Definition

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

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

CompartmentDefinition.purpose
Element IdCompartmentDefinition.purpose
Definition

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

Short DisplayWhy this compartment definition is defined
Cardinality0..1
Typemarkdown
Summaryfalse
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.

CompartmentDefinition.code
Element IdCompartmentDefinition.code
Definition

Which compartment this definition describes.

Short DisplayPatient | Encounter | RelatedPerson | Practitioner | Device
Cardinality1..1
Terminology BindingCompartmentType (Required)
Typecode
Summarytrue
Comments

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

CompartmentDefinition.search
Element IdCompartmentDefinition.search
Definition

Whether the search syntax is supported,.

Short DisplayWhether the search syntax is supported
Cardinality1..1
Typeboolean
Summarytrue
Comments

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

CompartmentDefinition.resource
Element IdCompartmentDefinition.resource
Definition

Information about how a resource is related to the compartment.

Short DisplayHow a resource is related to the compartment
Cardinality0..*
Summarytrue
CompartmentDefinition.resource.code
Element IdCompartmentDefinition.resource.code
Definition

The name of a resource supported by the server.

Short DisplayName of resource type
Cardinality1..1
Terminology BindingResource Types (Required)
Typecode
Summarytrue
CompartmentDefinition.resource.param
Element IdCompartmentDefinition.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,.

Short DisplaySearch Parameter Name, or chained parameters
Cardinality0..*
Typestring
Summarytrue
Comments

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

CompartmentDefinition.resource.documentation
Element IdCompartmentDefinition.resource.documentation
Definition

Additional documentation about the resource and compartment.

Short DisplayAdditional documentation about the resource and compartment
Cardinality0..1
Typestring
Summaryfalse
CompartmentDefinition.resource.startParam
Element IdCompartmentDefinition.resource.startParam
Definition

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

Short DisplaySearch Param for interpreting $everything.start
Cardinality0..1
Typeuri
Summaryfalse
CompartmentDefinition.resource.endParam
Element IdCompartmentDefinition.resource.endParam
Definition

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

Short DisplaySearch Param for interpreting $everything.end
Cardinality0..1
Typeuri
Summaryfalse