ITB Implementation Guide
0.1.0 - Release Label
ITB Implementation Guide
0.1.0 - Release Label
ITB Implementation Guide, published by . This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/espen-servicewell/wof-portal-fhir-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://portal.wof.purified.link/fhir/StructureDefinition/ClinicalOrganization | Version: 0.1.0 | |||
| Draft as of 2025-08-20 | Computable Name: ClinicalOrganization | |||
This resource can be used to handle clinical organizations
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 |
  id |
SΣ | 0..1 | id | Logical id of this artifact |
  meta |
Σ | 0..1 | Meta | Metadata about the resource |
 lastUpdated |
SΣ | 0..1 | instant | When the resource version last changed |
 profile |
SΣ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  extension:ExtCreated |
S | 0..1 | dateTime | Portal Created Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extCreated |
| extension:ExtNameAsCode |
S | 0..1 | string | Name as code Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extNameAsCode |
| extension:ExtTenantIdenfier |
S | 0..1 | string | Tenant Identifier Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extTenantIdenfier |
 extension:ExtAttachment |
S | 0..1 | (Complex) | Attachment Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extAttachment |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| name |
SΣC | 0..1 | string | A name associated with the Clinical Organization |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 : 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-4 | error | Organization | If 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 | ||||
| id |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
SΣ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
SΣ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ExtCreated |
S | 0..1 | dateTime | Portal Created Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extCreated | ||||
| extension:ExtNameAsCode |
S | 0..1 | string | Name as code Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extNameAsCode | ||||
| extension:ExtTenantIdenfier |
S | 0..1 | string | Tenant Identifier Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extTenantIdenfier | ||||
| extension:ExtAttachment |
S | 0..1 | (Complex) | Attachment Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extAttachment | ||||
| 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 | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
| name |
SΣC | 0..1 | string | A name associated with the Clinical 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 | A contact detail for the organization Constraints: org-3 | ||||
| address |
C | 0..* | Address | An address for the organization Constraints: org-2 | ||||
 partOf |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
| contact |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Organization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Organization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typeFrom the FHIR Standard | ||||
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typeFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 : 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-4 | error | Organization | If 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from Organization
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 |
| id |
SΣ | 0..1 | id | Logical id of this artifact |
| meta |
Σ | 0..1 | Meta | Metadata about the resource |
| lastUpdated |
SΣ | 0..1 | instant | When the resource version last changed |
| profile |
SΣ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:ExtCreated |
S | 0..1 | dateTime | Portal Created Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extCreated |
| extension:ExtNameAsCode |
S | 0..1 | string | Name as code Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extNameAsCode |
| extension:ExtTenantIdenfier |
S | 0..1 | string | Tenant Identifier Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extTenantIdenfier |
| extension:ExtAttachment |
S | 0..1 | (Complex) | Attachment Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extAttachment |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| active |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| name |
SΣC | 0..1 | string | A name associated with the Clinical Organization |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 : 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-4 | error | Organization | If 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 |
Differential View
This structure is derived from Organization
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Organization |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 | ||||
| id |
SΣ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
SΣ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
SΣ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:ExtCreated |
S | 0..1 | dateTime | Portal Created Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extCreated | ||||
| extension:ExtNameAsCode |
S | 0..1 | string | Name as code Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extNameAsCode | ||||
| extension:ExtTenantIdenfier |
S | 0..1 | string | Tenant Identifier Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extTenantIdenfier | ||||
| extension:ExtAttachment |
S | 0..1 | (Complex) | Attachment Extension URL: http://portal.wof.purified.link/fhir/StructureDefinition/extAttachment | ||||
| 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 | Kind of organization Binding: OrganizationType (example): Used to categorize the organization. | ||||
| name |
SΣC | 0..1 | string | A name associated with the Clinical 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 | A contact detail for the organization Constraints: org-3 | ||||
| address |
C | 0..* | Address | An address for the organization Constraints: org-2 | ||||
| partOf |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
| contact |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
| 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 | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Organization.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Organization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typeFrom the FHIR Standard | ||||
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typeFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Organization | 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 : 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-4 | error | Organization | If 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-5 | error | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| org-2 | error | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-3 | error | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() |
This structure is derived from Organization
Other representations of profile: CSV, Excel, Schematron
