Mobile Care Services Discovery (mCSD)
3.9.0 - Trial-Implementation International flag

This page is part of the IHE ITI Mobile Care Services Discovery (v3.9.0: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: MCSDOrganizationAffiliationDocShare - Detailed Descriptions

Active as of 2024-12-02

Definitions for the IHE.mCSD.OrganizationAffiliation.DocShare resource profile.

Guidance on how to interpret the contents of this table can be found here

0. OrganizationAffiliation
2. OrganizationAffiliation.identifier
Definition

Shall be all the homeCommunityId(s) of all the communities in the affiliation network.

Shortthe homeCommunityId(s)
Comments

Open-Issue: should this be mandated, recommended, or forbidden?

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..?
Must Supporttrue
4. OrganizationAffiliation.code
SlicingThis element introduces a set of slices on OrganizationAffiliation.code. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
  • 6. OrganizationAffiliation.code:docshare
    Slice Namedocshare
    Control1..1
    Pattern Value{
      "coding" : [{
        "system" : "https://profiles.ihe.net/ITI/mCSD/CodeSystem/MCSDOrgAffTypes",
        "code" : "DocShare-federate"
      }]
    }
    8. OrganizationAffiliation.endpoint
    TypeReference(mCSD Endpoint for Document Sharing)

    Guidance on how to interpret the contents of this table can be found here

    0. OrganizationAffiliation
    Definition

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

    ShortDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
    Control0..*
    Is Modifierfalse
    Summaryfalse
    Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
    dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
    dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
    dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
    dom-6: A resource should have narrative for robust management (text.`div`.exists())
    2. OrganizationAffiliation.implicitRules
    Definition

    A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

    ShortA set of rules under which this content was created
    Comments

    Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

    Control0..01
    Typeuri
    Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    4. OrganizationAffiliation.modifierExtension
    Definition

    An Extension


    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensionExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..0*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    6. OrganizationAffiliation.identifier
    Definition

    Shall be all the homeCommunityId(s) of all the communities in the affiliation network.


    Business identifiers that are specific to this role.

    Shortthe homeCommunityId(s)Business identifiers that are specific to this role
    Comments

    Open-Issue: should this be mandated, recommended, or forbidden?

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control10..*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Often, specific identities are assigned for the agent.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. OrganizationAffiliation.active
    Definition

    Whether this organization affiliation record is in active use.

    ShortWhether this organization affiliation record is in active use
    Comments

    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.

    Control10..1
    Typeboolean
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    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.

    Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. OrganizationAffiliation.organization
    Definition

    Organization where the role is available (primary organization/has members).

    ShortOrganization where the role is available.
    Control10..1
    TypeReference(mCSD Organization, Organization)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. OrganizationAffiliation.participatingOrganization
    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).

    ShortThe Organization providing the role.Organization that provides/performs the role (e.g. providing services or is a member of)
    Control10..1
    TypeReference(mCSD Organization, Organization)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. OrganizationAffiliation.network
    Definition

    Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).

    ShortHealth insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
    Control0..0*
    TypeReference(Organization)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. OrganizationAffiliation.code
    Definition

    Definition of the role the participatingOrganization plays in the association.

    ShortThe type of affiliationDefinition of the role the participatingOrganization plays
    Control10..*
    BindingFor example codes, see OrganizationAffiliationRolehttp://hl7.org/fhir/ValueSet/organization-role
    (example to http://hl7.org/fhir/ValueSet/organization-role)

    The role the participating organization providing services to the primary organization.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on OrganizationAffiliation.code. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ $this
    • 18. OrganizationAffiliation.code:docshare
      Slice Namedocshare
      Definition

      Definition of the role the participatingOrganization plays in the association.

      ShortThe type of affiliationDefinition of the role the participatingOrganization plays
      Control10..1*
      BindingFor example codes, see OrganizationAffiliationRolehttp://hl7.org/fhir/ValueSet/organization-role
      (example to http://hl7.org/fhir/ValueSet/organization-role)

      The role the participating organization providing services to the primary organization.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Pattern Value{
        "coding" : [{
          "system" : "https://profiles.ihe.net/ITI/mCSD/CodeSystem/MCSDOrgAffTypes",
          "code" : "DocShare-federate"
        }]
      }
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. OrganizationAffiliation.telecom
      Definition

      Contact details at the participatingOrganization relevant to this Affiliation.

      ShortContact details at the participatingOrganization relevant to this Affiliation
      Control0..*
      TypeContactPoint
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. OrganizationAffiliation.endpoint
      Definition

      Technical endpoints providing access to services operated for this role.

      ShortTechnical endpoints providing access to services operated for this role
      Control0..*
      TypeReference(mCSD Endpoint for Document Sharing, Endpoint)
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be found here

      0. OrganizationAffiliation
      Definition

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

      ShortDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
      Control0..*
      Is Modifierfalse
      Summaryfalse
      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
      dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
      dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
      dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
      dom-6: A resource should have narrative for robust management (text.`div`.exists())
      2. OrganizationAffiliation.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

      Control0..1
      Typeid
      Is Modifierfalse
      Summarytrue
      4. OrganizationAffiliation.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. OrganizationAffiliation.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

      Control0..0
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. OrganizationAffiliation.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..1
      BindingThe codes SHOULD be taken from CommonLanguages
      (preferred to http://hl7.org/fhir/ValueSet/languages)

      A human language.

      Additional BindingsPurpose
      AllLanguagesMax Binding
      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. OrganizationAffiliation.text
      Definition

      A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

      ShortText summary of the resource, for human interpretation
      Comments

      Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

      Control0..1
      TypeNarrative
      Is Modifierfalse
      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      12. OrganizationAffiliation.contained
      Definition

      These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

      ShortContained, inline Resources
      Comments

      This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

      Control0..*
      TypeResource
      Is Modifierfalse
      Summaryfalse
      Alternate Namesinline resources, anonymous resources, contained resources
      14. OrganizationAffiliation.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      16. OrganizationAffiliation.modifierExtension
      Definition

      An Extension

      ShortExtension
      Control0..0
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      18. OrganizationAffiliation.identifier
      Definition

      Shall be all the homeCommunityId(s) of all the communities in the affiliation network.

      Shortthe homeCommunityId(s)
      Comments

      Open-Issue: should this be mandated, recommended, or forbidden?

      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..*
      TypeIdentifier
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Requirements

      Often, specific identities are assigned for the agent.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. OrganizationAffiliation.active
      Definition

      Whether this organization affiliation record is in active use.

      ShortWhether this organization affiliation record is in active use
      Comments

      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.

      Control1..1
      Typeboolean
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      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.

      Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. OrganizationAffiliation.period
      Definition

      The period during which the participatingOrganization is affiliated with the primary organization.

      ShortThe period during which the participatingOrganization is affiliated with the primary organization
      Control0..1
      TypePeriod
      Is Modifierfalse
      Summarytrue
      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.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. OrganizationAffiliation.organization
      Definition

      Organization where the role is available (primary organization/has members).

      ShortOrganization where the role is available.
      Control1..1
      TypeReference(mCSD Organization)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. OrganizationAffiliation.participatingOrganization
      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).

      ShortThe Organization providing the role.
      Control1..1
      TypeReference(mCSD Organization)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. OrganizationAffiliation.network
      Definition

      Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined).

      ShortHealth insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined)
      Control0..0
      TypeReference(Organization)
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      30. OrganizationAffiliation.code
      Definition

      Definition of the role the participatingOrganization plays in the association.

      ShortThe type of affiliation
      Control1..*
      BindingFor example codes, see OrganizationAffiliationRole
      (example to http://hl7.org/fhir/ValueSet/organization-role)

      The role the participating organization providing services to the primary organization.

      TypeCodeableConcept
      Is Modifierfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on OrganizationAffiliation.code. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ $this
      • 32. OrganizationAffiliation.code:docshare
        Slice Namedocshare
        Definition

        Definition of the role the participatingOrganization plays in the association.

        ShortThe type of affiliation
        Control1..1
        BindingFor example codes, see OrganizationAffiliationRole
        (example to http://hl7.org/fhir/ValueSet/organization-role)

        The role the participating organization providing services to the primary organization.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Pattern Value{
          "coding" : [{
            "system" : "https://profiles.ihe.net/ITI/mCSD/CodeSystem/MCSDOrgAffTypes",
            "code" : "DocShare-federate"
          }]
        }
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        34. OrganizationAffiliation.specialty
        Definition

        Specific specialty of the participatingOrganization in the context of the role.

        ShortSpecific specialty of the participatingOrganization in the context of the role
        Control0..*
        BindingThe codes SHOULD be taken from PracticeSettingCodeValueSet
        (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes)

        Specific specialty associated with the participating organization.

        TypeCodeableConcept
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        36. OrganizationAffiliation.location
        Definition

        The location(s) at which the role occurs.

        ShortThe location(s) at which the role occurs
        Control0..*
        TypeReference(mCSD Location)
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        38. OrganizationAffiliation.healthcareService
        Definition

        Healthcare services provided through the role.

        ShortHealthcare services provided through the role
        Control0..*
        TypeReference(mCSD HealthcareService)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. OrganizationAffiliation.telecom
        Definition

        Contact details at the participatingOrganization relevant to this Affiliation.

        ShortContact details at the participatingOrganization relevant to this Affiliation
        Control0..*
        TypeContactPoint
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        Requirements

        Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        42. OrganizationAffiliation.endpoint
        Definition

        Technical endpoints providing access to services operated for this role.

        ShortTechnical endpoints providing access to services operated for this role
        Control0..*
        TypeReference(mCSD Endpoint for Document Sharing)
        Is Modifierfalse
        Summaryfalse
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))