Current Build

5.6 Resource CompartmentDefinition - Content

FHIR Infrastructure Work GroupMaturity Level: 1 Trial Use Compartments: Not linked to any defined compartments

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

Each resource may belong to one or more logical compartments. A compartment is a logical grouping of resources which share a common property. Compartments have two principal roles:

  • Function as an access mechanism for finding a set of related resources quickly
  • Provide a definitional basis for applying access control to resources quickly

Note:

At present, CompartmentDefinitions can only be defined by HL7 International. This is because their existence creates significant impact on the behavior of servers.

Compartment definitions describe how particular compartment instances are named and identified, and how systems know which resources are in the compartment. The following compartments are defined by this specification:

TitleDescriptionIdentityMembership
PatientThe set of resources associated with a particular patientThere is an instance of the patient compartment for each patient resource, and the identity of the compartment is the same as the patient. When a patient is linked to another patient, all the records associated with the linked patient are in the compartment associated with the target of the link.The patient compartment includes any resources where the subject of the resource is the patient, and some other resources that are directly linked to resources in the patient compartment
EncounterThe set of resources associated with a particular encounterThere is an instance of the encounter compartment for each encounter resource, and the identity of the compartment is the same as the encounterThe encounter compartment includes any resources where the resource has an explicitly nominated encounter, and some other resources that themselves link to resources in the encounter compartment. Note that for many resources, the exact nature of the link to encounter can be ambiguous (e.g. for a DiagnosticReport, is it the encounter when it was initiated, or when it was reported?)
RelatedPersonThe set of resources associated with a particular 'related person'There is an instance of the relatedPerson compartment for each relatedPerson resource, and the identity of the compartment is the same as the relatedPersonThe relatedPerson compartment includes any resources where the resource is explicitly linked to relatedPerson (usually as author)
PractitionerThe set of resources associated with a particular practitionerThere is an instance of the practitioner compartment for each Practitioner resource, and the identity of the compartment is the same as the PractitionerThe practitioner compartment includes any resources where the resource is explicitly linked to a Practitioner (usually as author, but other kinds of linkage exist)
DeviceThe set of resources associated with a particular deviceThere is an instance of the practitioner compartment for each Device resource, and the identity of the compartment is the same as the DeviceThe device compartment includes any resources where the resource is explicitly linked to a Device (mostly subject or performer)

The full definitions of these compartments are published as CompartmentDefinition resources. Servers typically do not support the full definition of a compartment, and are not required to. Systems may publish CompartmentDefinition resources so that other systems may make use of compartments properly.

  • CompartmentDefinitions are used by CapabilityStatement instances for specifying how resources are accessed

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CompartmentDefinition DomainResourceCompartment Definition for a resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ1..1uriLogical URI to reference this compartment definition (globally unique)
... name Σ1..1stringName for this compartment definition (computer friendly)
... title Σ0..1stringName for this compartment definition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the compartment definition
... purpose 0..1markdownWhy this compartment definition is defined
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for compartment definition (if applicable)
Jurisdiction ValueSet (Extensible)
... code Σ1..1codePatient | Encounter | RelatedPerson | Practitioner | Device
CompartmentType (Required)
... search Σ1..1booleanWhether the search syntax is supported
... resource Σ0..*BackboneElementHow a resource is related to the compartment
.... code Σ1..1codeName of resource type
ResourceType (Required)
.... param Σ0..*stringSearch Parameter Name, or chained parameters
.... documentation 0..1stringAdditional documentation about the resource and compartment

doco Documentation for this format

UML Diagram (Legend)

CompartmentDefinition (DomainResource)An absolute URI 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. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions)url : uri [1..1]A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1]A short, descriptive, user-friendly title for the compartment definitiontitle : string [0..1]The status of this compartment definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changesdate : dateTime [0..1]The name of the individual or organization that published the compartment definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the compartment definition from a consumer's perspectivedescription : markdown [0..1]Explaination of why this compartment definition is needed and why it has been designed as it haspurpose : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate compartment definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the compartment definition is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ »Which compartment this definition describescode : code [1..1] « Which compartment a compartment definition describes (Strength=Required)CompartmentType! »Whether the search syntax is supported,search : boolean [1..1]ResourceThe name of a resource supported by the servercode : code [1..1] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »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 in more than one way,param : string [0..*]Additional documentation about the resource and compartmentdocumentation : string [0..1]Information about how a resource is related to the compartmentresource[0..*]

XML Template

<CompartmentDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Logical URI to reference this compartment definition (globally unique) -->
 <name value="[string]"/><!-- 1..1 Name for this compartment definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this compartment definition (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the compartment definition -->
 <purpose value="[markdown]"/><!-- 0..1 Why this compartment definition is defined -->
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for compartment definition (if applicable) --></jurisdiction>
 <code value="[code]"/><!-- 1..1 Patient | Encounter | RelatedPerson | Practitioner | Device -->
 <search value="[boolean]"/><!-- 1..1 Whether the search syntax is supported -->
 <resource>  <!-- 0..* How a resource is related to the compartment -->
  <code value="[code]"/><!-- 1..1 Name of resource type -->
  <param value="[string]"/><!-- 0..* Search Parameter Name, or chained parameters -->
  <documentation value="[string]"/><!-- 0..1 Additional documentation about the resource and compartment -->
 </resource>
</CompartmentDefinition>

JSON Template

{doco
  "resourceType" : "CompartmentDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Logical URI to reference this compartment definition (globally unique)
  "name" : "<string>", // R!  Name for this compartment definition (computer friendly)
  "title" : "<string>", // Name for this compartment definition (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the compartment definition
  "purpose" : "<markdown>", // Why this compartment definition is defined
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for compartment definition (if applicable)
  "code" : "<code>", // R!  Patient | Encounter | RelatedPerson | Practitioner | Device
  "search" : <boolean>, // R!  Whether the search syntax is supported
  "resource" : [{ // How a resource is related to the compartment
    "code" : "<code>", // R!  Name of resource type
    "param" : ["<string>"], // Search Parameter Name, or chained parameters
    "documentation" : "<string>" // Additional documentation about the resource and compartment
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:CompartmentDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:CompartmentDefinition.url [ uri ]; # 1..1 Logical URI to reference this compartment definition (globally unique)
  fhir:CompartmentDefinition.name [ string ]; # 1..1 Name for this compartment definition (computer friendly)
  fhir:CompartmentDefinition.title [ string ]; # 0..1 Name for this compartment definition (human friendly)
  fhir:CompartmentDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:CompartmentDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:CompartmentDefinition.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:CompartmentDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:CompartmentDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:CompartmentDefinition.description [ markdown ]; # 0..1 Natural language description of the compartment definition
  fhir:CompartmentDefinition.purpose [ markdown ]; # 0..1 Why this compartment definition is defined
  fhir:CompartmentDefinition.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:CompartmentDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for compartment definition (if applicable)
  fhir:CompartmentDefinition.code [ code ]; # 1..1 Patient | Encounter | RelatedPerson | Practitioner | Device
  fhir:CompartmentDefinition.search [ boolean ]; # 1..1 Whether the search syntax is supported
  fhir:CompartmentDefinition.resource [ # 0..* How a resource is related to the compartment
    fhir:CompartmentDefinition.resource.code [ code ]; # 1..1 Name of resource type
    fhir:CompartmentDefinition.resource.param [ string ], ... ; # 0..* Search Parameter Name, or chained parameters
    fhir:CompartmentDefinition.resource.documentation [ string ]; # 0..1 Additional documentation about the resource and compartment
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CompartmentDefinition DomainResourceCompartment Definition for a resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ1..1uriLogical URI to reference this compartment definition (globally unique)
... name Σ1..1stringName for this compartment definition (computer friendly)
... title Σ0..1stringName for this compartment definition (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the compartment definition
... purpose 0..1markdownWhy this compartment definition is defined
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for compartment definition (if applicable)
Jurisdiction ValueSet (Extensible)
... code Σ1..1codePatient | Encounter | RelatedPerson | Practitioner | Device
CompartmentType (Required)
... search Σ1..1booleanWhether the search syntax is supported
... resource Σ0..*BackboneElementHow a resource is related to the compartment
.... code Σ1..1codeName of resource type
ResourceType (Required)
.... param Σ0..*stringSearch Parameter Name, or chained parameters
.... documentation 0..1stringAdditional documentation about the resource and compartment

doco Documentation for this format

UML Diagram (Legend)

CompartmentDefinition (DomainResource)An absolute URI 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. The URL SHOULD include the major version of the compartment definition. For more information see [Technical and Business Versions](resource.html#versions)url : uri [1..1]A natural language name identifying the compartment definition. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1]A short, descriptive, user-friendly title for the compartment definitiontitle : string [0..1]The status of this compartment definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A boolean value to indicate that this compartment definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the compartment definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the compartment definition changesdate : dateTime [0..1]The name of the individual or organization that published the compartment definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the compartment definition from a consumer's perspectivedescription : markdown [0..1]Explaination of why this compartment definition is needed and why it has been designed as it haspurpose : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate compartment definition instancesuseContext : UsageContext [0..*]A legal or geographic region in which the compartment definition is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ »Which compartment this definition describescode : code [1..1] « Which compartment a compartment definition describes (Strength=Required)CompartmentType! »Whether the search syntax is supported,search : boolean [1..1]ResourceThe name of a resource supported by the servercode : code [1..1] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »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 in more than one way,param : string [0..*]Additional documentation about the resource and compartmentdocumentation : string [0..1]Information about how a resource is related to the compartmentresource[0..*]

XML Template

<CompartmentDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Logical URI to reference this compartment definition (globally unique) -->
 <name value="[string]"/><!-- 1..1 Name for this compartment definition (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this compartment definition (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the compartment definition -->
 <purpose value="[markdown]"/><!-- 0..1 Why this compartment definition is defined -->
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for compartment definition (if applicable) --></jurisdiction>
 <code value="[code]"/><!-- 1..1 Patient | Encounter | RelatedPerson | Practitioner | Device -->
 <search value="[boolean]"/><!-- 1..1 Whether the search syntax is supported -->
 <resource>  <!-- 0..* How a resource is related to the compartment -->
  <code value="[code]"/><!-- 1..1 Name of resource type -->
  <param value="[string]"/><!-- 0..* Search Parameter Name, or chained parameters -->
  <documentation value="[string]"/><!-- 0..1 Additional documentation about the resource and compartment -->
 </resource>
</CompartmentDefinition>

JSON Template

{doco
  "resourceType" : "CompartmentDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Logical URI to reference this compartment definition (globally unique)
  "name" : "<string>", // R!  Name for this compartment definition (computer friendly)
  "title" : "<string>", // Name for this compartment definition (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the compartment definition
  "purpose" : "<markdown>", // Why this compartment definition is defined
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for compartment definition (if applicable)
  "code" : "<code>", // R!  Patient | Encounter | RelatedPerson | Practitioner | Device
  "search" : <boolean>, // R!  Whether the search syntax is supported
  "resource" : [{ // How a resource is related to the compartment
    "code" : "<code>", // R!  Name of resource type
    "param" : ["<string>"], // Search Parameter Name, or chained parameters
    "documentation" : "<string>" // Additional documentation about the resource and compartment
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:CompartmentDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:CompartmentDefinition.url [ uri ]; # 1..1 Logical URI to reference this compartment definition (globally unique)
  fhir:CompartmentDefinition.name [ string ]; # 1..1 Name for this compartment definition (computer friendly)
  fhir:CompartmentDefinition.title [ string ]; # 0..1 Name for this compartment definition (human friendly)
  fhir:CompartmentDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:CompartmentDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:CompartmentDefinition.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:CompartmentDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:CompartmentDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:CompartmentDefinition.description [ markdown ]; # 0..1 Natural language description of the compartment definition
  fhir:CompartmentDefinition.purpose [ markdown ]; # 0..1 Why this compartment definition is defined
  fhir:CompartmentDefinition.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:CompartmentDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for compartment definition (if applicable)
  fhir:CompartmentDefinition.code [ code ]; # 1..1 Patient | Encounter | RelatedPerson | Practitioner | Device
  fhir:CompartmentDefinition.search [ boolean ]; # 1..1 Whether the search syntax is supported
  fhir:CompartmentDefinition.resource [ # 0..* How a resource is related to the compartment
    fhir:CompartmentDefinition.resource.code [ code ]; # 1..1 Name of resource type
    fhir:CompartmentDefinition.resource.param [ string ], ... ; # 0..* Search Parameter Name, or chained parameters
    fhir:CompartmentDefinition.resource.documentation [ string ]; # 0..1 Additional documentation about the resource and compartment
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions

PathDefinitionTypeReference
CompartmentDefinition.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
CompartmentDefinition.jurisdiction Countries and regions within which this artifact is targeted for useExtensibleJurisdiction ValueSet
CompartmentDefinition.code Which compartment a compartment definition describesRequiredCompartmentType
CompartmentDefinition.resource.code One of the resource types defined as part of FHIR.RequiredResource Types

As an example of compartment usage, to retrieve a list of a patient's conditions, use the URL:

  GET [base]/Patient/[id]/Condition

Additional search parameters can be defined, such as this hypothetical search for acute conditions:

  GET [base]/Patient/[id]/Condition?code:in=http://hspc.org/ValueSet/acute-concerns

Note that as searches, these are syntactic variations on these two search URLs respectively:

  GET [base]/Condition?patient=[id]
  GET [base]/Condition?patient=[id]&code:in=http://hspc.org/ValueSet/acute-concerns

Note that the outcome of a compartment search is the same as the equivalent normal search. As an example, both these searches return the same outcome if there is no patient 333:

  GET [base]/Patient/333/Condition
  GET [base]/Condition?patient=333

Whether the patient doesn't exist, or the user has no access to the patient, both these searches return an empty bundle with no matches. Some systems will include an operation outcome warning that there is no matching patient.

However, there is a key difference in functionality between compartment based searches and direct searches with parameters. Consider this search:

  GET [base]/Patient/[id]/Communication

Because the definition of the patient compartment for Communication says that a Communication resource is in the patient compartment if the subject, sender, or recipient is the patient, the compartment search is actually the same as the union of these 3 searches:

  GET [base]/Communication?subject=[id]
  GET [base]/Communication?sender=[id]
  GET [base]/Communication?recipient=[id]

There is no way to do this as a single search, except by using the _filter:

  GET [base]/Communication?_filter=subject re [id] or sender re [id] or recipient re [id]

Further details of searching by compartment are described under the search operation. As a search related operation, the assignment of resources to compartments is only based on the current version of any of the resources involved. Note that contained patient resources cannot create a patient compartment of their own.

Compartments may be used explicitly, like this, but can also be used implicitly. For instance, if a FHIR server is providing a patient view of a record, the authorized user associated with use of the FHIR RESTful API may be limited to accessing records from the compartment instance(s) logically associated with their identity. Irrespective of whether compartments are being used explicitly or implicitly, servers will need to make arrangements to make some resources with no direct link to a patient available to the client (medications, substances, etc.).

Note that resources may cross between compartments, or interlink them. Examples of this would be where a Diagnostic Report identifies a subject, but an Observation it references identifies a different subject, or where a List resource references items that identify different subjects. Such cross-linking may arise for many valid reasons, including:

  • Cases where subject records are inter-linked - Transplants, Perinatal care, family therapy etc.
  • Workflow management where action lists link multiple patients and/or practitioners

Given the wide variety of use cases and contexts in which FHIR is used, compartments do not define how cross-linking is handled. Systems may reject resources, remove them from both compartments, or place them in both, or act in some other fashion.

It is at the discretion of the server whether to include resources in a compartment when the reference to the resource that establishes the compartment is in an extension.

Some resources are not in any compartment, e.g. Medication, Substance, Location. These resources are not directly to a patient or authored record, and are sometimes called 'master files'. Servers will need to make arrangements to make these resources available to the clients that are limited to particular compartments. For example, a Medication resource describes a medication itself and does not link to a patient; however, a resource such as MedicationAdministration connects the Medication (details of what was administered) to the patient (for whom was it administered), and so is required to interpret the administration.

Compartments are defined and added the list above when implementer communities identify them as common access points for data. As described below, compartments have both syntactical and logical consequences, and both these aspects of their functionality are evaluated when deciding whether to define compartments.

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
codetokenPatient | Encounter | RelatedPerson | Practitioner | DeviceCompartmentDefinition.code
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
jurisdictiontokenIntended jurisdiction for the compartment definitionCompartmentDefinition.jurisdiction
namestringComputationally friendly name of the compartment definitionCompartmentDefinition.name
publisherstringName of the publisher of the compartment definitionCompartmentDefinition.publisher
resourcetokenName of resource typeCompartmentDefinition.resource.code
statustokenThe current status of the compartment definitionCompartmentDefinition.status
titlestringThe human-friendly name of the compartment definitionCompartmentDefinition.title
urluriThe uri that identifies the compartment definitionCompartmentDefinition.url