HL7 Europe Base and Core FHIR IG
0.1.0-ballotRecon - ci-build 150

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

Resource Profile: Organization (EU base)

Official URL: http://hl7.eu/fhir/base-r5/StructureDefinition/organization-eu Version: 0.1.0-ballotRecon
Standards status: Draft Maturity Level: 2 Computable Name: OrganizationEu

Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1, name-or-identifier
... 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
... 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
... contact C 0..* ExtendedContactDetail Organization contact infos
Constraints: org-3, org-4
.... telecom Σ 0..* ContactPoint Organization telecom
.... address Σ 0..1 AddressEu Address for the contact
... partOf Σ 0..1 Reference(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN

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().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()
name-or-identifiererrorOrganizationidentifier 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-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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: name-or-identifier
... identifier 0..* Identifier Organization business identifier
... type 0..* CodeableConcept Organization type
... name 0..1 string Name of the organization
.... telecom 0..* ContactPoint Organization telecom
.... address 0..1 AddressEu Address for the contact
... partOf 0..1 Reference(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
name-or-identifiererrorOrganizationidentifier or name SHALL be present
: identifier.exists() or name.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1, name-or-identifier
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 Organization business identifier
... 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
... 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 Organization contact infos
Constraints: org-3, org-4
.... 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 Organization telecom
.... address Σ 0..1 AddressEu Address for the contact
.... 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(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN
... 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 Description: (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.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
From the FHIR Standard
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()
name-or-identifiererrorOrganizationidentifier 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-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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1, name-or-identifier
... 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
... 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
... contact C 0..* ExtendedContactDetail Organization contact infos
Constraints: org-3, org-4
.... telecom Σ 0..* ContactPoint Organization telecom
.... address Σ 0..1 AddressEu Address for the contact
... partOf Σ 0..1 Reference(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN

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().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()
name-or-identifiererrorOrganizationidentifier 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-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()

Differential View

This structure is derived from Organization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: name-or-identifier
... identifier 0..* Identifier Organization business identifier
... type 0..* CodeableConcept Organization type
... name 0..1 string Name of the organization
.... telecom 0..* ContactPoint Organization telecom
.... address 0..1 AddressEu Address for the contact
... partOf 0..1 Reference(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN

doco Documentation for this format

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Organization C 0..* Organization A grouping of people or organizations with a common purpose
Constraints: org-1, name-or-identifier
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 Organization business identifier
... 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
... 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 Organization contact infos
Constraints: org-3, org-4
.... 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 Organization telecom
.... address Σ 0..1 AddressEu Address for the contact
.... 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(Organization (EU base)) The organization of which this organization is part of: e.g. an ERN
... 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 Description: (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.typeexampleOrganizationType
http://hl7.org/fhir/ValueSet/organization-type
From the FHIR Standard
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()
name-or-identifiererrorOrganizationidentifier 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-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()

 

Other representations of profile: CSV, Excel, Schematron