Data Model Libraries
    Preparing search index...

    Class CompartmentDefinition

    CompartmentDefinition Class

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

    FHIR Specification

    • 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.
    • FHIR Version: 4.3.0

    FHIR CompartmentDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url version? name publicationStatusEnum status experimental? date? publisher? contact? description? useContext? purpose? compartmentTypeEnum code search resource?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getNameElement setNameElement hasNameElement getName setName hasName getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getUseContext setUseContext addUseContext hasUseContext getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getCodeEnumType setCodeEnumType hasCodeEnumType getCodeElement setCodeElement hasCodeElement getCode setCode hasCode getSearchElement setSearchElement hasSearchElement getSearch setSearch hasSearch getResource setResource addResource hasResource fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initContact initUseContext initResource

    Constructors

    Properties

    url: null | UriType

    CompartmentDefinition.url Element

    FHIR Specification

    • 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. The 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. In 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 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.
    • FHIR Type: uri
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    version?: StringType

    CompartmentDefinition.version Element

    FHIR Specification

    • 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].
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name: null | StringType

    CompartmentDefinition.name Element

    FHIR Specification

    • 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.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    CompartmentDefinition.status Element

    FHIR Specification

    • 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.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    experimental?: BooleanType

    CompartmentDefinition.experimental Element

    FHIR Specification

    • 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.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    date?: DateTimeType

    CompartmentDefinition.date Element

    FHIR Specification

    • 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.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    CompartmentDefinition.publisher Element

    FHIR Specification

    • 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    CompartmentDefinition.contact Element

    FHIR Specification

    • 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.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    CompartmentDefinition.description Element

    FHIR Specification

    • 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).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    useContext?: UsageContext[]

    CompartmentDefinition.useContext Element

    FHIR Specification

    • 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.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    CompartmentDefinition.purpose Element

    FHIR Specification

    • 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.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    compartmentTypeEnum: CompartmentTypeEnum

    FHIR CodeSystem: CompartmentType

    CompartmentTypeEnum

    code: null | EnumCodeType

    CompartmentDefinition.code Element

    FHIR Specification

    • 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.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: CompartmentTypeEnum

    search: null | BooleanType

    CompartmentDefinition.search Element

    FHIR Specification

    • 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.
    • FHIR Type: boolean
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    resource?: CompartmentDefinitionResourceComponent[]

    CompartmentDefinition.resource Element

    FHIR Specification

    • Short: How a resource is related to the compartment
    • Definition: Information about how a resource is related to the compartment.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided CompartmentDefinition JSON to instantiate the CompartmentDefinition data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR CompartmentDefinition

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CompartmentDefinition

      Returns undefined | CompartmentDefinition

      CompartmentDefinition data model or undefined for CompartmentDefinition

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetExperimentalElementsetExperimentalElementhasExperimentalElementgetExperimentalsetExperimentalhasExperimentalgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetUseContextsetUseContextaddUseContexthasUseContextgetPurposeElementsetPurposeElementhasPurposeElementgetPurposesetPurposehasPurposegetCodeEnumTypesetCodeEnumTypehasCodeEnumTypegetCodeElementsetCodeElementhasCodeElementgetCodesetCodehasCodegetSearchElementsetSearchElementhasSearchElementgetSearchsetSearchhasSearchgetResourcesetResourceaddResourcehasResourcefhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitContactinitUseContextinitResource