Common FHIR profile vendor collaboration
1.0.0 - release
Common FHIR profile vendor collaboration
1.0.0 - release
This page is part of the Common FHIR profile vendor collaboration (v1.0.0: Release) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Official URL: https://commonprofiles.care/fhir/StructureDefinition/OrganizationSEVendorLite | Version: 1.0.0 | |||
| Active as of 2023-03-17 | Computable Name: OrganizationSEVendorLite | |||
This is a light weight Swedish Organization profile. It can be used when Organizations have been referenced by other resources, such as Observation, ServiceRequest or Appointment. It can also be used for presenting a list of organizations with associated information.
To define a small lightweight Organization resource for the primary use case of being included as referenced/contained from other resources. This will allow applications to display the most fundamental organization information like name and business identifier together with other resources like a ServiceRequest or an Observation. When fetching such resources, the referenced Organization resource can be included using this profile. The profile can be used for healthcare organizations, often identified using hsa id, but also non-healthcare organizations, often identified using organization id.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SEBaseOrganization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | 0..* | SEBaseOrganization | A grouping of people or organizations with a common purpose | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 hsaHierarchy | S | 0..* | (Complex) | HSA Hierarchy URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy |
 identifier | S | 0..* | Identifier | Identifies this organization across multiple systems |
 identifier:hsaid | S | 0..1 | Identifier | This slice should be used if the organization has a HSA id. HSA id is an official identifier for healthcare organizations and practitioners in Sweden. |
  system | S | 1..1 | uri | URI for objects (e.g. organizations or practitioners) in the HSA catalog. |
 value | S | 1..1 | string | HSA id. |
| identifier:organizationIdentifier | S | 0..1 | Identifier | Organization id |
| system | S | 1..1 | uri | URI for Swedish organization number. |
| value | S | 1..1 | string | Swedish organization id. |
 Slices for type | S | 0..* | CodeableConcept | Kind of organization Slice: Unordered, Open by value:coding.code |
 type:careUnit | S | 0..1 | CodeableConcept | Kind of organization |
  coding | S | 1..1 | Coding | Code defined by a terminology system |
 system | S | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
| version | S | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 |
 code | S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 43741000 |
 type:careProvider | S | 0..1 | CodeableConcept | Kind of organization |
| coding | S | 1..1 | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
| version | S | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 |
| code | S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 143591000052106 |
| name | S | 1..1 | string | Name used for the organization |
| telecom | S | 0..* | ContactPoint | A contact detail for the organization |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 1..1 | string | The actual contact point details |
 address | S | 0..* | Address | An address for the organization |
| line | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| careOf | S | 0..* | string | careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf |
| streetAddressLine | S | 0..* | string | streetAddressLine URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | SEBaseOrganization | A grouping of people or organizations with a common purpose |
 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 | |
| hsaHierarchy | S | 0..* | (Complex) | HSA Hierarchy URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
| identifier:hsaid | SΣC | 0..1 | Identifier | This slice should be used if the organization has a HSA id. HSA id is an official identifier for healthcare organizations and practitioners in Sweden. |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 1..1 | uri | URI for objects (e.g. organizations or practitioners) in the HSA catalog. Fixed Value: urn:oid:1.2.752.29.4.19 |
| value | SΣ | 1..1 | string | HSA id. Example General: 123456 |
| identifier:organizationIdentifier | SΣC | 0..1 | Identifier | Organization id |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 1..1 | uri | URI for Swedish organization number. Fixed Value: urn:oid:2.5.4.97 |
| value | SΣ | 1..1 | string | Swedish organization id. Example General: 123456 |
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| Slices for type | SΣ | 0..* | CodeableConcept | Kind of organization Slice: Unordered, Open by value:coding.code Binding: SEBaseHSAVerksamhetVS (extensible) |
| type:careUnit | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: SEBaseHSAVerksamhetVS (extensible) |
 coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
| system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
| version | SΣ | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 43741000 |
| type:careProvider | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: SEBaseHSAVerksamhetVS (extensible) |
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
| system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
| version | SΣ | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 143591000052106 |
| name | SΣC | 1..1 | string | Name used for the organization |
| telecom | SC | 0..* | ContactPoint | A contact detail for the organization |
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| address | SC | 0..* | Address | An address for the organization |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| careOf | S | 0..* | string | careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf |
| streetAddressLine | S | 0..* | string | streetAddressLine URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organization.identifier:hsaid.use | required | IdentifierUse |
| Organization.identifier:organizationIdentifier.use | required | IdentifierUse |
| Organization.type | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) |
| Organization.type:careUnit | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) |
| Organization.type:careProvider | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) |
| Organization.telecom.system | required | ContactPointSystem |
| Organization.telecom.use | required | ContactPointUse |
| Organization.address.use | required | AddressUse |
| 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() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization | C | 0..* | SEBaseOrganization | A grouping of people or organizations with a common purpose | ||||
| 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 | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| hsaHierarchy | S | 0..* | (Complex) | HSA Hierarchy URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | ||||
| identifier:hsaid | SΣC | 0..1 | Identifier | This slice should be used if the organization has a HSA id. HSA id is an official identifier for healthcare organizations and practitioners in Sweden. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
 type | Σ | 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 (Provider number) | ||||
  id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..0 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |||||
| display | 0..0 | string | Representation defined by the system | |||||
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..0 | string | Plain text representation of the concept | |||||
| system | SΣ | 1..1 | uri | URI for objects (e.g. organizations or practitioners) in the HSA catalog. Fixed Value: urn:oid:1.2.752.29.4.19 | ||||
| value | SΣ | 1..1 | string | HSA id. Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:organizationIdentifier | SΣC | 0..1 | Identifier | Organization id | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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) | ||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..0 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: XX | |||||
| display | 0..0 | string | Representation defined by the system | |||||
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..0 | string | Plain text representation of the concept | |||||
| system | SΣ | 1..1 | uri | URI for Swedish organization number. Fixed Value: urn:oid:2.5.4.97 | ||||
| value | SΣ | 1..1 | string | Swedish organization id. Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
| Slices for type | SΣ | 0..* | CodeableConcept | Kind of organization Slice: Unordered, Open by value:coding.code Binding: SEBaseHSAVerksamhetVS (extensible) | ||||
| type:careUnit | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: SEBaseHSAVerksamhetVS (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
| version | SΣ | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 43741000 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| type:careProvider | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: SEBaseHSAVerksamhetVS (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
| version | SΣ | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 143591000052106 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| name | SΣC | 1..1 | string | Name used for the organization | ||||
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| telecom | SC | 0..* | ContactPoint | A contact detail for the organization | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address | SC | 0..* | Address | An address for the organization | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| careOf | S | 0..* | string | careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf | ||||
| streetAddressLine | S | 0..* | string | streetAddressLine URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine | ||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| 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 / Code | ||||
| Organization.language | preferred | CommonLanguages
| ||||
| Organization.identifier:hsaid.use | required | IdentifierUse | ||||
| Organization.identifier:hsaid.type | extensible | Fixed Value: PRN | ||||
| Organization.identifier:organizationIdentifier.use | required | IdentifierUse | ||||
| Organization.identifier:organizationIdentifier.type | extensible | Fixed Value: XX | ||||
| Organization.type | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) | ||||
| Organization.type:careUnit | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) | ||||
| Organization.type:careProvider | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) | ||||
| Organization.telecom.system | required | ContactPointSystem | ||||
| Organization.telecom.use | required | ContactPointUse | ||||
| Organization.address.use | required | AddressUse | ||||
| Organization.address.type | required | AddressType | ||||
| Organization.contact.purpose | extensible | ContactEntityType |
| Id | Grade | Path(s) | Details | Requirements |
| 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-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 SEBaseOrganization
Summary
Mandatory: 1 element (12 nested mandatory elements)
Must-Support: 26 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from SEBaseOrganization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | 0..* | SEBaseOrganization | A grouping of people or organizations with a common purpose | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| hsaHierarchy | S | 0..* | (Complex) | HSA Hierarchy URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy |
| identifier | S | 0..* | Identifier | Identifies this organization across multiple systems |
| identifier:hsaid | S | 0..1 | Identifier | This slice should be used if the organization has a HSA id. HSA id is an official identifier for healthcare organizations and practitioners in Sweden. |
| system | S | 1..1 | uri | URI for objects (e.g. organizations or practitioners) in the HSA catalog. |
| value | S | 1..1 | string | HSA id. |
| identifier:organizationIdentifier | S | 0..1 | Identifier | Organization id |
| system | S | 1..1 | uri | URI for Swedish organization number. |
| value | S | 1..1 | string | Swedish organization id. |
| Slices for type | S | 0..* | CodeableConcept | Kind of organization Slice: Unordered, Open by value:coding.code |
| type:careUnit | S | 0..1 | CodeableConcept | Kind of organization |
| coding | S | 1..1 | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
| version | S | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 |
| code | S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 43741000 |
| type:careProvider | S | 0..1 | CodeableConcept | Kind of organization |
| coding | S | 1..1 | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
| version | S | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 |
| code | S | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 143591000052106 |
| name | S | 1..1 | string | Name used for the organization |
| telecom | S | 0..* | ContactPoint | A contact detail for the organization |
| system | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 1..1 | string | The actual contact point details |
| address | S | 0..* | Address | An address for the organization |
| line | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| careOf | S | 0..* | string | careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf |
| streetAddressLine | S | 0..* | string | streetAddressLine URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | SEBaseOrganization | A grouping of people or organizations with a common purpose |
| 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 | |
| hsaHierarchy | S | 0..* | (Complex) | HSA Hierarchy URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system |
| identifier:hsaid | SΣC | 0..1 | Identifier | This slice should be used if the organization has a HSA id. HSA id is an official identifier for healthcare organizations and practitioners in Sweden. |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 1..1 | uri | URI for objects (e.g. organizations or practitioners) in the HSA catalog. Fixed Value: urn:oid:1.2.752.29.4.19 |
| value | SΣ | 1..1 | string | HSA id. Example General: 123456 |
| identifier:organizationIdentifier | SΣC | 0..1 | Identifier | Organization id |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 1..1 | uri | URI for Swedish organization number. Fixed Value: urn:oid:2.5.4.97 |
| value | SΣ | 1..1 | string | Swedish organization id. Example General: 123456 |
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use |
| Slices for type | SΣ | 0..* | CodeableConcept | Kind of organization Slice: Unordered, Open by value:coding.code Binding: SEBaseHSAVerksamhetVS (extensible) |
| type:careUnit | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: SEBaseHSAVerksamhetVS (extensible) |
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
| system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
| version | SΣ | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 43741000 |
| type:careProvider | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: SEBaseHSAVerksamhetVS (extensible) |
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
| system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct |
| version | SΣ | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 143591000052106 |
| name | SΣC | 1..1 | string | Name used for the organization |
| telecom | SC | 0..* | ContactPoint | A contact detail for the organization |
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 1..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| address | SC | 0..* | Address | An address for the organization |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| careOf | S | 0..* | string | careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf |
| streetAddressLine | S | 0..* | string | streetAddressLine URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organization.identifier:hsaid.use | required | IdentifierUse |
| Organization.identifier:organizationIdentifier.use | required | IdentifierUse |
| Organization.type | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) |
| Organization.type:careUnit | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) |
| Organization.type:careProvider | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) |
| Organization.telecom.system | required | ContactPointSystem |
| Organization.telecom.use | required | ContactPointUse |
| Organization.address.use | required | AddressUse |
| 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() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization | C | 0..* | SEBaseOrganization | A grouping of people or organizations with a common purpose | ||||
| 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 | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| hsaHierarchy | S | 0..* | (Complex) | HSA Hierarchy URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣC | 0..* | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | ||||
| identifier:hsaid | SΣC | 0..1 | Identifier | This slice should be used if the organization has a HSA id. HSA id is an official identifier for healthcare organizations and practitioners in Sweden. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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 (Provider number) | ||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..0 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN | |||||
| display | 0..0 | string | Representation defined by the system | |||||
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..0 | string | Plain text representation of the concept | |||||
| system | SΣ | 1..1 | uri | URI for objects (e.g. organizations or practitioners) in the HSA catalog. Fixed Value: urn:oid:1.2.752.29.4.19 | ||||
| value | SΣ | 1..1 | string | HSA id. Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:organizationIdentifier | SΣC | 0..1 | Identifier | Organization id | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 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) | ||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| coding | 1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..0 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||
| version | 0..0 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: XX | |||||
| display | 0..0 | string | Representation defined by the system | |||||
| userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..0 | string | Plain text representation of the concept | |||||
| system | SΣ | 1..1 | uri | URI for Swedish organization number. Fixed Value: urn:oid:2.5.4.97 | ||||
| value | SΣ | 1..1 | string | Swedish organization id. Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| active | ?!Σ | 0..1 | boolean | Whether the organization's record is still in active use | ||||
| Slices for type | SΣ | 0..* | CodeableConcept | Kind of organization Slice: Unordered, Open by value:coding.code Binding: SEBaseHSAVerksamhetVS (extensible) | ||||
| type:careUnit | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: SEBaseHSAVerksamhetVS (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
| version | SΣ | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 43741000 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| type:careProvider | SΣ | 0..1 | CodeableConcept | Kind of organization Binding: SEBaseHSAVerksamhetVS (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
| version | SΣ | 1..1 | string | Version of the system - if relevant Required Pattern: http://snomed.info/sct/45991000052106/version/20220531 | ||||
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Required Pattern: 143591000052106 | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| name | SΣC | 1..1 | string | Name used for the organization | ||||
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
| telecom | SC | 0..* | ContactPoint | A contact detail for the organization | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 1..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address | SC | 0..* | Address | An address for the organization | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| careOf | S | 0..* | string | careOf URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf | ||||
| streetAddressLine | S | 0..* | string | streetAddressLine URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine | ||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) | ||||
| postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| 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 / Code | ||||
| Organization.language | preferred | CommonLanguages
| ||||
| Organization.identifier:hsaid.use | required | IdentifierUse | ||||
| Organization.identifier:hsaid.type | extensible | Fixed Value: PRN | ||||
| Organization.identifier:organizationIdentifier.use | required | IdentifierUse | ||||
| Organization.identifier:organizationIdentifier.type | extensible | Fixed Value: XX | ||||
| Organization.type | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) | ||||
| Organization.type:careUnit | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) | ||||
| Organization.type:careProvider | extensible | SEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3) | ||||
| Organization.telecom.system | required | ContactPointSystem | ||||
| Organization.telecom.use | required | ContactPointUse | ||||
| Organization.address.use | required | AddressUse | ||||
| Organization.address.type | required | AddressType | ||||
| Organization.contact.purpose | extensible | ContactEntityType |
| Id | Grade | Path(s) | Details | Requirements |
| 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-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 SEBaseOrganization
Summary
Mandatory: 1 element (12 nested mandatory elements)
Must-Support: 26 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron