HL7 Belgium FHIR specifications
0.1 - QA review

This page is part of the HL7 Belgium FHIR Specifications (v2020May: QA Preview) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

StructureDefinition: BeOrganization

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

The official URL for this profile is: 

https://www.ehealth.fgov.be/standards/fhir/StructureDefinition/be-organization

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 (5 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
... identifier S0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:NIHDI 0..*IdentifierIdentifies this organization across multiple systems
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/nihdi
..... value 1..1stringThe value that is unique
.... identifier:CBE 0..*IdentifierIdentifies this organization across multiple systems
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/cbe
..... value 1..1stringThe value that is unique
.... identifier:SSIN 0..*IdentifierIdentifies this organization across multiple systems
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value 1..1stringThe value that is unique
.... identifier:EHP 0..*IdentifierIdentifies this organization across multiple systems
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ehp
..... value 1..1stringThe value that is unique
... active 0..1booleanWhether the organization's record is still in active use
... type 0..*(Slice Definition)Kind of organization
Slice: Unordered, Open by value:coding.system
.... type:CD-HCPARTY 0..*CodeableConceptKind of organization
​..... coding
...... system 0..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/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 ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*(Slice Definition)Identifies 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 I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/nihdi
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..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 I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/cbe
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..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 I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..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 I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ehp
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether the organization's record is still in active use
... type ΣI0..*(Slice Definition)Kind of organization
Slice: Unordered, Open by value:coding.system
Binding: OrganizationType (example)
.... type:CD-HCPARTY ΣI0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/CodeSystem/cd-hcparty
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
... name ΣI0..1stringName used for the organization
... alias I0..*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 ΣI0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose I0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name I0..1HumanNameA name associated with the contact
.... telecom I0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address I0..1AddressVisiting or postal addresses for the contact
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

This structure is derived from Organization

Summary

Mandatory: 0 element (5 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
... identifier S0..*(Slice Definition)Identifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:NIHDI 0..*IdentifierIdentifies this organization across multiple systems
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/nihdi
..... value 1..1stringThe value that is unique
.... identifier:CBE 0..*IdentifierIdentifies this organization across multiple systems
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/cbe
..... value 1..1stringThe value that is unique
.... identifier:SSIN 0..*IdentifierIdentifies this organization across multiple systems
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value 1..1stringThe value that is unique
.... identifier:EHP 0..*IdentifierIdentifies this organization across multiple systems
..... system 0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ehp
..... value 1..1stringThe value that is unique
... active 0..1booleanWhether the organization's record is still in active use
... type 0..*(Slice Definition)Kind of organization
Slice: Unordered, Open by value:coding.system
.... type:CD-HCPARTY 0..*CodeableConceptKind of organization
​..... coding
...... system 0..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/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 ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI0..*(Slice Definition)Identifies 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 I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/nihdi
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..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 I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/cbe
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..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 I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ssin
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..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 I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system ΣI0..1uriThe namespace for the identifier value
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/NamingSystem/ehp
..... value ΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!ΣI0..1booleanWhether the organization's record is still in active use
... type ΣI0..*(Slice Definition)Kind of organization
Slice: Unordered, Open by value:coding.system
Binding: OrganizationType (example)
.... type:CD-HCPARTY ΣI0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI0..1uriIdentity of the terminology system
Fixed Value: https://www.ehealth.fgov.be/standards/fhir/CodeSystem/cd-hcparty
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI1..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... text ΣI0..1stringPlain text representation of the concept
... name ΣI0..1stringName used for the organization
... alias I0..*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 ΣI0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose I0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name I0..1HumanNameA name associated with the contact
.... telecom I0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address I0..1AddressVisiting or postal addresses for the contact
... endpoint I0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

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

Constraints

Constraints

IdPathDetailsRequirements