eHealth Platform Federal Core Profiles
2.0.1 - STU1

This page is part of the HL7 Belgium FHIR Implementation Guide - Core profiles (v2.0.1: Trial Use) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: BeOrganization

Official URL: https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-organization Version: 2.0.1
Active as of 2022-09-13 Responsible: eHealth Platform Realm: BE Computable Name: BeOrganization

Belgian federal profile for an organization. Initially based on the functional description of the NIHDI.

Usage:

Formal Views of Profile Content

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

This structure is derived from Organization

Summary

Mandatory: 0 element (10 nested mandatory elements)
Must-Support: 1 element
Fixed Value: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the value of value:system
  • The element Organization.type is sliced based on the value of value:coding.system

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationA grouping of people or organizations with a common purpose
... Slices for identifier S0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:NIHDI 0..*IdentifierIdentifies this organization across multiple systems
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi
..... value 1..1stringThe value that is unique
.... identifier:CBE 0..*IdentifierIdentifies this organization across multiple systems
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/cbe
..... value 1..1stringThe value that is unique
.... identifier:SSIN 0..*IdentifierIdentifies this organization across multiple systems
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
..... value 1..1stringThe value that is unique
.... identifier:EHP 0..*IdentifierIdentifies this organization across multiple systems
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ehp
..... value 1..1stringThe value that is unique
... active 0..1booleanWhether the organization's record is still in active use
... Slices for type 0..*CodeableConceptKind of organization
Slice: Unordered, Open by value:coding.system
.... type:CD-HCPARTY 0..*CodeableConceptKind of organization
..... coding
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty
...... code 1..1codeSymbol in syntax defined by the system
... address 0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣI0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:NIHDI ΣI0..*IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CBE ΣI0..*IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/cbe
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:SSIN ΣI0..*IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:EHP ΣI0..*IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ehp
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... Slices for type Σ0..*CodeableConceptKind of organization
Slice: Unordered, Open by value:coding.system
Binding: OrganizationType (example): Used to categorize the organization.


.... type:CD-HCPARTY Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... name ΣI0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
... address I0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
... identifier ΣI0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system

doco Documentation for this format

This structure is derived from Organization

Summary

Mandatory: 0 element (10 nested mandatory elements)
Must-Support: 1 element
Fixed Value: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the value of value:system
  • The element Organization.type is sliced based on the value of value:coding.system

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*OrganizationA grouping of people or organizations with a common purpose
... Slices for identifier S0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:NIHDI 0..*IdentifierIdentifies this organization across multiple systems
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi
..... value 1..1stringThe value that is unique
.... identifier:CBE 0..*IdentifierIdentifies this organization across multiple systems
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/cbe
..... value 1..1stringThe value that is unique
.... identifier:SSIN 0..*IdentifierIdentifies this organization across multiple systems
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
..... value 1..1stringThe value that is unique
.... identifier:EHP 0..*IdentifierIdentifies this organization across multiple systems
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ehp
..... value 1..1stringThe value that is unique
... active 0..1booleanWhether the organization's record is still in active use
... Slices for type 0..*CodeableConceptKind of organization
Slice: Unordered, Open by value:coding.system
.... type:CD-HCPARTY 0..*CodeableConceptKind of organization
..... coding
...... system 1..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty
...... code 1..1codeSymbol in syntax defined by the system
... address 0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationA grouping of people or organizations with a common purpose
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣI0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:NIHDI ΣI0..*IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:CBE ΣI0..*IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/cbe
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:SSIN ΣI0..*IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:EHP ΣI0..*IdentifierIdentifies this organization across multiple systems
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ehp
..... value Σ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... Slices for type Σ0..*CodeableConceptKind of organization
Slice: Unordered, Open by value:coding.system
Binding: OrganizationType (example): Used to categorize the organization.


.... type:CD-HCPARTY Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example): Used to categorize the organization.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... name ΣI0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
... address I0..*BeAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Organization.languagepreferredCommonLanguages
Max Binding: AllLanguages
Organization.identifier:NIHDI.userequiredIdentifierUse
Organization.identifier:NIHDI.typeextensibleIdentifier Type Codes
Organization.identifier:CBE.userequiredIdentifierUse
Organization.identifier:CBE.typeextensibleIdentifier Type Codes
Organization.identifier:SSIN.userequiredIdentifierUse
Organization.identifier:SSIN.typeextensibleIdentifier Type Codes
Organization.identifier:EHP.userequiredIdentifierUse
Organization.identifier:EHP.typeextensibleIdentifier Type Codes
Organization.typeexampleOrganizationType
Organization.type:CD-HCPARTYexampleOrganizationType
Organization.contact.purposeextensibleContactEntityType