Skip to main content


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


id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
url1..1uriCanonical identifier for this compartment definition, represented as a URI (globally unique)
version0..1stringBusiness version of the compartment definition
name1..1stringName for this compartment definition (computer friendly)
status1..1codedraft | active | retired | unknown
experimental0..1booleanFor testing purposes, not real usage
date0..1dateTimeDate last changed
publisher0..1stringName of the publisher (organization or individual)
contact0..*ContactDetailContact details for the publisher
description0..1markdownNatural language description of the compartment definition
useContext0..*UsageContextThe context that the content is intended to support
purpose0..1markdownWhy this compartment definition is defined
code1..1codePatient | Encounter | RelatedPerson | Practitioner | Device
search1..1booleanWhether the search syntax is supported
resource0..*BackboneElementHow a resource is related to the compartment

Search Parameters

contexttokenA use context assigned to the compartment definitionCompartmentDefinition.useContext.value
context-quantityquantityA quantity- or range-valued use context assigned to the compartment definitionCompartmentDefinition.useContext.value
context-typetokenA type of use context assigned to the compartment definitionCompartmentDefinition.useContext.code
datedateThe compartment definition publication
descriptionstringThe description of the compartment definitionCompartmentDefinition.description
namestringComputationally friendly name of the compartment
publisherstringName of the publisher of the compartment definitionCompartmentDefinition.publisher
statustokenThe current status of the compartment definitionCompartmentDefinition.status
urluriThe uri that identifies the compartment definitionCompartmentDefinition.url
versiontokenThe business version of the compartment definitionCompartmentDefinition.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the compartment definitionCompartmentDefinition.useContext
context-type-valuecompositeA use context type and value assigned to the compartment definitionCompartmentDefinition.useContext
codetokenPatient | Encounter | RelatedPerson | Practitioner | DeviceCompartmentDefinition.code
resourcetokenName of resource typeCompartmentDefinition.resource.code