{
  "resourceType": "StructureDefinition",
  "id": "CompartmentDefinition",
  "meta": {
    "lastUpdated": "2021-01-04T23:01:24.148+00:00"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
      "valueString": "Foundation.Conformance"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 1
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
      "valueCode": "anonymous"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status",
      "valueCode": ".status = retired"
    },
    {
      "url": "http://hl7.org/fhir/build/StructureDefinition/template",
      "valueString": "CanonicalResource"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/CompartmentDefinition",
  "version": "4.6.0",
  "name": "CompartmentDefinition",
  "status": "draft",
  "date": "2021-01-04T23:01:24+00:00",
  "publisher": "Health Level Seven International (FHIR Infrastructure)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg/index.cfm"
        }
      ]
    }
  ],
  "description": "A compartment definition that defines how resources are accessed on a server.",
  "fhirVersion": "4.6.0",
  "mapping": [
    {
      "identity": "v2",
      "uri": "http://hl7.org/v2",
      "name": "HL7 v2 Mapping"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern Mapping"
    },
    {
      "identity": "workflow",
      "uri": "http://hl7.org/fhir/workflow",
      "name": "Workflow Pattern"
    },
    {
      "identity": "objimpl",
      "uri": "http://hl7.org/fhir/object-implementation",
      "name": "Object Implementation Information"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "CompartmentDefinition",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CanonicalResource",
  "derivation": "specialization",
  "differential": {
    "element": [
      {
        "id": "CompartmentDefinition",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/svg",
            "valueCode": "0,0"
          }
        ],
        "path": "CompartmentDefinition",
        "short": "Compartment Definition for a resource",
        "definition": "A compartment definition that defines how resources are accessed on a server.",
        "comment": "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.",
        "min": 0,
        "max": "*",
        "constraint": [
          {
            "key": "cnl-0",
            "severity": "warning",
            "human": "Name should be usable as an identifier for the module by machine processing applications such as code generation",
            "expression": "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')",
            "xpath": "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')",
            "source": "http://hl7.org/fhir/StructureDefinition/CompartmentDefinition"
          }
        ],
        "mapping": [
          {
            "identity": "v2",
            "map": "n/a"
          },
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "w5",
            "map": "conformance.behavior"
          }
        ]
      },
      {
        "id": "CompartmentDefinition.url",
        "path": "CompartmentDefinition.url",
        "short": "Canonical identifier for this compartment definition, represented as a URI (globally unique)",
        "definition": "An absolute URI that is used to identify this compartment definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this compartment definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the compartment definition is stored on different servers.",
        "comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred.  Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author.  Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
        "requirements": "Allows the compartment definition to be referenced by a single globally unique identifier.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.url"
          },
          {
            "identity": "w5",
            "map": "FiveWs.identifier"
          }
        ]
      },
      {
        "id": "CompartmentDefinition.version",
        "path": "CompartmentDefinition.version",
        "short": "Business version of the compartment definition",
        "definition": "The identifier that is used to identify this version of the compartment definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the compartment definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.",
        "comment": "There may be different compartment definition instances that have the same identifier but different versions.  The version can be appended to the url in a reference to allow a reference to a particular business version of the compartment definition with the format [url]|[version].",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.version"
          },
          {
            "identity": "w5",
            "map": "FiveWs.version"
          }
        ]
      },
      {
        "id": "CompartmentDefinition.name",
        "path": "CompartmentDefinition.name",
        "short": "Name for this compartment definition (computer friendly)",
        "definition": "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 generation.",
        "comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.This is often the same as the code for the parameter, but does not need to be.",
        "requirements": "Support human navigation and code generation.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "condition": [
          "cnl-0"
        ],
        "isSummary": true
      },
      {
        "id": "CompartmentDefinition.status",
        "path": "CompartmentDefinition.status",
        "short": "draft | active | retired | unknown",
        "definition": "The status of this compartment definition. Enables tracking the life-cycle of the content.",
        "comment": "Allows filtering of compartment definitions that are appropriate for use versus not.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "PublicationStatus"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
              "valueBoolean": true
            }
          ],
          "strength": "required",
          "description": "The lifecycle status of an artifact.",
          "valueSet": "http://hl7.org/fhir/ValueSet/publication-status"
        },
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.status"
          },
          {
            "identity": "w5",
            "map": "FiveWs.status"
          }
        ]
      },
      {
        "id": "CompartmentDefinition.experimental",
        "path": "CompartmentDefinition.experimental",
        "short": "For testing purposes, not real usage",
        "definition": "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.",
        "comment": "Allows filtering of compartment definitions that are appropriate for use versus not.",
        "requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level compartment definition.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.experimental"
          },
          {
            "identity": "w5",
            "map": "FiveWs.class"
          }
        ]
      },
      {
        "id": "CompartmentDefinition.date",
        "path": "CompartmentDefinition.date",
        "short": "Date last changed",
        "definition": "The date  (and optionally time) when the compartment definition was published. The date must change 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 changes.",
        "comment": "Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the compartment definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.",
        "alias": [
          "Revision Date"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.date"
          },
          {
            "identity": "w5",
            "map": "FiveWs.recorded"
          }
        ]
      },
      {
        "id": "CompartmentDefinition.publisher",
        "path": "CompartmentDefinition.publisher",
        "short": "Name of the publisher (organization or individual)",
        "definition": "The name of the organization or individual that published the compartment definition.",
        "comment": "Usually an organization but may be an individual. The publisher (or steward) of the compartment definition is the organization or individual primarily responsible for the maintenance and upkeep of the compartment definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the compartment definition. This item SHOULD be populated unless the information is available from context.",
        "requirements": "Helps establish the \"authority/credibility\" of the compartment definition.  May also allow for contact.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.publisher"
          },
          {
            "identity": "w5",
            "map": "FiveWs.witness"
          }
        ]
      },
      {
        "id": "CompartmentDefinition.contact",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/svg",
            "valueCode": "350,60"
          }
        ],
        "path": "CompartmentDefinition.contact",
        "short": "Contact details for the publisher",
        "definition": "Contact details to assist a user in finding and communicating with the publisher.",
        "comment": "May be a web site, an email address, a telephone number, etc.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "ContactDetail"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.contact"
          }
        ]
      },
      {
        "id": "CompartmentDefinition.description",
        "path": "CompartmentDefinition.description",
        "short": "Natural language description of the compartment definition",
        "definition": "A free text natural language description of the compartment definition from a consumer's perspective.",
        "comment": "This description can be used to capture details such as why the compartment definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the compartment definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the compartment definition is presumed to be the predominant language in the place the compartment definition was created).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "markdown"
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.description"
          }
        ]
      },
      {
        "id": "CompartmentDefinition.useContext",
        "path": "CompartmentDefinition.useContext",
        "short": "The context that the content is intended to support",
        "definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate compartment definition instances.",
        "comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
        "requirements": "Assist in searching for appropriate content.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "UsageContext"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.useContext"
          }
        ]
      },
      {
        "id": "CompartmentDefinition.purpose",
        "path": "CompartmentDefinition.purpose",
        "short": "Why this compartment definition is defined",
        "definition": "Explanation of why this compartment definition is needed and why it has been designed as it has.",
        "comment": "This element does not describe the usage of the compartment definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is.  This may be used to point to source materials or specifications that drove the structure of this compartment definition.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "markdown"
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Definition.purpose"
          },
          {
            "identity": "w5",
            "map": "FiveWs.why[x]"
          },
          {
            "identity": "objimpl",
            "map": "no-gen-base"
          }
        ]
      },
      {
        "id": "CompartmentDefinition.code",
        "path": "CompartmentDefinition.code",
        "short": "Patient | Encounter | RelatedPerson | Practitioner | Device",
        "definition": "Which compartment this definition describes.",
        "comment": "Only the specification can define the compartments that can exist. Servers can choose to support them.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "CompartmentType"
            }
          ],
          "strength": "required",
          "description": "Which type a compartment definition describes.",
          "valueSet": "http://hl7.org/fhir/ValueSet/compartment-type"
        }
      },
      {
        "id": "CompartmentDefinition.search",
        "path": "CompartmentDefinition.search",
        "short": "Whether the search syntax is supported",
        "definition": "Whether the search syntax is supported,.",
        "comment": "Servers may define and use compartments to manage logical access without implementing the compartment related syntax.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ],
        "isSummary": true
      },
      {
        "id": "CompartmentDefinition.resource",
        "extension": [
          {
            "url": "http://hl7.org/fhir/build/StructureDefinition/svg",
            "valueCode": "350,260"
          }
        ],
        "path": "CompartmentDefinition.resource",
        "short": "How a resource is related to the compartment",
        "definition": "Information about how a resource is related to the compartment.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "BackboneElement"
          }
        ],
        "isSummary": true
      },
      {
        "id": "CompartmentDefinition.resource.code",
        "path": "CompartmentDefinition.resource.code",
        "short": "Name of resource type",
        "definition": "The name of a resource supported by the server.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isSummary": true,
        "binding": {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
              "valueString": "ResourceType"
            },
            {
              "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
              "valueBoolean": true
            }
          ],
          "strength": "required",
          "description": "One of the resource types defined as part of this version of FHIR.",
          "valueSet": "http://hl7.org/fhir/ValueSet/resource-types"
        }
      },
      {
        "id": "CompartmentDefinition.resource.param",
        "path": "CompartmentDefinition.resource.param",
        "short": "Search Parameter Name, or chained parameters",
        "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 in more than one way,.",
        "comment": "If no search parameters are listed, then the resource is not linked to the compartment.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ],
        "isSummary": true
      },
      {
        "id": "CompartmentDefinition.resource.documentation",
        "path": "CompartmentDefinition.resource.documentation",
        "short": "Additional documentation about the resource and compartment",
        "definition": "Additional documentation about the resource and compartment.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      }
    ]
  }
}