CompartmentDefinition

ResourceFoundation · ConformanceTrial useMaturity 1

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

12 of 14 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
urlRequiredΣ	1..1	uri	Canonical identifier for this compartment definition, represented as a URI (globally unique)
versionΣ	0..1	string	Business version of the compartment definition
nameRequiredΣ	1..1	string	Name for this compartment definition (computer friendly)
statusRequired?!Σ	1..1	code	draft | active | retired | unknownBinding (required): publication-status
experimentalΣ	0..1	boolean	For testing purposes, not real usage
dateΣ	0..1	dateTime	Date last changed
publisherΣ	0..1	string	Name of the publisher (organization or individual)
contactΣ	0..*	ContactDetail	Contact details for the publisher
description	0..1	markdown	Natural language description of the compartment definition
useContextΣ	0..*	UsageContext	The context that the content is intended to support
purpose	0..1	markdown	Why this compartment definition is defined
codeRequiredΣ	1..1	code	Patient | Encounter | RelatedPerson | Practitioner | DeviceBinding (required): compartment-type
searchRequiredΣ	1..1	boolean	Whether the search syntax is supported
resourceΣ	0..*	BackboneElement	How a resource is related to the compartment
codeRequiredΣ	1..1	code	Name of resource typeBinding (required): resource-types
paramΣ	0..*	string	Search Parameter Name, or chained parameters
documentation	0..1	string	Additional documentation about the resource and compartment

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/CompartmentDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
code	token	Patient | Encounter | RelatedPerson | Practitioner | Device CompartmentDefinition.code
context	token	A use context assigned to the compartment definition (CompartmentDefinition.useContext.value.ofType(CodeableConcept))
context-quantity	quantity	A quantity- or range-valued use context assigned to the compartment definition (CompartmentDefinition.useContext.value.ofType(Quantity)) | (CompartmentDefinition.useContext.value.ofType(Range))
context-type	token	A type of use context assigned to the compartment definition CompartmentDefinition.useContext.code
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the compartment definition CompartmentDefinition.useContext
context-type-value	composite	A use context type and value assigned to the compartment definition CompartmentDefinition.useContext
date	date	The compartment definition publication date CompartmentDefinition.date
description	string	The description of the compartment definition CompartmentDefinition.description
name	string	Computationally friendly name of the compartment definition CompartmentDefinition.name
publisher	string	Name of the publisher of the compartment definition CompartmentDefinition.publisher
resource	token	Name of resource type CompartmentDefinition.resource.code
status	token	The current status of the compartment definition CompartmentDefinition.status
url	uri	The uri that identifies the compartment definition CompartmentDefinition.url
version	token	The business version of the compartment definition CompartmentDefinition.version

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition