Swedish Base Profiles Implementation Guide
1.1.0 - release
Swedish Base Profiles Implementation Guide, published by HL7 Sweden. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7Sweden/basprofiler-r4/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.se/fhir/ig/base/StructureDefinition/SEBaseOrganization | Version: 1.1.0 | |||
| Active as of 2025-11-17 | Computable Name: SEBaseOrganization | |||
This is the base Organization profile to be used when profiling on Organization in a Swedish context
There are currently different ways of representing the master source of the HSA identifier. HSA identifiers are used to identify a number of different kinds of objects, such as people, organisations and assigments. Each of these object types have their own OID, but that OID does not uniquely scope the identifier part, but the entire object. The OID chosen in the Swedish base profiles is the one referring to the identifiers as a whole, no matter what object class they represent. Unfortunately, this will lead to cases where the OID used here will differ from the OID used in other formal specifications.
This can be very important to keep in mind for implementors that get their HSA-ids from different sources and use them in different interactions.
The business category of an organization is represented using a HealthcareService instance which makes a providedBy reference to the organization instance. The HealthcareService.category element provides a way to code the business category of the referenced organization. As these HealthcareService instances is only used in the context of an Organization, this HealthcareService instance would preferrably be inline.
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: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Identifies this organization across multiple systems |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description 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. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Identifies this organization across multiple systems |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description 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. Fixed Value: As shown (Organization identifier) |
![]() ![]() ![]() ![]() ![]() |
0..0 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: XX | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..0 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97 |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() |
Σ | 0..* | CodeableConcept | Kind of organization Binding: SE ValueSet for organization types (extensible) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.identifier:hsaid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:hsaid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:organizationIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:organizationIdentifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.type | Base | extensible | SE ValueSet for organization types | 📦1.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Organization | A grouping of people or organizations with a common purpose | |
![]() ![]() |
0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
0..1 | Identifier | Identifies this organization across multiple systems | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 | |
![]() ![]() ![]() |
0..1 | Identifier | Identifies this organization across multiple systems | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Fixed Value: As shown (Organization identifier) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: XX | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97 | |
![]() ![]() |
0..* | CodeableConcept | Kind of organization Binding: SE ValueSet for organization types (extensible) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | extensible | SE ValueSet for organization types | 📦1.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Identifies this organization across multiple systems | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description 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. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Identifies this organization across multiple systems | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description 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. Fixed Value: As shown (Organization identifier) | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: XX | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Kind of organization Binding: SE ValueSet for organization types (extensible) | ||||
![]() ![]() |
ΣC | 0..1 | string | Name used for the organization | ||||
![]() ![]() |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
![]() ![]() |
C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
![]() ![]() |
C | 0..* | Address | An address for the organization Constraints: org-2 | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Organization.identifier:hsaid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:hsaid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:organizationIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:organizationIdentifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.type | Base | extensible | SE ValueSet for organization types | 📦1.1.0 | This IG |
| Organization.contact.purpose | Base | extensible | Contact entity type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 2 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Identifies this organization across multiple systems |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description 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. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Identifies this organization across multiple systems |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description 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. Fixed Value: As shown (Organization identifier) |
![]() ![]() ![]() ![]() ![]() |
0..0 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: XX | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() |
0..0 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97 |
![]() ![]() |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
![]() ![]() |
Σ | 0..* | CodeableConcept | Kind of organization Binding: SE ValueSet for organization types (extensible) |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.identifier:hsaid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:hsaid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:organizationIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:organizationIdentifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.type | Base | extensible | SE ValueSet for organization types | 📦1.1.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Organization | A grouping of people or organizations with a common purpose | |
![]() ![]() |
0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | |
![]() ![]() ![]() |
0..1 | Identifier | Identifies this organization across multiple systems | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 | |
![]() ![]() ![]() |
0..1 | Identifier | Identifies this organization across multiple systems | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Fixed Value: As shown (Organization identifier) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: XX | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97 | |
![]() ![]() |
0..* | CodeableConcept | Kind of organization Binding: SE ValueSet for organization types (extensible) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.type | Base | extensible | SE ValueSet for organization types | 📦1.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | Organization | A grouping of people or organizations with a common purpose Constraints: org-1 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
ΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Identifies this organization across multiple systems | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description 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. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Identifies this organization across multiple systems | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description 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. Fixed Value: As shown (Organization identifier) | ||||
![]() ![]() ![]() ![]() ![]() |
0..0 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: XX | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.5.4.97 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Kind of organization Binding: SE ValueSet for organization types (extensible) | ||||
![]() ![]() |
ΣC | 0..1 | string | Name used for the organization | ||||
![]() ![]() |
0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
![]() ![]() |
C | 0..* | ContactPoint | A contact detail for the organization Constraints: org-3 | ||||
![]() ![]() |
C | 0..* | Address | An address for the organization Constraints: org-2 | ||||
![]() ![]() |
Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part | ||||
![]() ![]() |
0..* | BackboneElement | Contact for the organization for a certain purpose | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact | |||||
![]() ![]() ![]() |
0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |||||
![]() ![]() ![]() |
0..1 | Address | Visiting or postal addresses for the contact | |||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Organization.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Organization.identifier:hsaid.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:hsaid.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.identifier:organizationIdentifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Organization.identifier:organizationIdentifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Organization.type | Base | extensible | SE ValueSet for organization types | 📦1.1.0 | This IG |
| Organization.contact.purpose | Base | extensible | Contact entity type | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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
Summary
Mandatory: 0 element(2 nested mandatory elements)
Fixed: 2 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron