CARE.COMMONPROFILES.FHIR\HSA Hierarchy

Swedish FHIR group common profiles

1.0.2 - ci-build Sweden flag

Swedish FHIR group common profiles, published by Swedish FHIR group. This guide is not an authorized publication; it is the continuous build for version 1.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/commonprofiles-care/fhir/ and changes regularly. See the Directory of published versions

Extension: HSA Hierarchy

Official URL: https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy				Version: 1.0.2
Active as of 2025-02-26				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: Organization

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

Element ID: Resource
Element ID: Organization

Usage info

Usage:

Use this Extension: OrganizationSECommonsLite

Formal Views of Extension Content

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

This structure is derived from Extension

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	HSA Hierarchy
Slices for extension			Content/Rules for all slices
extension:hsaCareProvider	0..1	Extension	Extension
extension	0..0
url	1..1	uri	"hsaCareProvider"
value[x]	1..1	Reference(Organization)	Value of extension
type	0..1	uri	Type the reference refers to (e.g. "Patient") Fixed Value: Organization
identifier
system	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19
value	1..1	string	The value that is unique
extension:hsaCareUnit	0..1	Extension	Extension
extension	0..0
url	1..1	uri	"hsaCareUnit"
value[x]	1..1	Reference(Organization)	Value of extension
type	0..1	uri	Type the reference refers to (e.g. "Patient") Fixed Value: Organization
identifier
system	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19
value	1..1	string	The value that is unique
url	1..1	uri	"https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy"
value[x]	0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Extension		0..*	Extension	HSA Hierarchy
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:hsaCareProvider		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"hsaCareProvider"
value[x]		1..1	Reference(Organization)	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type 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..1	Identifier	Logical reference, when literal reference is not known
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.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19
value	Σ	1..1	string	The value that is unique 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)
display	Σ	0..1	string	Text alternative for the resource
extension:hsaCareUnit		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"hsaCareUnit"
value[x]		1..1	Reference(Organization)	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type 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..1	Identifier	Logical reference, when literal reference is not known
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.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19
value	Σ	1..1	string	The value that is unique 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)
display	Σ	0..1	string	Text alternative for the resource
url		1..1	uri	"https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy"
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

Name	Card.	Type	Description & Constraints
Extension	0..*	Extension	HSA Hierarchy
Slices for extension			Content/Rules for all slices
extension:hsaCareProvider	0..1	Extension	Extension
extension	0..0
url	1..1	uri	"hsaCareProvider"
value[x]	1..1	Reference(Organization)	Value of extension
type	0..1	uri	Type the reference refers to (e.g. "Patient") Fixed Value: Organization
identifier
system	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19
value	1..1	string	The value that is unique
extension:hsaCareUnit	0..1	Extension	Extension
extension	0..0
url	1..1	uri	"hsaCareUnit"
value[x]	1..1	Reference(Organization)	Value of extension
type	0..1	uri	Type the reference refers to (e.g. "Patient") Fixed Value: Organization
identifier
system	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19
value	1..1	string	The value that is unique
url	1..1	uri	"https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy"
value[x]	0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Extension		0..*	Extension	HSA Hierarchy
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:hsaCareProvider		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"hsaCareProvider"
value[x]		1..1	Reference(Organization)	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type 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..1	Identifier	Logical reference, when literal reference is not known
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.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19
value	Σ	1..1	string	The value that is unique 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)
display	Σ	0..1	string	Text alternative for the resource
extension:hsaCareUnit		0..1	Extension	Extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"hsaCareUnit"
value[x]		1..1	Reference(Organization)	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type 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..1	Identifier	Logical reference, when literal reference is not known
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.
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: urn:oid:1.2.752.29.4.19
value	Σ	1..1	string	The value that is unique 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)
display	Σ	0..1	string	Text alternative for the resource
url		1..1	uri	"https://commonprofiles.care/fhir/StructureDefinition/common-hsaHierarchy"
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

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Extension.extension:hsaCareProvider.value[x].type	extensible	Fixed Value: Organization `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Extension.extension:hsaCareProvider.value[x].identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Extension.extension:hsaCareProvider.value[x].identifier.type	extensible	Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
Extension.extension:hsaCareUnit.value[x].type	extensible	Fixed Value: Organization `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
Extension.extension:hsaCareUnit.value[x].identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Extension.extension:hsaCareUnit.value[x].identifier.type	extensible	Identifier Type Codes `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard

Constraints

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

IG © 2021+ Swedish FHIR group. Package care.commonprofiles.fhir#1.0.2 based on FHIR 4.0.1. Generated 2025-02-26
Links: Table of Contents | QA Report