Common FHIR profile vendor collaboration

1.0.0 - release Sweden flag

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

Extension: HSA Hierarchy

Official URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy Version: 1.0.0
Active as of 2023-03-17 Computable Name: HsaHierarchy

This extension is used to describe a unit’s (Location or Organization) place in the Swedish HSA hierarchy. There are two important levels in the hierarchy:

HSA Vårdgivare (eng HSA Care Provider) - This is often a region or private healthcare provider and the highest defined level in the hierarchy HSA Vårdenhet (eng HSA Department) - This is often a department within a region or private healthcare provider and the lower defined level in the hierarchy All official healthcare units in Sweden will have a representation in the national HSA catalogue, and all will have a relationship to a parent HSA Vårdenhet (lower level) and/or HSA Vårdgivare (highest level).

This can among other things be used to evaluate PDL (Patientdatalagen, eng Patient Data Law) rules.

Context of Use

This extension may be used on the following element(s):

  • Element ID Resource
  • Element ID Element

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

Summary

Complex Extension: This extension is used to describe a unit's (Location or Organization) place in the Swedish HSA hierarchy. There are two important levels in the hierarchy: HSA Vårdgivare (eng HSA Care Provider) - This is often a region or private healthcare provider and the highest defined level in the hierarchy HSA Vårdenhet (eng HSA Department) - This is often a department within a region or private healthcare provider and the lower defined level in the hierarchy All official healthcare units in Sweden will have a representation in the national HSA catalogue, and all will have a relationship to a parent HSA Vårdenhet (lower level) and/or HSA Vårdgivare (highest level). This can among other things be used to evaluate PDL (Patientdatalagen, eng Patient Data Law) rules.

  • hsaCareProvider: Reference: An Extension
  • hsaCareUnit: Reference: An Extension

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionHSA Hierarchy
... extension:hsaCareProvider 0..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"hsaCareProvider"
.... value[x] 1..1Reference(Organization)Value of extension
..... type 0..1uriType the reference refers to (e.g. "Patient")
Fixed Value: Organization
..... identifier
...... system 1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
...... value 1..1stringThe value that is unique
... extension:hsaCareUnit 0..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"hsaCareUnit"
.... value[x] 1..1Reference(Organization)Value of extension
..... type 0..1uriType the reference refers to (e.g. "Patient")
Fixed Value: Organization
..... identifier
...... system 1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
...... value 1..1stringThe value that is unique
... url 1..1uri"https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionHSA Hierarchy
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:hsaCareProvider 0..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"hsaCareProvider"
.... value[x] 1..1Reference(Organization)Value of extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Fixed Value: Organization
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... 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.

...... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
...... value Σ1..1stringThe value that is unique
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)
..... display Σ0..1stringText alternative for the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"hsaCareUnit"
.... value[x] 1..1Reference(Organization)Value of extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Fixed Value: Organization
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... 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.

...... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
...... value Σ1..1stringThe value that is unique
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)
..... display Σ0..1stringText alternative for the resource
... url 1..1uri"https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension is used to describe a unit's (Location or Organization) place in the Swedish HSA hierarchy. There are two important levels in the hierarchy: HSA Vårdgivare (eng HSA Care Provider) - This is often a region or private healthcare provider and the highest defined level in the hierarchy HSA Vårdenhet (eng HSA Department) - This is often a department within a region or private healthcare provider and the lower defined level in the hierarchy All official healthcare units in Sweden will have a representation in the national HSA catalogue, and all will have a relationship to a parent HSA Vårdenhet (lower level) and/or HSA Vårdgivare (highest level). This can among other things be used to evaluate PDL (Patientdatalagen, eng Patient Data Law) rules.

  • hsaCareProvider: Reference: An Extension
  • hsaCareUnit: Reference: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionHSA Hierarchy
... extension:hsaCareProvider 0..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"hsaCareProvider"
.... value[x] 1..1Reference(Organization)Value of extension
..... type 0..1uriType the reference refers to (e.g. "Patient")
Fixed Value: Organization
..... identifier
...... system 1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
...... value 1..1stringThe value that is unique
... extension:hsaCareUnit 0..1ExtensionExtension
.... extension 0..0
.... url 1..1uri"hsaCareUnit"
.... value[x] 1..1Reference(Organization)Value of extension
..... type 0..1uriType the reference refers to (e.g. "Patient")
Fixed Value: Organization
..... identifier
...... system 1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
...... value 1..1stringThe value that is unique
... url 1..1uri"https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionHSA Hierarchy
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:hsaCareProvider 0..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"hsaCareProvider"
.... value[x] 1..1Reference(Organization)Value of extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Fixed Value: Organization
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... 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.

...... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
...... value Σ1..1stringThe value that is unique
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)
..... display Σ0..1stringText alternative for the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"hsaCareUnit"
.... value[x] 1..1Reference(Organization)Value of extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
..... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).


Fixed Value: Organization
..... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... 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.

...... system Σ1..1uriThe namespace for the identifier value
Fixed Value: urn:oid:1.2.752.29.4.19
...... value Σ1..1stringThe value that is unique
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)
..... display Σ0..1stringText alternative for the resource
... url 1..1uri"https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Extension.extension:hsaCareProvider.value[x].typeextensibleFixed Value: Organization
Extension.extension:hsaCareProvider.value[x].identifier.userequiredIdentifierUse
Extension.extension:hsaCareProvider.value[x].identifier.typeextensibleIdentifier Type Codes
Extension.extension:hsaCareUnit.value[x].typeextensibleFixed Value: Organization
Extension.extension:hsaCareUnit.value[x].identifier.userequiredIdentifierUse
Extension.extension:hsaCareUnit.value[x].identifier.typeextensibleIdentifier Type Codes

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()