Properties

NameRequiredTypeDescription
urlYesuriCanonical identifier for this compartment definition, represented as a URI (globally unique)
versionNostringBusiness version of the compartment definition
nameYesstringName for this compartment definition (computer friendly)
statusYescodedraft / active / retired / unknown
experimentalNobooleanFor testing purposes, not real usage
dateNodateTimeDate last changed
publisherNostringName of the publisher (organization or individual)
contactNoContactDetail[]Contact details for the publisher
descriptionNomarkdownNatural language description of the compartment definition
useContextNoUsageContext[]The context that the content is intended to support
purposeNomarkdownWhy this compartment definition is defined
codeYescodePatient / Encounter / RelatedPerson / Practitioner / Device
searchYesbooleanWhether the search syntax is supported
resourceNoCompartmentDefinitionResourceHow a resource is related to the compartment
- idNostringUnique id for inter-element referencing
- extensionNoExtension[]Additional content defined by implementations
- modifierExtensionNoExtension[]Extensions that cannot be ignored even if unrecognized
- codeYescodeName of resource type
- paramNostring[]Search Parameter Name, or chained parameters
- documentationNostringAdditional documentation about the resource and compartment

Search Parameters

NameTypeDescriptionExpression
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 dateCompartmentDefinition.date
descriptionstringThe description of the compartment definitionCompartmentDefinition.description
namestringComputationally friendly name of the compartment definitionCompartmentDefinition.name
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

Inherited Properties

NameRequiredTypeDescription
idNostringLogical id of this artifact
metaNoMetaMetadata about the resource
implicitRulesNouriA set of rules under which this content was created
languageNocodeLanguage of the resource content
textNoNarrativeText summary of the resource, for human interpretation
containedNoResource[]Contained, inline Resources
extensionNoExtension[]Additional content defined by implementations
modifierExtensionNoExtension[]Extensions that cannot be ignored

To view the FHIR specification for this resource, see CompartmentDefinition.