HL7 Europe Base Profiles
0.0.1-ci - ci-build 150

HL7 Europe Base Profiles, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.0.1-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/base/ and changes regularly. See the Directory of published versions

Resource Profile: Organization (EU base)

Official URL: http://hl7.eu/fhir/base/StructureDefinition/organization-eu Version: 0.0.1-ci
Standards status: Draft Maturity Level: 1 Computable Name: OrganizationEu

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

This profile specifies how the HL7 FHIR Organization resource should be used for conveying commonly used concepts in the European context.

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 C 0..* Organization A grouping of people or organizations with a common purpose
name-or-identier: identifier or name SHALL be present
... type 0..* CodeableConcept Organization type
... name 0..1 string Name of the organization
... telecom 0..* ContactPoint Organization telecom
... partOf 0..1 Reference(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN
... contact 0..* BackboneElement Organization contact infos

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
name-or-identiererrorOrganizationidentifier or name SHALL be present
: .identifier.exists() or name.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
name-or-identier: identifier or name SHALL be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
ele-1: All FHIR elements must have a @value or children
... name ΣC 0..1 string Name of the organization
ele-1: All FHIR elements must have a @value or children
... telecom C 0..* ContactPoint Organization telecom
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
... address C 0..* AddressEu An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
... partOf Σ 0..1 Reference(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN
ele-1: All FHIR elements must have a @value or children
... contact 0..* BackboneElement Organization contact infos
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
name-or-identiererrorOrganizationidentifier or name SHALL be present
: .identifier.exists() or name.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
name-or-identier: identifier or name SHALL be present
... 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 ΣC 0..* Identifier Identifies this organization across multiple systems
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... type Σ 0..* CodeableConcept Organization type
Binding: OrganizationType (example): Used to categorize the organization.


... name ΣC 0..1 string Name of the organization
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom C 0..* ContactPoint Organization telecom
org-3: The telecom of an organization can never be of use 'home'
... address C 0..* AddressEu An address expressed using postal conventions (as opposed to GPS or other location definition formats)
org-2: An address of an organization can never be of use 'home'
... partOf Σ 0..1 Reference(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN
... contact 0..* BackboneElement Organization contact infos
.... 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
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1 HumanName A name associated with the contact
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address 0..1 Address Visiting 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

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
name-or-identiererrorOrganizationidentifier or name SHALL be present
: .identifier.exists() or name.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
name-or-identier: identifier or name SHALL be present
... type 0..* CodeableConcept Organization type
... name 0..1 string Name of the organization
... telecom 0..* ContactPoint Organization telecom
... partOf 0..1 Reference(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN
... contact 0..* BackboneElement Organization contact infos

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
name-or-identiererrorOrganizationidentifier or name SHALL be present
: .identifier.exists() or name.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
name-or-identier: identifier or name SHALL be present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
ele-1: All FHIR elements must have a @value or children
... name ΣC 0..1 string Name of the organization
ele-1: All FHIR elements must have a @value or children
... telecom C 0..* ContactPoint Organization telecom
ele-1: All FHIR elements must have a @value or children
org-3: The telecom of an organization can never be of use 'home'
... address C 0..* AddressEu An address expressed using postal conventions (as opposed to GPS or other location definition formats)
ele-1: All FHIR elements must have a @value or children
org-2: An address of an organization can never be of use 'home'
... partOf Σ 0..1 Reference(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN
ele-1: All FHIR elements must have a @value or children
... contact 0..* BackboneElement Organization contact infos
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
name-or-identiererrorOrganizationidentifier or name SHALL be present
: .identifier.exists() or name.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
org-1: The organization SHALL at least have a name or an identifier, and possibly more than one
name-or-identier: identifier or name SHALL be present
... 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 ΣC 0..* Identifier Identifies this organization across multiple systems
... active ?!Σ 0..1 boolean Whether the organization's record is still in active use
... type Σ 0..* CodeableConcept Organization type
Binding: OrganizationType (example): Used to categorize the organization.


... name ΣC 0..1 string Name of the organization
... alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
... telecom C 0..* ContactPoint Organization telecom
org-3: The telecom of an organization can never be of use 'home'
... address C 0..* AddressEu An address expressed using postal conventions (as opposed to GPS or other location definition formats)
org-2: An address of an organization can never be of use 'home'
... partOf Σ 0..1 Reference(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN
... contact 0..* BackboneElement Organization contact infos
.... 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
.... purpose 0..1 CodeableConcept The type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1 HumanName A name associated with the contact
.... telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
.... address 0..1 Address Visiting 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

Terminology Bindings

PathConformanceValueSetURI
Organization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Organization.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
from the FHIR Standard
Organization.contact.purposeextensibleContactEntityType
http://hl7.org/fhir/ValueSet/contactentity-type
from the FHIR Standard

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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
name-or-identiererrorOrganizationidentifier or name SHALL be present
: .identifier.exists() or name.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

 

Other representations of profile: CSV, Excel, Schematron