CompartmentDefinition
FoundationA compartment definition that defines how resources are accessed on a server.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| CompartmentDefinition | 0..* | — | Compartment Definition for a resource |
| .idΣ | 0..1 | String | Logical id of this artifact |
| .metaΣ | 0..1 | Meta | Metadata about the resource |
| .implicitRules?!Σ | 0..1 | uri | A set of rules under which this content was created |
| .language | 0..1 | code | Language of the resource content Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .urlΣ | 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 |
| .nameΣ | 1..1 | string | Name for this compartment definition (computer friendly) |
| .status?!Σ | 1..1 | code | draft | active | retired | unknown Bindingpublication-status(required) |
| .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 |
| .codeΣ | 1..1 | code | Patient | Encounter | RelatedPerson | Practitioner | Device Bindingcompartment-type(required) |
| .searchΣ | 1..1 | boolean | Whether the search syntax is supported |
| .resourceΣ | 0..* | BackboneElement | How a resource is related to the compartment |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .codeΣ | 1..1 | code | Name of resource type Bindingresource-types(required) |
| .paramΣ | 0..* | string | Search Parameter Name, or chained parameters |
| .documentation | 0..1 | string | Additional documentation about the resource and compartment |