This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3
Detailed Descriptions for the elements in the CompartmentDefinition resource.
CompartmentDefinition | |
Definition | A compartment definition that defines how resources are accessed on a server. |
Control | 1..1 |
Comments | In FHIR, search is not performed directly on a resource (by XML or JSON path), but on a named parameter that maps into the resource content. |
CompartmentDefinition.url | |
Definition | An absolute URL that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this compartment definition is (or will be) published. |
Control | 1..1 |
Type | uri |
Requirements | To allow referencing and reusing compartment definition definitions under other names on operational systems (in case of name clash). |
Summary | true |
CompartmentDefinition.name | |
Definition | A free text natural language name identifying the compartment definition. |
Control | 1..1 |
Type | string |
Summary | true |
Comments | This is often the same as the code for the parameter, but does not need to be. |
CompartmentDefinition.status | |
Definition | The status of this compartment definition definition. |
Control | 0..1 |
Binding | ConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | This is not intended for use with actual conformance statements, but where conformance statements are used to describe possible or desired systems. |
CompartmentDefinition.experimental | |
Definition | A flag to indicate that this compartment definition definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. |
Control | 0..1 |
Type | boolean |
Summary | true |
Comments | Allows filtering of compartment definition definitions that are appropriate for use vs. not. |
CompartmentDefinition.publisher | |
Definition | The name of the individual or organization that published the compartment definition. |
Control | 0..1 |
Type | string |
Requirements | Helps establish the "authority/credibility" of the compartment definition. May also allow for contact. |
Summary | true |
Comments | Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context. |
CompartmentDefinition.contact | |
Definition | Contacts to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Summary | true |
Comments | May be a web site, an email address, a telephone number (tel:), etc. |
CompartmentDefinition.contact.name | |
Definition | The name of an individual to contact regarding the compartment definition. |
Control | 0..1 |
Type | string |
Summary | true |
Comments | If there is no named individual, the telecom is for the organization as a whole. |
CompartmentDefinition.contact.telecom | |
Definition | Contact details for individual (if a name was provided) or the publisher. |
Control | 0..* |
Type | ContactPoint |
Summary | true |
CompartmentDefinition.date | |
Definition | The date (and optionally time) when the compartment definition definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changes. |
Control | 0..1 |
Type | dateTime |
Summary | true |
Comments | Additional specific dates may be added as extensions. |
CompartmentDefinition.description | |
Definition | A free text natural language description of the CompartmentDefinition and its use. |
Control | 0..1 |
Type | markdown |
Summary | true |
CompartmentDefinition.requirements | |
Definition | The Scope and Usage that this compartment definition was created to meet. |
Control | 0..1 |
Type | markdown |
CompartmentDefinition.code | |
Definition | Which compartment this definition describes. |
Control | 1..1 |
Binding | CompartmentType: Which compartment a compartmnet definition describes (Required) |
Type | code |
Summary | true |
Comments | Only the specification can define the compartments that can exist. Servers can choose to support them. |
CompartmentDefinition.search | |
Definition | Whether the search syntax is supported. |
Control | 1..1 |
Type | boolean |
Summary | true |
Comments | Servers may define and use compartments to manage logical access without implementing the compoartment related syntax. |
CompartmentDefinition.resource | |
Definition | Information about how a resource it related to the compartment. |
Control | 0..* |
Summary | true |
CompartmentDefinition.resource.code | |
Definition | The name of a resource supported by the server. |
Control | 1..1 |
Binding | ResourceType: Any defined Resource Type name |
Type | code |
Summary | true |
CompartmentDefinition.resource.param | |
Definition | The name of a search parameter that represents the link to the compartment. More than one may be listed because a resource may be linked to a compartment more than one way. |
Control | 0..* |
Type | string |
Summary | true |
Comments | If no search parameters are listed, then the resource is not linked to the compartment. |
CompartmentDefinition.resource.documentation | |
Definition | Additional doco about the resource and compartment. |
Control | 0..1 |
Type | string |