/
Guide: Maintaining Organization Information Manually

Guide: Maintaining Organization Information Manually

Content

Introduction

As noted in https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/2059599875/Managing+and+Using+Organization+CareTeam+and+Practitioner#Origin-and-Use-of-Organization , most organisations are created and updated through import from external organisation sources.

To differentiate between organisation types, FHIR Organisation contains an synchronizationStatus element that indicates whether the FHIR Organization is kept up to date automatically.

How you manage an organisation depends on its synchronizationStatus value:

synchronizationStatus

Value

Automatically Updated Elements

Elements to Update Manually

synchronizationStatus

Value

Automatically Updated Elements

Elements to Update Manually

EligibleForSynchronization

identifier, active, type, name, alias, telecom, address, partOf, endpoint,

cvrNumber, regionCode, municipalityCode, providerIdentifier, specialty,

synchronizationStatus, source

contact, relatedTo

NoLongerSynchronized

None

All but identifier, partOf, synchonizationStatus, source

NotSynchronized

None

All but identifier, partOf, synchonizationStatus, source

Key Points

  • EligibleForSynchronization: Most elements are automatically updated from external sources. Only update contact and relatedTo manually.

  • NoLongerSynchronized: No automatic updates occur. You can manually update most elements.

  • NotSynchronized: No automatic updates occur. You can manually update most elements.

Important: Never manually update identifier, partOf, synchronizationStatus, or source elements, regardless of the synchronization status.

Guide: Maintaining Organization Information Manually

Some organizations are not synchronised with external sources and must be updated manually. For synchronised organizations, manual updates may be overwritten during the next automated update.

Before You Begin

  • Review the table above to identify which Organization elements can be updated manually

  • Determine the source type of the Organization you want to update

Manual Update Methods

Organizations with Manual Source

For organizations where the source is set to "manual":

  • Use Organization Update operations

  • Use Organization Patch operations

Organizations with External Source

For organizations where the source is set to anything other than "manual":

  • Use Organization Patch operations only

  • Warning: Update operations are restricted for these organizations

Important Considerations

Risk of Data Loss: When updating synchronized organizations manually, your changes will be lost during the next automated update from the external source.

Best Practice: Only update elements that are designated as safe for manual updates according to the reference table above.

Steps to Update an Organization

  1. Identify the Organization source type

    • Check whether the source is set to "manual" or another value

  2. Choose the appropriate update method

    • Manual source: Use Update or Patch operations

    • External source: Use Patch operations only

  3. Make your changes

    • Update only the elements specified in the reference table

    • Ensure your changes align with organizational requirements

  4. Monitor for overwrites

    • For synchronised organisations, be aware that changes may be overwritten

    • Document any manual changes for future reference