Estonian Base Implementation Guide
1.0.0 - ballot Estonia flag

Estonian Base Implementation Guide, published by HL7 Estonia. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7EE/ig-ee-base/ and changes regularly. See the Directory of published versions

Resource Profile: EEBase Organization

Official URL: https://fhir.ee/StructureDefinition/ee-organization Version: 1.0.0
Draft as of 2024-04-26 Computable Name: EEBaseOrganization

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. Yet, Organization could be used for documenting contact information and/or providing support for other resources that need to reference organizations.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..* Organization A grouping of people or organizations with a common purpose without substructure
... identifier S 1..* Identifier Identifies this organization across multiple systems
.... system S 1..1 uri The namespace for the identifier value
Binding: Organization Identifier Domain (required)
.... value S 1..1 string The value that is unique
... active S 1..1 boolean Whether the organization's record is in active use
... type 0..* CodeableConcept Kind of organization
Binding: Organization Types (extensible)
... contact
.... address S 0..1 EEBaseAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf 0..1 Reference(EEBase Organization) The organization of which this organization forms a part

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.identifier.systemrequiredEEBaseOrganizationIdentifierDomain
https://fhir.ee/ValueSet/organization-identifier-domain
from this IG
Organization.typeextensibleEEBaseOrganizationType
https://fhir.ee/ValueSet/organization-type
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose without substructure
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 1..1 uri The namespace for the identifier value
Binding: Organization Identifier Domain (required)
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 1..1 boolean Whether the organization's record is in active use
... type Σ 0..* CodeableConcept Kind of organization
Binding: Organization Types (extensible)
... name SΣC 1..1 string Name used for the organization
... contact C 0..* ExtendedContactDetail Official contact details for the Organization
org-3: The telecom of an organization can never be of use 'home'
org-4: The address of an organization can never be of use 'home'
.... address S 0..1 EEBaseAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf Σ 0..1 Reference(EEBase Organization) The organization of which this organization forms a part

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier.systemrequiredEEBaseOrganizationIdentifierDomain
https://fhir.ee/ValueSet/organization-identifier-domain
from this IG
Organization.typeextensibleEEBaseOrganizationType
https://fhir.ee/ValueSet/organization-type
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-3errorOrganization.contactThe telecom of an organization can never be of use 'home'
: telecom.where(use = 'home').empty()
org-4errorOrganization.contactThe address of an organization can never be of use 'home'
: address.where(use = 'home').empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose without substructure
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣC 1..* Identifier Identifies this organization across multiple systems
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 1..1 uri The namespace for the identifier value
Binding: Organization Identifier Domain (required)
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether the organization's record is in active use
... type Σ 0..* CodeableConcept Kind of organization
Binding: Organization Types (extensible)
... name SΣC 1..1 string Name used for the organization
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... description Σ 0..1 markdown Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name
... contact C 0..* ExtendedContactDetail Official contact details for the Organization
org-3: The telecom of an organization can never be of use 'home'
org-4: The address of an organization can never be of use 'home'
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... purpose Σ 0..1 CodeableConcept The type of contact
Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used.

.... name Σ 0..* HumanName Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details (e.g.phone/fax/url)
.... address S 0..1 EEBaseAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... organization Σ 0..1 Reference(Organization) This contact detail is handled/monitored by a specific organization
.... period Σ 0..1 Period Period that this contact was valid for usage
... partOf Σ 0..1 Reference(EEBase Organization) The organization of which this organization forms a part
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization
... qualification 0..* BackboneElement Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier An identifier for this qualification for the organization
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: (unbound) (example): Specific qualification the organization has to provide a service.

.... period 0..1 Period Period during which the qualification is valid
.... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.identifier.systemrequiredEEBaseOrganizationIdentifierDomain
https://fhir.ee/ValueSet/organization-identifier-domain
from this IG
Organization.typeextensibleEEBaseOrganizationType
https://fhir.ee/ValueSet/organization-type
from this IG
Organization.contact.purposepreferredContactEntityType
http://terminology.hl7.org/ValueSet/contactentity-type
Organization.qualification.codeexample

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-3errorOrganization.contactThe telecom of an organization can never be of use 'home'
: telecom.where(use = 'home').empty()
org-4errorOrganization.contactThe address of an organization can never be of use 'home'
: address.where(use = 'home').empty()

