CH Core (R4)
6.0.0-ballot-ci-build - ci-build Switzerland flag

CH Core (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 6.0.0-ballot-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-core/ and changes regularly. See the Directory of published versions

Resource Profile: CHCoreOrganizationEPR - Detailed Descriptions

Active as of 2025-01-15

Definitions for the ch-core-organization-epr resource profile.

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

0. Organization
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.

ShortCH Core Organization EPRA grouping of people or organizations with a common purpose
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())
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
2. Organization.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..1
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. Organization.modifierExtension
Definition

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).

ShortExtensions 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..*
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. Organization.identifier
Definition

Identifier for the organization that is used to identify the organization across multiple disparate systems.

ShortIdentifies this organization across multiple systems
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
This element is affected by the following invariants: org-1
TypeIdentifier
Is Modifierfalse
Summarytrue
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.

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 Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
  • 8. Organization.identifier:BER
    Slice NameBER
    Definition

    See BER


    Identifier for the organization that is used to identify the organization across multiple disparate systems.

    ShortBER (Business and Enterprise Register), BUR (Betriebs- und Unternehmensregister), REE (Registre des entreprises et des établissements), RIS (Registro delle imprese e degli stabilimenti)Identifies this organization across multiple systems
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1*
    This element is affected by the following invariants: org-1
    TypeIdentifier(BER Identifier)
    Is Modifierfalse
    Summarytrue
    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.

    Pattern Value{
      "system" : "urn:oid:2.16.756.5.45"
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Organization.identifier:UIDB
    Slice NameUIDB
    Definition

    See UIDB


    Identifier for the organization that is used to identify the organization across multiple disparate systems.

    ShortUIDB (Unique Identification Business), UID (Verwendung der Unternehmens-Identifikationsnummer), IDE (Utilisation du numéro d'identification des entreprises), IDI (Utilizzo del numero d'identificazione delle imprese)Identifies this organization across multiple systems
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1*
    This element is affected by the following invariants: org-1
    TypeIdentifier(UIDB Identifier)
    Is Modifierfalse
    Summarytrue
    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.

    Pattern Value{
      "system" : "urn:oid:2.16.756.5.35"
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Organization.identifier:ZSR
    Slice NameZSR
    Definition

    See ZSR/RCC


    Identifier for the organization that is used to identify the organization across multiple disparate systems.

    ShortZSR (Zahlstellenregister), RCC (Registre des codes-créanciers), RCC (Registro dei codici creditori)Identifies this organization across multiple systems
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1*
    This element is affected by the following invariants: org-1
    TypeIdentifier(ZSR Identifier)
    Is Modifierfalse
    Summarytrue
    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.

    Pattern Value{
      "system" : "urn:oid:2.16.756.5.30.1.123.100.2.1.1"
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. Organization.identifier:GLN
    Slice NameGLN
    Definition

    See GLN


    Identifier for the organization that is used to identify the organization across multiple disparate systems.

    ShortGlobal Location Number (GLN)Identifies this organization across multiple systems
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1*
    This element is affected by the following invariants: org-1
    TypeIdentifier(GLN Identifier)
    Is Modifierfalse
    Summarytrue
    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.

    Pattern Value{
      "system" : "urn:oid:2.51.1.3"
    }
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Organization.active
    Definition

    Whether the organization's record is still in active use.

    ShortWhether the organization's record is still in active use
    Comments

    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.

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

    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()))
    18. Organization.type
    Definition

    The kind(s) of organization that this is.

    ShortKind of organization
    Comments

    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.

    Control0..*
    BindingUnless not suitable, these codes SHALL be taken from For example codes, see DocumentEntry.healthcareFacilityTypeCodehttp://hl7.org/fhir/ValueSet/organization-type
    (extensible to http://fhir.ch/ig/ch-term/ValueSet/DocumentEntry.healthcareFacilityTypeCode)
    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Requirements

    Need to be able to track the kind of organization that this is - different organization types have different uses.

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

    A contact detail for the organization.

    ShortA contact detail for the organization
    Comments

    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.

    Control0..*
    This element is affected by the following invariants: org-3
    TypeContactPoint
    Is Modifierfalse
    Summaryfalse
    Requirements

    Human contact for the organization.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
    org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
    SlicingThis element introduces a set of slices on Organization.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ system
    • 22. Organization.telecom.system
      Definition

      Telecommunications form for contact point - what communications system is required to make use of the contact.

      Shortphone | fax | email | pager | url | sms | other
      Control10..1
      This element is affected by the following invariants: cpt-2
      BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
      (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1)

      Telecommunications form for contact point.

      Typecode
      Is Modifierfalse
      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()))
      24. Organization.telecom.value
      Definition

      The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

      ShortThe actual contact point details
      Comments

      Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

      Control10..1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to support legacy numbers that are not in a tightly controlled format.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      26. Organization.telecom.use
      Definition

      Identifies the purpose for the contact point.

      Shorthome | work | temp | old | mobile - purpose of this contact point
      Comments

      Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

      Control0..1
      BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
      (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1)

      Use of contact point.

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      28. Organization.telecom:email
      Slice Nameemail
      Definition

      A contact detail for the organization.

      ShortA contact detail for the organization
      Comments

      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.

      Control0..*
      This element is affected by the following invariants: org-3
      TypeContactPoint(CH Core ContactPoint eCH-0046 Email)
      Is Modifierfalse
      Summaryfalse
      Requirements

      Human contact for the organization.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
      org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
      30. Organization.telecom:phone
      Slice Namephone
      Definition

      A contact detail for the organization.

      ShortA contact detail for the organization
      Comments

      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.

      Control0..*
      This element is affected by the following invariants: org-3
      TypeContactPoint(CH Core ContactPoint eCH-0046 Phone)
      Is Modifierfalse
      Summaryfalse
      Requirements

      Human contact for the organization.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
      org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
      32. Organization.telecom:internet
      Slice Nameinternet
      Definition

      A contact detail for the organization.

      ShortA contact detail for the organization
      Comments

      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.

      Control0..*
      This element is affected by the following invariants: org-3
      TypeContactPoint(CH Core ContactPoint eCH-0046 Internet)
      Is Modifierfalse
      Summaryfalse
      Requirements

      Human contact for the organization.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
      org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
      34. Organization.address
      Definition

      An address for the organization.

      ShortAn address for the organization
      Comments

      Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

      Control0..1*
      This element is affected by the following invariants: org-2
      TypeAddress(CH Core Address)
      Is Modifierfalse
      Summaryfalse
      Requirements

      May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
      org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())