Data Model Libraries
    Preparing search index...

    Class OrganizationAffiliation

    OrganizationAffiliation Class

    Defines an affiliation/assotiation/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship.

    Need to define relationships between organizations that are not sub-divisions of the same organization (part-of relationships).

    FHIR Specification

    • Short: Defines an affiliation/association/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship
    • Definition: Defines an affiliation/association/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship.
    • FHIR Version: 5.0.0

    FHIR OrganizationAffiliation

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? active? period? organization? participatingOrganization? network? code? specialty? location? healthcareService? contact? endpoint?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getActiveElement setActiveElement hasActiveElement getActive setActive hasActive getPeriod setPeriod hasPeriod getOrganization setOrganization hasOrganization getParticipatingOrganization setParticipatingOrganization hasParticipatingOrganization getNetwork setNetwork addNetwork hasNetwork getCode setCode addCode hasCode getSpecialty setSpecialty addSpecialty hasSpecialty getLocation setLocation addLocation hasLocation getHealthcareService setHealthcareService addHealthcareService hasHealthcareService 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 initNetwork initCode initSpecialty initLocation initHealthcareService initContact initEndpoint

    Constructors

    Properties

    identifier?: Identifier[]

    OrganizationAffiliation.identifier Element

    FHIR Specification

    • Short: Business identifiers that are specific to this role
    • Definition: Business identifiers that are specific to this role.
    • Requirements: Often, specific identities are assigned for the agent.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    active?: BooleanType

    OrganizationAffiliation.active Element

    FHIR Specification

    • Short: Whether this organization affiliation record is in active use
    • Definition: Whether this organization affiliation record is in active use.
    • Comment: If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
    • Requirements: Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    period?: Period

    OrganizationAffiliation.period Element

    FHIR Specification

    • Short: The period during which the participatingOrganization is affiliated with the primary organization
    • Definition: The period during which the participatingOrganization is affiliated with the primary organization.
    • Requirements: An affiliation may be created ahead of time and only be active for a defined period of time. Once the affiliation is complete, the fact that it existed may still be required.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    organization?: Reference

    OrganizationAffiliation.organization Element

    FHIR Specification

    • Short: Organization where the role is available
    • Definition: Organization where the role is available (primary organization/has members).
    • Comment: For example, a Spotless Cleaning Services (participatingOrganization) is a supplier (code) to General Hospital (organization). Similarly, General Hospital (participatingOrganization) is a member (code) of Eastern HIE (organization). If there are two organizations that do not have a directional relationship, there would normally be a third organization that represents the joint partnership, and the two organizations would have a relationship to that joint Organization via two OrganizationAffiliations.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    participatingOrganization?: Reference

    OrganizationAffiliation.participatingOrganization Element

    FHIR Specification

    • Short: Organization that provides/performs the role (e.g. providing services or is a member of)
    • Definition: The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of).
    • Comment: See comments for OrganizationAffiliation.organization above.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    network?: Reference[]

    OrganizationAffiliation.network Element

    FHIR Specification

    • Short: The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
    • Definition: The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).
    • Comment: e.g. Commonly used for Health Insurance provider networks.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    code?: CodeableConcept[]

    OrganizationAffiliation.code Element

    FHIR Specification

    • Short: Definition of the role the participatingOrganization plays
    • Definition: Definition of the role the participatingOrganization plays in the association.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    specialty?: CodeableConcept[]

    OrganizationAffiliation.specialty Element

    FHIR Specification

    • Short: Specific specialty of the participatingOrganization in the context of the role
    • Definition: Specific specialty of the participatingOrganization in the context of the role.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    location?: Reference[]

    OrganizationAffiliation.location Element

    FHIR Specification

    • Short: The location(s) at which the role occurs
    • Definition: The location(s) at which the role occurs.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    healthcareService?: Reference[]

    OrganizationAffiliation.healthcareService Element

    FHIR Specification

    contact?: ExtendedContactDetail[]

    OrganizationAffiliation.contact Element

    FHIR Specification

    • Short: Official contact details at the participatingOrganization relevant to this Affiliation
    • Definition: The contact details of communication devices available at the participatingOrganization relevant to this Affiliation.
    • Requirements: Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.
    • FHIR Type: ExtendedContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    endpoint?: Reference[]

    OrganizationAffiliation.endpoint Element

    FHIR Specification

    • Short: Technical endpoints providing access to services operated for this role
    • Definition: Technical endpoints providing access to services operated for this role.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR OrganizationAffiliation

      • OptionaloptSourceField: string

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

      Returns undefined | OrganizationAffiliation

      OrganizationAffiliation data model or undefined for OrganizationAffiliation

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided ParticipatingOrganization object value to the participatingOrganization property.

      Parameters

      • value: undefined | Reference

        the participatingOrganization object value

      Returns this

      this

      @ReferenceTargets('OrganizationAffiliation.participatingOrganization', ['Organization',])

      InvalidTypeError for invalid data type or reference value

    • 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetActiveElementsetActiveElementhasActiveElementgetActivesetActivehasActivegetPeriodsetPeriodhasPeriodgetOrganizationsetOrganizationhasOrganizationgetParticipatingOrganizationsetParticipatingOrganizationhasParticipatingOrganizationgetNetworksetNetworkaddNetworkhasNetworkgetCodesetCodeaddCodehasCodegetSpecialtysetSpecialtyaddSpecialtyhasSpecialtygetLocationsetLocationaddLocationhasLocationgetHealthcareServicesetHealthcareServiceaddHealthcareServicehasHealthcareServicegetContactsetContactaddContacthasContactgetEndpointsetEndpointaddEndpointhasEndpointfhirTypeisEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisRequiredFieldsEmptyisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitNetworkinitCodeinitSpecialtyinitLocationinitHealthcareServiceinitContactinitEndpoint