Common FHIR profile vendor collaboration

1.0.1 - update Sweden flag

This page is part of the Common FHIR profile vendor collaboration (v1.0.1: Release) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: OrganizationSEVendorLite

Official URL: https://commonprofiles.care/fhir/StructureDefinition/OrganizationSEVendorLite Version: 1.0.1
Active as of 2023-06-12 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:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from SEBaseOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*SEBaseOrganizationA grouping of people or organizations with a common purpose
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... hsaHierarchy S0..*(Complex)HSA Hierarchy
URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy
... identifier S0..*IdentifierIdentifies this organization across multiple systems
.... system S1..1uriURI for objects (e.g. organizations or practitioners) in the HSA catalog.
.... value S1..1stringHSA id.
... identifier:organizationIdentifier S0..1IdentifierOrganization id
.... system S1..1uriURI for Swedish organization number.
.... value SC1..1stringSwedish organization id.
organisationsnummer-invariant: All identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
... Slices for type S0..*CodeableConceptKind of organization
Slice: Unordered, Open by value:coding.code
.... type:careUnit S0..1CodeableConceptKind of organization
..... coding S1..1CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version S1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code S1..1codeSymbol in syntax defined by the system
Required Pattern: 43741000
.... type:careProvider S0..1CodeableConceptKind of organization
..... coding S1..1CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version S1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code S1..1codeSymbol in syntax defined by the system
Required Pattern: 143591000052106
... name S1..1stringName used for the organization
... telecom S0..*ContactPointA contact detail for the organization
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
... address S0..*AddressAn address for the organization
.... line
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... careOf S0..*stringcareOf
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
..... streetAddressLine S0..*stringstreetAddressLine
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
organisationsnummer-invarianterrorOrganization.identifier:organizationIdentifier.valueAll identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
: $this.toString().matches('\\d{10}')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*SEBaseOrganizationA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... hsaHierarchy S0..*(Complex)HSA Hierarchy
URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy
... Slices for identifier SΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:hsaid SΣC0..1IdentifierThis 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..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriURI for objects (e.g. organizations or practitioners) in the HSA catalog.
Fixed Value: urn:oid:1.2.752.29.4.19
..... value SΣ1..1stringHSA id.
Example General: 123456
.... identifier:organizationIdentifier SΣC0..1IdentifierOrganization id
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriURI for Swedish organization number.
Fixed Value: urn:oid:2.5.4.97
..... value SΣC1..1stringSwedish organization id.
organisationsnummer-invariant: All identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
Example General: 123456
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... Slices for type SΣ0..*CodeableConceptKind of organization
Slice: Unordered, Open by value:coding.code
Binding: SEBaseHSAVerksamhetVS (extensible)
.... type:careUnit SΣ0..1CodeableConceptKind of organization
Binding: SEBaseHSAVerksamhetVS (extensible)
..... coding SΣ1..1CodingCode defined by a terminology system
...... system SΣ1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version SΣ1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code SΣ1..1codeSymbol in syntax defined by the system
Required Pattern: 43741000
.... type:careProvider SΣ0..1CodeableConceptKind of organization
Binding: SEBaseHSAVerksamhetVS (extensible)
..... coding SΣ1..1CodingCode defined by a terminology system
...... system SΣ1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version SΣ1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code SΣ1..1codeSymbol in syntax defined by the system
Required Pattern: 143591000052106
... name SΣC1..1stringName used for the organization
... telecom SC0..*ContactPointA contact detail for the organization
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address SC0..*AddressAn address for the organization
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line Σ0..*stringStreet 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..*ExtensionExtension
Slice: Unordered, Open by value:url
..... careOf S0..*stringcareOf
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
..... streetAddressLine S0..*stringstreetAddressLine
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.identifier:hsaid.userequiredIdentifierUse
Organization.identifier:organizationIdentifier.userequiredIdentifierUse
Organization.typeextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.type:careUnitextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.type:careProviderextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
organisationsnummer-invarianterrorOrganization.identifier:organizationIdentifier.valueAll identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
: $this.toString().matches('\\d{10}')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*SEBaseOrganizationA grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... hsaHierarchy S0..*(Complex)HSA Hierarchy
URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:hsaid SΣC0..1IdentifierThis 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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)
...... id0..0stringUnique id for inter-element referencing
...... extension0..0ExtensionAdditional content defined by implementations
...... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..0stringUnique id for inter-element referencing
....... extension0..0ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..0stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
....... display0..0stringRepresentation defined by the system
....... userSelected0..0booleanIf this coding was chosen directly by the user
...... text0..0stringPlain text representation of the concept
..... system SΣ1..1uriURI for objects (e.g. organizations or practitioners) in the HSA catalog.
Fixed Value: urn:oid:1.2.752.29.4.19
..... value SΣ1..1stringHSA id.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:organizationIdentifier SΣC0..1IdentifierOrganization id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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)
...... id0..0stringUnique id for inter-element referencing
...... extension0..0ExtensionAdditional content defined by implementations
...... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..0stringUnique id for inter-element referencing
....... extension0..0ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..0stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: XX
....... display0..0stringRepresentation defined by the system
....... userSelected0..0booleanIf this coding was chosen directly by the user
...... text0..0stringPlain text representation of the concept
..... system SΣ1..1uriURI for Swedish organization number.
Fixed Value: urn:oid:2.5.4.97
..... value SΣC1..1stringSwedish organization id.
organisationsnummer-invariant: All identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... Slices for type SΣ0..*CodeableConceptKind of organization
Slice: Unordered, Open by value:coding.code
Binding: SEBaseHSAVerksamhetVS (extensible)
.... type:careUnit SΣ0..1CodeableConceptKind of organization
Binding: SEBaseHSAVerksamhetVS (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version SΣ1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code SΣ1..1codeSymbol in syntax defined by the system
Required Pattern: 43741000
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... type:careProvider SΣ0..1CodeableConceptKind of organization
Binding: SEBaseHSAVerksamhetVS (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version SΣ1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code SΣ1..1codeSymbol in syntax defined by the system
Required Pattern: 143591000052106
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... name SΣC1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SC0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address SC0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet 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..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... careOf S0..*stringcareOf
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
..... streetAddressLine S0..*stringstreetAddressLine
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:hsaid.userequiredIdentifierUse
Organization.identifier:hsaid.typeextensibleFixed Value: PRN
Organization.identifier:organizationIdentifier.userequiredIdentifierUse
Organization.identifier:organizationIdentifier.typeextensibleFixed Value: XX
Organization.typeextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.type:careUnitextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.type:careProviderextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.contact.purposeextensibleContactEntityType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
organisationsnummer-invarianterrorOrganization.identifier:organizationIdentifier.valueAll identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
: $this.toString().matches('\\d{10}')

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:

  • The element Organization.type is sliced based on the value of value:coding.code

Differential View

This structure is derived from SEBaseOrganization

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*SEBaseOrganizationA grouping of people or organizations with a common purpose
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... hsaHierarchy S0..*(Complex)HSA Hierarchy
URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy
... identifier S0..*IdentifierIdentifies this organization across multiple systems
.... system S1..1uriURI for objects (e.g. organizations or practitioners) in the HSA catalog.
.... value S1..1stringHSA id.
... identifier:organizationIdentifier S0..1IdentifierOrganization id
.... system S1..1uriURI for Swedish organization number.
.... value SC1..1stringSwedish organization id.
organisationsnummer-invariant: All identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
... Slices for type S0..*CodeableConceptKind of organization
Slice: Unordered, Open by value:coding.code
.... type:careUnit S0..1CodeableConceptKind of organization
..... coding S1..1CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version S1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code S1..1codeSymbol in syntax defined by the system
Required Pattern: 43741000
.... type:careProvider S0..1CodeableConceptKind of organization
..... coding S1..1CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version S1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code S1..1codeSymbol in syntax defined by the system
Required Pattern: 143591000052106
... name S1..1stringName used for the organization
... telecom S0..*ContactPointA contact detail for the organization
.... system S1..1codephone | fax | email | pager | url | sms | other
.... value S1..1stringThe actual contact point details
... address S0..*AddressAn address for the organization
.... line
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... careOf S0..*stringcareOf
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
..... streetAddressLine S0..*stringstreetAddressLine
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
organisationsnummer-invarianterrorOrganization.identifier:organizationIdentifier.valueAll identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
: $this.toString().matches('\\d{10}')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*SEBaseOrganizationA grouping of people or organizations with a common purpose
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... hsaHierarchy S0..*(Complex)HSA Hierarchy
URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy
... Slices for identifier SΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:hsaid SΣC0..1IdentifierThis 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..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriURI for objects (e.g. organizations or practitioners) in the HSA catalog.
Fixed Value: urn:oid:1.2.752.29.4.19
..... value SΣ1..1stringHSA id.
Example General: 123456
.... identifier:organizationIdentifier SΣC0..1IdentifierOrganization id
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriURI for Swedish organization number.
Fixed Value: urn:oid:2.5.4.97
..... value SΣC1..1stringSwedish organization id.
organisationsnummer-invariant: All identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
Example General: 123456
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... Slices for type SΣ0..*CodeableConceptKind of organization
Slice: Unordered, Open by value:coding.code
Binding: SEBaseHSAVerksamhetVS (extensible)
.... type:careUnit SΣ0..1CodeableConceptKind of organization
Binding: SEBaseHSAVerksamhetVS (extensible)
..... coding SΣ1..1CodingCode defined by a terminology system
...... system SΣ1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version SΣ1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code SΣ1..1codeSymbol in syntax defined by the system
Required Pattern: 43741000
.... type:careProvider SΣ0..1CodeableConceptKind of organization
Binding: SEBaseHSAVerksamhetVS (extensible)
..... coding SΣ1..1CodingCode defined by a terminology system
...... system SΣ1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version SΣ1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code SΣ1..1codeSymbol in syntax defined by the system
Required Pattern: 143591000052106
... name SΣC1..1stringName used for the organization
... telecom SC0..*ContactPointA contact detail for the organization
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address SC0..*AddressAn address for the organization
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line Σ0..*stringStreet 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..*ExtensionExtension
Slice: Unordered, Open by value:url
..... careOf S0..*stringcareOf
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
..... streetAddressLine S0..*stringstreetAddressLine
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Organization.identifier:hsaid.userequiredIdentifierUse
Organization.identifier:organizationIdentifier.userequiredIdentifierUse
Organization.typeextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.type:careUnitextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.type:careProviderextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorOrganizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorOrganizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorOrganizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceOrganizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-1errorOrganizationThe organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
organisationsnummer-invarianterrorOrganization.identifier:organizationIdentifier.valueAll identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
: $this.toString().matches('\\d{10}')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization C0..*SEBaseOrganizationA grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... hsaHierarchy S0..*(Complex)HSA Hierarchy
URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣC0..*IdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... identifier:hsaid SΣC0..1IdentifierThis 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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)
...... id0..0stringUnique id for inter-element referencing
...... extension0..0ExtensionAdditional content defined by implementations
...... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..0stringUnique id for inter-element referencing
....... extension0..0ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..0stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PRN
....... display0..0stringRepresentation defined by the system
....... userSelected0..0booleanIf this coding was chosen directly by the user
...... text0..0stringPlain text representation of the concept
..... system SΣ1..1uriURI for objects (e.g. organizations or practitioners) in the HSA catalog.
Fixed Value: urn:oid:1.2.752.29.4.19
..... value SΣ1..1stringHSA id.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:organizationIdentifier SΣC0..1IdentifierOrganization id
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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)
...... id0..0stringUnique id for inter-element referencing
...... extension0..0ExtensionAdditional content defined by implementations
...... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..0stringUnique id for inter-element referencing
....... extension0..0ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..0stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: XX
....... display0..0stringRepresentation defined by the system
....... userSelected0..0booleanIf this coding was chosen directly by the user
...... text0..0stringPlain text representation of the concept
..... system SΣ1..1uriURI for Swedish organization number.
Fixed Value: urn:oid:2.5.4.97
..... value SΣC1..1stringSwedish organization id.
organisationsnummer-invariant: All identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... Slices for type SΣ0..*CodeableConceptKind of organization
Slice: Unordered, Open by value:coding.code
Binding: SEBaseHSAVerksamhetVS (extensible)
.... type:careUnit SΣ0..1CodeableConceptKind of organization
Binding: SEBaseHSAVerksamhetVS (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version SΣ1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code SΣ1..1codeSymbol in syntax defined by the system
Required Pattern: 43741000
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... type:careProvider SΣ0..1CodeableConceptKind of organization
Binding: SEBaseHSAVerksamhetVS (extensible)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding SΣ1..1CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ1..1uriIdentity of the terminology system
Required Pattern: http://snomed.info/sct
...... version SΣ1..1stringVersion of the system - if relevant
Required Pattern: http://snomed.info/sct/45991000052106/version/20220531
...... code SΣ1..1codeSymbol in syntax defined by the system
Required Pattern: 143591000052106
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
... name SΣC1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SC0..*ContactPointA contact detail for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address SC0..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet 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..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... careOf S0..*stringcareOf
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf
..... streetAddressLine S0..*stringstreetAddressLine
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetAddressLine
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... city Σ0..1stringName of city, town etc.
Example General: Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact 0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.

.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Organization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Organization.identifier:hsaid.userequiredIdentifierUse
Organization.identifier:hsaid.typeextensibleFixed Value: PRN
Organization.identifier:organizationIdentifier.userequiredIdentifierUse
Organization.identifier:organizationIdentifier.typeextensibleFixed Value: XX
Organization.typeextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.type:careUnitextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.type:careProviderextensibleSEBaseHSAVerksamhetVS (a valid code from urn:oid:1.2.752.129.2.2.1.3)
Organization.telecom.systemrequiredContactPointSystem
Organization.telecom.userequiredContactPointUse
Organization.address.userequiredAddressUse
Organization.address.typerequiredAddressType
Organization.contact.purposeextensibleContactEntityType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
org-2errorOrganization.addressAn address of an organization can never be of use 'home'
: where(use = 'home').empty()
org-3errorOrganization.telecomThe telecom of an organization can never be of use 'home'
: where(use = 'home').empty()
organisationsnummer-invarianterrorOrganization.identifier:organizationIdentifier.valueAll identifiers that identifies as organisationsnummer SHALL comply with the specified regex:\d{10}
: $this.toString().matches('\\d{10}')

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:

  • The element Organization.type is sliced based on the value of value:coding.code

 

Other representations of profile: CSV, Excel, Schematron