Work in progress.
This section of the Implementation Guide is subject to change.

Profile EEBaseOrganization


Profile Purpose

According to FHIR specification, Organization is a resource intended for documenting information related to an entity that has been formed for the purpose of achieving some form of collective action. 'Organization' as such has a narrower definition in context of EEBase - in order to be conformant to EEBaseOrganization profile, an organization MUST be registered as a business, since Organization.identifier element uses specific namespaces (see below). Yet, Organization could be used for documenting contact information and/or providing support for other resources that need to reference organizations.

Example usage scenarios

  • Query for organizations that are part of a specific organization using the query parameter Organization.partOf
  • Query for organizations that share the code specifying the type of the organization using the query parameter Organization.type
  • Exchange Organization information within a FHIR document or message


Snapshot View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
medre-tam-org-idS Σ I0..1EEBase Medre TAM Organization ID
org-idS Σ I0..1EEBase Business Registry ID
vat-idS Σ I0..1EEBase VATIN
activeS Σ ?!1..1boolean
typeΣ0..*CodeableConceptBinding
nameS Σ I1..1string
alias0..*string
telecomI0..*ContactPoint
addressS I0..*EEBase Address
partOfΣ I0..1Reference(EEBase Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1EEBase Address
endpointI0..*Reference(Endpoint)

Differential View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
medre-tam-org-idS Σ I0..1EEBase Medre TAM Organization ID
org-idS Σ I0..1EEBase Business Registry ID
vat-idS Σ I0..1EEBase VATIN
activeS Σ ?!1..1boolean
typeΣ0..*CodeableConceptBinding
nameS Σ I1..1string
alias0..*string
telecomI0..*ContactPoint
addressS I0..*EEBase Address
partOfΣ I0..1Reference(EEBase Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1EEBase Address
endpointI0..*Reference(Endpoint)

Hybrid View

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
medre-tam-org-idS Σ I0..1EEBase Medre TAM Organization ID
org-idS Σ I0..1EEBase Business Registry ID
vat-idS Σ I0..1EEBase VATIN
activeS Σ ?!1..1boolean
typeΣ0..*CodeableConceptBinding
nameS Σ I1..1string
alias0..*string
telecomI0..*ContactPoint
addressS I0..*EEBase Address
partOfΣ I0..1Reference(EEBase Organization)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
purpose0..1CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1EEBase Address
endpointI0..*Reference(Endpoint)

Table View

Organization..
Organization.identifier1..
Organization.identifierEEBase Medre TAM Organization ID..1
Organization.identifierEEBase Business Registry ID..1
Organization.identifierEEBase VATIN..1
Organization.active1..
Organization.type..
Organization.name1..
Organization.addressEEBase Address..
Organization.partOfReference(EEBase Organization)..
Organization.contact..
Organization.contact.addressEEBase Address..

XML View

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="EEBase-Organization" />
    <meta>
        <versionId value="1" />
        <lastUpdated value="2022-11-21T13:25:49.780106+00:00" />
    </meta>
    <url value="https://hl7.ee/fhir/StructureDefinition/EEBase-Organization" />
    <version value="1.0.0" />
    <name value="EEBaseOrganization" />
    <title value="EEBase Organization" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2022-11-21T13:27:21.8266446+00:00" />
    <publisher value="HL7 EE" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="true" />
    <type value="Organization" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Organization" />
    <derivation value="constraint" />
    <differential>
        <element id="Organization">
            <path value="Organization" />
            <short value="A grouping of people or organizations with a common purpose without substructure" />
        </element>
        <element id="Organization.identifier">
            <path value="Organization.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier:medre-tam-org-id">
            <path value="Organization.identifier" />
            <sliceName value="medre-tam-org-id" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/ee-medre-orgid" />
            </type>
        </element>
        <element id="Organization.identifier:org-id">
            <path value="Organization.identifier" />
            <sliceName value="org-id" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-BRID" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Organization.identifier:vat-id">
            <path value="Organization.identifier" />
            <sliceName value="vat-id" />
            <max value="1" />
            <type>
                <code value="Identifier" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/ee-vatin" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Organization.active">
            <path value="Organization.active" />
            <short value="Whether the organization&#39;s record is in active use" />
            <definition value="Whether the organization&#39;s record is in active use" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.type">
            <path value="Organization.type" />
            <binding>
                <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
                    <valueString value="OrganizationType" />
                </extension>
                <strength value="extensible" />
                <valueSet value="https://hl7.ee/ValueSet/ee-organization-type" />
            </binding>
        </element>
        <element id="Organization.name">
            <path value="Organization.name" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="Organization.address">
            <path value="Organization.address" />
            <type>
                <code value="Address" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Address" />
            </type>
            <mustSupport value="true" />
        </element>
        <element id="Organization.partOf">
            <path value="Organization.partOf" />
            <type>
                <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy">
                    <valueBoolean value="true" />
                </extension>
                <code value="Reference" />
                <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Organization" />
            </type>
        </element>
        <element id="Organization.contact.address">
            <path value="Organization.contact.address" />
            <type>
                <code value="Address" />
                <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Address" />
            </type>
        </element>
    </differential>
</StructureDefinition>

JSON View

{
    "resourceType": "StructureDefinition",
    "id": "EEBase-Organization",
    "meta": {
        "versionId": "1",
        "lastUpdated": "2022-11-21T13:25:49.780106+00:00"
    },
    "url": "https://hl7.ee/fhir/StructureDefinition/EEBase-Organization",
    "version": "1.0.0",
    "name": "EEBaseOrganization",
    "title": "EEBase Organization",
    "status": "draft",
    "experimental": false,
    "date": "2022-11-21T13:27:21.8266446+00:00",
    "publisher": "HL7 EE",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": true,
    "type": "Organization",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Organization",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Organization",
                "path": "Organization",
                "short": "A grouping of people or organizations with a common purpose without substructure"
            },
            {
                "id": "Organization.identifier",
                "path": "Organization.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                },
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.identifier:medre-tam-org-id",
                "path": "Organization.identifier",
                "sliceName": "medre-tam-org-id",
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/ee-medre-orgid"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.identifier:org-id",
                "path": "Organization.identifier",
                "sliceName": "org-id",
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-BRID"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.identifier:vat-id",
                "path": "Organization.identifier",
                "sliceName": "vat-id",
                "max": "1",
                "type":  [
                    {
                        "code": "Identifier",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/ee-vatin"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.active",
                "path": "Organization.active",
                "short": "Whether the organization's record is in active use",
                "definition": "Whether the organization's record is in active use",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.type",
                "path": "Organization.type",
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "OrganizationType"
                        }
                    ],
                    "strength": "extensible",
                    "valueSet": "https://hl7.ee/ValueSet/ee-organization-type"
                }
            },
            {
                "id": "Organization.name",
                "path": "Organization.name",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Organization.address",
                "path": "Organization.address",
                "type":  [
                    {
                        "code": "Address",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Address"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Organization.partOf",
                "path": "Organization.partOf",
                "type":  [
                    {
                        "extension":  [
                            {
                                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
                                "valueBoolean": true
                            }
                        ],
                        "code": "Reference",
                        "targetProfile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Organization"
                        ]
                    }
                ]
            },
            {
                "id": "Organization.contact.address",
                "path": "Organization.contact.address",
                "type":  [
                    {
                        "code": "Address",
                        "profile":  [
                            "https://hl7.ee/fhir/StructureDefinition/EEBase-Address"
                        ]
                    }
                ]
            }
        ]
    }
}


identifier (Must Support)

This is a mandatory data element.
The values allowed for this data element are limited and MUST originate from the system defined by Estonian Business Register Number NamingSystem. Providing VAT numbers or values from the system defined by Estonian Health Board Organization License Number NamingSystem is voluntary.

Business identifier for identifying organizations across multiple systems. At least one value (identifier.value) MUST be provided as an identifier.


active (Must Support)

This is a mandatory data element.
Please note that this active flag is not intended to be used to mark an organization as temporarily closed or under construction.

A boolean value referring whether the organization's record is in active use.

type

Coded value describing the type of the organization.

The preferred ValueSet used in this case is eebase-organization-type (Binding Strength = Extended), meaning these values SHOULD be exchanged, however, using additional concepts is allowed if necessary.


name (Must Support)

This is a mandatory data element.
The name attributed to the organization. If the name of an organization changes, consider putting the old name in the alias so that it can still be located through searches.

alias

Any alternate names the organization has used for referring to itself over time.


telecom

Any official contact point (phone, email address, URL or other) used by the organization.


address (Must Support)

Please note that the Address datatype used by this element has been standardized, see Address profile for more details.

An address used by the organization.


partOf

A reference to EEBaseOrganization used in case this particular organization is part of an hierarchy within the organization.


contact

Please note that this element SHOULD be populated only if the organization uses different contact points for specific purposes (e.g one for media enquiries and other for administrative information etc).
Any contact point (phone, email address, URL or other) used by the organization for certain purposes.

endpoint

Please note that this data element includes reference to Endpoint resource which has not been covered (profiled) in this Implementation Guide.
Technical endpoints providing access to services operated for the organization by reference to Endpoint.