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.

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

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

An Extension

R5: CompartmentDefinition.version (new:string)

Element CompartmentDefinition.version has a context of CompartmentDefinition based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.version has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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.

R5: CompartmentDefinition.versionAlgorithm[x] (new:Coding, string)

Element CompartmentDefinition.versionAlgorithm[x] has a context of CompartmentDefinition based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.versionAlgorithm[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element CompartmentDefinition.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. 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.

R5: CompartmentDefinition.title (new:string)

Element CompartmentDefinition.title has a context of CompartmentDefinition based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.title has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element CompartmentDefinition.title: http://hl7.org/fhir/StructureDefinition/artifact-title. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

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.

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.

An absolute URI 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.

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.

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

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.

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. This is often the same as the code for the parameter, but does not need to be.

Support human navigation and code generation.

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

Allows filtering of compartment definitions that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired compartment definition without due consideration.

The lifecycle status of a Value Set or Concept Map.

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.

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

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

Which compartment this definition describes.

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

The codes SHALL be taken from CompartmentType http://hl7.org/fhir/ValueSet/compartment-type|3.0.2
(required to http://hl7.org/fhir/ValueSet/compartment-type|3.0.2)

Which compartment a compartment definition describes

An Extension

R5: CompartmentDefinition.code

Element CompartmentDefinition.code is mapped to FHIR STU3 element CompartmentDefinition.code as SourceIsBroaderThanTarget. 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 compartment related syntax.

R5: CompartmentDefinition.version (new:string)

Element CompartmentDefinition.version has a context of CompartmentDefinition based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.version has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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.

R5: CompartmentDefinition.versionAlgorithm[x] (new:Coding, string)

Element CompartmentDefinition.versionAlgorithm[x] has a context of CompartmentDefinition based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.versionAlgorithm[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element CompartmentDefinition.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. 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.

R5: CompartmentDefinition.title (new:string)

Element CompartmentDefinition.title has a context of CompartmentDefinition based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.title has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element CompartmentDefinition.title: http://hl7.org/fhir/StructureDefinition/artifact-title. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

R5: CompartmentDefinition.contact additional types (ContactDetail) additional types from child elements (name, telecom)

Element CompartmentDefinition.contact is mapped to FHIR STU3 element CompartmentDefinition.contact as SourceIsBroaderThanTarget. The mappings for CompartmentDefinition.contact do not cover the following types: ContactDetail. The mappings for CompartmentDefinition.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

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

R5: CompartmentDefinition.code

Element CompartmentDefinition.code is mapped to FHIR STU3 element CompartmentDefinition.code as SourceIsBroaderThanTarget. Only the specification can define the compartments that can exist. Servers can choose to support them.

R5: CompartmentDefinition.resource.startParam (new:uri)

Element CompartmentDefinition.resource.startParam has a context of CompartmentDefinition.resource based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.resource.startParam has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

R5: CompartmentDefinition.resource.endParam (new:uri)

Element CompartmentDefinition.resource.endParam has a context of CompartmentDefinition.resource based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.resource.endParam has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

R5: CompartmentDefinition.resource.code additional codes

Element CompartmentDefinition.resource.code is mapped to FHIR STU3 element CompartmentDefinition.resource.code as RelatedTo. The mappings for CompartmentDefinition.resource.code do not allow expression of the necessary codes, per the bindings on the source and target.

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.

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

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

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.

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

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

The base language in which the resource is written.

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

Unless not suitable, these codes SHALL be taken from Common Languages
(extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

A human language.

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.

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.

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.

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.

An Extension

R5: CompartmentDefinition.version (new:string)

Element CompartmentDefinition.version has a context of CompartmentDefinition based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.version has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). 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.

R5: CompartmentDefinition.versionAlgorithm[x] (new:Coding, string)

Element CompartmentDefinition.versionAlgorithm[x] has a context of CompartmentDefinition based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.versionAlgorithm[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element CompartmentDefinition.versionAlgorithm[x]: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm. 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.

R5: CompartmentDefinition.title (new:string)

Element CompartmentDefinition.title has a context of CompartmentDefinition based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.title has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element CompartmentDefinition.title: http://hl7.org/fhir/StructureDefinition/artifact-title. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

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.

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.

An absolute URI 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.

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.

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

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.

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly. This is often the same as the code for the parameter, but does not need to be.

Support human navigation and code generation.

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

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

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

Allows filtering of compartment definitions that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired compartment definition without due consideration.

The lifecycle status of a Value Set or Concept Map.

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.

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

Enables experimental content to be developed following the same lifecycle that would be used for a production-level compartment 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.

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.

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

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.

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

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.

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

An Extension

R5: CompartmentDefinition.contact additional types (ContactDetail) additional types from child elements (name, telecom)

Element CompartmentDefinition.contact is mapped to FHIR STU3 element CompartmentDefinition.contact as SourceIsBroaderThanTarget. The mappings for CompartmentDefinition.contact do not cover the following types: ContactDetail. The mappings for CompartmentDefinition.contact do not cover the following types based on type expansion: name, telecom. May be a web site, an email address, a telephone number, etc.

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

The name of an individual to contact.

If there is no named individual, the telecom information is for the organization as a whole.

The contact details for the individual (if a name was provided) or the organization.

A free text natural language description of the compartment definition from a 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 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 is presumed to be the predominant language in the place the profile was created).

Explaination of 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 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.

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 for appropriate compartment definition instances.

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

Assist in searching for appropriate content.

A legal or geographic region in which the compartment definition is intended to be used.

It may be possible for the compartment definition to be used in jurisdictions other than those for which it was originally designed or intended.

Countries and regions within which this artifact is targeted for use

Which compartment this definition describes.

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

The codes SHALL be taken from CompartmentType
(required to http://hl7.org/fhir/ValueSet/compartment-type|3.0.2)

Which compartment a compartment definition describes

unique id for the element within a resource (for internal references)

An Extension

R5: CompartmentDefinition.code

Element CompartmentDefinition.code is mapped to FHIR STU3 element CompartmentDefinition.code as SourceIsBroaderThanTarget. Only the specification can define the compartments that can exist. Servers can choose to support them.

Primitive value for code

Whether the search syntax is supported,.

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

Information about how a resource is related to the compartment.

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

An Extension

R5: CompartmentDefinition.resource.startParam (new:uri)

Element CompartmentDefinition.resource.startParam has a context of CompartmentDefinition.resource based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.resource.startParam has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

R5: CompartmentDefinition.resource.endParam (new:uri)

Element CompartmentDefinition.resource.endParam has a context of CompartmentDefinition.resource based on following the parent source element upwards and mapping to CompartmentDefinition. Element CompartmentDefinition.resource.endParam has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

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.

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.

The name of a resource supported by the server.

The codes SHALL be taken from ResourceType
(required to http://hl7.org/fhir/ValueSet/resource-types|3.0.2)

One of the resource types defined as part of FHIR.

unique id for the element within a resource (for internal references)

An Extension

R5: CompartmentDefinition.resource.code additional codes

Element CompartmentDefinition.resource.code is mapped to FHIR STU3 element CompartmentDefinition.resource.code as RelatedTo. The mappings for CompartmentDefinition.resource.code do not allow expression of the necessary codes, per the bindings on the source and target.

Primitive value for code

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

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

Additional documentation about the resource and compartment.