Data Model Libraries
    Preparing search index...

    Class Organization

    Organization Class

    A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

    FHIR Specification

    • Short: A grouping of people or organizations with a common purpose
    • Definition: A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
    • FHIR Version: 4.3.0

    FHIR Organization

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? active? type_? name? alias? telecom? address? partOf? contact? endpoint?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getActiveElement setActiveElement hasActiveElement getActive setActive hasActive getType setType addType hasType getNameElement setNameElement hasNameElement getName setName hasName getAliasElement setAliasElement addAliasElement hasAliasElement getAlias setAlias addAlias hasAlias getTelecom setTelecom addTelecom hasTelecom getAddress setAddress addAddress hasAddress getPartOf setPartOf hasPartOf getContact setContact addContact hasContact getEndpoint setEndpoint addEndpoint hasEndpoint fhirType isEmpty 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 isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initType initAlias initTelecom initAddress initContact initEndpoint

    Constructors

    Properties

    identifier?: Identifier[]

    Organization.identifier Element

    FHIR Specification

    • Short: Identifies this organization across multiple systems
    • Definition: Identifier for the organization that is used to identify the organization across multiple disparate systems.
    • Requirements: Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    active?: BooleanType

    Organization.active Element

    FHIR Specification

    • Short: Whether the organization's record is still in active use
    • Definition: Whether the organization's record is still in active use.
    • Comment: This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error.
    • Requirements: Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: true
    • isModifierReason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
    • isSummary: true

    Private Optionaltype_

    type_?: CodeableConcept[]

    Organization.type Element

    FHIR Specification

    • Short: Kind of organization
    • Definition: The kind(s) of organization that this is.
    • Comment: Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality.
    • Requirements: Need to be able to track the kind of organization that this is - different organization types have different uses.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    name?: StringType

    Organization.name Element

    FHIR Specification

    • Short: Name used for the organization
    • Definition: A name associated with the organization.
    • Comment: If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
    • Requirements: Need to use the name as the label of the organization.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    alias?: StringType[]

    Organization.alias Element

    FHIR Specification

    • Short: A list of alternate names that the organization is known as, or was known as in the past
    • Definition: A list of alternate names that the organization is known as, or was known as in the past.
    • Comment: There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
    • Requirements: Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    telecom?: ContactPoint[]

    Organization.telecom Element

    FHIR Specification

    • Short: A contact detail for the organization
    • Definition: A contact detail for the organization.
    • Comment: The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.
    • Requirements: Human contact for the organization.
    • FHIR Type: ContactPoint
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    address?: Address[]

    Organization.address Element

    FHIR Specification

    • Short: An address for the organization
    • Definition: An address for the organization.
    • Comment: Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
    • Requirements: May need to keep track of the organization's addresses for contacting, billing or reporting requirements.
    • FHIR Type: Address
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    partOf?: Reference

    Organization.partOf Element

    FHIR Specification

    • Short: The organization of which this organization forms a part
    • Definition: The organization of which this organization forms a part.
    • Requirements: Need to be able to track the hierarchy of organizations within an organization.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: OrganizationContactComponent[]

    Organization.contact Element

    FHIR Specification

    • Short: Contact for the organization for a certain purpose
    • Definition: Contact for the organization for a certain purpose.
    • Comment: Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
    • Requirements: Need to keep track of assigned contact points within bigger organization.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endpoint?: Reference[]

    Organization.endpoint Element

    FHIR Specification

    • Short: Technical endpoints providing access to services operated for the organization
    • Definition: Technical endpoints providing access to services operated for the organization.
    • Requirements: Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR Organization

      • OptionaloptSourceField: string

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

      Returns undefined | Organization

      Organization data model or undefined for Organization

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetActiveElementsetActiveElementhasActiveElementgetActivesetActivehasActivegetTypesetTypeaddTypehasTypegetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetAliasElementsetAliasElementaddAliasElementhasAliasElementgetAliassetAliasaddAliashasAliasgetTelecomsetTelecomaddTelecomhasTelecomgetAddresssetAddressaddAddresshasAddressgetPartOfsetPartOfhasPartOfgetContactsetContactaddContacthasContactgetEndpointsetEndpointaddEndpointhasEndpointfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitTypeinitAliasinitTelecominitAddressinitContactinitEndpoint