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
EEBaseOrganization (Organization) | I | Organization | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | S Σ I | 1..* | Identifier |
medre-tam-org-id | S Σ I | 0..1 | EEBase Medre TAM Organization ID |
org-id | S Σ I | 0..1 | EEBase Business Registry ID |
vat-id | S Σ I | 0..1 | EEBase VATIN |
active | S Σ ?! | 1..1 | boolean |
type | Σ | 0..* | CodeableConceptBinding |
name | S Σ I | 1..1 | string |
alias | 0..* | string | |
telecom | I | 0..* | ContactPoint |
address | S I | 0..* | EEBase Address |
partOf | Σ I | 0..1 | Reference(EEBase Organization) |
contact | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
purpose | 0..1 | CodeableConceptBinding | |
name | 0..1 | HumanName | |
telecom | I | 0..* | ContactPoint |
address | 0..1 | EEBase Address | |
endpoint | I | 0..* | Reference(Endpoint) |
Differential View
EEBaseOrganization (Organization) | I | Organization | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | S Σ I | 1..* | Identifier |
medre-tam-org-id | S Σ I | 0..1 | EEBase Medre TAM Organization ID |
org-id | S Σ I | 0..1 | EEBase Business Registry ID |
vat-id | S Σ I | 0..1 | EEBase VATIN |
active | S Σ ?! | 1..1 | boolean |
type | Σ | 0..* | CodeableConceptBinding |
name | S Σ I | 1..1 | string |
alias | 0..* | string | |
telecom | I | 0..* | ContactPoint |
address | S I | 0..* | EEBase Address |
partOf | Σ I | 0..1 | Reference(EEBase Organization) |
contact | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
purpose | 0..1 | CodeableConceptBinding | |
name | 0..1 | HumanName | |
telecom | I | 0..* | ContactPoint |
address | 0..1 | EEBase Address | |
endpoint | I | 0..* | Reference(Endpoint) |
Hybrid View
EEBaseOrganization (Organization) | I | Organization | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | S Σ I | 1..* | Identifier |
medre-tam-org-id | S Σ I | 0..1 | EEBase Medre TAM Organization ID |
org-id | S Σ I | 0..1 | EEBase Business Registry ID |
vat-id | S Σ I | 0..1 | EEBase VATIN |
active | S Σ ?! | 1..1 | boolean |
type | Σ | 0..* | CodeableConceptBinding |
name | S Σ I | 1..1 | string |
alias | 0..* | string | |
telecom | I | 0..* | ContactPoint |
address | S I | 0..* | EEBase Address |
partOf | Σ I | 0..1 | Reference(EEBase Organization) |
contact | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
purpose | 0..1 | CodeableConceptBinding | |
name | 0..1 | HumanName | |
telecom | I | 0..* | ContactPoint |
address | 0..1 | EEBase Address | |
endpoint | I | 0..* | Reference(Endpoint) |
Table View
Organization | .. | |
Organization.identifier | 1.. | |
Organization.identifier | EEBase Medre TAM Organization ID | ..1 |
Organization.identifier | EEBase Business Registry ID | ..1 |
Organization.identifier | EEBase VATIN | ..1 |
Organization.active | 1.. | |
Organization.type | .. | |
Organization.name | 1.. | |
Organization.address | EEBase Address | .. |
Organization.partOf | Reference(EEBase Organization) | .. |
Organization.contact | .. | |
Organization.contact.address | EEBase 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's record is in active use" /> <definition value="Whether the organization'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)
Business identifier for identifying organizations across multiple systems. At least one value (identifier.value
) MUST be provided as an identifier.
active
(Must Support)
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)
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)
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.