CompartmentDefinition

Trial Use 3 Conformance

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

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/CompartmentDefinition

Interaction	Method	Path
Read	`GET`	`/fhir/R5/CompartmentDefinition/[id]`
Vread	`GET`	`/fhir/R5/CompartmentDefinition/[id]/_history/[vid]`
Update	`PUT`	`/fhir/R5/CompartmentDefinition/[id]`
Patch	`PATCH`	`/fhir/R5/CompartmentDefinition/[id]`
Delete	`DELETE`	`/fhir/R5/CompartmentDefinition/[id]`
Create	`POST`	`/fhir/R5/CompartmentDefinition`
Search	`GET`	`/fhir/R5/CompartmentDefinition?...`
History	`GET`	`/fhir/R5/CompartmentDefinition/[id]/_history`
Type-history	`GET`	`/fhir/R5/CompartmentDefinition/_history`

Element	Type(s)	Cardinality	Description
`url`	`uri`	`1..1`	Canonical identifier for this compartment definition, represented as a URI (globally unique)
`version`	`string`	`0..1`	Business version of the compartment definition
`versionAlgorithm[x]`	`string` / `Coding`	`0..1`	How to compare versions
`name`	`string`	`1..1`	Name for this compartment definition (computer friendly)
`title`	`string`	`0..1`	Name for this compartment definition (human friendly)
`status`	`code`	`1..1`	draft
`experimental`	`boolean`	`0..1`	For testing purposes, not real usage
`date`	`dateTime`	`0..1`	Date last changed
`publisher`	`string`	`0..1`	Name of the publisher/steward (organization or individual)
`contact`	`ContactDetail`	`0..*`	Contact details for the publisher
`description`	`markdown`	`0..1`	Natural language description of the compartment definition
`useContext`	`UsageContext`	`0..*`	The context that the content is intended to support
`purpose`	`markdown`	`0..1`	Why this compartment definition is defined
`code`	`code`	`1..1`	Patient
`search`	`boolean`	`1..1`	Whether the search syntax is supported
`resource`	`BackboneElement`	`0..*`	How a resource is related to the compartment

Parameter	Type	Description
`code`	`token`	Patient
`context`	`token`	A use context assigned to the activity definition

`context-quantity`	`quantity`	A quantity- or range-valued use context assigned to the activity definition

`context-type`	`token`	A type of use context assigned to the activity definition

`context-type-quantity`	`composite`	A use context type and quantity- or range-based value assigned to the activity definition

`context-type-value`	`composite`	A use context type and value assigned to the activity definition

`date`	`date`	The activity definition publication date

`description`	`string`	The description of the activity definition

`name`	`string`	Computationally friendly name of the activity definition

`publisher`	`string`	Name of the publisher of the activity definition

`resource`	`token`	Name of resource type
`status`	`token`	The current status of the activity definition

`url`	`uri`	The uri that identifies the activity definition

`version`	`token`	The business version of the activity definition