This structure is derived from Organization

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..* Organization A grouping of people or organizations with a common purpose without substructure
... identifier S 1..* Identifier Identifies this organization across multiple systems
.... system S 1..1 uri The namespace for the identifier value
Binding: Organization Identifier Domain (required)
.... value S 1..1 string The value that is unique
... active S 1..1 boolean Whether the organization's record is in active use
... type 0..* CodeableConcept Kind of organization
Binding: Organization Types (extensible)
... contact
.... address S 0..1 EEBaseAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf 0..1 Reference(EEBase Organization) The organization of which this organization forms a part

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organization.identifier.systemrequiredEEBaseOrganizationIdentifierDomain
https://fhir.ee/ValueSet/organization-identifier-domain
from this IG
Organization.typeextensibleEEBaseOrganizationType
https://fhir.ee/ValueSet/organization-type
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose without substructure
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system SΣ 1..1 uri The namespace for the identifier value
Binding: Organization Identifier Domain (required)
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 1..1 boolean Whether the organization's record is in active use
... type Σ 0..* CodeableConcept Kind of organization
Binding: Organization Types (extensible)
... name SΣC 1..1 string Name used for the organization
... contact C 0..* ExtendedContactDetail Official contact details for the Organization
org-3: The telecom of an organization can never be of use 'home'
org-4: The address of an organization can never be of use 'home'
.... address S 0..1 EEBaseAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf Σ 0..1 Reference(EEBase Organization) The organization of which this organization forms a part

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier.systemrequiredEEBaseOrganizationIdentifierDomain
https://fhir.ee/ValueSet/organization-identifier-domain
from this IG
Organization.typeextensibleEEBaseOrganizationType
https://fhir.ee/ValueSet/organization-type
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-3errorOrganization.contactThe telecom of an organization can never be of use 'home'
: telecom.where(use = 'home').empty()
org-4errorOrganization.contactThe address of an organization can never be of use 'home'
: address.where(use = 'home').empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose without substructure
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣC 1..* Identifier Identifies this organization across multiple systems
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ 1..1 uri The namespace for the identifier value
Binding: Organization Identifier Domain (required)
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 1..1 boolean Whether the organization's record is in active use
... type Σ 0..* CodeableConcept Kind of organization
Binding: Organization Types (extensible)
... name SΣC 1..1 string Name used for the organization
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... description Σ 0..1 markdown Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name
... contact C 0..* ExtendedContactDetail Official contact details for the Organization
org-3: The telecom of an organization can never be of use 'home'
org-4: The address of an organization can never be of use 'home'
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... purpose Σ 0..1 CodeableConcept The type of contact
Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used.

.... name Σ 0..* HumanName Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details (e.g.phone/fax/url)
.... address S 0..1 EEBaseAddress An address expressed using postal conventions (as opposed to GPS or other location definition formats)
.... organization Σ 0..1 Reference(Organization) This contact detail is handled/monitored by a specific organization
.... period Σ 0..1 Period Period that this contact was valid for usage
... partOf Σ 0..1 Reference(EEBase Organization) The organization of which this organization forms a part
... endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization
... qualification 0..* BackboneElement Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier An identifier for this qualification for the organization
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: (unbound) (example): Specific qualification the organization has to provide a service.

.... period 0..1 Period Period during which the qualification is valid
.... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Organization.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|5.0.0
from the FHIR Standard
Organization.identifier.typeextensibleIdentifierTypeCodes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Organization.identifier.systemrequiredEEBaseOrganizationIdentifierDomain
https://fhir.ee/ValueSet/organization-identifier-domain
from this IG
Organization.typeextensibleEEBaseOrganizationType
https://fhir.ee/ValueSet/organization-type
from this IG
Organization.contact.purposepreferredContactEntityType
http://terminology.hl7.org/ValueSet/contactentity-type
Organization.qualification.codeexample

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf 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-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-3errorOrganization.contactThe telecom of an organization can never be of use 'home'
: telecom.where(use = 'home').empty()
org-4errorOrganization.contactThe address of an organization can never be of use 'home'
: address.where(use = 'home').empty()

This structure is derived from Organization

 

Other representations of profile: CSV, Excel, Schematron

Notes: